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

ListLicenseConfigurations

Lists the license configurations for your account.

Request Syntax

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

One or more filters.

  • licenseCountingType - The dimension on which licenses are counted (vCPU). Conditions supported are EQUALS | NOT_EQUALS.

  • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Conditions supported are EQUALS | NOT_EQUALS.

  • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Conditions supported are EQUALS | NOT_EQUALS.

Type: Array of Filter objects

Required: No

LicenseConfigurationArns

Amazon Resource Names (ARN) of the license configurations.

Type: Array of strings

Required: No

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

{ "LicenseConfigurations": [ { "ConsumedLicenses": number, "ConsumedLicenseSummaryList": [ { "ConsumedLicenses": number, "ResourceType": "string" } ], "Description": "string", "LicenseConfigurationArn": "string", "LicenseConfigurationId": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "ManagedResourceSummaryList": [ { "AssociationCount": number, "ResourceType": "string" } ], "Name": "string", "OwnerAccountId": "string", "Status": "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.

LicenseConfigurations

Information about the license configurations.

Type: Array of LicenseConfiguration 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: