com.amazonaws.services.licensemanager

Class AWSLicenseManagerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.licensemanager.AWSLicenseManagerClient

All Implemented Interfaces:

AWSLicenseManager

Direct Known Subclasses:

AWSLicenseManagerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSLicenseManagerClient
extends AmazonWebServiceClient
implements AWSLicenseManager

Client for accessing AWS License Manager. All service calls made using this client are blocking, and will not return until the service call completes.

AWS License Manager

AWS License Manager makes it easier to manage licenses from software vendors across multiple AWS accounts and on-premises servers.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.licensemanager.AWSLicenseManager

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AcceptGrantResult	acceptGrant(AcceptGrantRequest request) Accepts the specified grant.
static AWSLicenseManagerClientBuilder	builder()
CheckInLicenseResult	checkInLicense(CheckInLicenseRequest request) Checks in the specified license.
CheckoutBorrowLicenseResult	checkoutBorrowLicense(CheckoutBorrowLicenseRequest request) Checks out the specified license for offline use.
CheckoutLicenseResult	checkoutLicense(CheckoutLicenseRequest request) Checks out the specified license.
CreateGrantResult	createGrant(CreateGrantRequest request) Creates a grant for the specified license.
CreateGrantVersionResult	createGrantVersion(CreateGrantVersionRequest request) Creates a new version of the specified grant.
CreateLicenseResult	createLicense(CreateLicenseRequest request) Creates a license.
CreateLicenseConfigurationResult	createLicenseConfiguration(CreateLicenseConfigurationRequest request) Creates a license configuration.
CreateLicenseVersionResult	createLicenseVersion(CreateLicenseVersionRequest request) Creates a new version of the specified license.
CreateTokenResult	createToken(CreateTokenRequest request) Creates a long-lived token.
DeleteGrantResult	deleteGrant(DeleteGrantRequest request) Deletes the specified grant.
DeleteLicenseResult	deleteLicense(DeleteLicenseRequest request) Deletes the specified license.
DeleteLicenseConfigurationResult	deleteLicenseConfiguration(DeleteLicenseConfigurationRequest request) Deletes the specified license configuration.
DeleteTokenResult	deleteToken(DeleteTokenRequest request) Deletes the specified token.
ExtendLicenseConsumptionResult	extendLicenseConsumption(ExtendLicenseConsumptionRequest request) Extends the expiration date for license consumption.
GetAccessTokenResult	getAccessToken(GetAccessTokenRequest request) Gets a temporary access token to use with AssumeRoleWithWebIdentity.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetGrantResult	getGrant(GetGrantRequest request) Gets detailed information about the specified grant.
GetLicenseResult	getLicense(GetLicenseRequest request) Gets detailed information about the specified license.
GetLicenseConfigurationResult	getLicenseConfiguration(GetLicenseConfigurationRequest request) Gets detailed information about the specified license configuration.
GetLicenseUsageResult	getLicenseUsage(GetLicenseUsageRequest request) Gets detailed information about the usage of the specified license.
GetServiceSettingsResult	getServiceSettings(GetServiceSettingsRequest request) Gets the License Manager settings for the current Region.
ListAssociationsForLicenseConfigurationResult	listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest request) Lists the resource associations for the specified license configuration.
ListDistributedGrantsResult	listDistributedGrants(ListDistributedGrantsRequest request) Lists the grants distributed for the specified license.
ListFailuresForLicenseConfigurationOperationsResult	listFailuresForLicenseConfigurationOperations(ListFailuresForLicenseConfigurationOperationsRequest request) Lists the license configuration operations that failed.
ListLicenseConfigurationsResult	listLicenseConfigurations(ListLicenseConfigurationsRequest request) Lists the license configurations for your account.
ListLicensesResult	listLicenses(ListLicensesRequest request) Lists the licenses for your account.
ListLicenseSpecificationsForResourceResult	listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest request) Describes the license configurations for the specified resource.
ListLicenseVersionsResult	listLicenseVersions(ListLicenseVersionsRequest request) Lists all versions of the specified license.
ListReceivedGrantsResult	listReceivedGrants(ListReceivedGrantsRequest request) Lists grants that are received but not accepted.
ListReceivedLicensesResult	listReceivedLicenses(ListReceivedLicensesRequest request) Lists received licenses.
ListResourceInventoryResult	listResourceInventory(ListResourceInventoryRequest request) Lists resources managed using Systems Manager inventory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified license configuration.
ListTokensResult	listTokens(ListTokensRequest request) Lists your tokens.
ListUsageForLicenseConfigurationResult	listUsageForLicenseConfiguration(ListUsageForLicenseConfigurationRequest request) Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.
RejectGrantResult	rejectGrant(RejectGrantRequest request) Rejects the specified grant.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to the specified license configuration.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified license configuration.
UpdateLicenseConfigurationResult	updateLicenseConfiguration(UpdateLicenseConfigurationRequest request) Modifies the attributes of an existing license configuration.
UpdateLicenseSpecificationsForResourceResult	updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest request) Adds or removes the specified license configurations for the specified AWS resource.
UpdateServiceSettingsResult	updateServiceSettings(UpdateServiceSettingsRequest request) Updates License Manager settings for the current Region.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSLicenseManagerClientBuilder builder()

