WorkSpaces / Client / describe_application_associations

describe_application_associations#

WorkSpaces.Client.describe_application_associations(**kwargs)#

Describes the associations between the application and the specified associated resources.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_associations(
    MaxResults=123,
    NextToken='string',
    ApplicationId='string',
    AssociatedResourceTypes=[
        'WORKSPACE'|'BUNDLE'|'IMAGE',
    ]
)
Parameters:

  • MaxResults (integer) – The maximum number of associations to return.

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • ApplicationId (string) –

    [REQUIRED]

    The identifier of the specified application.

  • AssociatedResourceTypes (list) –

    [REQUIRED]

    The resource type of the associated resources.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Associations': [
        {
            'ApplicationId': 'string',
            'AssociatedResourceId': 'string',
            'AssociatedResourceType': 'WORKSPACE'|'BUNDLE'|'IMAGE',
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Associations (list) –

      List of associations and information about them.

      • (dict) –

        Describes the association between an application and an application resource.

        • ApplicationId (string) –

          The identifier of the application.

        • AssociatedResourceId (string) –

          The identifier of the associated resource.

        • AssociatedResourceType (string) –

          The resource type of the associated resource.

        • Created (datetime) –

          The time the association was created.

        • LastUpdatedTime (datetime) –

          The time the association status was last updated.

        • State (string) –

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

    • NextToken (string) –

      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Exceptions