com.amazonaws.services.licensemanagerusersubscriptions

Interface AWSLicenseManagerUserSubscriptions

All Known Subinterfaces:

AWSLicenseManagerUserSubscriptionsAsync

All Known Implementing Classes:

AbstractAWSLicenseManagerUserSubscriptions, AbstractAWSLicenseManagerUserSubscriptionsAsync, AWSLicenseManagerUserSubscriptionsAsyncClient, AWSLicenseManagerUserSubscriptionsClient

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

Interface for accessing AWS License Manager User Subscriptions.

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

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

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

Method Summary

Modifier and Type	Method and Description
AssociateUserResult	associateUser(AssociateUserRequest associateUserRequest) Associates the user to an EC2 instance to utilize user-based subscriptions.
DeregisterIdentityProviderResult	deregisterIdentityProvider(DeregisterIdentityProviderRequest deregisterIdentityProviderRequest) Deregisters the identity provider from providing user-based subscriptions.
DisassociateUserResult	disassociateUser(DisassociateUserRequest disassociateUserRequest) 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 listIdentityProvidersRequest) Lists the identity providers for user-based subscriptions.
ListInstancesResult	listInstances(ListInstancesRequest listInstancesRequest) Lists the EC2 instances providing user-based subscriptions.
ListProductSubscriptionsResult	listProductSubscriptions(ListProductSubscriptionsRequest listProductSubscriptionsRequest) Lists the user-based subscription products available from an identity provider.
ListUserAssociationsResult	listUserAssociations(ListUserAssociationsRequest listUserAssociationsRequest) Lists user associations for an identity provider.
RegisterIdentityProviderResult	registerIdentityProvider(RegisterIdentityProviderRequest registerIdentityProviderRequest) 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 startProductSubscriptionRequest) Starts a product subscription for a user with the specified identity provider.
StopProductSubscriptionResult	stopProductSubscription(StopProductSubscriptionRequest stopProductSubscriptionRequest) Stops a product subscription for a user with the specified identity provider.
UpdateIdentityProviderSettingsResult	updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest updateIdentityProviderSettingsRequest) Updates additional product configuration settings for the registered identity provider.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateUser

AssociateUserResult associateUser(AssociateUserRequest associateUserRequest)

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.

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

DeregisterIdentityProviderResult deregisterIdentityProvider(DeregisterIdentityProviderRequest deregisterIdentityProviderRequest)

Deregisters the identity provider from providing user-based subscriptions.

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

DisassociateUserResult disassociateUser(DisassociateUserRequest disassociateUserRequest)

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

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

ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)

Lists the identity providers for user-based subscriptions.

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

ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)

Lists the EC2 instances providing user-based subscriptions.

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

ListProductSubscriptionsResult listProductSubscriptions(ListProductSubscriptionsRequest listProductSubscriptionsRequest)

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

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

ListUserAssociationsResult listUserAssociations(ListUserAssociationsRequest listUserAssociationsRequest)

Lists user associations for an identity provider.

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

RegisterIdentityProviderResult registerIdentityProvider(RegisterIdentityProviderRequest registerIdentityProviderRequest)

Registers an identity provider for user-based subscriptions.

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

StartProductSubscriptionResult startProductSubscription(StartProductSubscriptionRequest startProductSubscriptionRequest)

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.

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

StopProductSubscriptionResult stopProductSubscription(StopProductSubscriptionRequest stopProductSubscriptionRequest)

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

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

UpdateIdentityProviderSettingsResult updateIdentityProviderSettings(UpdateIdentityProviderSettingsRequest updateIdentityProviderSettingsRequest)

Updates additional product configuration settings for the registered identity provider.

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

shutdown

void shutdown()

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

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

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