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

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

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 DescribeSessionsRequest data as a 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

Instance Attribute Details

#authentication_typeString

The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Returns:

  • (String)


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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

#fleet_nameString

The name of the fleet for which to list sessions.

Returns:

  • (String)


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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

#limitInteger

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

Returns:

  • (Integer)


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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

#stack_nameString

The name of the stack for which to list sessions.

Returns:

  • (String)


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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

#user_idString

The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.

Returns:

  • (String)


669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 669

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