list_world_export_jobs
(**kwargs)¶Lists world export jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_world_export_jobs(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.ListWorldExportJobs
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs
returns up to 100 results and a nextToken
value if applicable.Optional filters to limit results. You can use generationJobId
and templateId
.
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'worldExportJobSummaries': [
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'worlds': [
'string',
],
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
worldExportJobSummaries (list) --
Summary information for world export jobs.
(dict) --
Information about a world export job.
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.
worlds (list) --
A list of worlds.
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.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.ThrottlingException