Class: Aws::AppStream::Types::DescribeSessionsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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.

Returns:

  • (String)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_nameString

The name of the fleet. This value is case-sensitive.

Returns:

  • (String)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

The size of each page of results. The default value is 20 and the maximum value is 50.

Returns:

  • (Integer)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  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)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name of the stack. This value is case-sensitive.

Returns:

  • (String)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

Returns:

  • (String)


2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2225

class DescribeSessionsRequest < Struct.new(
  :stack_name,
  :fleet_name,
  :user_id,
  :next_token,
  :limit,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end