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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::DescribeSessionsRequest

Includes:

Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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.

Instance Attribute Details

#authentication_type ⇒ String

The authentication method. Specify ‘API` for a user authenticated using a streaming URL, `SAML` for a SAML 2.0-federated user, or `USERPOOL` for a user in the AppStream 2.0 user pool. The default is to authenticate users using a streaming URL.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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

#fleet_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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

#stack_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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

#user_id ⇒ String

The user identifier.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1426

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