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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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

Returns:

  • (String)


1894
1895
1896
1897
1898
1899
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1894

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

#max_resultsInteger

The maximum size of each page of results.

Returns:

  • (Integer)


1894
1895
1896
1897
1898
1899
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1894

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

#next_tokenString

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)


1894
1895
1896
1897
1898
1899
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1894

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