com.amazonaws.services.licensemanagerusersubscriptions

Class AWSLicenseManagerUserSubscriptionsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.licensemanagerusersubscriptions.AWSLicenseManagerUserSubscriptionsClient

All Implemented Interfaces:

AWSLicenseManagerUserSubscriptions

Direct Known Subclasses:

AWSLicenseManagerUserSubscriptionsAsyncClient

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

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

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.licensemanagerusersubscriptions.AWSLicenseManagerUserSubscriptions

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateUserResult	associateUser(AssociateUserRequest request) Associates the user to an EC2 instance to utilize user-based subscriptions.
static AWSLicenseManagerUserSubscriptionsClientBuilder	builder()
DeregisterIdentityProviderResult	deregisterIdentityProvider(DeregisterIdentityProviderRequest request) Deregisters the identity provider from providing user-based subscriptions.
DisassociateUserResult	disassociateUser(DisassociateUserRequest request) Disassociates the user from an EC2 instance providing user-based subscriptions.
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.
ListIdentityProvidersResult	listIdentityProviders(ListIdentityProvidersRequest request) Lists the identity providers for user-based subscriptions.
ListInstancesResult	listInstances(ListInstancesRequest request) Lists the EC2 instances providing user-based subscriptions.
ListProductSubscriptionsResult	listProductSubscriptions(ListProductSubscriptionsRequest request) Lists the user-based subscription products available from an identity provider.
ListUserAssociationsResult	listUserAssociations(ListUserAssociationsRequest request) Lists user associations for an identity provider.
RegisterIdentityProviderResult	registerIdentityProvider(RegisterIdentityProviderRequest request) Registers an identity provider for user-based subscriptions.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartProductSubscriptionResult	startProductSubscription(StartProductSubscriptionRequest request) Starts a product subscription for a user with the specified identity provider.
StopProductSubscriptionResult	stopProductSubscription(StopProductSubscriptionRequest request) Stops a product subscription for a user with the specified identity provider.
UpdateIdentityProviderSettingsResult	updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest request) Updates additional product configuration settings for the registered identity provider.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSLicenseManagerUserSubscriptionsClientBuilder builder()

associateUser

public AssociateUserResult associateUser(AssociateUserRequest request)

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Specified by:

associateUser in interface AWSLicenseManagerUserSubscriptions

Parameters:

associateUserRequest -

Returns:

Result of the AssociateUser operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

deregisterIdentityProvider

public DeregisterIdentityProviderResult deregisterIdentityProvider(DeregisterIdentityProviderRequest request)

Deregisters the identity provider from providing user-based subscriptions.

Specified by:

deregisterIdentityProvider in interface AWSLicenseManagerUserSubscriptions

Parameters:

deregisterIdentityProviderRequest -

Returns:

Result of the DeregisterIdentityProvider operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

disassociateUser

public DisassociateUserResult disassociateUser(DisassociateUserRequest request)

Disassociates the user from an EC2 instance providing user-based subscriptions.

Specified by:

disassociateUser in interface AWSLicenseManagerUserSubscriptions

Parameters:

disassociateUserRequest -

Returns:

Result of the DisassociateUser operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

listIdentityProviders

public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest request)

Lists the identity providers for user-based subscriptions.

Specified by:

listIdentityProviders in interface AWSLicenseManagerUserSubscriptions

Parameters:

listIdentityProvidersRequest -

Returns:

Result of the ListIdentityProviders operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

listInstances

public ListInstancesResult listInstances(ListInstancesRequest request)

Lists the EC2 instances providing user-based subscriptions.

Specified by:

listInstances in interface AWSLicenseManagerUserSubscriptions

Parameters:

listInstancesRequest -

Returns:

Result of the ListInstances operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

listProductSubscriptions

public ListProductSubscriptionsResult listProductSubscriptions(ListProductSubscriptionsRequest request)

Lists the user-based subscription products available from an identity provider.

Specified by:

listProductSubscriptions in interface AWSLicenseManagerUserSubscriptions

Parameters:

listProductSubscriptionsRequest -

Returns:

Result of the ListProductSubscriptions operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

listUserAssociations

public ListUserAssociationsResult listUserAssociations(ListUserAssociationsRequest request)

Lists user associations for an identity provider.

Specified by:

listUserAssociations in interface AWSLicenseManagerUserSubscriptions

Parameters:

listUserAssociationsRequest -

Returns:

Result of the ListUserAssociations operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

registerIdentityProvider

public RegisterIdentityProviderResult registerIdentityProvider(RegisterIdentityProviderRequest request)

Registers an identity provider for user-based subscriptions.

Specified by:

registerIdentityProvider in interface AWSLicenseManagerUserSubscriptions

Parameters:

registerIdentityProviderRequest -

Returns:

Result of the RegisterIdentityProvider operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

startProductSubscription

public StartProductSubscriptionResult startProductSubscription(StartProductSubscriptionRequest request)

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Specified by:

startProductSubscription in interface AWSLicenseManagerUserSubscriptions

Parameters:

startProductSubscriptionRequest -

Returns:

Result of the StartProductSubscription operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

stopProductSubscription

public StopProductSubscriptionResult stopProductSubscription(StopProductSubscriptionRequest request)

Stops a product subscription for a user with the specified identity provider.

Specified by:

stopProductSubscription in interface AWSLicenseManagerUserSubscriptions

Parameters:

stopProductSubscriptionRequest -

Returns:

Result of the StopProductSubscription operation returned by the service.

Throws:

ServiceQuotaExceededException - The request failed because a service quota is exceeded.

ConflictException - The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

ResourceNotFoundException - The resource couldn't be found.

AccessDeniedException - You don't have sufficient access to perform this action.

See Also:

AWS API Documentation

updateIdentityProviderSettings

public UpdateIdentityProviderSettingsResult updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest request)

Updates additional product configuration settings for the registered identity provider.

Specified by:

updateIdentityProviderSettings in interface AWSLicenseManagerUserSubscriptions

Parameters:

updateIdentityProviderSettingsRequest -

Returns:

Result of the UpdateIdentityProviderSettings operation returned by the service.

Throws:

ValidationException - A parameter is not valid.

ThrottlingException - The request was denied because of request throttling. Retry the request.

InternalServerException - An exception occurred with the service.

AccessDeniedException - You don't have sufficient access to perform this action.

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 AWSLicenseManagerUserSubscriptions

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

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

Specified by:

shutdown in interface AWSLicenseManagerUserSubscriptions

Overrides:

shutdown in class AmazonWebServiceClient