Struct aws_sdk_robomaker::output::DescribeWorldGenerationJobOutput

#[non_exhaustive]
pub struct DescribeWorldGenerationJobOutput {
    pub arn: Option<String>,
    pub status: Option<WorldGenerationJobStatus>,
    pub created_at: Option<DateTime>,
    pub failure_code: Option<WorldGenerationJobErrorCode>,
    pub failure_reason: Option<String>,
    pub client_request_token: Option<String>,
    pub template: Option<String>,
    pub world_count: Option<WorldCount>,
    pub finished_worlds_summary: Option<FinishedWorldsSummary>,
    pub tags: Option<HashMap<String, String>>,
    pub world_tags: Option<HashMap<String, String>>,
}

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 world generation job.

status: Option<WorldGenerationJobStatus>

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.

created_at: Option<DateTime>

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

failure_code: Option<WorldGenerationJobErrorCode>

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.

failure_reason: Option<String>

The reason why the world generation job failed.

client_request_token: Option<String>

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

template: Option<String>

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

world_count: Option<WorldCount>

Information about the world count.

finished_worlds_summary: Option<FinishedWorldsSummary>

Summary information about finished worlds.

tags: Option<HashMap<String, String>>

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

world_tags: Option<HashMap<String, String>>

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

Implementations

impl DescribeWorldGenerationJobOutput

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

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

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

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.

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

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

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

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.

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

The reason why the world generation job failed.

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

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

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

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

pub fn world_count(&self) -> Option<&WorldCount>

Information about the world count.

pub fn finished_worlds_summary(&self) -> Option<&FinishedWorldsSummary>

Summary information about finished worlds.

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

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

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

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

impl DescribeWorldGenerationJobOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeWorldGenerationJobOutput

Trait Implementations

impl Clone for DescribeWorldGenerationJobOutput

fn clone(&self) -> DescribeWorldGenerationJobOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeWorldGenerationJobOutput

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

Formats the value using the given formatter.

impl PartialEq<DescribeWorldGenerationJobOutput> for DescribeWorldGenerationJobOutput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeWorldGenerationJobOutput