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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_tokenString

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

Returns:

  • (String)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_atTime

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

Returns:

  • (Time)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_codeString

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)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_reasonString

The reason why the world generation job failed.

Returns:

  • (String)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_summaryTypes::FinishedWorldsSummary

Summary information about finished worlds.



3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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

#statusString

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)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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

#templateString

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

Returns:

  • (String)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_countTypes::WorldCount

Information about the world count.

Returns:



3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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_tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3172

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