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

GetLicenseConfiguration

Gets detailed information about the specified license configuration.

Request Syntax

{ "LicenseConfigurationArn": "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.

LicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: Yes

Response Syntax

{ "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", "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.

ConsumedLicenses

Number of licenses assigned to resources.

Type: Long

ConsumedLicenseSummaryList

Summaries of the licenses consumed by resources.

Type: Array of ConsumedLicenseSummary objects

Description

Description of the license configuration.

Type: String

LicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

LicenseConfigurationId

Unique ID for the license configuration.

Type: String

LicenseCount

Number of available licenses.

Type: Long

LicenseCountHardLimit

Sets the number of available licenses as a hard limit.

Type: Boolean

LicenseCountingType

Dimension on which the licenses are counted.

Type: String

Valid Values: vCPU | Instance | Core | Socket

LicenseRules

License rules.

Type: Array of strings

ManagedResourceSummaryList

Summaries of the managed resources.

Type: Array of ManagedResourceSummary objects

Name

Name of the license configuration.

Type: String

OwnerAccountId

Account ID of the owner of the license configuration.

Type: String

Status

License configuration status.

Type: String

Tags

Tags for the license configuration.

Type: Array of Tag objects

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

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: