DescribeCustomWorkspaceImageImport
Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.
Request Syntax
{
"ImageId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- ImageId
-
The identifier of the WorkSpace image.
Type: String
Pattern:
wsi-[0-9a-z]{9,63}$Required: Yes
Response Syntax
{
"Created": number,
"ErrorDetails": [
{
"ErrorCode": "string",
"ErrorMessage": "string"
}
],
"ImageBuilderInstanceId": "string",
"ImageId": "string",
"ImageSource": { ... },
"InfrastructureConfigurationArn": "string",
"LastUpdatedTime": number,
"State": "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.
- Created
-
The timestamp when the WorkSpace image import was created.
Type: Timestamp
- ErrorDetails
-
Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
Type: Array of CustomWorkspaceImageImportErrorDetails objects
- ImageBuilderInstanceId
-
The image builder instance ID of the WorkSpace image.
Type: String
Length Constraints: Minimum length of 1.
- ImageId
-
The identifier of the WorkSpace image.
Type: String
Pattern:
wsi-[0-9a-z]{9,63}$ - ImageSource
-
Describes the image import source.
Type: ImageSourceIdentifier object
Note: This object is a Union. Only one member of this object can be specified or returned.
- InfrastructureConfigurationArn
-
The infrastructure configuration ARN that specifies how the WorkSpace image is built.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$ - LastUpdatedTime
-
The timestamp when the WorkSpace image import was last updated.
Type: Timestamp
- State
-
The state of the WorkSpace image.
Type: String
Valid Values:
PENDING | IN_PROGRESS | COMPLETED | ERROR
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: