com.amazonaws.services.licensemanager

Interface AWSLicenseManager

All Known Subinterfaces:

AWSLicenseManagerAsync

All Known Implementing Classes:

AbstractAWSLicenseManager, AbstractAWSLicenseManagerAsync, AWSLicenseManagerAsyncClient, AWSLicenseManagerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSLicenseManager

Interface for accessing AWS License Manager.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSLicenseManager instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptGrantResult	acceptGrant(AcceptGrantRequest acceptGrantRequest) Accepts the specified grant.
CheckInLicenseResult	checkInLicense(CheckInLicenseRequest checkInLicenseRequest) Checks in the specified license.
CheckoutBorrowLicenseResult	checkoutBorrowLicense(CheckoutBorrowLicenseRequest checkoutBorrowLicenseRequest) Checks out the specified license for offline use.
CheckoutLicenseResult	checkoutLicense(CheckoutLicenseRequest checkoutLicenseRequest) Checks out the specified license.
CreateGrantResult	createGrant(CreateGrantRequest createGrantRequest) Creates a grant for the specified license.
CreateGrantVersionResult	createGrantVersion(CreateGrantVersionRequest createGrantVersionRequest) Creates a new version of the specified grant.
CreateLicenseResult	createLicense(CreateLicenseRequest createLicenseRequest) Creates a license.
CreateLicenseConfigurationResult	createLicenseConfiguration(CreateLicenseConfigurationRequest createLicenseConfigurationRequest) Creates a license configuration.
CreateLicenseConversionTaskForResourceResult	createLicenseConversionTaskForResource(CreateLicenseConversionTaskForResourceRequest createLicenseConversionTaskForResourceRequest) Creates a new license conversion task.
CreateLicenseManagerReportGeneratorResult	createLicenseManagerReportGenerator(CreateLicenseManagerReportGeneratorRequest createLicenseManagerReportGeneratorRequest) Creates a report generator.
CreateLicenseVersionResult	createLicenseVersion(CreateLicenseVersionRequest createLicenseVersionRequest) Creates a new version of the specified license.
CreateTokenResult	createToken(CreateTokenRequest createTokenRequest) Creates a long-lived token.
DeleteGrantResult	deleteGrant(DeleteGrantRequest deleteGrantRequest) Deletes the specified grant.
DeleteLicenseResult	deleteLicense(DeleteLicenseRequest deleteLicenseRequest) Deletes the specified license.
DeleteLicenseConfigurationResult	deleteLicenseConfiguration(DeleteLicenseConfigurationRequest deleteLicenseConfigurationRequest) Deletes the specified license configuration.
DeleteLicenseManagerReportGeneratorResult	deleteLicenseManagerReportGenerator(DeleteLicenseManagerReportGeneratorRequest deleteLicenseManagerReportGeneratorRequest) Deletes the specified report generator.
DeleteTokenResult	deleteToken(DeleteTokenRequest deleteTokenRequest) Deletes the specified token.
ExtendLicenseConsumptionResult	extendLicenseConsumption(ExtendLicenseConsumptionRequest extendLicenseConsumptionRequest) Extends the expiration date for license consumption.
GetAccessTokenResult	getAccessToken(GetAccessTokenRequest getAccessTokenRequest) 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 getGrantRequest) Gets detailed information about the specified grant.
GetLicenseResult	getLicense(GetLicenseRequest getLicenseRequest) Gets detailed information about the specified license.
GetLicenseConfigurationResult	getLicenseConfiguration(GetLicenseConfigurationRequest getLicenseConfigurationRequest) Gets detailed information about the specified license configuration.
GetLicenseConversionTaskResult	getLicenseConversionTask(GetLicenseConversionTaskRequest getLicenseConversionTaskRequest) Gets information about the specified license type conversion task.
GetLicenseManagerReportGeneratorResult	getLicenseManagerReportGenerator(GetLicenseManagerReportGeneratorRequest getLicenseManagerReportGeneratorRequest) Gets information about the specified report generator.
GetLicenseUsageResult	getLicenseUsage(GetLicenseUsageRequest getLicenseUsageRequest) Gets detailed information about the usage of the specified license.
GetServiceSettingsResult	getServiceSettings(GetServiceSettingsRequest getServiceSettingsRequest) Gets the License Manager settings for the current Region.
ListAssociationsForLicenseConfigurationResult	listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest listAssociationsForLicenseConfigurationRequest) Lists the resource associations for the specified license configuration.
ListDistributedGrantsResult	listDistributedGrants(ListDistributedGrantsRequest listDistributedGrantsRequest) Lists the grants distributed for the specified license.
ListFailuresForLicenseConfigurationOperationsResult	listFailuresForLicenseConfigurationOperations(ListFailuresForLicenseConfigurationOperationsRequest listFailuresForLicenseConfigurationOperationsRequest) Lists the license configuration operations that failed.
ListLicenseConfigurationsResult	listLicenseConfigurations(ListLicenseConfigurationsRequest listLicenseConfigurationsRequest) Lists the license configurations for your account.
ListLicenseConversionTasksResult	listLicenseConversionTasks(ListLicenseConversionTasksRequest listLicenseConversionTasksRequest) Lists the license type conversion tasks for your account.
ListLicenseManagerReportGeneratorsResult	listLicenseManagerReportGenerators(ListLicenseManagerReportGeneratorsRequest listLicenseManagerReportGeneratorsRequest) Lists the report generators for your account.
ListLicensesResult	listLicenses(ListLicensesRequest listLicensesRequest) Lists the licenses for your account.
ListLicenseSpecificationsForResourceResult	listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest listLicenseSpecificationsForResourceRequest) Describes the license configurations for the specified resource.
ListLicenseVersionsResult	listLicenseVersions(ListLicenseVersionsRequest listLicenseVersionsRequest) Lists all versions of the specified license.
ListReceivedGrantsResult	listReceivedGrants(ListReceivedGrantsRequest listReceivedGrantsRequest) Lists grants that are received but not accepted.
ListReceivedLicensesResult	listReceivedLicenses(ListReceivedLicensesRequest listReceivedLicensesRequest) Lists received licenses.
ListResourceInventoryResult	listResourceInventory(ListResourceInventoryRequest listResourceInventoryRequest) Lists resources managed using Systems Manager inventory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified license configuration.
ListTokensResult	listTokens(ListTokensRequest listTokensRequest) Lists your tokens.
ListUsageForLicenseConfigurationResult	listUsageForLicenseConfiguration(ListUsageForLicenseConfigurationRequest listUsageForLicenseConfigurationRequest) Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.
RejectGrantResult	rejectGrant(RejectGrantRequest rejectGrantRequest) Rejects the specified grant.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified license configuration.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified license configuration.
UpdateLicenseConfigurationResult	updateLicenseConfiguration(UpdateLicenseConfigurationRequest updateLicenseConfigurationRequest) Modifies the attributes of an existing license configuration.
UpdateLicenseManagerReportGeneratorResult	updateLicenseManagerReportGenerator(UpdateLicenseManagerReportGeneratorRequest updateLicenseManagerReportGeneratorRequest) Updates a report generator.
UpdateLicenseSpecificationsForResourceResult	updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest) Adds or removes the specified license configurations for the specified Amazon Web Services resource.
UpdateServiceSettingsResult	updateServiceSettings(UpdateServiceSettingsRequest updateServiceSettingsRequest) Updates License Manager settings for the current Region.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptGrant

AcceptGrantResult acceptGrant(AcceptGrantRequest acceptGrantRequest)

Accepts the specified grant.

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

See Also:

AWS API Documentation

checkInLicense

CheckInLicenseResult checkInLicense(CheckInLicenseRequest checkInLicenseRequest)

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

Parameters:

checkInLicenseRequest -

Returns:

Result of the CheckInLicense 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.

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.

See Also:

AWS API Documentation

checkoutBorrowLicense

CheckoutBorrowLicenseResult checkoutBorrowLicense(CheckoutBorrowLicenseRequest checkoutBorrowLicenseRequest)

Checks out the specified license for offline use.

Parameters:

checkoutBorrowLicenseRequest -

Returns:

Result of the CheckoutBorrowLicense 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.

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.

See Also:

AWS API Documentation

checkoutLicense

CheckoutLicenseResult checkoutLicense(CheckoutLicenseRequest checkoutLicenseRequest)

Checks out the specified license.

Parameters:

checkoutLicenseRequest -

Returns:

Result of the CheckoutLicense 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.

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.

See Also:

AWS API Documentation

createGrant

CreateGrantResult createGrant(CreateGrantRequest createGrantRequest)

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

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

See Also:

AWS API Documentation

createGrantVersion

CreateGrantVersionResult createGrantVersion(CreateGrantVersionRequest createGrantVersionRequest)

Creates a new version of the specified grant.

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

See Also:

AWS API Documentation

createLicense

CreateLicenseResult createLicense(CreateLicenseRequest createLicenseRequest)

Creates a license.

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

See Also:

AWS API Documentation

createLicenseConfiguration

CreateLicenseConfigurationResult createLicenseConfiguration(CreateLicenseConfigurationRequest createLicenseConfigurationRequest)

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.

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

See Also:

AWS API Documentation

createLicenseConversionTaskForResource

