Interface ConfirmDeviceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<ConfirmDeviceRequest.Builder,ConfirmDeviceRequest>, SdkBuilder<ConfirmDeviceRequest.Builder,ConfirmDeviceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ConfirmDeviceRequest

public static interface ConfirmDeviceRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<ConfirmDeviceRequest.Builder,ConfirmDeviceRequest>

Method Summary

Modifier and Type	Method	Description
ConfirmDeviceRequest.Builder	accessToken(String accessToken)	A valid access token that Amazon Cognito issued to the currently signed-in user.
ConfirmDeviceRequest.Builder	deviceKey(String deviceKey)	The unique identifier, or device key, of the device that you want to update the status for.
ConfirmDeviceRequest.Builder	deviceName(String deviceName)	A friendly name for the device, for example MyMobilePhone.
default ConfirmDeviceRequest.Builder	deviceSecretVerifierConfig(Consumer<DeviceSecretVerifierConfigType.Builder> deviceSecretVerifierConfig)	The configuration of the device secret verifier.
ConfirmDeviceRequest.Builder	deviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)	The configuration of the device secret verifier.
ConfirmDeviceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ConfirmDeviceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

accessToken

ConfirmDeviceRequest.Builder accessToken(String 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

deviceKey

ConfirmDeviceRequest.Builder deviceKey(String deviceKey)

The unique identifier, or device key, of the device that you want to update the status for.

Parameters:

deviceKey - The unique identifier, or device key, of the device that you want to update the status for.

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceSecretVerifierConfig

ConfirmDeviceRequest.Builder deviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)

The configuration of the device secret verifier.

Parameters:

deviceSecretVerifierConfig - The configuration of the device secret verifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceSecretVerifierConfig

default ConfirmDeviceRequest.Builder deviceSecretVerifierConfig(Consumer<DeviceSecretVerifierConfigType.Builder> deviceSecretVerifierConfig)

The configuration of the device secret verifier.

This is a convenience method that creates an instance of the DeviceSecretVerifierConfigType.Builder avoiding the need to create one manually via DeviceSecretVerifierConfigType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceSecretVerifierConfig(DeviceSecretVerifierConfigType).

Parameters:

deviceSecretVerifierConfig - a consumer that will call methods on DeviceSecretVerifierConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• deviceSecretVerifierConfig(DeviceSecretVerifierConfigType)

deviceName

ConfirmDeviceRequest.Builder deviceName(String deviceName)

A friendly name for the device, for example MyMobilePhone.

Parameters:

deviceName - A friendly name for the device, for example MyMobilePhone.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ConfirmDeviceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ConfirmDeviceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.