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.GetTokensFromRefreshTokenRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetTokensFromRefreshTokenRequest.Builder,GetTokensFromRefreshTokenRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetTokensFromRefreshTokenRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<GetTokensFromRefreshTokenRequest.Builder,GetTokensFromRefreshTokenRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetTokensFromRefreshTokenRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetTokensFromRefreshTokenRequest.Builder`	`builder()`
`String`	`clientId()`	The app client that issued the refresh token to the user who wants to request new tokens.
`Map<String,String>`	`clientMetadata()`	A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
`String`	`clientSecret()`	The client secret of the requested app client, if the client has a secret.
`String`	`deviceKey()`	When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasClientMetadata()`	For responses, this returns true if the service returned a value for the ClientMetadata property.
`int`	`hashCode()`
`String`	`refreshToken()`	A valid refresh token that can authorize the request for new tokens.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetTokensFromRefreshTokenRequest.Builder>`	`serializableBuilderClass()`
`GetTokensFromRefreshTokenRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - refreshToken
```
public final String refreshToken()
```
    A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete.
    
    Returns:
    
    A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete.
  - clientId
```
public final String clientId()
```
    The app client that issued the refresh token to the user who wants to request new tokens.
    
    Returns:
    
    The app client that issued the refresh token to the user who wants to request new tokens.
  - clientSecret
```
public final String clientSecret()
```
    The client secret of the requested app client, if the client has a secret.
    
    Returns:
    
    The client secret of the requested app client, if the client has a secret.
  - deviceKey
```
public final String deviceKey()
```
    When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.
    
    For more information about device remembering, see Working with devices.
    
    Returns:
    
    When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.
    
    For more information about device remembering, see Working with devices.
  - hasClientMetadata
```
public final boolean hasClientMetadata()
```
    For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - clientMetadata
```
public final Map<String,String> clientMetadata()
```
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.
    
    For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.
    Returns:
    
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.
    
    For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
  - toBuilder
```
public GetTokensFromRefreshTokenRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetTokensFromRefreshTokenRequest.Builder,GetTokensFromRefreshTokenRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static GetTokensFromRefreshTokenRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetTokensFromRefreshTokenRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - 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

Class GetTokensFromRefreshTokenRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

refreshToken

clientId

clientSecret

deviceKey

hasClientMetadata

clientMetadata

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField