software.amazon.awssdk.services.licensemanager

Interface LicenseManagerAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface LicenseManagerAsyncClient
extends SdkClient

Service client for accessing AWS License Manager asynchronously. This can be created using the static builder() method. 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

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static LicenseManagerAsyncClientBuilder	builder() Create a builder that can be used to configure and create a LicenseManagerAsyncClient.
static LicenseManagerAsyncClient	create() Create a LicenseManagerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateLicenseConfigurationResponse>	createLicenseConfiguration(Consumer<CreateLicenseConfigurationRequest.Builder> createLicenseConfigurationRequest) Creates a new license configuration object.
default CompletableFuture<CreateLicenseConfigurationResponse>	createLicenseConfiguration(CreateLicenseConfigurationRequest createLicenseConfigurationRequest) Creates a new license configuration object.
default CompletableFuture<DeleteLicenseConfigurationResponse>	deleteLicenseConfiguration(Consumer<DeleteLicenseConfigurationRequest.Builder> deleteLicenseConfigurationRequest) Deletes an existing license configuration.
default CompletableFuture<DeleteLicenseConfigurationResponse>	deleteLicenseConfiguration(DeleteLicenseConfigurationRequest deleteLicenseConfigurationRequest) Deletes an existing license configuration.
default CompletableFuture<GetLicenseConfigurationResponse>	getLicenseConfiguration(Consumer<GetLicenseConfigurationRequest.Builder> getLicenseConfigurationRequest) Returns a detailed description of a license configuration.
default CompletableFuture<GetLicenseConfigurationResponse>	getLicenseConfiguration(GetLicenseConfigurationRequest getLicenseConfigurationRequest) Returns a detailed description of a license configuration.
default CompletableFuture<GetServiceSettingsResponse>	getServiceSettings(Consumer<GetServiceSettingsRequest.Builder> getServiceSettingsRequest) Gets License Manager settings for a region.
default CompletableFuture<GetServiceSettingsResponse>	getServiceSettings(GetServiceSettingsRequest getServiceSettingsRequest) Gets License Manager settings for a region.
default CompletableFuture<ListAssociationsForLicenseConfigurationResponse>	listAssociationsForLicenseConfiguration(Consumer<ListAssociationsForLicenseConfigurationRequest.Builder> listAssociationsForLicenseConfigurationRequest) Lists the resource associations for a license configuration.
default CompletableFuture<ListAssociationsForLicenseConfigurationResponse>	listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest listAssociationsForLicenseConfigurationRequest) Lists the resource associations for a license configuration.
default CompletableFuture<ListLicenseConfigurationsResponse>	listLicenseConfigurations(Consumer<ListLicenseConfigurationsRequest.Builder> listLicenseConfigurationsRequest) Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.
default CompletableFuture<ListLicenseConfigurationsResponse>	listLicenseConfigurations(ListLicenseConfigurationsRequest listLicenseConfigurationsRequest) Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.
default CompletableFuture<ListLicenseSpecificationsForResourceResponse>	listLicenseSpecificationsForResource(Consumer<ListLicenseSpecificationsForResourceRequest.Builder> listLicenseSpecificationsForResourceRequest) Returns the license configuration for a resource.
default CompletableFuture<ListLicenseSpecificationsForResourceResponse>	listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest listLicenseSpecificationsForResourceRequest) Returns the license configuration for a resource.
default CompletableFuture<ListResourceInventoryResponse>	listResourceInventory(Consumer<ListResourceInventoryRequest.Builder> listResourceInventoryRequest) Returns a detailed list of resources.
default CompletableFuture<ListResourceInventoryResponse>	listResourceInventory(ListResourceInventoryRequest listResourceInventoryRequest) Returns a detailed list of resources.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags attached to a resource.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags attached to a resource.
default CompletableFuture<ListUsageForLicenseConfigurationResponse>	listUsageForLicenseConfiguration(Consumer<ListUsageForLicenseConfigurationRequest.Builder> listUsageForLicenseConfigurationRequest) Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.
default CompletableFuture<ListUsageForLicenseConfigurationResponse>	listUsageForLicenseConfiguration(ListUsageForLicenseConfigurationRequest listUsageForLicenseConfigurationRequest) Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.
default CompletableFuture<TagResourceResponse>	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attach one of more tags to any resource.
default CompletableFuture<TagResourceResponse>	tagResource(TagResourceRequest tagResourceRequest) Attach one of more tags to any resource.
default CompletableFuture<UntagResourceResponse>	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a resource.
default CompletableFuture<UntagResourceResponse>	untagResource(UntagResourceRequest untagResourceRequest) Remove tags from a resource.
default CompletableFuture<UpdateLicenseConfigurationResponse>	updateLicenseConfiguration(Consumer<UpdateLicenseConfigurationRequest.Builder> updateLicenseConfigurationRequest) Modifies the attributes of an existing license configuration object.
default CompletableFuture<UpdateLicenseConfigurationResponse>	updateLicenseConfiguration(UpdateLicenseConfigurationRequest updateLicenseConfigurationRequest) Modifies the attributes of an existing license configuration object.
default CompletableFuture<UpdateLicenseSpecificationsForResourceResponse>	updateLicenseSpecificationsForResource(Consumer<UpdateLicenseSpecificationsForResourceRequest.Builder> updateLicenseSpecificationsForResourceRequest) Adds or removes license configurations for a specified AWS resource.
default CompletableFuture<UpdateLicenseSpecificationsForResourceResponse>	updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest) Adds or removes license configurations for a specified AWS resource.
default CompletableFuture<UpdateServiceSettingsResponse>	updateServiceSettings(Consumer<UpdateServiceSettingsRequest.Builder> updateServiceSettingsRequest) Updates License Manager service settings.
default CompletableFuture<UpdateServiceSettingsResponse>	updateServiceSettings(UpdateServiceSettingsRequest updateServiceSettingsRequest) Updates License Manager service settings.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static LicenseManagerAsyncClient create()

Create a LicenseManagerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static LicenseManagerAsyncClientBuilder builder()

Create a builder that can be used to configure and create a LicenseManagerAsyncClient.

createLicenseConfiguration

default CompletableFuture<CreateLicenseConfigurationResponse> createLicenseConfiguration(CreateLicenseConfigurationRequest createLicenseConfigurationRequest)

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.

Parameters:

createLicenseConfigurationRequest -

Returns:

A Java Future containing the result of the CreateLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createLicenseConfiguration

default CompletableFuture<CreateLicenseConfigurationResponse> createLicenseConfiguration(Consumer<CreateLicenseConfigurationRequest.Builder> createLicenseConfigurationRequest)

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.

This is a convenience which creates an instance of the CreateLicenseConfigurationRequest.Builder avoiding the need to create one manually via CreateLicenseConfigurationRequest.builder()

Parameters:

createLicenseConfigurationRequest - A Consumer that will call methods on CreateLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteLicenseConfiguration

default CompletableFuture<DeleteLicenseConfigurationResponse> deleteLicenseConfiguration(DeleteLicenseConfigurationRequest deleteLicenseConfigurationRequest)

Deletes an existing license configuration. This action fails if the configuration is in use.

Parameters:

deleteLicenseConfigurationRequest -

Returns:

A Java Future containing the result of the DeleteLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteLicenseConfiguration

default CompletableFuture<DeleteLicenseConfigurationResponse> deleteLicenseConfiguration(Consumer<DeleteLicenseConfigurationRequest.Builder> deleteLicenseConfigurationRequest)

Deletes an existing license configuration. This action fails if the configuration is in use.

This is a convenience which creates an instance of the DeleteLicenseConfigurationRequest.Builder avoiding the need to create one manually via DeleteLicenseConfigurationRequest.builder()

Parameters:

deleteLicenseConfigurationRequest - A Consumer that will call methods on DeleteLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getLicenseConfiguration

default CompletableFuture<GetLicenseConfigurationResponse> getLicenseConfiguration(GetLicenseConfigurationRequest getLicenseConfigurationRequest)

Returns a detailed description of a license configuration.

Parameters:

getLicenseConfigurationRequest -

Returns:

A Java Future containing the result of the GetLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getLicenseConfiguration

default CompletableFuture<GetLicenseConfigurationResponse> getLicenseConfiguration(Consumer<GetLicenseConfigurationRequest.Builder> getLicenseConfigurationRequest)

Returns a detailed description of a license configuration.

This is a convenience which creates an instance of the GetLicenseConfigurationRequest.Builder avoiding the need to create one manually via GetLicenseConfigurationRequest.builder()

Parameters:

getLicenseConfigurationRequest - A Consumer that will call methods on GetLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getServiceSettings

default CompletableFuture<GetServiceSettingsResponse> getServiceSettings(GetServiceSettingsRequest getServiceSettingsRequest)

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

Parameters:

getServiceSettingsRequest -

Returns:

A Java Future containing the result of the GetServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getServiceSettings

default CompletableFuture<GetServiceSettingsResponse> getServiceSettings(Consumer<GetServiceSettingsRequest.Builder> getServiceSettingsRequest)

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

This is a convenience which creates an instance of the GetServiceSettingsRequest.Builder avoiding the need to create one manually via GetServiceSettingsRequest.builder()

Parameters:

getServiceSettingsRequest - A Consumer that will call methods on GetServiceSettingsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listAssociationsForLicenseConfiguration

default CompletableFuture<ListAssociationsForLicenseConfigurationResponse> listAssociationsForLicenseConfiguration(ListAssociationsForLicenseConfigurationRequest listAssociationsForLicenseConfigurationRequest)

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.

Parameters:

listAssociationsForLicenseConfigurationRequest -

Returns:

A Java Future containing the result of the ListAssociationsForLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listAssociationsForLicenseConfiguration

default CompletableFuture<ListAssociationsForLicenseConfigurationResponse> listAssociationsForLicenseConfiguration(Consumer<ListAssociationsForLicenseConfigurationRequest.Builder> listAssociationsForLicenseConfigurationRequest)

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.

This is a convenience which creates an instance of the ListAssociationsForLicenseConfigurationRequest.Builder avoiding the need to create one manually via ListAssociationsForLicenseConfigurationRequest.builder()

Parameters:

listAssociationsForLicenseConfigurationRequest - A Consumer that will call methods on ListAssociationsForLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListAssociationsForLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLicenseConfigurations

default CompletableFuture<ListLicenseConfigurationsResponse> listLicenseConfigurations(ListLicenseConfigurationsRequest listLicenseConfigurationsRequest)

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

Parameters:

listLicenseConfigurationsRequest -

Returns:

A Java Future containing the result of the ListLicenseConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLicenseConfigurations

default CompletableFuture<ListLicenseConfigurationsResponse> listLicenseConfigurations(Consumer<ListLicenseConfigurationsRequest.Builder> listLicenseConfigurationsRequest)

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

This is a convenience which creates an instance of the ListLicenseConfigurationsRequest.Builder avoiding the need to create one manually via ListLicenseConfigurationsRequest.builder()

Parameters:

listLicenseConfigurationsRequest - A Consumer that will call methods on ListLicenseConfigurationsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListLicenseConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLicenseSpecificationsForResource

default CompletableFuture<ListLicenseSpecificationsForResourceResponse> listLicenseSpecificationsForResource(ListLicenseSpecificationsForResourceRequest listLicenseSpecificationsForResourceRequest)

Returns the license configuration for a resource.

Parameters:

listLicenseSpecificationsForResourceRequest -

Returns:

A Java Future containing the result of the ListLicenseSpecificationsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listLicenseSpecificationsForResource

default CompletableFuture<ListLicenseSpecificationsForResourceResponse> listLicenseSpecificationsForResource(Consumer<ListLicenseSpecificationsForResourceRequest.Builder> listLicenseSpecificationsForResourceRequest)

Returns the license configuration for a resource.

This is a convenience which creates an instance of the ListLicenseSpecificationsForResourceRequest.Builder avoiding the need to create one manually via ListLicenseSpecificationsForResourceRequest.builder()

Parameters:

listLicenseSpecificationsForResourceRequest - A Consumer that will call methods on ListLicenseSpecificationsForResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListLicenseSpecificationsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listResourceInventory

default CompletableFuture<ListResourceInventoryResponse> listResourceInventory(ListResourceInventoryRequest listResourceInventoryRequest)

Returns a detailed list of resources.

Parameters:

listResourceInventoryRequest -

Returns:

A Java Future containing the result of the ListResourceInventory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listResourceInventory

default CompletableFuture<ListResourceInventoryResponse> listResourceInventory(Consumer<ListResourceInventoryRequest.Builder> listResourceInventoryRequest)

Returns a detailed list of resources.

This is a convenience which creates an instance of the ListResourceInventoryRequest.Builder avoiding the need to create one manually via ListResourceInventoryRequest.builder()

Parameters:

listResourceInventoryRequest - A Consumer that will call methods on ListResourceInventoryRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListResourceInventory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists tags attached to a resource.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Lists tags attached to a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsageForLicenseConfiguration

default CompletableFuture<ListUsageForLicenseConfigurationResponse> 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:

A Java Future containing the result of the ListUsageForLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsageForLicenseConfiguration

default CompletableFuture<ListUsageForLicenseConfigurationResponse> listUsageForLicenseConfiguration(Consumer<ListUsageForLicenseConfigurationRequest.Builder> 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.

This is a convenience which creates an instance of the ListUsageForLicenseConfigurationRequest.Builder avoiding the need to create one manually via ListUsageForLicenseConfigurationRequest.builder()

Parameters:

listUsageForLicenseConfigurationRequest - A Consumer that will call methods on ListUsageForLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListUsageForLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

Attach one of more tags to any resource.

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Attach one of more tags to any resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

Remove tags from a resource.

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Remove tags from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLicenseConfiguration

default CompletableFuture<UpdateLicenseConfigurationResponse> updateLicenseConfiguration(UpdateLicenseConfigurationRequest updateLicenseConfigurationRequest)

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.

Parameters:

updateLicenseConfigurationRequest -

Returns:

A Java Future containing the result of the UpdateLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLicenseConfiguration

default CompletableFuture<UpdateLicenseConfigurationResponse> updateLicenseConfiguration(Consumer<UpdateLicenseConfigurationRequest.Builder> updateLicenseConfigurationRequest)

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.

This is a convenience which creates an instance of the UpdateLicenseConfigurationRequest.Builder avoiding the need to create one manually via UpdateLicenseConfigurationRequest.builder()

Parameters:

updateLicenseConfigurationRequest - A Consumer that will call methods on UpdateLicenseConfigurationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateLicenseConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

default CompletableFuture<UpdateLicenseSpecificationsForResourceResponse> updateLicenseSpecificationsForResource(UpdateLicenseSpecificationsForResourceRequest updateLicenseSpecificationsForResourceRequest)

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.

Parameters:

updateLicenseSpecificationsForResourceRequest -

Returns:

A Java Future containing the result of the UpdateLicenseSpecificationsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateLicenseSpecificationsForResource

default CompletableFuture<UpdateLicenseSpecificationsForResourceResponse> updateLicenseSpecificationsForResource(Consumer<UpdateLicenseSpecificationsForResourceRequest.Builder> updateLicenseSpecificationsForResourceRequest)

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.

This is a convenience which creates an instance of the UpdateLicenseSpecificationsForResourceRequest.Builder avoiding the need to create one manually via UpdateLicenseSpecificationsForResourceRequest.builder()

Parameters:

updateLicenseSpecificationsForResourceRequest - A Consumer that will call methods on UpdateLicenseSpecificationsForResourceRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateLicenseSpecificationsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateServiceSettings

default CompletableFuture<UpdateServiceSettingsResponse> updateServiceSettings(UpdateServiceSettingsRequest updateServiceSettingsRequest)

Updates License Manager service settings.

Parameters:

updateServiceSettingsRequest -

Returns:

A Java Future containing the result of the UpdateServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateServiceSettings

default CompletableFuture<UpdateServiceSettingsResponse> updateServiceSettings(Consumer<UpdateServiceSettingsRequest.Builder> updateServiceSettingsRequest)

Updates License Manager service settings.

This is a convenience which creates an instance of the UpdateServiceSettingsRequest.Builder avoiding the need to create one manually via UpdateServiceSettingsRequest.builder()

Parameters:

updateServiceSettingsRequest - A Consumer that will call methods on UpdateServiceSettingsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateServiceSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• LicenseManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation