Interface AdminUpdateDeviceStatusRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>, SdkBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
AdminUpdateDeviceStatusRequest
@Mutable @NotThreadSafe public static interface AdminUpdateDeviceStatusRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AdminUpdateDeviceStatusRequest.Builder,AdminUpdateDeviceStatusRequest>

  • Method Details

    • userPoolId

      AdminUpdateDeviceStatusRequest.Builder userPoolId(String userPoolId)

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

      Parameters:
      userPoolId - The ID of the user pool where you want to change a user's device status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      AdminUpdateDeviceStatusRequest.Builder username(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • deviceKey

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

    • deviceRememberedStatus

      AdminUpdateDeviceStatusRequest.Builder deviceRememberedStatus(String deviceRememberedStatus)

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

      Parameters:
      deviceRememberedStatus - To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceRememberedStatus

      AdminUpdateDeviceStatusRequest.Builder deviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus)

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

      Parameters:
      deviceRememberedStatus - To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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