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

Class AdminListDevicesRequest

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

Represents the request to list devices, as an administrator.

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where the device owner is a user.

      Returns:
      The ID of the user pool where the device owner is a user.

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

    • limit

      public final Integer limit()

      The maximum number of devices that you want Amazon Cognito to return in the response.

      Returns:
      The maximum number of devices that you want Amazon Cognito to return in the response.

    • paginationToken

      public final String paginationToken()

      This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

      Returns:
      This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

    • toBuilder

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

    • builder

      public static AdminListDevicesRequest.Builder builder()

    • serializableBuilderClass

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