RoboMaker / Client / create_world_export_job

create_world_export_job#

RoboMaker.Client.create_world_export_job(**kwargs)#

Creates a world export job.

Request Syntax

response = client.create_world_export_job(
    clientRequestToken='string',
    worlds=[
        'string',
    ],
    outputLocation={
        's3Bucket': 'string',
        's3Prefix': 'string'
    },
    iamRole='string',
    tags={
        'string': 'string'
    }
)

Parameters:

clientRequestToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
worlds (list) –
[REQUIRED]

A list of Amazon Resource Names (arns) that correspond to worlds to export.
- (string) –
outputLocation (dict) –
[REQUIRED]

The output location.
- s3Bucket (string) –
  
  The S3 bucket for output.
- s3Prefix (string) –
  
  The S3 folder in the s3Bucket where output files will be placed.
iamRole (string) –
[REQUIRED]

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags (dict) –
A map that contains tag keys and tag values that are attached to the world export job.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
    'createdAt': datetime(2015, 1, 1),
    'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AccessDenied',
    'clientRequestToken': 'string',
    'outputLocation': {
        's3Bucket': 'string',
        's3Prefix': 'string'
    },
    'iamRole': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the world export job.
- status (string) –
  
  The status of the world export job.
  
  Pending
  
  The world export job request is pending.
  
  Running
  
  The world export job is running.
  
  Completed
  
  The world export job completed.
  
  Failed
  
  The world export job failed. See failureCode for more information.
  
  Canceled
  
  The world export job was cancelled.
  
  Canceling
  
  The world export job is being cancelled.
- createdAt (datetime) –
  
  The time, in milliseconds since the epoch, when the world export job was created.
- 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.
  
  AllWorldGenerationFailed
  
  All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.
  
  For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
- clientRequestToken (string) –
  
  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- outputLocation (dict) –
  
  The output location.
  - s3Bucket (string) –
    
    The S3 bucket for output.
  - s3Prefix (string) –
    
    The S3 folder in the s3Bucket where output files will be placed.
- iamRole (string) –
  
  The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
- tags (dict) –
  
  A map that contains tag keys and tag values that are attached to the world export job.
  - (string) –
    - (string) –

Exceptions

RoboMaker.Client.exceptions.ResourceNotFoundException
RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.ThrottlingException
RoboMaker.Client.exceptions.IdempotentParameterMismatchException
RoboMaker.Client.exceptions.ServiceUnavailableException