A low-level client representing 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.
client = session.create_client('marketplace-entitlement')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
See also: AWS API Documentation
Request Syntax
response = client.get_entitlements(
ProductCode='string',
Filter={
'string': [
'string',
]
},
NextToken='string',
MaxResults=123
)
ProductCode (string) –
[REQUIRED]
Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.
Filter (dict) –
Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.
(string) –
(list) –
(string) –
NextToken (string) – For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
MaxResults (integer) – The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.
dict
Response Syntax
{
'Entitlements': [
{
'ProductCode': 'string',
'Dimension': 'string',
'CustomerIdentifier': 'string',
'Value': {
'IntegerValue': 123,
'DoubleValue': 123.0,
'BooleanValue': True|False,
'StringValue': 'string'
},
'ExpirationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
The GetEntitlementsRequest contains results from the GetEntitlements operation.
Entitlements (list) –
The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.
(dict) –
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.
ProductCode (string) –
The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
Dimension (string) –
The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
CustomerIdentifier (string) –
The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.
Value (dict) –
The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
IntegerValue (integer) –
The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.
DoubleValue (float) –
The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.
BooleanValue (boolean) –
The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.
StringValue (string) –
The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.
ExpirationDate (datetime) –
The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.
NextToken (string) –
For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
MarketplaceEntitlementService.Client.exceptions.InternalServiceErrorException
MarketplaceEntitlementService.Client.exceptions.InvalidParameterException
MarketplaceEntitlementService.Client.exceptions.ThrottlingException
An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
Example
try:
...
except client.exceptions.InternalServiceErrorException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more parameters in your request was invalid.
Example
try:
...
except client.exceptions.InvalidParameterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
One or more parameters in your request was invalid.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The calls to the GetEntitlements API are throttled.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The calls to the GetEntitlements API are throttled.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
paginator = client.get_paginator('get_entitlements')
Creates an iterator that will paginate through responses from MarketplaceEntitlementService.Client.get_entitlements()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProductCode='string',
Filter={
'string': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ProductCode (string) –
[REQUIRED]
Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.
Filter (dict) –
Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.
(string) –
(list) –
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Entitlements': [
{
'ProductCode': 'string',
'Dimension': 'string',
'CustomerIdentifier': 'string',
'Value': {
'IntegerValue': 123,
'DoubleValue': 123.0,
'BooleanValue': True|False,
'StringValue': 'string'
},
'ExpirationDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) –
The GetEntitlementsRequest contains results from the GetEntitlements operation.
Entitlements (list) –
The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.
(dict) –
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.
ProductCode (string) –
The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
Dimension (string) –
The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
CustomerIdentifier (string) –
The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.
Value (dict) –
The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
IntegerValue (integer) –
The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.
DoubleValue (float) –
The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.
BooleanValue (boolean) –
The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.
StringValue (string) –
The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.
ExpirationDate (datetime) –
The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.