custom_workspace_image_imports

Creates, updates, deletes, gets or lists a custom_workspace_image_imports resource.

Overview

Name	custom_workspace_image_imports
Type	Resource
Id	aws.workspaces.custom_workspace_image_imports

Fields

The following fields are returned by SELECT queries:

describe_custom_workspace_image_import

Name	Datatype	Description
created	string (date-time)	The timestamp when the WorkSpace image import was created.
error_details	array	Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
image_builder_instance_id	string	The image builder instance ID of the WorkSpace image.
image_id	string	The identifier of the WorkSpace image. (pattern: <code>wsi-[0-9a-z]{9,63}$</code>)
image_source	object	Describes the image import source.
infrastructure_configuration_arn	string	The infrastructure configuration ARN that specifies how the WorkSpace image is built. (pattern: <code>^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$</code>)
last_updated_time	string (date-time)	The timestamp when the WorkSpace image import was last updated.
progress_percentage	integer	The estimated progress percentage of the WorkSpace image import workflow.
state	string	The state of the WorkSpace image. (PENDING, IN_PROGRESS, PROCESSING_SOURCE_IMAGE, IMAGE_TESTING_START, UPDATING_OPERATING_SYSTEM, IMAGE_COMPATIBILITY_CHECKING, IMAGE_TESTING_GENERALIZATION, CREATING_TEST_INSTANCE, INSTALLING_COMPONENTS, GENERALIZING, VALIDATING, PUBLISHING, COMPLETED, ERROR)
state_message	string	The state message of the WorkSpace image import workflow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_workspace_image_import	select	region		Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_custom_workspace_image_import

Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

SELECT
created,
error_details,
image_builder_instance_id,
image_id,
image_source,
infrastructure_configuration_arn,
last_updated_time,
progress_percentage,
state,
state_message
FROM aws.workspaces.custom_workspace_image_imports
WHERE region = '{{ region }}' -- required
;