WorkSpaces / Client / describe_image_associations

describe_image_associations#

WorkSpaces.Client.describe_image_associations(**kwargs)#

Describes the associations between the applications and the specified image.

Request Syntax

response = client.describe_image_associations(
    ImageId='string',
    AssociatedResourceTypes=[
        'APPLICATION',
    ]
)

Parameters:

ImageId (string) –
[REQUIRED]

The identifier of the image.
AssociatedResourceTypes (list) –
[REQUIRED]

The resource types of the associated resource.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Associations': [
        {
            'AssociatedResourceId': 'string',
            'AssociatedResourceType': 'APPLICATION',
            'Created': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'ImageId': 'string',
            'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
            'StateReason': {
                'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- Associations (list) –
  
  List of information about the specified associations.
  - (dict) –
    
    Describes the association between an application and an image resource.
    - AssociatedResourceId (string) –
      
      The identifier of the associated resource.
    - AssociatedResourceType (string) –
      
      The resource type of the associated resources.
    - Created (datetime) –
      
      The time the association is created.
    - LastUpdatedTime (datetime) –
      
      The time the association status was last updated.
    - ImageId (string) –
      
      The identifier of the image.
    - State (string) –
      
      The status of the image resource association.
    - StateReason (dict) –
      
      The reason the association deployment failed.
      - ErrorCode (string) –
        
        The error code of the association deployment failure.
      - ErrorMessage (string) –
        
        The error message of the association deployment failure.

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.OperationNotSupportedException
WorkSpaces.Client.exceptions.ResourceNotFoundException