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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ServerInternalException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

ResourceNotFoundException:

The resource cannot be found.

ConflictException:

There was a conflict processing the request. Try your request again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

ResourceNotFoundException:

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.

RedirectException:

This is not the correct Region for the resource. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

The server experienced an internal error. Try again.

CheckoutLicense

$result = $client->checkoutLicense([/* ... */]);
$promise = $client->checkoutLicenseAsync([/* ... */]);

Checks out the specified license.

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

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

ResourceNotFoundException:

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.

RedirectException:

This is not the correct Region for the resource. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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 a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.

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

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

AccessDeniedException:

Access to resource denied.

CreateGrantVersion

$result = $client->createGrantVersion([/* ... */]);
$promise = $client->createGrantVersionAsync([/* ... */]);

Creates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.

Parameter Syntax

$result = $client->createGrantVersion([
    'AllowedOperations' => ['<string>', ...],
    'ClientToken' => '<string>', // REQUIRED
    'GrantArn' => '<string>', // REQUIRED
    'GrantName' => '<string>',
    'Options' => [
        'ActivationOverrideBehavior' => 'DISTRIBUTED_GRANTS_ONLY|ALL_GRANTS_PERMITTED_BY_ISSUER',
    ],
    'SourceVersion' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'StatusReason' => '<string>',
]);

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

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[
    'LicenseArn' => '<string>',
    'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
    'Version' => '<string>',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

RedirectException:

This is not the correct Region for the resource. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

Result Syntax

[
    'LicenseConfigurationArn' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

ResourceLimitExceededException:

Your resource limits have been exceeded.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[
    'LicenseConversionTaskId' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ValidationException:

The provided input is not valid. Try your request again.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[
    'LicenseManagerReportGeneratorArn' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

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

Result Syntax

[
    'LicenseArn' => '<string>',
    'Status' => 'AVAILABLE|PENDING_AVAILABLE|DEACTIVATED|SUSPENDED|EXPIRED|PENDING_DELETE|DELETED',
    'Version' => '<string>',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

The resource cannot be found.

RedirectException:

This is not the correct Region for the resource. Try again.

ConflictException:

There was a conflict processing the request. Try your request again.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

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

Result Syntax

[
    'Token' => '<string>',
    'TokenId' => '<string>',
    'TokenType' => 'REFRESH_TOKEN',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ServerInternalException:

The server experienced an internal error. Try again.

ResourceNotFoundException:

The resource cannot be found.

RedirectException:

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

Result Syntax

[
    'GrantArn' => '<string>',
    'Status' => 'PENDING_WORKFLOW|PENDING_ACCEPT|REJECTED|ACTIVE|FAILED_WORKFLOW|DELETED|PENDING_DELETE|DISABLED|WORKFLOW_COMPLETED',
    'Version' => '<string>',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ServerInternalException:

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

Result Syntax

[
    'DeletionDate' => '<string>',
    'Status' => 'PENDING_DELETE|DELETED',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

RedirectException:

This is not the correct Region for the resource. Try again.

ConflictException:

There was a conflict processing the request. Try your request again.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

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

ValidationException:

The provided input is not valid. Try your request again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

The server experienced an internal error. Try again.

ResourceNotFoundException:

The resource cannot be found.

RedirectException:

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

Result Syntax

[
    'Expiration' => '<string>',
    'LicenseConsumptionToken' => '<string>',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

The server experienced an internal error. Try again.

ResourceNotFoundException:

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

Result Syntax

[
    'AccessToken' => '<string>',
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

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>',
        'Options' => [
            'ActivationOverrideBehavior' => 'DISTRIBUTED_GRANTS_ONLY|ALL_GRANTS_PERMITTED_BY_ISSUER',
        ],
        'ParentArn' => '<string>',
        'StatusReason' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

Result Syntax

[
    'EnableCrossAccountsDiscovery' => true || false,
    'LicenseManagerResourceShareArn' => '<string>',
    'OrganizationConfiguration' => [
        'EnableIntegration' => true || false,
    ],
    'S3BucketArn' => '<string>',
    'SnsTopicArn' => '<string>',
]

Result Details

Errors

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

FilterLimitExceededException:

The request uses too many filters or too many filter values.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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>',
            'Options' => [
                'ActivationOverrideBehavior' => 'DISTRIBUTED_GRANTS_ONLY|ALL_GRANTS_PERMITTED_BY_ISSUER',
            ],
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

FilterLimitExceededException:

The request uses too many filters or too many filter values.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

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

Result Syntax

[
    'LicenseSpecifications' => [
        [
            'AmiAssociationScope' => '<string>',
            'LicenseConfigurationArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

The server experienced an internal error. Try again.

ListReceivedGrants

$result = $client->listReceivedGrants([/* ... */]);
$promise = $client->listReceivedGrantsAsync([/* ... */]);

Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.

Parameter Syntax

$result = $client->listReceivedGrants([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'GrantArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

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>',
            'Options' => [
                'ActivationOverrideBehavior' => 'DISTRIBUTED_GRANTS_ONLY|ALL_GRANTS_PERMITTED_BY_ISSUER',
            ],
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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>',
            'Options' => [
                'ActivationOverrideBehavior' => 'DISTRIBUTED_GRANTS_ONLY|ALL_GRANTS_PERMITTED_BY_ISSUER',
            ],
            'ParentArn' => '<string>',
            'StatusReason' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

ValidationException:

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.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

FilterLimitExceededException:

The request uses too many filters or too many filter values.

FailedDependencyException:

A dependency required to run the API is missing.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'Tokens' => [
        [
            'ExpirationTime' => '<string>',
            'LicenseArn' => '<string>',
            'RoleArns' => ['<string>', ...],
            'Status' => '<string>',
            'TokenId' => '<string>',
            'TokenProperties' => ['<string>', ...],
            'TokenType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

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

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

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

FilterLimitExceededException:

The request uses too many filters or too many filter values.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ResourceLimitExceededException:

Your resource limits have been exceeded.

ServerInternalException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

The provided input is not valid. Try your request again.

InvalidParameterValueException:

One or more parameter values are not valid.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

ResourceNotFoundException:

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

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.

LicenseUsageException:

You do not have enough licenses available to support a new resource launch.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

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

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

One or more parameter values are not valid.

ServerInternalException:

The server experienced an internal error. Try again.

AuthorizationException:

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

AccessDeniedException:

Access to resource denied.

RateLimitExceededException:

Too many requests have been submitted. Try again after a brief wait.