AppStream / Client / describe_software_associations

describe_software_associations

AppStream.Client.describe_software_associations(**kwargs)

Retrieves license included application associations for a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_software_associations(
    AssociatedResource='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AssociatedResource (string) –

    [REQUIRED]

    The ARN of the resource to describe software associations. Possible resources are Image and ImageBuilder.

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

  • NextToken (string) – The pagination token to use to retrieve the next page of results for this operation.

Return type:

dict

Returns:

Response Syntax

{
    'AssociatedResource': 'string',
    'SoftwareAssociations': [
        {
            'SoftwareName': 'string',
            'Status': 'STAGED_FOR_INSTALLATION'|'PENDING_INSTALLATION'|'INSTALLED'|'STAGED_FOR_UNINSTALLATION'|'PENDING_UNINSTALLATION'|'FAILED_TO_INSTALL'|'FAILED_TO_UNINSTALL',
            'DeploymentError': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AssociatedResource (string) –

      The ARN of the resource to describe software associations.

    • SoftwareAssociations (list) –

      Collection of license included applications association details including:

      • License included application name and version information

      • Deployment status (SoftwareDeploymentStatus enum)

      • Error details for failed deployments

      • Association timestamps

      • (dict) –

        The association between a license-included application and a resource.

        • SoftwareName (string) –

          The name of the license-included application.

          Possible values include the following:

          • Microsoft_Office_2021_LTSC_Professional_Plus_32Bit

          • Microsoft_Office_2021_LTSC_Professional_Plus_64Bit

          • Microsoft_Office_2024_LTSC_Professional_Plus_32Bit

          • Microsoft_Office_2024_LTSC_Professional_Plus_64Bit

          • Microsoft_Visio_2021_LTSC_Professional_32Bit

          • Microsoft_Visio_2021_LTSC_Professional_64Bit

          • Microsoft_Visio_2024_LTSC_Professional_32Bit

          • Microsoft_Visio_2024_LTSC_Professional_64Bit

          • Microsoft_Project_2021_Professional_32Bit

          • Microsoft_Project_2021_Professional_64Bit

          • Microsoft_Project_2024_Professional_32Bit

          • Microsoft_Project_2024_Professional_64Bit

          • Microsoft_Office_2021_LTSC_Standard_32Bit

          • Microsoft_Office_2021_LTSC_Standard_64Bit

          • Microsoft_Office_2024_LTSC_Standard_32Bit

          • Microsoft_Office_2024_LTSC_Standard_64Bit

          • Microsoft_Visio_2021_LTSC_Standard_32Bit

          • Microsoft_Visio_2021_LTSC_Standard_64Bit

          • Microsoft_Visio_2024_LTSC_Standard_32Bit

          • Microsoft_Visio_2024_LTSC_Standard_64Bit

          • Microsoft_Project_2021_Standard_32Bit

          • Microsoft_Project_2021_Standard_64Bit

          • Microsoft_Project_2024_Standard_32Bit

          • Microsoft_Project_2024_Standard_64Bit

        • Status (string) –

          The deployment status of the license-included application.

        • DeploymentError (list) –

          The error details for failed deployments of the license-included application.

          • (dict) –

            The error details.

            • ErrorCode (string) –

              The error code.

            • ErrorMessage (string) –

              The error message.

    • NextToken (string) –

      The pagination token to use to retrieve the next page of results for this operation.

Exceptions