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.

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

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
CreateLicenseConfigurationResult	createLicenseConfiguration(CreateLicenseConfigurationRequest createLicenseConfigurationRequest) Creates a license configuration.
DeleteLicenseConfigurationResult	deleteLicenseConfiguration(DeleteLicenseConfigurationRequest deleteLicenseConfigurationRequest) Deletes the specified license configuration.
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.
GetLicenseConfigurationResult	getLicenseConfiguration(GetLicenseConfigurationRequest getLicenseConfigurationRequest) Gets detailed information about the specified license configuration.
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.
ListFailuresForLicenseConfigurationOperationsResult	listFailuresForLicenseConfigurationOperations(ListFailuresForLicenseConfigurationOperationsRequest listFailuresForLicenseConfigurationOperationsRequest) Lists the license configuration operations that failed.
ListLicenseConfigurationsResult	listLicenseConfigurations(ListLicenseConfigurationsRequest listLicenseConfigurationsRequest) Lists the license configurations for your account.
ListLicenseSpecificationsForResourceResult	listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest listLicenseSpecificationsForResourceRequest) Describes the license configurations for the specified resource.
ListResourceInventoryResult	listResourceInventory(ListResourceInventoryRequest listResourceInventoryRequest) Lists resources managed using Systems Manager inventory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified license configuration.
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.
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.
UpdateLicenseSpecificationsForResourceResult	updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest) Adds or removes the specified license configurations for the specified AWS 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

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), host affinity (how long a VM 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 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

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

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

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

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

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

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

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

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

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

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

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

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

UpdateLicenseConfigurationResult updateLicenseConfiguration(UpdateLicenseConfigurationRequest updateLicenseConfigurationRequest)

Modifies the attributes of an existing 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), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

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.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

UpdateLicenseSpecificationsForResourceResult updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest)

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.

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

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

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.