Interface AdminListUserAuthEventsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<AdminListUserAuthEventsRequest.Builder,
,AdminListUserAuthEventsRequest> SdkBuilder<AdminListUserAuthEventsRequest.Builder,
,AdminListUserAuthEventsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AdminListUserAuthEventsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of authentication events to return.This API operation returns a limited number of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The name of the user that you want to query or modify.userPoolId
(String userPoolId) The Id of the user pool that contains the user profile with the logged events.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
userPoolId
The Id of the user pool that contains the user profile with the logged events.
- Parameters:
userPoolId
- The Id of the user pool that contains the user profile with the logged events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If
username
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Parameters:
username
- The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. Ifusername
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of authentication events to return. Returns 60 events if you set
MaxResults
to 0, or if you don't include aMaxResults
parameter.- Parameters:
maxResults
- The maximum number of authentication events to return. Returns 60 events if you setMaxResults
to 0, or if you don't include aMaxResults
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
- Parameters:
nextToken
- This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AdminListUserAuthEventsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AdminListUserAuthEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-