You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::ListUserPoolClientsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass ListUserPoolClientsRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKey",
}

Represents the request to list the user pool clients.

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results you want the request to return when listing the user pool clients.

Returns:

  • (Integer)


3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3797

class ListUserPoolClientsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (String)


3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3797

class ListUserPoolClientsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :next_token)
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool where you want to list user pool clients.

Returns:

  • (String)


3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3797

class ListUserPoolClientsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :next_token)
  include Aws::Structure
end