AWS License Manager
API Reference (API Version 2018-08-01)

ListUsageForLicenseConfiguration

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "LicenseConfigurationArn": "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.

Filters

Filters to apply.

  • resourceArn - The ARN of the license configuration resource. Conditions supported are EQUALS | NOT_EQUALS.

  • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Conditions supported are EQUALS | NOT_EQUALS.

  • resourceAccount - The ID of the account that owns the resource. Conditions supported are EQUALS | NOT_EQUALS.

Type: Array of Filter objects

Required: No

LicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: Yes

MaxResults

Maximum number of results to return in a single call.

Type: Integer

Required: No

NextToken

Token for the next set of results.

Type: String

Required: No

Response Syntax

{ "LicenseConfigurationUsageList": [ { "AssociationTime": number, "ConsumedLicenses": number, "ResourceArn": "string", "ResourceOwnerId": "string", "ResourceStatus": "string", "ResourceType": "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.

LicenseConfigurationUsageList

Information about the license configurations.

Type: Array of LicenseConfigurationUsage objects

NextToken

Token for the next set of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

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

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: