Class: Aws::RoboMaker::Types::DescribeWorldGenerationJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::RoboMaker::Types::DescribeWorldGenerationJobResponse

Includes:

Structure

Defined in:

lib/aws-sdk-robomaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the world generation job.

• #client_request_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #created_at ⇒ Time

  The time, in milliseconds since the epoch, when the world generation job was created.

• #failure_code ⇒ String

  The failure code of the world generation job if it failed:.

• #failure_reason ⇒ String

  The reason why the world generation job failed.

• #finished_worlds_summary ⇒ Types::FinishedWorldsSummary

  Summary information about finished worlds.

• #status ⇒ String

  The status of the world generation job:.

• #tags ⇒ Hash<String,String>

  A map that contains tag keys and tag values that are attached to the world generation job.

• #template ⇒ String

  The Amazon Resource Name (arn) of the world template.

• #world_count ⇒ Types::WorldCount

  Information about the world count.

• #world_tags ⇒ Hash<String,String>

  A map that contains tag keys and tag values that are attached to the generated worlds.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the world generation job.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time, in milliseconds since the epoch, when the world generation job was created.

Returns:

• (Time)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ String

The failure code of the world generation job if it failed:

InternalServiceError

: Internal service error.

LimitExceeded

: The requested resource exceeds the maximum number allowed, or the

number of concurrent stream requests exceeds the maximum number
allowed.

ResourceNotFound

: The specified resource could not be found.

RequestThrottled

: The request was throttled.

InvalidInput

: An input parameter in the request is not valid.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The reason why the world generation job failed.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#finished_worlds_summary ⇒ Types::FinishedWorldsSummary

Summary information about finished worlds.

Returns:

• (Types::FinishedWorldsSummary)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the world generation job:

Pending

: The world generation job request is pending.

Running

: The world generation job is running.

Completed

: The world generation job completed.

Failed

: The world generation job failed. See ‘failureCode` for more

information.

PartialFailed

: Some worlds did not generate.

Canceled

: The world generation job was cancelled.

Canceling

: The world generation job is being cancelled.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map that contains tag keys and tag values that are attached to the world generation job.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#template ⇒ String

The Amazon Resource Name (arn) of the world template.

Returns:

• (String)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#world_count ⇒ Types::WorldCount

Information about the world count.

Returns:

• (Types::WorldCount)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end

#world_tags ⇒ Hash<String,String>

A map that contains tag keys and tag values that are attached to the generated worlds.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-robomaker/types.rb', line 2810

class DescribeWorldGenerationJobResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :template,
  :world_count,
  :finished_worlds_summary,
  :tags,
  :world_tags)
  SENSITIVE = []
  include Aws::Structure
end