Class: Aws::AppStream::Types::DescribeUsersRequest

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

Overview

Note:

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

{
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
  max_results: 1,
  next_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_type ⇒ String

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

Returns:

  • (String) 


1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-appstream/types.rb', line 1581

class DescribeUsersRequest < Struct.new(
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum size of each page of results.

Returns:

  • (Integer) 


1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-appstream/types.rb', line 1581

class DescribeUsersRequest < Struct.new(
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

  • (String) 


1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-appstream/types.rb', line 1581

class DescribeUsersRequest < Struct.new(
  :authentication_type,
  :max_results,
  :next_token)
  include Aws::Structure
end