ListLicenseSpecificationsForResource
Describes the license configurations for the specified resource.
Request Syntax
{ "MaxResults": number, "NextToken": "string", "ResourceArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
MaxResults (p. 112)
Maximum number of results to return in a single call.
Type: Integer Required: No NextToken (p. 112)
Token for the next set of results.
Type: String Required: No ResourceArn (p. 112)
Amazon Resource Name (ARN) of a resource that has an associated license configuration.
Type: String Required: Yes
Response Syntax
{
"LicenseSpecifications": [ {
"AmiAssociationScope": "string", "LicenseConfigurationArn": "string"
} ],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
LicenseSpecifications (p. 112)
License configurations associated with a resource.
Type: Array of LicenseSpecification (p. 189) objects NextToken (p. 112)
Token for the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
ListLicenseVersions
ListLicenseVersions
Lists all versions of the specified license.
Request Syntax
{
"LicenseArn": "string", "MaxResults": number, "NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
LicenseArn (p. 115)
Amazon Resource Name (ARN) of the license.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[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 (p. 115)
Maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 115)
Token for the next set of results.
Type: String Required: No
Response Syntax
{
"Licenses": [ {
Response Elements
"NextToken": "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.
Licenses (p. 115) License details.
Type: Array of License (p. 175) objects NextToken (p. 115)
Token for the next set of results.
Errors
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListReceivedGrants
ListReceivedGrants
Lists grants that are received but not accepted.
Request Syntax
"GrantArns": [ "string" ], "MaxResults": number, "NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
Filters (p. 118)
Filters to scope the results. The following filters are supported:
• ProductSKU
• LicenseIssuerName
• LicenseArn
• GrantStatus
• GranterAccountId
Type: Array of Filter (p. 165) objects Required: No
GrantArns (p. 118)
Amazon Resource Names (ARNs) of the grants.
Type: Array of strings
Length Constraints: Maximum length of 2048.
Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[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: No MaxResults (p. 118)
Maximum number of results to return in a single call.
Type: Integer
Response Syntax
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 118)
Token for the next set of results.
Type: String "GranteePrincipalArn": "string", "GrantName": "string",
"NextToken": "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.
Grants (p. 119)
Received grant details.
Type: Array of Grant (p. 166) objects NextToken (p. 119)
Token for the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400
See Also
AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ResourceLimitExceededException
Your resource limits have been exceeded.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
HTTP Status Code: 500 ValidationException
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListReceivedLicenses
ListReceivedLicenses
Lists received licenses.
Request Syntax
"LicenseArns": [ "string" ], "MaxResults": number,
"NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
Filters (p. 121)
Filters to scope the results. The following filters are supported:
• ProductSKU
• Status
• Fingerprint
• IssuerName
• Beneficiary
Type: Array of Filter (p. 165) objects Required: No
LicenseArns (p. 121)
Amazon Resource Names (ARNs) of the licenses.
Type: Array of strings
Length Constraints: Maximum length of 2048.
Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[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: No MaxResults (p. 121)
Maximum number of results to return in a single call.
Type: Integer
Response Syntax
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 121)
Token for the next set of results.
Type: String
Response Elements
"NextToken": "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.
Licenses (p. 122)
Received license details.
Type: Array of GrantedLicense (p. 169) objects NextToken (p. 122)
Token for the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ResourceLimitExceededException
Your resource limits have been exceeded.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
See Also
HTTP Status Code: 500 ValidationException
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListResourceInventory
ListResourceInventory
Lists resources managed using Systems Manager inventory.
Request Syntax
"MaxResults": number, "NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
Filters (p. 125)
Filters to scope the results. The following filters and logical operators are supported:
• account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
• application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.
• license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS.
Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
• platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.
• resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.
• tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).
Type: Array of InventoryFilter (p. 172) objects Required: No
MaxResults (p. 125)
Maximum number of results to return in a single call.
Type: Integer Required: No NextToken (p. 125)
Token for the next set of results.
Type: String
Response Syntax
Required: No
Response Syntax
{
"NextToken": "string", "ResourceInventoryList": [ {
"Platform": "string",
"PlatformVersion": "string", "ResourceArn": "string", "ResourceId": "string",
"ResourceOwningAccountId": "string", "ResourceType": "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.
NextToken (p. 126)
Token for the next set of results.
Type: String
ResourceInventoryList (p. 126) Information about the resources.
Type: Array of ResourceInventory (p. 203) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 FailedDependencyException
A dependency required to run the API is missing.
HTTP Status Code: 400
See Also
FilterLimitExceededException
The request uses too many filters or too many filter values.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForResource
ListTagsForResource
Lists the tags for the specified license configuration.
Request Syntax
{
"ResourceArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
ResourceArn (p. 128)
Amazon Resource Name (ARN) of the license configuration.
Type: String Required: Yes
Response Syntax
{
"Tags": [ {
"Key": "string", "Value": "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.
Tags (p. 128)
Information about the tags.
Type: Array of Tag (p. 206) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
See Also
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 InvalidParameterValueException
One or more parameter values are not valid.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTokens
ListTokens
Lists your tokens.
Request Syntax
"MaxResults": number, "NextToken": "string", "TokenIds": [ "string" ] }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 209).
The request accepts the following data in JSON format.
Filters (p. 130)
Filters to scope the results. The following filter is supported:
• LicenseArns
Type: Array of Filter (p. 165) objects Required: No
MaxResults (p. 130)
Maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 130)
Token for the next set of results.
Type: String Required: No TokenIds (p. 130)
Token IDs.
Type: Array of strings Required: No
Response Syntax
Response Syntax
{ "NextToken": "string", "Tokens": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 131)
Token for the next set of results.
Type: String Tokens (p. 131)
Received token details.
Type: Array of TokenData (p. 207) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 211).
AccessDeniedException Access to resource denied.
HTTP Status Code: 400 AuthorizationException
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400 RateLimitExceededException
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400 ServerInternalException
The server experienced an internal error. Try again.
See Also
HTTP Status Code: 500 ValidationException
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3