WorkSpaces / Client / describe_workspace_associations

describe_workspace_associations

WorkSpaces.Client.describe_workspace_associations(**kwargs)

Describes the associations betweens applications and the specified WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace_associations(
    WorkspaceId='string',
    AssociatedResourceTypes=[
        'APPLICATION',
    ]
)

Parameters:

• WorkspaceId (string) –

  [REQUIRED]

  The identifier of the WorkSpace.

• AssociatedResourceTypes (list) –

  [REQUIRED]

  The resource types of the associated resources.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Associations': [
        {
            'AssociatedResourceId': 'string',
            'AssociatedResourceType': 'APPLICATION',
            'Created': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            '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'
            },
            'WorkspaceId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Associations (list) –

    List of information about the specified associations.

    • (dict) –

      Describes the association between an application and a WorkSpace resource.

      • AssociatedResourceId (string) –

        The identifier of the associated resource.

      • AssociatedResourceType (string) –

        The resource types of the associated resource.

      • Created (datetime) –

        The time the association is created.

      • LastUpdatedTime (datetime) –

        The time the association status was last updated.

      • State (string) –

        The status of the WorkSpace 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.

      • WorkspaceId (string) –

        The identifier of the WorkSpace.

Exceptions

• WorkSpaces.Client.exceptions.AccessDeniedException

• WorkSpaces.Client.exceptions.InvalidParameterValuesException

• WorkSpaces.Client.exceptions.OperationNotSupportedException

• WorkSpaces.Client.exceptions.ResourceNotFoundException