Struct aws_sdk_robomaker::operation::start_simulation_job_batch::StartSimulationJobBatchOutput

#[non_exhaustive]
pub struct StartSimulationJobBatchOutput {
    pub arn: Option<String>,
    pub status: Option<SimulationJobBatchStatus>,
    pub created_at: Option<DateTime>,
    pub client_request_token: Option<String>,
    pub batch_policy: Option<BatchPolicy>,
    pub failure_code: Option<SimulationJobBatchErrorCode>,
    pub failure_reason: Option<String>,
    pub failed_requests: Option<Vec<FailedCreateSimulationJobRequest>>,
    pub pending_requests: Option<Vec<SimulationJobRequest>>,
    pub created_requests: Option<Vec<SimulationJobSummary>>,
    pub tags: Option<HashMap<String, String>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

The Amazon Resource Name (arn) of the batch.

status: Option<SimulationJobBatchStatus>

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.

created_at: Option<DateTime>

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

client_request_token: Option<String>

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

batch_policy: Option<BatchPolicy>

The batch policy.

failure_code: Option<SimulationJobBatchErrorCode>

The failure code if the simulation job batch failed.

failure_reason: Option<String>

The reason the simulation job batch failed.

failed_requests: Option<Vec<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.

pending_requests: Option<Vec<SimulationJobRequest>>

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

created_requests: Option<Vec<SimulationJobSummary>>

A list of created simulation job request summaries.

tags: Option<HashMap<String, String>>

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

Implementations

impl StartSimulationJobBatchOutput

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (arn) of the batch.

pub fn status(&self) -> Option<&SimulationJobBatchStatus>

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.

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn client_request_token(&self) -> Option<&str>

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

pub fn batch_policy(&self) -> Option<&BatchPolicy>

The batch policy.

pub fn failure_code(&self) -> Option<&SimulationJobBatchErrorCode>

The failure code if the simulation job batch failed.

pub fn failure_reason(&self) -> Option<&str>

The reason the simulation job batch failed.

pub fn failed_requests(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .failed_requests.is_none().

pub fn pending_requests(&self) -> &[SimulationJobRequest]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pending_requests.is_none().

pub fn created_requests(&self) -> &[SimulationJobSummary]

A list of created simulation job request summaries.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .created_requests.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl StartSimulationJobBatchOutput

pub fn builder() -> StartSimulationJobBatchOutputBuilder

Creates a new builder-style object to manufacture StartSimulationJobBatchOutput.

Trait Implementations

impl Clone for StartSimulationJobBatchOutput

fn clone(&self) -> StartSimulationJobBatchOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSimulationJobBatchOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartSimulationJobBatchOutput

fn eq(&self, other: &StartSimulationJobBatchOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for StartSimulationJobBatchOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for StartSimulationJobBatchOutput