describe-software-associations¶

Description¶

Retrieves license included application associations for a specified resource.

Synopsis¶

  describe-software-associations
--associated-resource <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--associated-resource (string) [required]

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

Constraints:

pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

--max-results (integer)

The maximum number of results to return.

--next-token (string)

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

Constraints:

min: 1

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

AssociatedResource -> (string)

The ARN of the resource to describe software associations.

Constraints:

pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

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

(structure)

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

Constraints:

min: 1

Status -> (string)

The deployment status of the license-included application.

Possible values:

STAGED_FOR_INSTALLATION

PENDING_INSTALLATION

INSTALLED

STAGED_FOR_UNINSTALLATION

PENDING_UNINSTALLATION

FAILED_TO_INSTALL

FAILED_TO_UNINSTALL

DeploymentError -> (list)

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

(structure)

The error details.

ErrorCode -> (string)

The error code.

Constraints:

min: 1

ErrorMessage -> (string)

The error message.

Constraints:

min: 1

NextToken -> (string)