DescribeSoftwareAssociations
Retrieves license included application associations for a specified resource.
Request Syntax
{
"AssociatedResource": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AssociatedResource
-
The ARN of the resource to describe software associations. Possible resources are Image and ImageBuilder.
Type: String
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}$Required: Yes
- MaxResults
-
The maximum number of results to return.
Type: Integer
Required: No
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"AssociatedResource": "string",
"NextToken": "string",
"SoftwareAssociations": [
{
"DeploymentError": [
{
"ErrorCode": "string",
"ErrorMessage": "string"
}
],
"SoftwareName": "string",
"Status": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AssociatedResource
-
The ARN of the resource to describe software associations.
Type: String
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}$ - NextToken
-
The pagination token to use to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
- SoftwareAssociations
-
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
Type: Array of SoftwareAssociations objects
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- OperationNotPermittedException
-
The attempted operation is not permitted.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The error message in the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
