java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.AdminRespondToAuthChallengeResponse

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

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

Responds to the authentication challenge, as an administrator.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AdminRespondToAuthChallengeResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationResultType`	`authenticationResult()`	The outcome of a successful authentication process.
`static AdminRespondToAuthChallengeResponse.Builder`	`builder()`
`ChallengeNameType`	`challengeName()`	The name of the challenge that you must next respond to.
`String`	`challengeNameAsString()`	The name of the challenge that you must next respond to.
`Map<String,String>`	`challengeParameters()`	The parameters that define your response to the next challenge.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChallengeParameters()`	For responses, this returns true if the service returned a value for the ChallengeParameters property.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdminRespondToAuthChallengeResponse.Builder>`	`serializableBuilderClass()`
`String`	`session()`	The session identifier that maintains the state of authentication requests and challenge responses.
`AdminRespondToAuthChallengeResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - challengeName
```
public final ChallengeNameType challengeName()
```
    The name of the challenge that you must next respond to. You can find more information about values for ChallengeName in the response parameters of AdminInitiateAuth.
    
    If the service returns an enum value that is not available in the current SDK version, challengeName will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from challengeNameAsString().
    
    Returns:
    
    The name of the challenge that you must next respond to. You can find more information about values for ChallengeName in the response parameters of AdminInitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - challengeNameAsString
```
public final String challengeNameAsString()
```
    The name of the challenge that you must next respond to. You can find more information about values for ChallengeName in the response parameters of AdminInitiateAuth.
    
    If the service returns an enum value that is not available in the current SDK version, challengeName will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from challengeNameAsString().
    
    Returns:
    
    The name of the challenge that you must next respond to. You can find more information about values for ChallengeName in the response parameters of AdminInitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - session
```
public final String session()
```
    The session identifier that maintains the state of authentication requests and challenge responses. If an AdminInitiateAuth or AdminRespondToAuthChallenge API request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the next AdminRespondToAuthChallenge request.
    
    Returns:
    
    The session identifier that maintains the state of authentication requests and challenge responses. If an AdminInitiateAuth or AdminRespondToAuthChallenge API request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the next AdminRespondToAuthChallenge request.
  - hasChallengeParameters
```
public final boolean hasChallengeParameters()
```
    For responses, this returns true if the service returned a value for the ChallengeParameters 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.
  - challengeParameters
```
public final Map<String,String> challengeParameters()
```
    The parameters that define your response to the next challenge. Take the values in ChallengeParameters and provide values for them in the ChallengeResponses of the next AdminRespondToAuthChallenge request.
    
    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 hasChallengeParameters() method.
    
    Returns:
    
    The parameters that define your response to the next challenge. Take the values in ChallengeParameters and provide values for them in the ChallengeResponses of the next AdminRespondToAuthChallenge request.
  - authenticationResult
```
public final AuthenticationResultType authenticationResult()
```
    The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns an AuthenticationResult with the JSON web tokens (JWTs) that indicate successful sign-in.
    
    Returns:
    
    The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns an AuthenticationResult with the JSON web tokens (JWTs) that indicate successful sign-in.
  - toBuilder
```
public AdminRespondToAuthChallengeResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static AdminRespondToAuthChallengeResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AdminRespondToAuthChallengeResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - 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 AdminRespondToAuthChallengeResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

challengeName

challengeNameAsString

session

hasChallengeParameters

challengeParameters

authenticationResult

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField