AWS License Manager 2018-08-01
- Client: Aws\LicenseManager\LicenseManagerClient
- Service ID: license-manager
- Version: 2018-08-01
This page describes the parameters and results for the operations of the AWS License Manager (2018-08-01), and shows how to use the Aws\LicenseManager\LicenseManagerClient object to call the described operations. This documentation is specific to the 2018-08-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcceptGrant ( array $params = [] )
Accepts the specified grant.
- CheckInLicense ( array $params = [] )
Checks in the specified license.
- CheckoutBorrowLicense ( array $params = [] )
Checks out the specified license for offline use.
- CheckoutLicense ( array $params = [] )
Checks out the specified license.
- CreateGrant ( array $params = [] )
Creates a grant for the specified license.
- CreateGrantVersion ( array $params = [] )
Creates a new version of the specified grant.
- CreateLicense ( array $params = [] )
Creates a license.
- CreateLicenseConfiguration ( array $params = [] )
Creates a license configuration.
- CreateLicenseConversionTaskForResource ( array $params = [] )
Creates a new license conversion task.
- CreateLicenseManagerReportGenerator ( array $params = [] )
Creates a report generator.
- CreateLicenseVersion ( array $params = [] )
Creates a new version of the specified license.
- CreateToken ( array $params = [] )
Creates a long-lived token.
- DeleteGrant ( array $params = [] )
Deletes the specified grant.
- DeleteLicense ( array $params = [] )
Deletes the specified license.
- DeleteLicenseConfiguration ( array $params = [] )
Deletes the specified license configuration.
- DeleteLicenseManagerReportGenerator ( array $params = [] )
Deletes the specified report generator.
- DeleteToken ( array $params = [] )
Deletes the specified token.
- ExtendLicenseConsumption ( array $params = [] )
Extends the expiration date for license consumption.
- GetAccessToken ( array $params = [] )
Gets a temporary access token to use with AssumeRoleWithWebIdentity.
- GetGrant ( array $params = [] )
Gets detailed information about the specified grant.
- GetLicense ( array $params = [] )
Gets detailed information about the specified license.
- GetLicenseConfiguration ( array $params = [] )
Gets detailed information about the specified license configuration.
- GetLicenseConversionTask ( array $params = [] )
Gets information about the specified license type conversion task.
- GetLicenseManagerReportGenerator ( array $params = [] )
Gets information about the specified report generator.
- GetLicenseUsage ( array $params = [] )
Gets detailed information about the usage of the specified license.
- GetServiceSettings ( array $params = [] )
Gets the License Manager settings for the current Region.
- ListAssociationsForLicenseConfiguration ( array $params = [] )
Lists the resource associations for the specified license configuration.
- ListDistributedGrants ( array $params = [] )
Lists the grants distributed for the specified license.
- ListFailuresForLicenseConfigurationOperations ( array $params = [] )
Lists the license configuration operations that failed.
- ListLicenseConfigurations ( array $params = [] )
Lists the license configurations for your account.
- ListLicenseConversionTasks ( array $params = [] )
Lists the license type conversion tasks for your account.
- ListLicenseManagerReportGenerators ( array $params = [] )
Lists the report generators for your account.
- ListLicenseSpecificationsForResource ( array $params = [] )
Describes the license configurations for the specified resource.
- ListLicenseVersions ( array $params = [] )
Lists all versions of the specified license.
- ListLicenses ( array $params = [] )
Lists the licenses for your account.
- ListReceivedGrants ( array $params = [] )
Lists grants that are received but not accepted.
- ListReceivedGrantsForOrganization ( array $params = [] )
Lists the grants received for all accounts in the organization.
- ListReceivedLicenses ( array $params = [] )
Lists received licenses.
- ListReceivedLicensesForOrganization ( array $params = [] )
Lists the licenses received for all accounts in the organization.
- ListResourceInventory ( array $params = [] )
Lists resources managed using Systems Manager inventory.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified license configuration.
- ListTokens ( array $params = [] )
Lists your tokens.
- ListUsageForLicenseConfiguration ( array $params = [] )
Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.
- RejectGrant ( array $params = [] )
Rejects the specified grant.
- TagResource ( array $params = [] )
Adds the specified tags to the specified license configuration.
- UntagResource ( array $params = [] )
Removes the specified tags from the specified license configuration.
- UpdateLicenseConfiguration ( array $params = [] )
Modifies the attributes of an existing license configuration.
- UpdateLicenseManagerReportGenerator ( array $params = [] )
Updates a report generator.
- UpdateLicenseSpecificationsForResource ( array $params = [] )
Adds or removes the specified license configurations for the specified Amazon Web Services resource.
- UpdateServiceSettings ( array $params = [] )
Updates License Manager settings for the current Region.
Operations
AcceptGrant
$result = $client->acceptGrant([/* ... */]); $promise = $client->acceptGrantAsync([/* ... */]);
Accepts the specified grant.
Parameter Syntax
$result = $client->acceptGrant([
'GrantArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'GrantArn' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
CheckInLicense
$result = $client->checkInLicense([/* ... */]); $promise = $client->checkInLicenseAsync([/* ... */]);
Checks in the specified license. Check in a license when it is no longer in use.
Parameter Syntax
$result = $client->checkInLicense([
'Beneficiary' => '<string>',
'LicenseConsumptionToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The resource cannot be found.
-
There was a conflict processing the request. Try your request again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
CheckoutBorrowLicense
$result = $client->checkoutBorrowLicense([/* ... */]); $promise = $client->checkoutBorrowLicenseAsync([/* ... */]);
Checks out the specified license for offline use.
Parameter Syntax
$result = $client->checkoutBorrowLicense([
'CheckoutMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'ClientToken' => '<string>', // REQUIRED
'DigitalSignatureMethod' => 'JWT_PS384', // REQUIRED
'Entitlements' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
'Value' => '<string>',
],
// ...
],
'LicenseArn' => '<string>', // REQUIRED
'NodeId' => '<string>',
]);
Parameter Details
Members
- CheckoutMetadata
-
- Type: Array of Metadata structures
Information about constraints.
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- DigitalSignatureMethod
-
- Required: Yes
- Type: string
Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
- Entitlements
-
- Required: Yes
- Type: Array of EntitlementData structures
License entitlements. Partial checkouts are not supported.
- LicenseArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
- NodeId
-
- Type: string
Node ID.
Result Syntax
[
'CheckoutMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'EntitlementsAllowed' => [
[
'Name' => '<string>',
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'Expiration' => '<string>',
'IssuedAt' => '<string>',
'LicenseArn' => '<string>',
'LicenseConsumptionToken' => '<string>',
'NodeId' => '<string>',
'SignedToken' => '<string>',
]
Result Details
Members
- CheckoutMetadata
-
- Type: Array of Metadata structures
Information about constraints.
- EntitlementsAllowed
-
- Type: Array of EntitlementData structures
Allowed license entitlements.
- Expiration
-
- Type: string
Date and time at which the license checkout expires.
- IssuedAt
-
- Type: string
Date and time at which the license checkout is issued.
- LicenseArn
-
- Type: string
Amazon Resource Name (ARN) of the license.
- LicenseConsumptionToken
-
- Type: string
License consumption token.
- NodeId
-
- Type: string
Node ID.
- SignedToken
-
- Type: string
Signed token.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The resource cannot be found.
-
NoEntitlementsAllowedException:
There are no entitlements found for this license, or the entitlement maximum count is reached.
-
EntitlementNotAllowedException:
The entitlement is not allowed.
-
UnsupportedDigitalSignatureMethodException:
The digital signature method is unsupported. Try your request again.
-
This is not the correct Region for the resource. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
CheckoutLicense
$result = $client->checkoutLicense([/* ... */]); $promise = $client->checkoutLicenseAsync([/* ... */]);
Checks out the specified license.
If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.
Parameter Syntax
$result = $client->checkoutLicense([
'Beneficiary' => '<string>',
'CheckoutType' => 'PROVISIONAL|PERPETUAL', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'Entitlements' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
'Value' => '<string>',
],
// ...
],
'KeyFingerprint' => '<string>', // REQUIRED
'NodeId' => '<string>',
'ProductSKU' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Beneficiary
-
- Type: string
License beneficiary.
- CheckoutType
-
- Required: Yes
- Type: string
Checkout type.
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Entitlements
-
- Required: Yes
- Type: Array of EntitlementData structures
License entitlements.
- KeyFingerprint
-
- Required: Yes
- Type: string
Key fingerprint identifying the license.
- NodeId
-
- Type: string
Node ID.
- ProductSKU
-
- Required: Yes
- Type: string
Product SKU.
Result Syntax
[
'CheckoutType' => 'PROVISIONAL|PERPETUAL',
'EntitlementsAllowed' => [
[
'Name' => '<string>',
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'Expiration' => '<string>',
'IssuedAt' => '<string>',
'LicenseArn' => '<string>',
'LicenseConsumptionToken' => '<string>',
'NodeId' => '<string>',
'SignedToken' => '<string>',
]
Result Details
Members
- CheckoutType
-
- Type: string
Checkout type.
- EntitlementsAllowed
-
- Type: Array of EntitlementData structures
Allowed license entitlements.
- Expiration
-
- Type: string
Date and time at which the license checkout expires.
- IssuedAt
-
- Type: string
Date and time at which the license checkout is issued.
- LicenseArn
-
- Type: string
Amazon Resource Name (ARN) of the checkout license.
- LicenseConsumptionToken
-
- Type: string
License consumption token.
- NodeId
-
- Type: string
Node ID.
- SignedToken
-
- Type: string
Signed token.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The resource cannot be found.
-
NoEntitlementsAllowedException:
There are no entitlements found for this license, or the entitlement maximum count is reached.
-
UnsupportedDigitalSignatureMethodException:
The digital signature method is unsupported. Try your request again.
-
This is not the correct Region for the resource. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
CreateGrant
$result = $client->createGrant([/* ... */]); $promise = $client->createGrantAsync([/* ... */]);
Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services accounts.
Parameter Syntax
$result = $client->createGrant([
'AllowedOperations' => ['<string>', ...], // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'GrantName' => '<string>', // REQUIRED
'HomeRegion' => '<string>', // REQUIRED
'LicenseArn' => '<string>', // REQUIRED
'Principals' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- AllowedOperations
-
- Required: Yes
- Type: Array of strings
Allowed operations for the grant.
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- GrantName
-
- Required: Yes
- Type: string
Grant name.
- HomeRegion
-
- Required: Yes
- Type: string
Home Region of the grant.
- LicenseArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license.
- Principals
-
- Required: Yes
- Type: Array of strings
The grant principals. This value should be specified as an Amazon Resource Name (ARN).
Result Syntax
[
'GrantArn' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
-
Access to resource denied.
CreateGrantVersion
$result = $client->createGrantVersion([/* ... */]); $promise = $client->createGrantVersionAsync([/* ... */]);
Creates a new version of the specified grant.
Parameter Syntax
$result = $client->createGrantVersion([
'AllowedOperations' => ['<string>', ...],
'ClientToken' => '<string>', // REQUIRED
'GrantArn' => '<string>', // REQUIRED
'GrantName' => '<string>',
'SourceVersion' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'StatusReason' => '<string>',
]);
Parameter Details
Members
- AllowedOperations
-
- Type: Array of strings
Allowed operations for the grant.
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- GrantArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the grant.
- GrantName
-
- Type: string
Grant name.
- SourceVersion
-
- Type: string
Current version of the grant.
- Status
-
- Type: string
Grant status.
- StatusReason
-
- Type: string
Grant status reason.
Result Syntax
[
'GrantArn' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
CreateLicense
$result = $client->createLicense([/* ... */]); $promise = $client->createLicenseAsync([/* ... */]);
Creates a license.
Parameter Syntax
$result = $client->createLicense([
'Beneficiary' => '<string>', // REQUIRED
'ClientToken' => '<string>', // REQUIRED
'ConsumptionConfiguration' => [ // REQUIRED
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false, // REQUIRED
'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
],
'RenewType' => 'None|Weekly|Monthly',
],
'Entitlements' => [ // REQUIRED
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>', // REQUIRED
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>', // REQUIRED
'Issuer' => [ // REQUIRED
'Name' => '<string>', // REQUIRED
'SignKey' => '<string>',
],
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>', // REQUIRED
'ProductName' => '<string>', // REQUIRED
'ProductSKU' => '<string>', // REQUIRED
'Validity' => [ // REQUIRED
'Begin' => '<string>', // REQUIRED
'End' => '<string>',
],
]);
Parameter Details
Members
- Beneficiary
-
- Required: Yes
- Type: string
License beneficiary.
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- ConsumptionConfiguration
-
- Required: Yes
- Type: ConsumptionConfiguration structure
Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
- Entitlements
-
- Required: Yes
- Type: Array of Entitlement structures
License entitlements.
- HomeRegion
-
- Required: Yes
- Type: string
Home Region for the license.
- Issuer
-
- Required: Yes
- Type: Issuer structure
License issuer.
- LicenseMetadata
-
- Type: Array of Metadata structures
Information about the license.
- LicenseName
-
- Required: Yes
- Type: string
License name.
- ProductName
-
- Required: Yes
- Type: string
Product name.
- ProductSKU
-
- Required: Yes
- Type: string
Product SKU.
- Validity
-
- Required: Yes
- Type: DatetimeRange structure
Date and time range during which the license is valid, in ISO8601-UTC format.
Result Syntax
[
'LicenseArn' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
This is not the correct Region for the resource. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
CreateLicenseConfiguration
$result = $client->createLicenseConfiguration([/* ... */]); $promise = $client->createLicenseConfigurationAsync([/* ... */]);
Creates a license configuration.
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
Parameter Syntax
$result = $client->createLicenseConfiguration([
'Description' => '<string>',
'DisassociateWhenNotFound' => true || false,
'LicenseCount' => <integer>,
'LicenseCountHardLimit' => true || false,
'LicenseCountingType' => 'vCPU|Instance|Core|Socket', // REQUIRED
'LicenseRules' => ['<string>', ...],
'Name' => '<string>', // REQUIRED
'ProductInformationList' => [
[
'ProductInformationFilterList' => [ // REQUIRED
[
'ProductInformationFilterComparator' => '<string>', // REQUIRED
'ProductInformationFilterName' => '<string>', // REQUIRED
'ProductInformationFilterValue' => ['<string>', ...],
],
// ...
],
'ResourceType' => '<string>', // REQUIRED
],
// ...
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
Description of the license configuration.
- DisassociateWhenNotFound
-
- Type: boolean
When true, disassociates a resource when software is uninstalled.
- LicenseCount
-
- Type: long (int|float)
Number of licenses managed by the license configuration.
- LicenseCountHardLimit
-
- Type: boolean
Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
- LicenseCountingType
-
- Required: Yes
- Type: string
Dimension used to track the license inventory.
- LicenseRules
-
- Type: Array of strings
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
-
Coresdimension:allowedTenancy|licenseAffinityToHost|maximumCores|minimumCores -
Instancesdimension:allowedTenancy|maximumCores|minimumCores|maximumSockets|minimumSockets|maximumVcpus|minimumVcpus -
Socketsdimension:allowedTenancy|licenseAffinityToHost|maximumSockets|minimumSockets -
vCPUsdimension:allowedTenancy|honorVcpuOptimization|maximumVcpus|minimumVcpus
The unit for
licenseAffinityToHostis days and the range is 1 to 180. The possible values forallowedTenancyareEC2-Default,EC2-DedicatedHost, andEC2-DedicatedInstance. The possible values forhonorVcpuOptimizationareTrueandFalse. - Name
-
- Required: Yes
- Type: string
Name of the license configuration.
- ProductInformationList
-
- Type: Array of ProductInformation structures
Product information.
- Tags
-
- Type: Array of Tag structures
Tags to add to the license configuration.
Result Syntax
[
'LicenseConfigurationArn' => '<string>',
]
Result Details
Members
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
CreateLicenseConversionTaskForResource
$result = $client->createLicenseConversionTaskForResource([/* ... */]); $promise = $client->createLicenseConversionTaskForResourceAsync([/* ... */]);
Creates a new license conversion task.
Parameter Syntax
$result = $client->createLicenseConversionTaskForResource([
'DestinationLicenseContext' => [ // REQUIRED
'UsageOperation' => '<string>',
],
'ResourceArn' => '<string>', // REQUIRED
'SourceLicenseContext' => [ // REQUIRED
'UsageOperation' => '<string>',
],
]);
Parameter Details
Members
- DestinationLicenseContext
-
- Required: Yes
- Type: LicenseConversionContext structure
Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.
- ResourceArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the resource you are converting the license type for.
- SourceLicenseContext
-
- Required: Yes
- Type: LicenseConversionContext structure
Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.
Result Syntax
[
'LicenseConversionTaskId' => '<string>',
]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The provided input is not valid. Try your request again.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
CreateLicenseManagerReportGenerator
$result = $client->createLicenseManagerReportGenerator([/* ... */]); $promise = $client->createLicenseManagerReportGeneratorAsync([/* ... */]);
Creates a report generator.
Parameter Syntax
$result = $client->createLicenseManagerReportGenerator([
'ClientToken' => '<string>', // REQUIRED
'Description' => '<string>',
'ReportContext' => [ // REQUIRED
'licenseConfigurationArns' => ['<string>', ...], // REQUIRED
],
'ReportFrequency' => [ // REQUIRED
'period' => 'DAY|WEEK|MONTH',
'value' => <integer>,
],
'ReportGeneratorName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Description
-
- Type: string
Description of the report generator.
- ReportContext
-
- Required: Yes
- Type: ReportContext structure
Defines the type of license configuration the report generator tracks.
- ReportFrequency
-
- Required: Yes
- Type: ReportFrequency structure
Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
- ReportGeneratorName
-
- Required: Yes
- Type: string
Name of the report generator.
- Tags
-
- Type: Array of Tag structures
Tags to add to the report generator.
- Type
-
- Required: Yes
- Type: Array of strings
Type of reports to generate. The following report types an be generated:
-
License configuration report - Reports the number and details of consumed licenses for a license configuration.
-
Resource report - Reports the tracked licenses and resource consumption for a license configuration.
Result Syntax
[
'LicenseManagerReportGeneratorArn' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
-
Access to resource denied.
-
The resource cannot be found.
CreateLicenseVersion
$result = $client->createLicenseVersion([/* ... */]); $promise = $client->createLicenseVersionAsync([/* ... */]);
Creates a new version of the specified license.
Parameter Syntax
$result = $client->createLicenseVersion([
'ClientToken' => '<string>', // REQUIRED
'ConsumptionConfiguration' => [ // REQUIRED
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false, // REQUIRED
'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>, // REQUIRED
],
'RenewType' => 'None|Weekly|Monthly',
],
'Entitlements' => [ // REQUIRED
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>', // REQUIRED
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second', // REQUIRED
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>', // REQUIRED
'Issuer' => [ // REQUIRED
'Name' => '<string>', // REQUIRED
'SignKey' => '<string>',
],
'LicenseArn' => '<string>', // REQUIRED
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>', // REQUIRED
'ProductName' => '<string>', // REQUIRED
'SourceVersion' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED', // REQUIRED
'Validity' => [ // REQUIRED
'Begin' => '<string>', // REQUIRED
'End' => '<string>',
],
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- ConsumptionConfiguration
-
- Required: Yes
- Type: ConsumptionConfiguration structure
Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
- Entitlements
-
- Required: Yes
- Type: Array of Entitlement structures
License entitlements.
- HomeRegion
-
- Required: Yes
- Type: string
Home Region of the license.
- Issuer
-
- Required: Yes
- Type: Issuer structure
License issuer.
- LicenseArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license.
- LicenseMetadata
-
- Type: Array of Metadata structures
Information about the license.
- LicenseName
-
- Required: Yes
- Type: string
License name.
- ProductName
-
- Required: Yes
- Type: string
Product name.
- SourceVersion
-
- Type: string
Current version of the license.
- Status
-
- Required: Yes
- Type: string
License status.
- Validity
-
- Required: Yes
- Type: DatetimeRange structure
Date and time range during which the license is valid, in ISO8601-UTC format.
Result Syntax
[
'LicenseArn' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
Access to resource denied.
-
The resource cannot be found.
-
This is not the correct Region for the resource. Try again.
-
There was a conflict processing the request. Try your request again.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
CreateToken
$result = $client->createToken([/* ... */]); $promise = $client->createTokenAsync([/* ... */]);
Creates a long-lived token.
A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.
Parameter Syntax
$result = $client->createToken([
'ClientToken' => '<string>', // REQUIRED
'ExpirationInDays' => <integer>,
'LicenseArn' => '<string>', // REQUIRED
'RoleArns' => ['<string>', ...],
'TokenProperties' => ['<string>', ...],
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
Idempotency token, valid for 10 minutes.
- ExpirationInDays
-
- Type: int
Token expiration, in days, counted from token creation. The default is 365 days.
- LicenseArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.
- RoleArns
-
- Type: Array of strings
Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.
- TokenProperties
-
- Type: Array of strings
Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.
Result Syntax
[
'Token' => '<string>',
'TokenId' => '<string>',
'TokenType' => 'REFRESH_TOKEN',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The resource cannot be found.
-
This is not the correct Region for the resource. Try again.
DeleteGrant
$result = $client->deleteGrant([/* ... */]); $promise = $client->deleteGrantAsync([/* ... */]);
Deletes the specified grant.
Parameter Syntax
$result = $client->deleteGrant([
'GrantArn' => '<string>', // REQUIRED
'StatusReason' => '<string>',
'Version' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'GrantArn' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
DeleteLicense
$result = $client->deleteLicense([/* ... */]); $promise = $client->deleteLicenseAsync([/* ... */]);
Deletes the specified license.
Parameter Syntax
$result = $client->deleteLicense([
'LicenseArn' => '<string>', // REQUIRED
'SourceVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DeletionDate' => '<string>',
'Status' => 'PENDING_DELETE|DELETED',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
This is not the correct Region for the resource. Try again.
-
There was a conflict processing the request. Try your request again.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
DeleteLicenseConfiguration
$result = $client->deleteLicenseConfiguration([/* ... */]); $promise = $client->deleteLicenseConfigurationAsync([/* ... */]);
Deletes the specified license configuration.
You cannot delete a license configuration that is in use.
Parameter Syntax
$result = $client->deleteLicenseConfiguration([
'LicenseConfigurationArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
DeleteLicenseManagerReportGenerator
$result = $client->deleteLicenseManagerReportGenerator([/* ... */]); $promise = $client->deleteLicenseManagerReportGeneratorAsync([/* ... */]);
Deletes the specified report generator.
This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.
Parameter Syntax
$result = $client->deleteLicenseManagerReportGenerator([
'LicenseManagerReportGeneratorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
-
Access to resource denied.
-
The resource cannot be found.
DeleteToken
$result = $client->deleteToken([/* ... */]); $promise = $client->deleteTokenAsync([/* ... */]);
Deletes the specified token. Must be called in the license home Region.
Parameter Syntax
$result = $client->deleteToken([
'TokenId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The provided input is not valid. Try your request again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
-
The resource cannot be found.
-
This is not the correct Region for the resource. Try again.
ExtendLicenseConsumption
$result = $client->extendLicenseConsumption([/* ... */]); $promise = $client->extendLicenseConsumptionAsync([/* ... */]);
Extends the expiration date for license consumption.
Parameter Syntax
$result = $client->extendLicenseConsumption([
'DryRun' => true || false,
'LicenseConsumptionToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Expiration' => '<string>',
'LicenseConsumptionToken' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
-
The resource cannot be found.
GetAccessToken
$result = $client->getAccessToken([/* ... */]); $promise = $client->getAccessTokenAsync([/* ... */]);
Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.
Parameter Syntax
$result = $client->getAccessToken([
'Token' => '<string>', // REQUIRED
'TokenProperties' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'AccessToken' => '<string>',
]
Result Details
Errors
-
The provided input is not valid. Try your request again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
GetGrant
$result = $client->getGrant([/* ... */]); $promise = $client->getGrantAsync([/* ... */]);
Gets detailed information about the specified grant.
Parameter Syntax
$result = $client->getGrant([
'GrantArn' => '<string>', // REQUIRED
'Version' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Grant' => [
'GrantArn' => '<string>',
'GrantName' => '<string>',
'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'GrantedOperations' => ['<string>', ...],
'GranteePrincipalArn' => '<string>',
'HomeRegion' => '<string>',
'LicenseArn' => '<string>',
'ParentArn' => '<string>',
'StatusReason' => '<string>',
'Version' => '<string>',
],
]
Result Details
Members
- Grant
-
- Type: Grant structure
Grant details.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
GetLicense
$result = $client->getLicense([/* ... */]); $promise = $client->getLicenseAsync([/* ... */]);
Gets detailed information about the specified license.
Parameter Syntax
$result = $client->getLicense([
'LicenseArn' => '<string>', // REQUIRED
'Version' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'License' => [
'Beneficiary' => '<string>',
'ConsumptionConfiguration' => [
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false,
'MaxTimeToLiveInMinutes' => <integer>,
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>,
],
'RenewType' => 'None|Weekly|Monthly',
],
'CreateTime' => '<string>',
'Entitlements' => [
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>',
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>',
'Issuer' => [
'KeyFingerprint' => '<string>',
'Name' => '<string>',
'SignKey' => '<string>',
],
'LicenseArn' => '<string>',
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>',
'ProductName' => '<string>',
'ProductSKU' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Validity' => [
'Begin' => '<string>',
'End' => '<string>',
],
'Version' => '<string>',
],
]
Result Details
Members
- License
-
- Type: License structure
License details.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
GetLicenseConfiguration
$result = $client->getLicenseConfiguration([/* ... */]); $promise = $client->getLicenseConfigurationAsync([/* ... */]);
Gets detailed information about the specified license configuration.
Parameter Syntax
$result = $client->getLicenseConfiguration([
'LicenseConfigurationArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AutomatedDiscoveryInformation' => [
'LastRunTime' => <DateTime>,
],
'ConsumedLicenseSummaryList' => [
[
'ConsumedLicenses' => <integer>,
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'ConsumedLicenses' => <integer>,
'Description' => '<string>',
'DisassociateWhenNotFound' => true || false,
'LicenseConfigurationArn' => '<string>',
'LicenseConfigurationId' => '<string>',
'LicenseCount' => <integer>,
'LicenseCountHardLimit' => true || false,
'LicenseCountingType' => 'vCPU|Instance|Core|Socket',
'LicenseRules' => ['<string>', ...],
'ManagedResourceSummaryList' => [
[
'AssociationCount' => <integer>,
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'Name' => '<string>',
'OwnerAccountId' => '<string>',
'ProductInformationList' => [
[
'ProductInformationFilterList' => [
[
'ProductInformationFilterComparator' => '<string>',
'ProductInformationFilterName' => '<string>',
'ProductInformationFilterValue' => ['<string>', ...],
],
// ...
],
'ResourceType' => '<string>',
],
// ...
],
'Status' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- AutomatedDiscoveryInformation
-
- Type: AutomatedDiscoveryInformation structure
Automated discovery information.
- ConsumedLicenseSummaryList
-
- Type: Array of ConsumedLicenseSummary structures
Summaries of the licenses consumed by resources.
- ConsumedLicenses
-
- Type: long (int|float)
Number of licenses assigned to resources.
- Description
-
- Type: string
Description of the license configuration.
- DisassociateWhenNotFound
-
- Type: boolean
When true, disassociates a resource when software is uninstalled.
- LicenseConfigurationArn
-
- Type: string
Amazon Resource Name (ARN) of the license configuration.
- LicenseConfigurationId
-
- Type: string
Unique ID for the license configuration.
- LicenseCount
-
- Type: long (int|float)
Number of available licenses.
- LicenseCountHardLimit
-
- Type: boolean
Sets the number of available licenses as a hard limit.
- LicenseCountingType
-
- Type: string
Dimension for which the licenses are counted.
- LicenseRules
-
- Type: Array of strings
License rules.
- ManagedResourceSummaryList
-
- Type: Array of ManagedResourceSummary structures
Summaries of the managed resources.
- Name
-
- Type: string
Name of the license configuration.
- OwnerAccountId
-
- Type: string
Account ID of the owner of the license configuration.
- ProductInformationList
-
- Type: Array of ProductInformation structures
Product information.
- Status
-
- Type: string
License configuration status.
- Tags
-
- Type: Array of Tag structures
Tags for the license configuration.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
GetLicenseConversionTask
$result = $client->getLicenseConversionTask([/* ... */]); $promise = $client->getLicenseConversionTaskAsync([/* ... */]);
Gets information about the specified license type conversion task.
Parameter Syntax
$result = $client->getLicenseConversionTask([
'LicenseConversionTaskId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DestinationLicenseContext' => [
'UsageOperation' => '<string>',
],
'EndTime' => <DateTime>,
'LicenseConversionTaskId' => '<string>',
'LicenseConversionTime' => <DateTime>,
'ResourceArn' => '<string>',
'SourceLicenseContext' => [
'UsageOperation' => '<string>',
],
'StartTime' => <DateTime>,
'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
'StatusMessage' => '<string>',
]
Result Details
Members
- DestinationLicenseContext
-
- Type: LicenseConversionContext structure
Information about the license type converted to.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time at which the license type conversion task was completed.
- LicenseConversionTaskId
-
- Type: string
ID of the license type conversion task.
- LicenseConversionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Amount of time to complete the license type conversion.
- ResourceArn
-
- Type: string
Amazon Resource Names (ARN) of the resources the license conversion task is associated with.
- SourceLicenseContext
-
- Type: LicenseConversionContext structure
Information about the license type converted from.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time at which the license type conversion task was started .
- Status
-
- Type: string
Status of the license type conversion task.
- StatusMessage
-
- Type: string
The status message for the conversion task.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
GetLicenseManagerReportGenerator
$result = $client->getLicenseManagerReportGenerator([/* ... */]); $promise = $client->getLicenseManagerReportGeneratorAsync([/* ... */]);
Gets information about the specified report generator.
Parameter Syntax
$result = $client->getLicenseManagerReportGenerator([
'LicenseManagerReportGeneratorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ReportGenerator' => [
'CreateTime' => '<string>',
'Description' => '<string>',
'LastReportGenerationTime' => '<string>',
'LastRunFailureReason' => '<string>',
'LastRunStatus' => '<string>',
'LicenseManagerReportGeneratorArn' => '<string>',
'ReportContext' => [
'licenseConfigurationArns' => ['<string>', ...],
],
'ReportCreatorAccount' => '<string>',
'ReportFrequency' => [
'period' => 'DAY|WEEK|MONTH',
'value' => <integer>,
],
'ReportGeneratorName' => '<string>',
'ReportType' => ['<string>', ...],
'S3Location' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- ReportGenerator
-
- Type: ReportGenerator structure
A report generator that creates periodic reports about your license configurations.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
-
Access to resource denied.
-
The resource cannot be found.
GetLicenseUsage
$result = $client->getLicenseUsage([/* ... */]); $promise = $client->getLicenseUsageAsync([/* ... */]);
Gets detailed information about the usage of the specified license.
Parameter Syntax
$result = $client->getLicenseUsage([
'LicenseArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'LicenseUsage' => [
'EntitlementUsages' => [
[
'ConsumedValue' => '<string>',
'MaxCount' => '<string>',
'Name' => '<string>',
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
],
// ...
],
],
]
Result Details
Members
- LicenseUsage
-
- Type: LicenseUsage structure
License usage details.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
GetServiceSettings
$result = $client->getServiceSettings([/* ... */]); $promise = $client->getServiceSettingsAsync([/* ... */]);
Gets the License Manager settings for the current Region.
Parameter Syntax
$result = $client->getServiceSettings([ ]);
Parameter Details
Members
Result Syntax
[
'EnableCrossAccountsDiscovery' => true || false,
'LicenseManagerResourceShareArn' => '<string>',
'OrganizationConfiguration' => [
'EnableIntegration' => true || false,
],
'S3BucketArn' => '<string>',
'SnsTopicArn' => '<string>',
]
Result Details
Members
- EnableCrossAccountsDiscovery
-
- Type: boolean
Indicates whether cross-account discovery is enabled.
- LicenseManagerResourceShareArn
-
- Type: string
Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.
- OrganizationConfiguration
-
- Type: OrganizationConfiguration structure
Indicates whether Organizations is integrated with License Manager for cross-account discovery.
- S3BucketArn
-
- Type: string
Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
- SnsTopicArn
-
- Type: string
SNS topic configured to receive notifications from License Manager.
Errors
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListAssociationsForLicenseConfiguration
$result = $client->listAssociationsForLicenseConfiguration([/* ... */]); $promise = $client->listAssociationsForLicenseConfigurationAsync([/* ... */]);
Lists the resource associations for the specified license configuration.
Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
Parameter Syntax
$result = $client->listAssociationsForLicenseConfiguration([
'LicenseConfigurationArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'LicenseConfigurationAssociations' => [
[
'AmiAssociationScope' => '<string>',
'AssociationTime' => <DateTime>,
'ResourceArn' => '<string>',
'ResourceOwnerId' => '<string>',
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseConfigurationAssociations
-
- Type: Array of LicenseConfigurationAssociation structures
Information about the associations for the license configuration.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The request uses too many filters or too many filter values.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListDistributedGrants
$result = $client->listDistributedGrants([/* ... */]); $promise = $client->listDistributedGrantsAsync([/* ... */]);
Lists the grants distributed for the specified license.
Parameter Syntax
$result = $client->listDistributedGrants([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'GrantArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
LicenseArn -
GrantStatus -
GranteePrincipalARN -
ProductSKU -
LicenseIssuerName
- GrantArns
-
- Type: Array of strings
Amazon Resource Names (ARNs) of the grants.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Grants' => [
[
'GrantArn' => '<string>',
'GrantName' => '<string>',
'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'GrantedOperations' => ['<string>', ...],
'GranteePrincipalArn' => '<string>',
'HomeRegion' => '<string>',
'LicenseArn' => '<string>',
'ParentArn' => '<string>',
'StatusReason' => '<string>',
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Grants
-
- Type: Array of Grant structures
Distributed grant details.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListFailuresForLicenseConfigurationOperations
$result = $client->listFailuresForLicenseConfigurationOperations([/* ... */]); $promise = $client->listFailuresForLicenseConfigurationOperationsAsync([/* ... */]);
Lists the license configuration operations that failed.
Parameter Syntax
$result = $client->listFailuresForLicenseConfigurationOperations([
'LicenseConfigurationArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'LicenseOperationFailureList' => [
[
'ErrorMessage' => '<string>',
'FailureTime' => <DateTime>,
'MetadataList' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'OperationName' => '<string>',
'OperationRequestedBy' => '<string>',
'ResourceArn' => '<string>',
'ResourceOwnerId' => '<string>',
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseOperationFailureList
-
- Type: Array of LicenseOperationFailure structures
License configuration operations that failed.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListLicenseConfigurations
$result = $client->listLicenseConfigurations([/* ... */]); $promise = $client->listLicenseConfigurationsAsync([/* ... */]);
Lists the license configurations for your account.
Parameter Syntax
$result = $client->listLicenseConfigurations([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'LicenseConfigurationArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters and logical operators are supported:
-
licenseCountingType- The dimension for which licenses are counted. Possible values arevCPU|Instance|Core|Socket. Logical operators areEQUALS|NOT_EQUALS. -
enforceLicenseCount- A Boolean value that indicates whether hard license enforcement is used. Logical operators areEQUALS|NOT_EQUALS. -
usagelimitExceeded- A Boolean value that indicates whether the available licenses have been exceeded. Logical operators areEQUALS|NOT_EQUALS.
- LicenseConfigurationArns
-
- Type: Array of strings
Amazon Resource Names (ARN) of the license configurations.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'LicenseConfigurations' => [
[
'AutomatedDiscoveryInformation' => [
'LastRunTime' => <DateTime>,
],
'ConsumedLicenseSummaryList' => [
[
'ConsumedLicenses' => <integer>,
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'ConsumedLicenses' => <integer>,
'Description' => '<string>',
'DisassociateWhenNotFound' => true || false,
'LicenseConfigurationArn' => '<string>',
'LicenseConfigurationId' => '<string>',
'LicenseCount' => <integer>,
'LicenseCountHardLimit' => true || false,
'LicenseCountingType' => 'vCPU|Instance|Core|Socket',
'LicenseRules' => ['<string>', ...],
'ManagedResourceSummaryList' => [
[
'AssociationCount' => <integer>,
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'Name' => '<string>',
'OwnerAccountId' => '<string>',
'ProductInformationList' => [
[
'ProductInformationFilterList' => [
[
'ProductInformationFilterComparator' => '<string>',
'ProductInformationFilterName' => '<string>',
'ProductInformationFilterValue' => ['<string>', ...],
],
// ...
],
'ResourceType' => '<string>',
],
// ...
],
'Status' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseConfigurations
-
- Type: Array of LicenseConfiguration structures
Information about the license configurations.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The request uses too many filters or too many filter values.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListLicenseConversionTasks
$result = $client->listLicenseConversionTasks([/* ... */]); $promise = $client->listLicenseConversionTasksAsync([/* ... */]);
Lists the license type conversion tasks for your account.
Parameter Syntax
$result = $client->listLicenseConversionTasks([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. Valid filters are
ResourceArnsandStatus. - MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'LicenseConversionTasks' => [
[
'DestinationLicenseContext' => [
'UsageOperation' => '<string>',
],
'EndTime' => <DateTime>,
'LicenseConversionTaskId' => '<string>',
'LicenseConversionTime' => <DateTime>,
'ResourceArn' => '<string>',
'SourceLicenseContext' => [
'UsageOperation' => '<string>',
],
'StartTime' => <DateTime>,
'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
'StatusMessage' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseConversionTasks
-
- Type: Array of LicenseConversionTask structures
Information about the license configuration tasks for your account.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListLicenseManagerReportGenerators
$result = $client->listLicenseManagerReportGenerators([/* ... */]); $promise = $client->listLicenseManagerReportGeneratorsAsync([/* ... */]);
Lists the report generators for your account.
Parameter Syntax
$result = $client->listLicenseManagerReportGenerators([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
LicenseConfigurationArn
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'NextToken' => '<string>',
'ReportGenerators' => [
[
'CreateTime' => '<string>',
'Description' => '<string>',
'LastReportGenerationTime' => '<string>',
'LastRunFailureReason' => '<string>',
'LastRunStatus' => '<string>',
'LicenseManagerReportGeneratorArn' => '<string>',
'ReportContext' => [
'licenseConfigurationArns' => ['<string>', ...],
],
'ReportCreatorAccount' => '<string>',
'ReportFrequency' => [
'period' => 'DAY|WEEK|MONTH',
'value' => <integer>,
],
'ReportGeneratorName' => '<string>',
'ReportType' => ['<string>', ...],
'S3Location' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
Token for the next set of results.
- ReportGenerators
-
- Type: Array of ReportGenerator structures
A report generator that creates periodic reports about your license configurations.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Too many requests have been submitted. Try again after a brief wait.
-
Access to resource denied.
-
The resource cannot be found.
ListLicenseSpecificationsForResource
$result = $client->listLicenseSpecificationsForResource([/* ... */]); $promise = $client->listLicenseSpecificationsForResourceAsync([/* ... */]);
Describes the license configurations for the specified resource.
Parameter Syntax
$result = $client->listLicenseSpecificationsForResource([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'LicenseSpecifications' => [
[
'AmiAssociationScope' => '<string>',
'LicenseConfigurationArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseSpecifications
-
- Type: Array of LicenseSpecification structures
License configurations associated with a resource.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListLicenseVersions
$result = $client->listLicenseVersions([/* ... */]); $promise = $client->listLicenseVersionsAsync([/* ... */]);
Lists all versions of the specified license.
Parameter Syntax
$result = $client->listLicenseVersions([
'LicenseArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Licenses' => [
[
'Beneficiary' => '<string>',
'ConsumptionConfiguration' => [
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false,
'MaxTimeToLiveInMinutes' => <integer>,
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>,
],
'RenewType' => 'None|Weekly|Monthly',
],
'CreateTime' => '<string>',
'Entitlements' => [
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>',
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>',
'Issuer' => [
'KeyFingerprint' => '<string>',
'Name' => '<string>',
'SignKey' => '<string>',
],
'LicenseArn' => '<string>',
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>',
'ProductName' => '<string>',
'ProductSKU' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Validity' => [
'Begin' => '<string>',
'End' => '<string>',
],
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Licenses
-
- Type: Array of License structures
License details.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
ListLicenses
$result = $client->listLicenses([/* ... */]); $promise = $client->listLicensesAsync([/* ... */]);
Lists the licenses for your account.
Parameter Syntax
$result = $client->listLicenses([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'LicenseArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
Beneficiary -
ProductSKU -
Fingerprint -
Status
- LicenseArns
-
- Type: Array of strings
Amazon Resource Names (ARNs) of the licenses.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Licenses' => [
[
'Beneficiary' => '<string>',
'ConsumptionConfiguration' => [
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false,
'MaxTimeToLiveInMinutes' => <integer>,
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>,
],
'RenewType' => 'None|Weekly|Monthly',
],
'CreateTime' => '<string>',
'Entitlements' => [
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>',
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>',
'Issuer' => [
'KeyFingerprint' => '<string>',
'Name' => '<string>',
'SignKey' => '<string>',
],
'LicenseArn' => '<string>',
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>',
'ProductName' => '<string>',
'ProductSKU' => '<string>',
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Validity' => [
'Begin' => '<string>',
'End' => '<string>',
],
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Licenses
-
- Type: Array of License structures
License details.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
ListReceivedGrants
$result = $client->listReceivedGrants([/* ... */]); $promise = $client->listReceivedGrantsAsync([/* ... */]);
Lists grants that are received but not accepted.
Parameter Syntax
$result = $client->listReceivedGrants([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'GrantArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
ProductSKU -
LicenseIssuerName -
LicenseArn -
GrantStatus -
GranterAccountId
- GrantArns
-
- Type: Array of strings
Amazon Resource Names (ARNs) of the grants.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Grants' => [
[
'GrantArn' => '<string>',
'GrantName' => '<string>',
'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'GrantedOperations' => ['<string>', ...],
'GranteePrincipalArn' => '<string>',
'HomeRegion' => '<string>',
'LicenseArn' => '<string>',
'ParentArn' => '<string>',
'StatusReason' => '<string>',
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Grants
-
- Type: Array of Grant structures
Received grant details.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListReceivedGrantsForOrganization
$result = $client->listReceivedGrantsForOrganization([/* ... */]); $promise = $client->listReceivedGrantsForOrganizationAsync([/* ... */]);
Lists the grants received for all accounts in the organization.
Parameter Syntax
$result = $client->listReceivedGrantsForOrganization([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'LicenseArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
ParentArn -
GranteePrincipalArn
- LicenseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the received license.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Grants' => [
[
'GrantArn' => '<string>',
'GrantName' => '<string>',
'GrantStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'GrantedOperations' => ['<string>', ...],
'GranteePrincipalArn' => '<string>',
'HomeRegion' => '<string>',
'LicenseArn' => '<string>',
'ParentArn' => '<string>',
'StatusReason' => '<string>',
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Grants
-
- Type: Array of Grant structures
Lists the grants the organization has received.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListReceivedLicenses
$result = $client->listReceivedLicenses([/* ... */]); $promise = $client->listReceivedLicensesAsync([/* ... */]);
Lists received licenses.
Parameter Syntax
$result = $client->listReceivedLicenses([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'LicenseArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
ProductSKU -
Status -
Fingerprint -
IssuerName -
Beneficiary
- LicenseArns
-
- Type: Array of strings
Amazon Resource Names (ARNs) of the licenses.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Licenses' => [
[
'Beneficiary' => '<string>',
'ConsumptionConfiguration' => [
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false,
'MaxTimeToLiveInMinutes' => <integer>,
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>,
],
'RenewType' => 'None|Weekly|Monthly',
],
'CreateTime' => '<string>',
'Entitlements' => [
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>',
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>',
'Issuer' => [
'KeyFingerprint' => '<string>',
'Name' => '<string>',
'SignKey' => '<string>',
],
'LicenseArn' => '<string>',
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>',
'ProductName' => '<string>',
'ProductSKU' => '<string>',
'ReceivedMetadata' => [
'AllowedOperations' => ['<string>', ...],
'ReceivedStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|DISABLED|WORKFLOW_COMPLETED',
'ReceivedStatusReason' => '<string>',
],
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Validity' => [
'Begin' => '<string>',
'End' => '<string>',
],
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Licenses
-
- Type: Array of GrantedLicense structures
Received license details.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListReceivedLicensesForOrganization
$result = $client->listReceivedLicensesForOrganization([/* ... */]); $promise = $client->listReceivedLicensesForOrganizationAsync([/* ... */]);
Lists the licenses received for all accounts in the organization.
Parameter Syntax
$result = $client->listReceivedLicensesForOrganization([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters are supported:
-
Beneficiary -
ProductSKU
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'Licenses' => [
[
'Beneficiary' => '<string>',
'ConsumptionConfiguration' => [
'BorrowConfiguration' => [
'AllowEarlyCheckIn' => true || false,
'MaxTimeToLiveInMinutes' => <integer>,
],
'ProvisionalConfiguration' => [
'MaxTimeToLiveInMinutes' => <integer>,
],
'RenewType' => 'None|Weekly|Monthly',
],
'CreateTime' => '<string>',
'Entitlements' => [
[
'AllowCheckIn' => true || false,
'MaxCount' => <integer>,
'Name' => '<string>',
'Overage' => true || false,
'Unit' => 'Count|None|Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second',
'Value' => '<string>',
],
// ...
],
'HomeRegion' => '<string>',
'Issuer' => [
'KeyFingerprint' => '<string>',
'Name' => '<string>',
'SignKey' => '<string>',
],
'LicenseArn' => '<string>',
'LicenseMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
'LicenseName' => '<string>',
'ProductName' => '<string>',
'ProductSKU' => '<string>',
'ReceivedMetadata' => [
'AllowedOperations' => ['<string>', ...],
'ReceivedStatus' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|DISABLED|WORKFLOW_COMPLETED',
'ReceivedStatusReason' => '<string>',
],
'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
'Validity' => [
'Begin' => '<string>',
'End' => '<string>',
],
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Licenses
-
- Type: Array of GrantedLicense structures
Lists the licenses the organization has received.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListResourceInventory
$result = $client->listResourceInventory([/* ... */]); $promise = $client->listResourceInventoryAsync([/* ... */]);
Lists resources managed using Systems Manager inventory.
Parameter Syntax
$result = $client->listResourceInventory([
'Filters' => [
[
'Condition' => 'EQUALS|NOT_EQUALS|BEGINS_WITH|CONTAINS', // REQUIRED
'Name' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of InventoryFilter structures
Filters to scope the results. The following filters and logical operators are supported:
-
account_id- The ID of the Amazon Web Services account that owns the resource. Logical operators areEQUALS|NOT_EQUALS. -
application_name- The name of the application. Logical operators areEQUALS|BEGINS_WITH. -
license_included- The type of license included. Logical operators areEQUALS|NOT_EQUALS. Possible values aresql-server-enterprise|sql-server-standard|sql-server-web|windows-server-datacenter. -
platform- The platform of the resource. Logical operators areEQUALS|BEGINS_WITH. -
resource_id- The ID of the resource. Logical operators areEQUALS|NOT_EQUALS. -
tag:<key>- The key/value combination of a tag assigned to the resource. Logical operators areEQUALS(single account) orEQUALS|NOT_EQUALS(cross account).
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'NextToken' => '<string>',
'ResourceInventoryList' => [
[
'Platform' => '<string>',
'PlatformVersion' => '<string>',
'ResourceArn' => '<string>',
'ResourceId' => '<string>',
'ResourceOwningAccountId' => '<string>',
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
Token for the next set of results.
- ResourceInventoryList
-
- Type: Array of ResourceInventory structures
Information about the resources.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The request uses too many filters or too many filter values.
-
A dependency required to run the API is missing.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified license configuration.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
Information about the tags.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
ListTokens
$result = $client->listTokens([/* ... */]); $promise = $client->listTokensAsync([/* ... */]);
Lists your tokens.
Parameter Syntax
$result = $client->listTokens([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TokenIds' => ['<string>', ...],
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filter is supported:
-
LicenseArns
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
- TokenIds
-
- Type: Array of strings
Token IDs.
Result Syntax
[
'NextToken' => '<string>',
'Tokens' => [
[
'ExpirationTime' => '<string>',
'LicenseArn' => '<string>',
'RoleArns' => ['<string>', ...],
'Status' => '<string>',
'TokenId' => '<string>',
'TokenProperties' => ['<string>', ...],
'TokenType' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
Token for the next set of results.
- Tokens
-
- Type: Array of TokenData structures
Received token details.
Errors
-
The provided input is not valid. Try your request again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
ListUsageForLicenseConfiguration
$result = $client->listUsageForLicenseConfiguration([/* ... */]); $promise = $client->listUsageForLicenseConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listUsageForLicenseConfiguration([
'Filters' => [
[
'Name' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'LicenseConfigurationArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters to scope the results. The following filters and logical operators are supported:
-
resourceArn- The ARN of the license configuration resource. Logical operators areEQUALS|NOT_EQUALS. -
resourceType- The resource type (EC2_INSTANCE|EC2_HOST|EC2_AMI|SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators areEQUALS|NOT_EQUALS. -
resourceAccount- The ID of the account that owns the resource. Logical operators areEQUALS|NOT_EQUALS.
- LicenseConfigurationArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license configuration.
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[
'LicenseConfigurationUsageList' => [
[
'AssociationTime' => <DateTime>,
'ConsumedLicenses' => <integer>,
'ResourceArn' => '<string>',
'ResourceOwnerId' => '<string>',
'ResourceStatus' => '<string>',
'ResourceType' => 'EC2_INSTANCE|EC2_HOST|EC2_AMI|RDS|SYSTEMS_MANAGER_MANAGED_INSTANCE',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LicenseConfigurationUsageList
-
- Type: Array of LicenseConfigurationUsage structures
Information about the license configurations.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The request uses too many filters or too many filter values.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
RejectGrant
$result = $client->rejectGrant([/* ... */]); $promise = $client->rejectGrantAsync([/* ... */]);
Rejects the specified grant.
Parameter Syntax
$result = $client->rejectGrant([
'GrantArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'GrantArn' => '<string>',
'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
'Version' => '<string>',
]
Result Details
Members
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
-
The server experienced an internal error. Try again.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds the specified tags to the specified license configuration.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license configuration.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
One or more tags.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the specified tags from the specified license configuration.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
UpdateLicenseConfiguration
$result = $client->updateLicenseConfiguration([/* ... */]); $promise = $client->updateLicenseConfigurationAsync([/* ... */]);
Modifies the attributes of an existing license configuration.
Parameter Syntax
$result = $client->updateLicenseConfiguration([
'Description' => '<string>',
'DisassociateWhenNotFound' => true || false,
'LicenseConfigurationArn' => '<string>', // REQUIRED
'LicenseConfigurationStatus' => 'AVAILABLE|DISABLED',
'LicenseCount' => <integer>,
'LicenseCountHardLimit' => true || false,
'LicenseRules' => ['<string>', ...],
'Name' => '<string>',
'ProductInformationList' => [
[
'ProductInformationFilterList' => [ // REQUIRED
[
'ProductInformationFilterComparator' => '<string>', // REQUIRED
'ProductInformationFilterName' => '<string>', // REQUIRED
'ProductInformationFilterValue' => ['<string>', ...],
],
// ...
],
'ResourceType' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
New description of the license configuration.
- DisassociateWhenNotFound
-
- Type: boolean
When true, disassociates a resource when software is uninstalled.
- LicenseConfigurationArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the license configuration.
- LicenseConfigurationStatus
-
- Type: string
New status of the license configuration.
- LicenseCount
-
- Type: long (int|float)
New number of licenses managed by the license configuration.
- LicenseCountHardLimit
-
- Type: boolean
New hard limit of the number of available licenses.
- LicenseRules
-
- Type: Array of strings
New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.
- Name
-
- Type: string
New name of the license configuration.
- ProductInformationList
-
- Type: Array of ProductInformation structures
New product information.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
UpdateLicenseManagerReportGenerator
$result = $client->updateLicenseManagerReportGenerator([/* ... */]); $promise = $client->updateLicenseManagerReportGeneratorAsync([/* ... */]);
Updates a report generator.
After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
Parameter Syntax
$result = $client->updateLicenseManagerReportGenerator([
'ClientToken' => '<string>', // REQUIRED
'Description' => '<string>',
'LicenseManagerReportGeneratorArn' => '<string>', // REQUIRED
'ReportContext' => [ // REQUIRED
'licenseConfigurationArns' => ['<string>', ...], // REQUIRED
],
'ReportFrequency' => [ // REQUIRED
'period' => 'DAY|WEEK|MONTH',
'value' => <integer>,
],
'ReportGeneratorName' => '<string>', // REQUIRED
'Type' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Description
-
- Type: string
Description of the report generator.
- LicenseManagerReportGeneratorArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the report generator to update.
- ReportContext
-
- Required: Yes
- Type: ReportContext structure
The report context.
- ReportFrequency
-
- Required: Yes
- Type: ReportFrequency structure
Frequency by which reports are generated.
- ReportGeneratorName
-
- Required: Yes
- Type: string
Name of the report generator.
- Type
-
- Required: Yes
- Type: Array of strings
Type of reports to generate. The following report types are supported:
-
License configuration report - Reports the number and details of consumed licenses for a license configuration.
-
Resource report - Reports the tracked licenses and resource consumption for a license configuration.
Result Syntax
[]
Result Details
Errors
-
The provided input is not valid. Try your request again.
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
Too many requests have been submitted. Try again after a brief wait.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
The resource cannot be found.
-
ResourceLimitExceededException:
Your resource limits have been exceeded.
UpdateLicenseSpecificationsForResource
$result = $client->updateLicenseSpecificationsForResource([/* ... */]); $promise = $client->updateLicenseSpecificationsForResourceAsync([/* ... */]);
Adds or removes the specified license configurations for the specified Amazon Web Services resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.
Parameter Syntax
$result = $client->updateLicenseSpecificationsForResource([
'AddLicenseSpecifications' => [
[
'AmiAssociationScope' => '<string>',
'LicenseConfigurationArn' => '<string>', // REQUIRED
],
// ...
],
'RemoveLicenseSpecifications' => [
[
'AmiAssociationScope' => '<string>',
'LicenseConfigurationArn' => '<string>', // REQUIRED
],
// ...
],
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AddLicenseSpecifications
-
- Type: Array of LicenseSpecification structures
ARNs of the license configurations to add.
- RemoveLicenseSpecifications
-
- Type: Array of LicenseSpecification structures
ARNs of the license configurations to remove.
- ResourceArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the Amazon Web Services resource.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
InvalidResourceStateException:
License Manager cannot allocate a license to a resource because of its state.
For example, you cannot allocate a license to an instance in the process of shutting down.
-
You do not have enough licenses available to support a new resource launch.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
UpdateServiceSettings
$result = $client->updateServiceSettings([/* ... */]); $promise = $client->updateServiceSettingsAsync([/* ... */]);
Updates License Manager settings for the current Region.
Parameter Syntax
$result = $client->updateServiceSettings([
'EnableCrossAccountsDiscovery' => true || false,
'OrganizationConfiguration' => [
'EnableIntegration' => true || false, // REQUIRED
],
'S3BucketArn' => '<string>',
'SnsTopicArn' => '<string>',
]);
Parameter Details
Members
- EnableCrossAccountsDiscovery
-
- Type: boolean
Activates cross-account discovery.
- OrganizationConfiguration
-
- Type: OrganizationConfiguration structure
Enables integration with Organizations for cross-account discovery.
- S3BucketArn
-
- Type: string
Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
- SnsTopicArn
-
- Type: string
Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One or more parameter values are not valid.
-
The server experienced an internal error. Try again.
-
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
-
Access to resource denied.
-
Too many requests have been submitted. Try again after a brief wait.
Shapes
AccessDeniedException
AuthorizationException
Description
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
Members
AutomatedDiscoveryInformation
Description
Describes automated discovery.
Members
BorrowConfiguration
Description
Details about a borrow configuration.
Members
ConflictException
Description
There was a conflict processing the request. Try your request again.
Members
ConsumedLicenseSummary
Description
Details about license consumption.
Members
ConsumptionConfiguration
Description
Details about a consumption configuration.
Members
- BorrowConfiguration
-
- Type: BorrowConfiguration structure
Details about a borrow configuration.
- ProvisionalConfiguration
-
- Type: ProvisionalConfiguration structure
Details about a provisional configuration.
- RenewType
-
- Type: string
Renewal frequency.
DatetimeRange
Description
Describes a time range, in ISO8601-UTC format.
Members
Entitlement
Description
Describes a resource entitled for use with a license.
Members
- AllowCheckIn
-
- Type: boolean
Indicates whether check-ins are allowed.
- MaxCount
-
- Type: long (int|float)
Maximum entitlement count. Use if the unit is not None.
- Name
-
- Required: Yes
- Type: string
Entitlement name.
- Overage
-
- Type: boolean
Indicates whether overages are allowed.
- Unit
-
- Required: Yes
- Type: string
Entitlement unit.
- Value
-
- Type: string
Entitlement resource. Use only if the unit is None.
EntitlementData
Description
Data associated with an entitlement resource.
Members
EntitlementNotAllowedException
EntitlementUsage
Description
Usage associated with an entitlement resource.
Members
FailedDependencyException
Description
A dependency required to run the API is missing.
Members
Filter
Description
A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
Members
FilterLimitExceededException
Description
The request uses too many filters or too many filter values.
Members
Grant
Description
Describes a grant.
Members
- GrantArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the grant.
- GrantName
-
- Required: Yes
- Type: string
Grant name.
- GrantStatus
-
- Required: Yes
- Type: string
Grant status.
- GrantedOperations
-
- Required: Yes
- Type: Array of strings
Granted operations.
- GranteePrincipalArn
-
- Required: Yes
- Type: string
The grantee principal ARN.
- HomeRegion
-
- Required: Yes
- Type: string
Home Region of the grant.
- LicenseArn
-
- Required: Yes
- Type: string
License ARN.
- ParentArn
-
- Required: Yes
- Type: string
Parent ARN.
- StatusReason
-
- Type: string
Grant status reason.
- Version
-
- Required: Yes
- Type: string
Grant version.
GrantedLicense
Description
Describes a license that is granted to a grantee.
Members
- Beneficiary
-
- Type: string
Granted license beneficiary.
- ConsumptionConfiguration
-
- Type: ConsumptionConfiguration structure
Configuration for consumption of the license.
- CreateTime
-
- Type: string
Creation time of the granted license.
- Entitlements
-
- Type: Array of Entitlement structures
License entitlements.
- HomeRegion
-
- Type: string
Home Region of the granted license.
- Issuer
-
- Type: IssuerDetails structure
Granted license issuer.
- LicenseArn
-
- Type: string
Amazon Resource Name (ARN) of the license.
- LicenseMetadata
-
- Type: Array of Metadata structures
Granted license metadata.
- LicenseName
-
- Type: string
License name.
- ProductName
-
- Type: string
Product name.
- ProductSKU
-
- Type: string
Product SKU.
- ReceivedMetadata
-
- Type: ReceivedMetadata structure
Granted license received metadata.
- Status
-
- Type: string
Granted license status.
- Validity
-
- Type: DatetimeRange structure
Date and time range during which the granted license is valid, in ISO8601-UTC format.
- Version
-
- Type: string
Version of the granted license.
InvalidParameterValueException
InvalidResourceStateException
Description
License Manager cannot allocate a license to a resource because of its state.
For example, you cannot allocate a license to an instance in the process of shutting down.
Members
InventoryFilter
Description
An inventory filter.
Members
Issuer
Description
Details about the issuer of a license.
Members
IssuerDetails
Description
Details associated with the issuer of a license.
Members
License
Description
Software license that is managed in License Manager.
Members
- Beneficiary
-
- Type: string
License beneficiary.
- ConsumptionConfiguration
-
- Type: ConsumptionConfiguration structure
Configuration for consumption of the license.
- CreateTime
-
- Type: string
License creation time.
- Entitlements
-
- Type: Array of Entitlement structures
License entitlements.
- HomeRegion
-
- Type: string
Home Region of the license.
- Issuer
-
- Type: IssuerDetails structure
License issuer.
- LicenseArn
-
- Type: string
Amazon Resource Name (ARN) of the license.
- LicenseMetadata
-
- Type: Array of Metadata structures
License metadata.
- LicenseName
-
- Type: string
License name.
- ProductName
-
- Type: string
Product name.
- ProductSKU
-
- Type: string
Product SKU.
- Status
-
- Type: string
License status.
- Validity
-
- Type: DatetimeRange structure
Date and time range during which the license is valid, in ISO8601-UTC format.
- Version
-
- Type: string
License version.
LicenseConfiguration
Description
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
Members
- AutomatedDiscoveryInformation
-
- Type: AutomatedDiscoveryInformation structure
Automated discovery information.
- ConsumedLicenseSummaryList
-
- Type: Array of ConsumedLicenseSummary structures
Summaries for licenses consumed by various resources.
- ConsumedLicenses
-
- Type: long (int|float)
Number of licenses consumed.
- Description
-
- Type: string
Description of the license configuration.
- DisassociateWhenNotFound
-
- Type: boolean
When true, disassociates a resource when software is uninstalled.
- LicenseConfigurationArn
-
- Type: string
Amazon Resource Name (ARN) of the license configuration.
- LicenseConfigurationId
-
- Type: string
Unique ID of the license configuration.
- LicenseCount
-
- Type: long (int|float)
Number of licenses managed by the license configuration.
- LicenseCountHardLimit
-
- Type: boolean
Number of available licenses as a hard limit.
- LicenseCountingType
-
- Type: string
Dimension to use to track the license inventory.
- LicenseRules
-
- Type: Array of strings
License rules.
- ManagedResourceSummaryList
-
- Type: Array of ManagedResourceSummary structures
Summaries for managed resources.
- Name
-
- Type: string
Name of the license configuration.
- OwnerAccountId
-
- Type: string
Account ID of the license configuration's owner.
- ProductInformationList
-
- Type: Array of ProductInformation structures
Product information.
- Status
-
- Type: string
Status of the license configuration.
LicenseConfigurationAssociation
Description
Describes an association with a license configuration.
Members
- AmiAssociationScope
-
- Type: string
Scope of AMI associations. The possible value is
cross-account. - AssociationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the license configuration was associated with the resource.
- ResourceArn
-
- Type: string
Amazon Resource Name (ARN) of the resource.
- ResourceOwnerId
-
- Type: string
ID of the Amazon Web Services account that owns the resource consuming licenses.
- ResourceType
-
- Type: string
Type of server resource.
LicenseConfigurationUsage
Description
Details about the usage of a resource associated with a license configuration.
Members
- AssociationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the license configuration was initially associated with the resource.
- ConsumedLicenses
-
- Type: long (int|float)
Number of licenses consumed by the resource.
- ResourceArn
-
- Type: string
Amazon Resource Name (ARN) of the resource.
- ResourceOwnerId
-
- Type: string
ID of the account that owns the resource.
- ResourceStatus
-
- Type: string
Status of the resource.
- ResourceType
-
- Type: string
Type of resource.
LicenseConversionContext
Description
Information about a license type conversion task.
Members
- UsageOperation
-
- Type: string
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
LicenseConversionTask
Description
Information about a license type conversion task.
Members
- DestinationLicenseContext
-
- Type: LicenseConversionContext structure
Information about the license type this conversion task converted to.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the conversion task was completed.
- LicenseConversionTaskId
-
- Type: string
The ID of the license type conversion task.
- LicenseConversionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the usage operation value of the resource was changed.
- ResourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.
- SourceLicenseContext
-
- Type: LicenseConversionContext structure
Information about the license type this conversion task converted from.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the conversion task was started at.
- Status
-
- Type: string
The status of the conversion task.
- StatusMessage
-
- Type: string
The status message for the conversion task.
LicenseOperationFailure
Description
Describes the failure of a license operation.
Members
- ErrorMessage
-
- Type: string
Error message.
- FailureTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Failure time.
- MetadataList
-
- Type: Array of Metadata structures
Reserved.
- OperationName
-
- Type: string
Name of the operation.
- OperationRequestedBy
-
- Type: string
The requester is "License Manager Automated Discovery".
- ResourceArn
-
- Type: string
Amazon Resource Name (ARN) of the resource.
- ResourceOwnerId
-
- Type: string
ID of the Amazon Web Services account that owns the resource.
- ResourceType
-
- Type: string
Resource type.
LicenseSpecification
Description
Details for associating a license configuration with a resource.
Members
LicenseUsage
Description
Describes the entitlement usage associated with a license.
Members
- EntitlementUsages
-
- Type: Array of EntitlementUsage structures
License entitlement usages.
LicenseUsageException
Description
You do not have enough licenses available to support a new resource launch.
Members
ManagedResourceSummary
Description
Summary information about a managed resource.
Members
Metadata
Description
Describes key/value pairs.
Members
NoEntitlementsAllowedException
Description
There are no entitlements found for this license, or the entitlement maximum count is reached.
Members
OrganizationConfiguration
Description
Configuration information for Organizations.
Members
ProductInformation
Description
Describes product information for a license configuration.
Members
- ProductInformationFilterList
-
- Required: Yes
- Type: Array of ProductInformationFilter structures
A Product information filter consists of a
ProductInformationFilterComparatorwhich is a logical operator, aProductInformationFilterNamewhich specifies the type of filter being declared, and aProductInformationFilterValuethat specifies the value to filter on.Accepted values for
ProductInformationFilterNameare listed here along with descriptions and valid options forProductInformationFilterComparator.The following filters and are supported when the resource type is
SSM_MANAGED:-
Application Name- The name of the application. Logical operator isEQUALS. -
Application Publisher- The publisher of the application. Logical operator isEQUALS. -
Application Version- The version of the application. Logical operator isEQUALS. -
Platform Name- The name of the platform. Logical operator isEQUALS. -
Platform Type- The platform type. Logical operator isEQUALS. -
Tag:key- The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator isNOT_EQUALS. The key for your tag must be appended toTag:following the example:Tag:name-of-your-key.ProductInformationFilterValueis optional if you are not using values for the key. -
AccountId- The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator isNOT_EQUALS. -
License Included- The type of license included. Logical operators areEQUALSandNOT_EQUALS. Possible values are:sql-server-enterprise|sql-server-standard|sql-server-web|windows-server-datacenter.
The following filters and logical operators are supported when the resource type is
RDS:-
Engine Edition- The edition of the database engine. Logical operator isEQUALS. Possible values are:oracle-ee|oracle-se|oracle-se1|oracle-se2. -
License Pack- The license pack. Logical operator isEQUALS. Possible values are:data guard|diagnostic pack sqlt|tuning pack sqlt|ols|olap.
- ResourceType
-
- Required: Yes
- Type: string
Resource type. The possible values are
SSM_MANAGED|RDS.
ProductInformationFilter
Description
Describes product information filters.
Members
ProvisionalConfiguration
Description
Details about a provisional configuration.
Members
RateLimitExceededException
Description
Too many requests have been submitted. Try again after a brief wait.
Members
ReceivedMetadata
Description
Metadata associated with received licenses and grants.
Members
RedirectException
Description
This is not the correct Region for the resource. Try again.
Members
ReportContext
Description
Details of the license configuration that this generator reports on.
Members
ReportFrequency
Description
Details about how frequently reports are generated.
Members
ReportGenerator
Description
Describe the details of a report generator.
Members
- CreateTime
-
- Type: string
Time the report was created.
- Description
-
- Type: string
Description of the report generator.
- LastReportGenerationTime
-
- Type: string
Time the last report was generated at.
- LastRunFailureReason
-
- Type: string
Failure message for the last report generation attempt.
- LastRunStatus
-
- Type: string
Status of the last report generation attempt.
- LicenseManagerReportGeneratorArn
-
- Type: string
Amazon Resource Name (ARN) of the report generator.
- ReportContext
-
- Type: ReportContext structure
License configuration type for this generator.
- ReportCreatorAccount
-
- Type: string
The Amazon Web Services account ID used to create the report generator.
- ReportFrequency
-
- Type: ReportFrequency structure
Details about how frequently reports are generated.
- ReportGeneratorName
-
- Type: string
Name of the report generator.
- ReportType
-
- Type: Array of strings
Type of reports that are generated.
- S3Location
-
- Type: S3Location structure
Details of the S3 bucket that report generator reports are published to.
- Tags
-
- Type: Array of Tag structures
Tags associated with the report generator.
ResourceInventory
Description
Details about a resource.
Members
- Platform
-
- Type: string
Platform of the resource.
- PlatformVersion
-
- Type: string
Platform version of the resource in the inventory.
- ResourceArn
-
- Type: string
Amazon Resource Name (ARN) of the resource.
- ResourceId
-
- Type: string
ID of the resource.
- ResourceOwningAccountId
-
- Type: string
ID of the account that owns the resource.
- ResourceType
-
- Type: string
Type of resource.
ResourceLimitExceededException
ResourceNotFoundException
S3Location
Description
Details of the S3 bucket that report generator reports are published to.
Members
ServerInternalException
Tag
Description
Details about a tag for a license configuration.
Members
TokenData
Description
Describes a token.
Members
- ExpirationTime
-
- Type: string
Token expiration time, in ISO8601-UTC format.
- LicenseArn
-
- Type: string
Amazon Resource Name (ARN) of the license.
- RoleArns
-
- Type: Array of strings
Amazon Resource Names (ARN) of the roles included in the token.
- Status
-
- Type: string
Token status. The possible values are
AVAILABLEandDELETED. - TokenId
-
- Type: string
Token ID.
- TokenProperties
-
- Type: Array of strings
Data specified by the caller.
- TokenType
-
- Type: string
Type of token generated. The supported value is
REFRESH_TOKEN.
UnsupportedDigitalSignatureMethodException
Description
The digital signature method is unsupported. Try your request again.