Class: Aws::CognitoIdentityProvider::Types::UserPoolClientDescription

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

Overview

A short description of a user pool app client.

This data type is a response parameter of [ListUserPoolClients].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html

Constant Summary collapse

SENSITIVE =
[:client_id]

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The app client ID.

Returns:

  • (String)


12305
12306
12307
12308
12309
12310
12311
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 12305

class UserPoolClientDescription < Struct.new(
  :client_id,
  :user_pool_id,
  :client_name)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#client_nameString

The app client name.

Returns:

  • (String)


12305
12306
12307
12308
12309
12310
12311
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 12305

class UserPoolClientDescription < Struct.new(
  :client_id,
  :user_pool_id,
  :client_name)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#user_pool_idString

The ID of the user pool that’s associated with the app client.

Returns:

  • (String)


12305
12306
12307
12308
12309
12310
12311
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 12305

class UserPoolClientDescription < Struct.new(
  :client_id,
  :user_pool_id,
  :client_name)
  SENSITIVE = [:client_id]
  include Aws::Structure
end