You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AppStream::Types::DescribeSessionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppStream::Types::DescribeSessionsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeSessionsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
stack_name: "String", # required
fleet_name: "String", # required
user_id: "UserId",
next_token: "String",
limit: 1,
authentication_type: "API", # accepts API, SAML, USERPOOL
}
Instance Attribute Summary collapse
-
#authentication_type ⇒ String
The authentication method.
-
#fleet_name ⇒ String
The name of the fleet.
-
#limit ⇒ Integer
The size of each page of results.
-
#next_token ⇒ String
The pagination token to use to retrieve the next page of results for this operation.
-
#stack_name ⇒ String
The name of the stack.
-
#user_id ⇒ String
The user identifier (ID).
Instance Attribute Details
#authentication_type ⇒ String
The authentication method. Specify API
for a user authenticated using
a streaming URL or SAML
for a SAML federated user. The default is to
authenticate users using a streaming URL.
Possible values:
- API
- SAML
- USERPOOL
#fleet_name ⇒ String
The name of the fleet. This value is case-sensitive.
#limit ⇒ Integer
The size of each page of results. The default value is 20 and the maximum value is 50.
#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.
#stack_name ⇒ String
The name of the stack. This value is case-sensitive.
#user_id ⇒ String
The user identifier (ID). If you specify a user ID, you must also specify the authentication type.