acceptGrant

public AcceptGrantResult acceptGrant(AcceptGrantRequest request)

Accepts the specified grant.

Specified by:

acceptGrant in interface AWSLicenseManager

Parameters:

acceptGrantRequest -

Returns:

Result of the AcceptGrant operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

checkInLicense

public CheckInLicenseResult checkInLicense(CheckInLicenseRequest request)

Checks in the specified license. Check in a license when it is no longer in use.

Specified by:

checkInLicense in interface AWSLicenseManager

Parameters:

checkInLicenseRequest -

Returns:

Result of the CheckInLicense operation returned by the service.

Throws:

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

ResourceNotFoundException - The resource cannot be found.

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

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

checkoutBorrowLicense

public CheckoutBorrowLicenseResult checkoutBorrowLicense(CheckoutBorrowLicenseRequest request)

Checks out the specified license for offline use.

Specified by:

checkoutBorrowLicense in interface AWSLicenseManager

Parameters:

checkoutBorrowLicenseRequest -

Returns:

Result of the CheckoutBorrowLicense operation returned by the service.

Throws:

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

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 AWS 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.

See Also:

AWS API Documentation

checkoutLicense

public CheckoutLicenseResult checkoutLicense(CheckoutLicenseRequest request)

Checks out the specified license.

Specified by:

checkoutLicense in interface AWSLicenseManager

Parameters:

checkoutLicenseRequest -

Returns:

Result of the CheckoutLicense operation returned by the service.

Throws:

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

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 AWS 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.

See Also:

AWS API Documentation

createGrant

public CreateGrantResult createGrant(CreateGrantRequest request)

Creates a grant for the specified license. A grant shares the use of license entitlements with specific AWS accounts.

Specified by:

createGrant in interface AWSLicenseManager

Parameters:

createGrantRequest -

Returns:

Result of the CreateGrant operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

createGrantVersion

public CreateGrantVersionResult createGrantVersion(CreateGrantVersionRequest request)

Creates a new version of the specified grant.

Specified by:

createGrantVersion in interface AWSLicenseManager

Parameters:

createGrantVersionRequest -

Returns:

Result of the CreateGrantVersion operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

createLicense

public CreateLicenseResult createLicense(CreateLicenseRequest request)

Creates a license.

Specified by:

createLicense in interface AWSLicenseManager

Parameters:

createLicenseRequest -

Returns:

Result of the CreateLicense operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

createLicenseConfiguration

public CreateLicenseConfigurationResult createLicenseConfiguration(CreateLicenseConfigurationRequest request)

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.

Specified by:

createLicenseConfiguration in interface AWSLicenseManager

Parameters:

createLicenseConfigurationRequest -

Returns:

Result of the CreateLicenseConfiguration operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

createLicenseVersion

public CreateLicenseVersionResult createLicenseVersion(CreateLicenseVersionRequest request)

Creates a new version of the specified license.

Specified by:

createLicenseVersion in interface AWSLicenseManager

Parameters:

createLicenseVersionRequest -

Returns:

Result of the CreateLicenseVersion operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

createToken

public CreateTokenResult createToken(CreateTokenRequest request)

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.

Specified by:

createToken in interface AWSLicenseManager

Parameters:

createTokenRequest -

Returns:

Result of the CreateToken operation returned by the service.

Throws:

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

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

deleteGrant

public DeleteGrantResult deleteGrant(DeleteGrantRequest request)

Deletes the specified grant.

Specified by:

deleteGrant in interface AWSLicenseManager

Parameters:

deleteGrantRequest -

Returns:

Result of the DeleteGrant operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

deleteLicense

public DeleteLicenseResult deleteLicense(DeleteLicenseRequest request)

Deletes the specified license.

Specified by:

deleteLicense in interface AWSLicenseManager

Parameters:

deleteLicenseRequest -

Returns:

Result of the DeleteLicense operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

deleteLicenseConfiguration

public DeleteLicenseConfigurationResult deleteLicenseConfiguration(DeleteLicenseConfigurationRequest request)

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

Specified by:

deleteLicenseConfiguration in interface AWSLicenseManager

Parameters:

deleteLicenseConfigurationRequest -

Returns:

Result of the DeleteLicenseConfiguration operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

deleteToken

public DeleteTokenResult deleteToken(DeleteTokenRequest request)

Deletes the specified token. Must be called in the license home Region.

Specified by:

deleteToken in interface AWSLicenseManager

Parameters:

deleteTokenRequest -

Returns:

Result of the DeleteToken operation returned by the service.

Throws:

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

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

extendLicenseConsumption

public ExtendLicenseConsumptionResult extendLicenseConsumption(ExtendLicenseConsumptionRequest request)

Extends the expiration date for license consumption.

Specified by:

extendLicenseConsumption in interface AWSLicenseManager

Parameters:

extendLicenseConsumptionRequest -

Returns:

Result of the ExtendLicenseConsumption operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getAccessToken

public GetAccessTokenResult getAccessToken(GetAccessTokenRequest request)

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

Specified by:

getAccessToken in interface AWSLicenseManager

Parameters:

getAccessTokenRequest -

Returns:

Result of the GetAccessToken operation returned by the service.

Throws:

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

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getGrant

public GetGrantResult getGrant(GetGrantRequest request)

Gets detailed information about the specified grant.

Specified by:

getGrant in interface AWSLicenseManager

Parameters:

getGrantRequest -

Returns:

Result of the GetGrant operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

getLicense

public GetLicenseResult getLicense(GetLicenseRequest request)

Gets detailed information about the specified license.

Specified by:

getLicense in interface AWSLicenseManager

Parameters:

getLicenseRequest -

Returns:

Result of the GetLicense operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getLicenseConfiguration

public GetLicenseConfigurationResult getLicenseConfiguration(GetLicenseConfigurationRequest request)

Gets detailed information about the specified license configuration.

Specified by:

getLicenseConfiguration in interface AWSLicenseManager

Parameters:

getLicenseConfigurationRequest -

Returns:

Result of the GetLicenseConfiguration operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getLicenseUsage

public GetLicenseUsageResult getLicenseUsage(GetLicenseUsageRequest request)

Gets detailed information about the usage of the specified license.

Specified by:

getLicenseUsage in interface AWSLicenseManager

Parameters:

getLicenseUsageRequest -

Returns:

Result of the GetLicenseUsage operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getServiceSettings

public GetServiceSettingsResult getServiceSettings(GetServiceSettingsRequest request)

Gets the License Manager settings for the current Region.

Specified by:

getServiceSettings in interface AWSLicenseManager

Parameters:

getServiceSettingsRequest -

Returns:

Result of the GetServiceSettings operation returned by the service.

Throws:

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listAssociationsForLicenseConfiguration

public ListAssociationsForLicenseConfigurationResult listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest request)

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).

Specified by:

listAssociationsForLicenseConfiguration in interface AWSLicenseManager

Parameters:

listAssociationsForLicenseConfigurationRequest -

Returns:

Result of the ListAssociationsForLicenseConfiguration operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listDistributedGrants

public ListDistributedGrantsResult listDistributedGrants(ListDistributedGrantsRequest request)

Lists the grants distributed for the specified license.

Specified by:

listDistributedGrants in interface AWSLicenseManager

Parameters:

listDistributedGrantsRequest -

Returns:

Result of the ListDistributedGrants operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listFailuresForLicenseConfigurationOperations

public ListFailuresForLicenseConfigurationOperationsResult listFailuresForLicenseConfigurationOperations(ListFailuresForLicenseConfigurationOperationsRequest request)

Lists the license configuration operations that failed.

Specified by:

listFailuresForLicenseConfigurationOperations in interface AWSLicenseManager

Parameters:

listFailuresForLicenseConfigurationOperationsRequest -

Returns:

Result of the ListFailuresForLicenseConfigurationOperations operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listLicenseConfigurations

public ListLicenseConfigurationsResult listLicenseConfigurations(ListLicenseConfigurationsRequest request)

Lists the license configurations for your account.

Specified by:

listLicenseConfigurations in interface AWSLicenseManager

Parameters:

listLicenseConfigurationsRequest -

Returns:

Result of the ListLicenseConfigurations operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listLicenseSpecificationsForResource

public ListLicenseSpecificationsForResourceResult listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest request)

Describes the license configurations for the specified resource.

Specified by:

listLicenseSpecificationsForResource in interface AWSLicenseManager

Parameters:

listLicenseSpecificationsForResourceRequest -

Returns:

Result of the ListLicenseSpecificationsForResource operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listLicenseVersions

public ListLicenseVersionsResult listLicenseVersions(ListLicenseVersionsRequest request)

Lists all versions of the specified license.

Specified by:

listLicenseVersions in interface AWSLicenseManager

Parameters:

listLicenseVersionsRequest -

Returns:

Result of the ListLicenseVersions operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listLicenses

public ListLicensesResult listLicenses(ListLicensesRequest request)

Lists the licenses for your account.

Specified by:

listLicenses in interface AWSLicenseManager

Parameters:

listLicensesRequest -

Returns:

Result of the ListLicenses operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listReceivedGrants

public ListReceivedGrantsResult listReceivedGrants(ListReceivedGrantsRequest request)

Lists grants that are received but not accepted.

Specified by:

listReceivedGrants in interface AWSLicenseManager

Parameters:

listReceivedGrantsRequest -

Returns:

Result of the ListReceivedGrants operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listReceivedLicenses

public ListReceivedLicensesResult listReceivedLicenses(ListReceivedLicensesRequest request)

Lists received licenses.

Specified by:

listReceivedLicenses in interface AWSLicenseManager

Parameters:

listReceivedLicensesRequest -

Returns:

Result of the ListReceivedLicenses operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listResourceInventory

public ListResourceInventoryResult listResourceInventory(ListResourceInventoryRequest request)

Lists resources managed using Systems Manager inventory.

Specified by:

listResourceInventory in interface AWSLicenseManager

Parameters:

listResourceInventoryRequest -

Returns:

Result of the ListResourceInventory operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified license configuration.

Specified by:

listTagsForResource in interface AWSLicenseManager

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listTokens

public ListTokensResult listTokens(ListTokensRequest request)

Lists your tokens.

Specified by:

listTokens in interface AWSLicenseManager

Parameters:

listTokensRequest -

Returns:

Result of the ListTokens operation returned by the service.

Throws:

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

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

listUsageForLicenseConfiguration

public ListUsageForLicenseConfigurationResult listUsageForLicenseConfiguration(ListUsageForLicenseConfigurationRequest request)

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.

Specified by:

listUsageForLicenseConfiguration in interface AWSLicenseManager

Parameters:

listUsageForLicenseConfigurationRequest -

Returns:

Result of the ListUsageForLicenseConfiguration operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

rejectGrant

public RejectGrantResult rejectGrant(RejectGrantRequest request)

Rejects the specified grant.

Specified by:

rejectGrant in interface AWSLicenseManager

Parameters:

rejectGrantRequest -

Returns:

Result of the RejectGrant operation returned by the service.

Throws:

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

InvalidParameterValueException - One or more parameter values are not valid.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified license configuration.

Specified by:

tagResource in interface AWSLicenseManager

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified license configuration.

Specified by:

untagResource in interface AWSLicenseManager

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

updateLicenseConfiguration

public UpdateLicenseConfigurationResult updateLicenseConfiguration(UpdateLicenseConfigurationRequest request)

Modifies the attributes of an existing license configuration.

Specified by:

updateLicenseConfiguration in interface AWSLicenseManager

Parameters:

updateLicenseConfigurationRequest -

Returns:

Result of the UpdateLicenseConfiguration operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

public UpdateLicenseSpecificationsForResourceResult updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest request)

Adds or removes the specified license configurations for the specified AWS resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.

Specified by:

updateLicenseSpecificationsForResource in interface AWSLicenseManager

Parameters:

updateLicenseSpecificationsForResourceRequest -

Returns:

Result of the UpdateLicenseSpecificationsForResource operation returned by the service.

Throws:

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 AWS 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.

See Also:

AWS API Documentation

updateServiceSettings

public UpdateServiceSettingsResult updateServiceSettings(UpdateServiceSettingsRequest request)

Updates License Manager settings for the current Region.

Specified by:

updateServiceSettings in interface AWSLicenseManager

Parameters:

updateServiceSettingsRequest -

Returns:

Result of the UpdateServiceSettings operation returned by the service.

Throws:

InvalidParameterValueException - One or more parameter values are not valid.

ServerInternalException - The server experienced an internal error. Try again.

AuthorizationException - The AWS 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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSLicenseManager

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSLicenseManager

Overrides:

shutdown in class AmazonWebServiceClient