@Generated(value="software.amazon.awssdk:codegen") public class RespondToAuthChallengeResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>
The response to respond to the authentication challenge.
Modifier and Type | Class and Description |
---|---|
static interface |
RespondToAuthChallengeResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AuthenticationResultType |
authenticationResult()
The result returned by the server in response to the request to respond to the authentication challenge.
|
static RespondToAuthChallengeResponse.Builder |
builder() |
ChallengeNameType |
challengeName()
The challenge name.
|
String |
challengeNameString()
The challenge name.
|
Map<String,String> |
challengeParameters()
The challenge parameters.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
static Class<? extends RespondToAuthChallengeResponse.Builder> |
serializableBuilderClass() |
String |
session()
The session which should be passed both ways in challenge-response calls to the service.
|
RespondToAuthChallengeResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public ChallengeNameType challengeName()
The challenge name. For more information, see InitiateAuth.
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 challengeNameString()
.
ChallengeNameType
public String challengeNameString()
The challenge name. For more information, see InitiateAuth.
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 challengeNameString()
.
ChallengeNameType
public String session()
The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge
API call.
RespondToAuthChallenge
API call.public Map<String,String> challengeParameters()
The challenge parameters. For more information, see InitiateAuth.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AuthenticationResultType authenticationResult()
The result returned by the server in response to the request to respond to the authentication challenge.
public RespondToAuthChallengeResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>
toBuilder
in class AwsResponse
public static RespondToAuthChallengeResponse.Builder builder()
public static Class<? extends RespondToAuthChallengeResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.