Interface VerifySoftwareTokenRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<VerifySoftwareTokenRequest.Builder,
,VerifySoftwareTokenRequest> SdkBuilder<VerifySoftwareTokenRequest.Builder,
,VerifySoftwareTokenRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
VerifySoftwareTokenRequest
@Mutable
@NotThreadSafe
public static interface VerifySoftwareTokenRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<VerifySoftwareTokenRequest.Builder,VerifySoftwareTokenRequest>
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) A valid access token that Amazon Cognito issued to the currently signed-in user.friendlyDeviceName
(String friendlyDeviceName) A friendly name for the device that's running the TOTP authenticator.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The session ID from anAssociateSoftwareToken
request.A TOTP that the user generated in their configured authenticator app.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
-
accessToken
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
aws.cognito.signin.user.admin
.- Parameters:
accessToken
- A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim foraws.cognito.signin.user.admin
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
session
The session ID from an
AssociateSoftwareToken
request.- Parameters:
session
- The session ID from anAssociateSoftwareToken
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userCode
A TOTP that the user generated in their configured authenticator app.
- Parameters:
userCode
- A TOTP that the user generated in their configured authenticator app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
friendlyDeviceName
A friendly name for the device that's running the TOTP authenticator.
- Parameters:
friendlyDeviceName
- A friendly name for the device that's running the TOTP authenticator.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
VerifySoftwareTokenRequest.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
VerifySoftwareTokenRequest.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.
-