Class: Aws::RoboMaker::Types::StartSimulationJobBatchResponse

Inherits:

Struct

• Object
• Struct
• Aws::RoboMaker::Types::StartSimulationJobBatchResponse

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 batch.

• #batch_policy ⇒ Types::BatchPolicy

  The batch policy.

• #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 simulation job batch was created.

• #created_requests ⇒ Array<Types::SimulationJobSummary>

  A list of created simulation job request summaries.

• #failed_requests ⇒ Array<Types::FailedCreateSimulationJobRequest>

  A list of failed simulation job requests.

• #failure_code ⇒ String

  The failure code if the simulation job batch failed.

• #failure_reason ⇒ String

  The reason the simulation job batch failed.

• #pending_requests ⇒ Array<Types::SimulationJobRequest>

  A list of pending simulation job requests.

• #status ⇒ String

  The status of the simulation job batch.

• #tags ⇒ Hash<String,String>

  A map that contains tag keys and tag values that are attached to the deployment job batch.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (arn) of the batch.

Returns:

• (String)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#batch_policy ⇒ Types::BatchPolicy

The batch policy.

Returns:

• (Types::BatchPolicy)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :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 5096

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time, in milliseconds since the epoch, when the simulation job batch was created.

Returns:

• (Time)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_requests ⇒ Array<Types::SimulationJobSummary>

A list of created simulation job request summaries.

Returns:

• (Array<Types::SimulationJobSummary>)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failed_requests ⇒ Array<Types::FailedCreateSimulationJobRequest>

A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

Returns:

• (Array<Types::FailedCreateSimulationJobRequest>)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ String

The failure code if the simulation job batch failed.

Returns:

• (String)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The reason the simulation job batch failed.

Returns:

• (String)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pending_requests ⇒ Array<Types::SimulationJobRequest>

A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

Returns:

• (Array<Types::SimulationJobRequest>)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the simulation job batch.

Pending

: The simulation job batch request is pending.

InProgress

: The simulation job batch is in progress.

Failed

: The simulation job batch failed. One or more simulation job

requests could not be completed due to an internal failure (like
`InternalServiceError`). See `failureCode` and `failureReason` for
more information.

Completed

: The simulation batch job completed. A batch is complete when (1)

there are no pending simulation job requests in the batch and none
of the failed simulation job requests are due to
`InternalServiceError` and (2) when all created simulation jobs
have reached a terminal state (for example, `Completed` or
`Failed`).

Canceled

: The simulation batch job was cancelled.

Canceling

: The simulation batch job is being cancelled.

Completing

: The simulation batch job is completing.

TimingOut

: The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were
failing due to an internal failure (like `InternalServiceError`),
the batch status will be `Failed`. If there are no such failing
request, the batch status will be `TimedOut`.

TimedOut

: The simulation batch job timed out.

Returns:

• (String)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map that contains tag keys and tag values that are attached to the deployment job batch.

Returns:

• (Hash<String,String>)

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

class StartSimulationJobBatchResponse < Struct.new(
  :arn,
  :status,
  :created_at,
  :client_request_token,
  :batch_policy,
  :failure_code,
  :failure_reason,
  :failed_requests,
  :pending_requests,
  :created_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end