Class VerifySoftwareTokenRequest
java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.VerifySoftwareTokenRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<VerifySoftwareTokenRequest.Builder,
VerifySoftwareTokenRequest>
@Generated("software.amazon.awssdk:codegen")
public final class VerifySoftwareTokenRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<VerifySoftwareTokenRequest.Builder,VerifySoftwareTokenRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
A valid access token that Amazon Cognito issued to the currently signed-in user.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A friendly name for the device that's running the TOTP authenticator.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
static Class
<? extends VerifySoftwareTokenRequest.Builder> final String
session()
The session ID from anAssociateSoftwareToken
request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userCode()
A TOTP that the user generated in their configured authenticator app.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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
.- Returns:
- 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
.
-
session
The session ID from an
AssociateSoftwareToken
request.- Returns:
- The session ID from an
AssociateSoftwareToken
request.
-
userCode
A TOTP that the user generated in their configured authenticator app.
- Returns:
- A TOTP that the user generated in their configured authenticator app.
-
friendlyDeviceName
A friendly name for the device that's running the TOTP authenticator.
- Returns:
- A friendly name for the device that's running the TOTP authenticator.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VerifySoftwareTokenRequest.Builder,
VerifySoftwareTokenRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-