CreateLicenseConversionTaskForResourceResult createLicenseConversionTaskForResource(CreateLicenseConversionTaskForResourceRequest createLicenseConversionTaskForResourceRequest)

Creates a new license conversion task.

Parameters:

createLicenseConversionTaskForResourceRequest -

Returns:

Result of the CreateLicenseConversionTaskForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createLicenseManagerReportGenerator

CreateLicenseManagerReportGeneratorResult createLicenseManagerReportGenerator(CreateLicenseManagerReportGeneratorRequest createLicenseManagerReportGeneratorRequest)

Creates a report generator.

Parameters:

createLicenseManagerReportGeneratorRequest -

Returns:

Result of the CreateLicenseManagerReportGenerator 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 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.

See Also:

AWS API Documentation

createLicenseVersion

CreateLicenseVersionResult createLicenseVersion(CreateLicenseVersionRequest createLicenseVersionRequest)

Creates a new version of the specified license.

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

See Also:

AWS API Documentation

createToken

CreateTokenResult createToken(CreateTokenRequest createTokenRequest)

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.

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

See Also:

AWS API Documentation

deleteGrant

DeleteGrantResult deleteGrant(DeleteGrantRequest deleteGrantRequest)

Deletes the specified grant.

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

See Also:

AWS API Documentation

deleteLicense

DeleteLicenseResult deleteLicense(DeleteLicenseRequest deleteLicenseRequest)

Deletes the specified license.

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

See Also:

AWS API Documentation

deleteLicenseConfiguration

DeleteLicenseConfigurationResult deleteLicenseConfiguration(DeleteLicenseConfigurationRequest deleteLicenseConfigurationRequest)

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

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

See Also:

AWS API Documentation

deleteLicenseManagerReportGenerator

DeleteLicenseManagerReportGeneratorResult deleteLicenseManagerReportGenerator(DeleteLicenseManagerReportGeneratorRequest deleteLicenseManagerReportGeneratorRequest)

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.

Parameters:

deleteLicenseManagerReportGeneratorRequest -

Returns:

Result of the DeleteLicenseManagerReportGenerator 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 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.

See Also:

AWS API Documentation

deleteToken

DeleteTokenResult deleteToken(DeleteTokenRequest deleteTokenRequest)

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

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

See Also:

AWS API Documentation

extendLicenseConsumption

ExtendLicenseConsumptionResult extendLicenseConsumption(ExtendLicenseConsumptionRequest extendLicenseConsumptionRequest)

Extends the expiration date for license consumption.

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

See Also:

AWS API Documentation

getAccessToken

GetAccessTokenResult getAccessToken(GetAccessTokenRequest getAccessTokenRequest)

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

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

See Also:

AWS API Documentation

getGrant

GetGrantResult getGrant(GetGrantRequest getGrantRequest)

Gets detailed information about the specified grant.

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

See Also:

AWS API Documentation

getLicense

GetLicenseResult getLicense(GetLicenseRequest getLicenseRequest)

Gets detailed information about the specified license.

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

See Also:

AWS API Documentation

getLicenseConfiguration

GetLicenseConfigurationResult getLicenseConfiguration(GetLicenseConfigurationRequest getLicenseConfigurationRequest)

Gets detailed information about the specified license configuration.

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

See Also:

AWS API Documentation

getLicenseConversionTask

GetLicenseConversionTaskResult getLicenseConversionTask(GetLicenseConversionTaskRequest getLicenseConversionTaskRequest)

Gets information about the specified license type conversion task.

Parameters:

getLicenseConversionTaskRequest -

Returns:

Result of the GetLicenseConversionTask 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 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.

See Also:

AWS API Documentation

getLicenseManagerReportGenerator

GetLicenseManagerReportGeneratorResult getLicenseManagerReportGenerator(GetLicenseManagerReportGeneratorRequest getLicenseManagerReportGeneratorRequest)

Gets information about the specified report generator.

Parameters:

getLicenseManagerReportGeneratorRequest -

Returns:

Result of the GetLicenseManagerReportGenerator 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 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.

See Also:

AWS API Documentation

getLicenseUsage

GetLicenseUsageResult getLicenseUsage(GetLicenseUsageRequest getLicenseUsageRequest)

Gets detailed information about the usage of the specified license.

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

See Also:

AWS API Documentation

getServiceSettings

GetServiceSettingsResult getServiceSettings(GetServiceSettingsRequest getServiceSettingsRequest)

Gets the License Manager settings for the current Region.

Parameters:

getServiceSettingsRequest -

Returns:

Result of the GetServiceSettings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAssociationsForLicenseConfiguration

ListAssociationsForLicenseConfigurationResult listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest listAssociationsForLicenseConfigurationRequest)

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

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

