Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AuthenticationResultType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AuthenticationResultType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuthenticationResultType.Builder,AuthenticationResultType>

@Generated("software.amazon.awssdk:codegen")
public final class AuthenticationResultType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuthenticationResultType.Builder,AuthenticationResultType>

The object that your application receives after authentication. Contains tokens and information for device authentication.

This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthenticationResultType.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	Your user's access token.
static AuthenticationResultType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expiresIn()	The expiration period of the authentication result in seconds.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	idToken()	Your user's ID token.
NewDeviceMetadataType	newDeviceMetadata()	The new device metadata from an authentication result.
String	refreshToken()	Your user's refresh token.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AuthenticationResultType.Builder>	serializableBuilderClass()
AuthenticationResultType.Builder	toBuilder()
String	tokenType()	The intended use of the token, for example Bearer.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accessToken

public final String accessToken()

Your user's access token.

Returns:

Your user's access token.

expiresIn

public final Integer expiresIn()

The expiration period of the authentication result in seconds.

Returns:

The expiration period of the authentication result in seconds.

tokenType

public final String tokenType()

The intended use of the token, for example Bearer.

Returns:

The intended use of the token, for example Bearer.

refreshToken

public final String refreshToken()

Your user's refresh token.

Returns:

Your user's refresh token.

idToken

public final String idToken()

Your user's ID token.

Returns:

Your user's ID token.

newDeviceMetadata

public final NewDeviceMetadataType newDeviceMetadata()

The new device metadata from an authentication result.

Returns:

The new device metadata from an authentication result.

toBuilder

public AuthenticationResultType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthenticationResultType.Builder,AuthenticationResultType>

builder

public static AuthenticationResultType.Builder builder()

serializableBuilderClass

public static Class<? extends AuthenticationResultType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo