GetExportImageTask - Amazon WorkSpaces Applications

GetExportImageTask

Retrieves information about an export image task, including its current state, progress, and any error details.

Request Syntax

{ "TaskId": "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.

TaskId

The unique identifier of the export image task to retrieve information about.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

Response Syntax

{ "ExportImageTask": { "AmiDescription": "string", "AmiId": "string", "AmiName": "string", "CreatedDate": number, "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ImageArn": "string", "State": "string", "TagSpecifications": { "string" : "string" }, "TaskId": "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.

ExportImageTask

Information about the export image task, including its current state, created date, and any error details.

Type: ExportImageTask object

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

ResourceNotFoundException

The specified resource was not found.

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: