Package software.amazon.awssdk.services.marketplaceentitlement

Interface MarketplaceEntitlementClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MarketplaceEntitlementClient
extends AwsClient

Service client for accessing AWS Marketplace Entitlement Service. This can be created using the static builder() method. 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	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MarketplaceEntitlementClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceEntitlementClient.
static MarketplaceEntitlementClient	create()	Create a MarketplaceEntitlementClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetEntitlementsResponse	getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)	GetEntitlements retrieves entitlement values for a given product.
default GetEntitlementsResponse	getEntitlements(GetEntitlementsRequest getEntitlementsRequest)	GetEntitlements retrieves entitlement values for a given product.
default GetEntitlementsIterable	getEntitlementsPaginator(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)	This is a variant of getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation.
default GetEntitlementsIterable	getEntitlementsPaginator(GetEntitlementsRequest getEntitlementsRequest)	This is a variant of getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation.
default MarketplaceEntitlementServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

getEntitlements

default GetEntitlementsResponse getEntitlements(GetEntitlementsRequest getEntitlementsRequest)
                                         throws InvalidParameterException,
                                                ThrottlingException,
                                                InternalServiceErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                MarketplaceEntitlementException

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.

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.

MarketplaceEntitlementException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getEntitlements

default GetEntitlementsResponse getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)
                                         throws InvalidParameterException,
                                                ThrottlingException,
                                                InternalServiceErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                MarketplaceEntitlementException

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

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

Parameters:

getEntitlementsRequest - A Consumer that will call methods on GetEntitlementsRequest.Builder to create a request. 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.

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.

MarketplaceEntitlementException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getEntitlementsPaginator

default GetEntitlementsIterable getEntitlementsPaginator(GetEntitlementsRequest getEntitlementsRequest)
                                                  throws InvalidParameterException,
                                                         ThrottlingException,
                                                         InternalServiceErrorException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         MarketplaceEntitlementException

This is a variant of getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client
             .getEntitlementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation.

Parameters:

getEntitlementsRequest - The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

MarketplaceEntitlementException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getEntitlementsPaginator

default GetEntitlementsIterable getEntitlementsPaginator(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)
                                                  throws InvalidParameterException,
                                                         ThrottlingException,
                                                         InternalServiceErrorException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         MarketplaceEntitlementException

This is a variant of getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client
             .getEntitlementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest) operation.

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

Parameters:

getEntitlementsRequest - A Consumer that will call methods on GetEntitlementsRequest.Builder to create a request. The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

MarketplaceEntitlementException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static MarketplaceEntitlementClient create()

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

builder

static MarketplaceEntitlementClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MarketplaceEntitlementServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient