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

Class AdminUpdateDeviceStatusRequest

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.AdminUpdateDeviceStatusRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>
@Generated("software.amazon.awssdk:codegen") public final class AdminUpdateDeviceStatusRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>

The request to update the device status, as an administrator.

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to change a user's device status.

      Returns:
      The ID of the user pool where you want to change a user's device status.

    • username

      public final String username()

      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

      Returns:
      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

    • deviceKey

      public final String deviceKey()

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

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

    • 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:

    • 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:

    • toBuilder

      public AdminUpdateDeviceStatusRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static AdminUpdateDeviceStatusRequest.Builder builder()

    • serializableBuilderClass

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