Interface AdminListDevicesRequest.Builder

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

  • Method Details

    • userPoolId

      AdminListDevicesRequest.Builder userPoolId(String userPoolId)

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

      Parameters:
      userPoolId - The ID of the user pool where the device owner is a user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

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

    • limit

      AdminListDevicesRequest.Builder limit(Integer limit)

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

      Parameters:
      limit - The maximum number of devices that you want Amazon Cognito to return in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • paginationToken

      AdminListDevicesRequest.Builder paginationToken(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.

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

    • overrideConfiguration

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

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