WorkSpaces / Client / describe_custom_workspace_image_import

describe_custom_workspace_image_import¶

WorkSpaces.Client.describe_custom_workspace_image_import(**kwargs)¶

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

Request Syntax

response = client.describe_custom_workspace_image_import(
    ImageId='string'
)

Parameters:

ImageId (string) –

[REQUIRED]

The identifier of the WorkSpace image.

Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string',
    'InfrastructureConfigurationArn': 'string',
    'State': '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',
    'StateMessage': 'string',
    'ProgressPercentage': 123,
    'Created': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'ImageSource': {
        'Ec2ImportTaskId': 'string',
        'ImageBuildVersionArn': 'string',
        'Ec2ImageId': 'string'
    },
    'ImageBuilderInstanceId': 'string',
    'ErrorDetails': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- ImageId (string) –
  
  The identifier of the WorkSpace image.
- InfrastructureConfigurationArn (string) –
  
  The infrastructure configuration ARN that specifies how the WorkSpace image is built.
- State (string) –
  
  The state of the WorkSpace image.
- StateMessage (string) –
  
  The state message of the WorkSpace image import workflow.
- ProgressPercentage (integer) –
  
  The estimated progress percentage of the WorkSpace image import workflow.
- Created (datetime) –
  
  The timestamp when the WorkSpace image import was created.
- LastUpdatedTime (datetime) –
  
  The timestamp when the WorkSpace image import was last updated.
- ImageSource (dict) –
  
  Describes the image import source.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: Ec2ImportTaskId, ImageBuildVersionArn, Ec2ImageId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - Ec2ImportTaskId (string) –
    
    The EC2 import task ID to import the image from the Amazon EC2 VM import process.
  - ImageBuildVersionArn (string) –
    
    The ARN of the EC2 Image Builder image.
  - Ec2ImageId (string) –
    
    The identifier of the EC2 image.
- ImageBuilderInstanceId (string) –
  
  The image builder instance ID of the WorkSpace image.
- ErrorDetails (list) –
  
  Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
  - (dict) –
    
    Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
    - ErrorCode (string) –
      
      The error code that is returned for the image import.
    - ErrorMessage (string) –
      
      The text of the error message that is returned for the image import.

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.ResourceNotFoundException