com.amazonaws.services.marketplaceentitlement

Interface AWSMarketplaceEntitlement

All Known Subinterfaces:

AWSMarketplaceEntitlementAsync

All Known Implementing Classes:

AbstractAWSMarketplaceEntitlement, AbstractAWSMarketplaceEntitlementAsync, AWSMarketplaceEntitlementAsyncClient, AWSMarketplaceEntitlementClient

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

Interface for accessing AWS Marketplace Entitlement Service.

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

AWS Marketplace Entitlement Service

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

Getting Entitlement Records

• GetEntitlements- Gets the entitlements for a Marketplace product.

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
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.
GetEntitlementsResult	getEntitlements(GetEntitlementsRequest getEntitlementsRequest) GetEntitlements retrieves entitlement values for a given product.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

getEntitlements

GetEntitlementsResult getEntitlements(GetEntitlementsRequest getEntitlementsRequest)

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

Parameters:

getEntitlementsRequest - The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

Returns:

Result of the GetEntitlements operation returned by the service.

Throws:

InvalidParameterException - One or more parameters in your request was invalid.

ThrottlingException - The calls to the GetEntitlements API are throttled.

InternalServiceErrorException - An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

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.