See Also:

AWS API Documentation

listDistributedGrants

ListDistributedGrantsResult listDistributedGrants(ListDistributedGrantsRequest listDistributedGrantsRequest)

Lists the grants distributed for the specified license.

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

See Also:

AWS API Documentation

listFailuresForLicenseConfigurationOperations

ListFailuresForLicenseConfigurationOperationsResult listFailuresForLicenseConfigurationOperations(ListFailuresForLicenseConfigurationOperationsRequest listFailuresForLicenseConfigurationOperationsRequest)

Lists the license configuration operations that failed.

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

See Also:

AWS API Documentation

listLicenseConfigurations

ListLicenseConfigurationsResult listLicenseConfigurations(ListLicenseConfigurationsRequest listLicenseConfigurationsRequest)

Lists the license configurations for your account.

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

See Also:

AWS API Documentation

listLicenseConversionTasks

ListLicenseConversionTasksResult listLicenseConversionTasks(ListLicenseConversionTasksRequest listLicenseConversionTasksRequest)

Lists the license type conversion tasks for your account.

Parameters:

listLicenseConversionTasksRequest -

Returns:

Result of the ListLicenseConversionTasks 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 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.

See Also:

AWS API Documentation

listLicenseManagerReportGenerators

ListLicenseManagerReportGeneratorsResult listLicenseManagerReportGenerators(ListLicenseManagerReportGeneratorsRequest listLicenseManagerReportGeneratorsRequest)

Lists the report generators for your account.

Parameters:

listLicenseManagerReportGeneratorsRequest -

Returns:

Result of the ListLicenseManagerReportGenerators 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 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.

See Also:

AWS API Documentation

listLicenseSpecificationsForResource

ListLicenseSpecificationsForResourceResult listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest listLicenseSpecificationsForResourceRequest)

Describes the license configurations for the specified resource.

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

See Also:

AWS API Documentation

listLicenseVersions

ListLicenseVersionsResult listLicenseVersions(ListLicenseVersionsRequest listLicenseVersionsRequest)

Lists all versions of the specified license.

Parameters:

listLicenseVersionsRequest -

Returns:

Result of the ListLicenseVersions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listLicenses

ListLicensesResult listLicenses(ListLicensesRequest listLicensesRequest)

Lists the licenses for your account.

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

See Also:

AWS API Documentation

listReceivedGrants

ListReceivedGrantsResult listReceivedGrants(ListReceivedGrantsRequest listReceivedGrantsRequest)

Lists grants that are received but not accepted.

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

See Also:

AWS API Documentation

listReceivedLicenses

ListReceivedLicensesResult listReceivedLicenses(ListReceivedLicensesRequest listReceivedLicensesRequest)

Lists received licenses.

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

See Also:

AWS API Documentation

listResourceInventory

ListResourceInventoryResult listResourceInventory(ListResourceInventoryRequest listResourceInventoryRequest)

Lists resources managed using Systems Manager inventory.

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

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified license configuration.

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

See Also:

AWS API Documentation

listTokens

ListTokensResult listTokens(ListTokensRequest listTokensRequest)

Lists your tokens.

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

See Also:

AWS API Documentation

listUsageForLicenseConfiguration

ListUsageForLicenseConfigurationResult listUsageForLicenseConfiguration(ListUsageForLicenseConfigurationRequest listUsageForLicenseConfigurationRequest)

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.

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

See Also:

AWS API Documentation

rejectGrant

RejectGrantResult rejectGrant(RejectGrantRequest rejectGrantRequest)

Rejects the specified grant.

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

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the specified license configuration.

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

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified license configuration.

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

See Also:

AWS API Documentation

updateLicenseConfiguration

UpdateLicenseConfigurationResult updateLicenseConfiguration(UpdateLicenseConfigurationRequest updateLicenseConfigurationRequest)

Modifies the attributes of an existing license configuration.

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

See Also:

AWS API Documentation

updateLicenseManagerReportGenerator

UpdateLicenseManagerReportGeneratorResult updateLicenseManagerReportGenerator(UpdateLicenseManagerReportGeneratorRequest updateLicenseManagerReportGeneratorRequest)

Updates a report generator.

After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

Parameters:

updateLicenseManagerReportGeneratorRequest -

Returns:

Result of the UpdateLicenseManagerReportGenerator 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.

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.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

UpdateLicenseSpecificationsForResourceResult updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest)

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.

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

See Also:

AWS API Documentation

updateServiceSettings

UpdateServiceSettingsResult updateServiceSettings(UpdateServiceSettingsRequest updateServiceSettingsRequest)

Updates License Manager settings for the current Region.

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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