ListExportImageTasks - Amazon WorkSpaces Applications

ListExportImageTasks

Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.

Type: Array of Filter objects

Required: No

MaxResults

The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 500.

Required: No

NextToken

The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "ExportImageTasks": [ { "AmiDescription": "string", "AmiId": "string", "AmiName": "string", "CreatedDate": number, "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ImageArn": "string", "State": "string", "TagSpecifications": { "string" : "string" }, "TaskId": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ExportImageTasks

The list of export image tasks that match the specified criteria.

Type: Array of ExportImageTask objects

NextToken

The pagination token to use for retrieving the next page of results. This field is only present when there are more results available.

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

OperationNotPermittedException

The attempted operation is not permitted.

Message

The error message in the exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: