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

Interface ListUsersResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>, SdkBuilder<ListUsersResponse.Builder,ListUsersResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
ListUsersResponse
public static interface ListUsersResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

  • Method Details

    • users

      ListUsersResponse.Builder users(Collection<UserType> users)

      A list of the user pool users, and their attributes, that match your query.

      Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

      Parameters:
      users - A list of the user pool users, and their attributes, that match your query.

      Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • users

      ListUsersResponse.Builder users(UserType... users)

      A list of the user pool users, and their attributes, that match your query.

      Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

      Parameters:
      users - A list of the user pool users, and their attributes, that match your query.

      Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • users

      ListUsersResponse.Builder users(Consumer<UserType.Builder>... users)

      A list of the user pool users, and their attributes, that match your query.

      Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

      This is a convenience method that creates an instance of the UserType.Builder avoiding the need to create one manually via UserType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to users(List<UserType>).

      Parameters:
      users - a consumer that will call methods on UserType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • paginationToken

      ListUsersResponse.Builder paginationToken(String paginationToken)

      The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

      Parameters:
      paginationToken - The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. 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.