Class: Aws::Deadline::Types::ListSessionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::ListSessionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-deadline/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #farm_id ⇒ String

  The farm ID for the list of sessions.

• #job_id ⇒ String

  The job ID for the list of sessions.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  The token for the next set of results, or ‘null` to start from the beginning.

• #queue_id ⇒ String

  The queue ID for the list of sessions.

Instance Attribute Details

#farm_id ⇒ String

The farm ID for the list of sessions.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 5831

class ListSessionsRequest < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID for the list of sessions.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 5831

class ListSessionsRequest < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Use this parameter with ‘NextToken` to get results as a set of sequential pages.

Returns:

• (Integer)

# File 'lib/aws-sdk-deadline/types.rb', line 5831

class ListSessionsRequest < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results, or ‘null` to start from the beginning.

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 5831

class ListSessionsRequest < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#queue_id ⇒ String

The queue ID for the list of sessions

Returns:

• (String)

# File 'lib/aws-sdk-deadline/types.rb', line 5831

class ListSessionsRequest < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end