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

This is the AWS License Manager API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for License Manager. The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

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
static AWSLicenseManagerClientBuilder	builder()
CreateLicenseConfigurationResult	createLicenseConfiguration(CreateLicenseConfigurationRequest request) Creates a new license configuration object.
DeleteLicenseConfigurationResult	deleteLicenseConfiguration(DeleteLicenseConfigurationRequest request) Deletes an existing 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 request) Returns a detailed description of a license configuration.
GetServiceSettingsResult	getServiceSettings(GetServiceSettingsRequest request) Gets License Manager settings for a region.
ListAssociationsForLicenseConfigurationResult	listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest request) Lists the resource associations for a license configuration.
ListLicenseConfigurationsResult	listLicenseConfigurations(ListLicenseConfigurationsRequest request) Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.
ListLicenseSpecificationsForResourceResult	listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest request) Returns the license configuration for a resource.
ListResourceInventoryResult	listResourceInventory(ListResourceInventoryRequest request) Returns a detailed list of resources.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists tags attached to a resource.
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.
TagResourceResult	tagResource(TagResourceRequest request) Attach one of more tags to any resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove tags from a resource.
UpdateLicenseConfigurationResult	updateLicenseConfiguration(UpdateLicenseConfigurationRequest request) Modifies the attributes of an existing license configuration object.
UpdateLicenseSpecificationsForResourceResult	updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest request) Adds or removes license configurations for a specified AWS resource.
UpdateServiceSettingsResult	updateServiceSettings(UpdateServiceSettingsRequest request) Updates License Manager service settings.

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, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Method Detail

builder

public static AWSLicenseManagerClientBuilder builder()

createLicenseConfiguration

public CreateLicenseConfigurationResult createLicenseConfiguration(CreateLicenseConfigurationRequest request)

Creates a new license configuration object. 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), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), 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

deleteLicenseConfiguration

public DeleteLicenseConfigurationResult deleteLicenseConfiguration(DeleteLicenseConfigurationRequest request)

Deletes an existing license configuration. This action fails if the configuration 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

getLicenseConfiguration

public GetLicenseConfigurationResult getLicenseConfiguration(GetLicenseConfigurationRequest request)

Returns a detailed description of a 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

getServiceSettings

public GetServiceSettingsResult getServiceSettings(GetServiceSettingsRequest request)

Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection.

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 a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration.

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

listLicenseConfigurations

public ListLicenseConfigurationsResult listLicenseConfigurations(ListLicenseConfigurationsRequest request)

Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.

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)

Returns the license configuration for a 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

listResourceInventory

public ListResourceInventoryResult listResourceInventory(ListResourceInventoryRequest request)

Returns a detailed list of resources.

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 tags attached to a resource.

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

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Attach one of more tags to any resource.

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)

Remove tags from a resource.

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 object. 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 (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used.

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.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

public UpdateLicenseSpecificationsForResourceResult updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest request)

Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances.

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

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.