Class: Aws::GameLiftStreams::Types::ListStreamSessionsInput

Inherits:

Struct

• Object
• Struct
• Aws::GameLiftStreams::Types::ListStreamSessionsInput

Includes:

Structure

Defined in:

lib/aws-sdk-gameliftstreams/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #export_files_status ⇒ String

  Filter by the exported files status.

• #identifier ⇒ String

  The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for.

• #max_results ⇒ Integer

  The number of results to return.

• #next_token ⇒ String

  The token that marks the start of the next set of results.

• #status ⇒ String

  Filter by the stream session status.

Instance Attribute Details

#export_files_status ⇒ String

Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

Exported files can be in one of the following states:

• ‘SUCCEEDED`: The exported files are successfully stored in an S3 bucket.

• ‘FAILED`: The session ended but Amazon GameLift Streams couldn’t collect and upload the files to S3.

• ‘PENDING`: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 2126

class ListStreamSessionsInput < Struct.new(
  :status,
  :export_files_status,
  :next_token,
  :max_results,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the [Amazon Resource Name (ARN)].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 2126

class ListStreamSessionsInput < Struct.new(
  :status,
  :export_files_status,
  :next_token,
  :max_results,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The number of results to return. Use this parameter with ‘NextToken` to return results in sequential pages. Default value is `25`.

Returns:

• (Integer)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 2126

class ListStreamSessionsInput < Struct.new(
  :status,
  :export_files_status,
  :next_token,
  :max_results,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 2126

class ListStreamSessionsInput < Struct.new(
  :status,
  :export_files_status,
  :next_token,
  :max_results,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 2126

class ListStreamSessionsInput < Struct.new(
  :status,
  :export_files_status,
  :next_token,
  :max_results,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end