RoboMaker / Client / describe_world_generation_job

describe_world_generation_job

RoboMaker.Client.describe_world_generation_job(**kwargs)

Describes a world generation job.

See also: AWS API Documentation

Request Syntax

response = client.describe_world_generation_job(
    job='string'
)

Parameters:

job (string) –

[REQUIRED]

The Amazon Resource Name (arn) of the world generation job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
    'createdAt': datetime(2015, 1, 1),
    'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
    'failureReason': 'string',
    'clientRequestToken': 'string',
    'template': 'string',
    'worldCount': {
        'floorplanCount': 123,
        'interiorCountPerFloorplan': 123
    },
    'finishedWorldsSummary': {
        'finishedCount': 123,
        'succeededWorlds': [
            'string',
        ],
        'failureSummary': {
            'totalFailureCount': 123,
            'failures': [
                {
                    'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
                    'sampleFailureReason': 'string',
                    'failureCount': 123
                },
            ]
        }
    },
    'tags': {
        'string': 'string'
    },
    'worldTags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • arn (string) –

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

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

  • createdAt (datetime) –

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

  • failureCode (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.

  • failureReason (string) –

    The reason why the world generation job failed.

  • clientRequestToken (string) –

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

  • template (string) –

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

  • worldCount (dict) –

    Information about the world count.

    • floorplanCount (integer) –

      The number of unique floorplans.

    • interiorCountPerFloorplan (integer) –

      The number of unique interiors per floorplan.

  • finishedWorldsSummary (dict) –

    Summary information about finished worlds.

    • finishedCount (integer) –

      The total number of finished worlds.

    • succeededWorlds (list) –

      A list of worlds that succeeded.

      • (string) –

    • failureSummary (dict) –

      Information about worlds that failed.

      • totalFailureCount (integer) –

        The total number of failures.

      • failures (list) –

        The worlds that failed.

        • (dict) –

          Information about a failed world.

          • failureCode (string) –

            The failure code of the world export 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.

          • sampleFailureReason (string) –

            The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

          • failureCount (integer) –

            The number of failed worlds.

  • tags (dict) –

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

    • (string) –

      • (string) –

  • worldTags (dict) –

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

    • (string) –

      • (string) –

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException