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

Class UpdateDeviceStatusRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDeviceStatusRequest.Builder,UpdateDeviceStatusRequest>

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

Represents the request to update the device status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDeviceStatusRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	A valid access token that Amazon Cognito issued to the currently signed-in user.
static UpdateDeviceStatusRequest.Builder	builder()
String	deviceKey()	The device key of the device you want to update, for example us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
DeviceRememberedStatusType	deviceRememberedStatus()	To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.
String	deviceRememberedStatusAsString()	To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDeviceStatusRequest.Builder>	serializableBuilderClass()
UpdateDeviceStatusRequest.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

accessToken

public final 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.

Returns:

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.

deviceKey

public final String deviceKey()

The device key of the device you want to update, for example us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Returns:

The device key of the device you want to update, for example us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

deviceRememberedStatus

public final DeviceRememberedStatusType deviceRememberedStatus()

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

If the service returns an enum value that is not available in the current SDK version, deviceRememberedStatus will return DeviceRememberedStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceRememberedStatusAsString().

Returns:

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

See Also:

DeviceRememberedStatusType

deviceRememberedStatusAsString

public final String deviceRememberedStatusAsString()

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

If the service returns an enum value that is not available in the current SDK version, deviceRememberedStatus will return DeviceRememberedStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceRememberedStatusAsString().

Returns:

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

See Also:

DeviceRememberedStatusType

toBuilder

public UpdateDeviceStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDeviceStatusRequest.Builder,UpdateDeviceStatusRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static UpdateDeviceStatusRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDeviceStatusRequest.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