<?php
// This file was auto-generated from sdk-root/src/data/entitlement.marketplace/2017-01-11/docs-2.json
return [ 'version' => '2.0', 'service' => '<fullname>AWS Marketplace Entitlement Service</fullname> <p>This reference provides descriptions of the AWS Marketplace Entitlement Service API.</p> <p>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.</p> <p> <b>Getting Entitlement Records</b> </p> <ul> <li> <p> <i>GetEntitlements</i>- Gets the entitlements for a Marketplace product.</p> </li> </ul>', 'operations' => [ 'GetEntitlements' => '<p>GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier, AWS account ID, or product dimensions.</p> <important> <p> The <code>CustomerIdentifier</code> parameter is on path for deprecation. Use <code>CustomerAWSAccountID</code> instead.</p> <p>These parameters are mutually exclusive. You can\'t specify both <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> in the same request. </p> </important>', ], 'shapes' => [ 'Boolean' => [ 'base' => NULL, 'refs' => [ 'EntitlementValue$BooleanValue' => '<p>The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.</p>', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'EntitlementValue$DoubleValue' => '<p>The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.</p>', ], ], 'Entitlement' => [ 'base' => '<p>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.</p>', 'refs' => [ 'EntitlementList$member' => NULL, ], ], 'EntitlementList' => [ 'base' => NULL, 'refs' => [ 'GetEntitlementsResult$Entitlements' => '<p>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.</p>', ], ], 'EntitlementValue' => [ 'base' => '<p>The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.</p>', 'refs' => [ 'Entitlement$Value' => '<p>The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.</p>', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InternalServiceErrorException$message' => NULL, 'InvalidParameterException$message' => NULL, 'ThrottlingException$message' => NULL, ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValueList$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'GetEntitlementFilters$value' => NULL, ], ], 'GetEntitlementFilterName' => [ 'base' => NULL, 'refs' => [ 'GetEntitlementFilters$key' => NULL, ], ], 'GetEntitlementFilters' => [ 'base' => NULL, 'refs' => [ 'GetEntitlementsRequest$Filter' => '<p>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 <i>unioned</i> for each value in the value list, and then <i>intersected</i> for each filter key.</p> <p> <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> are mutually exclusive. You can\'t specify both in the same request. </p>', ], ], 'GetEntitlementsRequest' => [ 'base' => '<p>The GetEntitlementsRequest contains parameters for the GetEntitlements operation.</p>', 'refs' => [], ], 'GetEntitlementsResult' => [ 'base' => '<p>The GetEntitlementsRequest contains results from the GetEntitlements operation.</p>', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'EntitlementValue$IntegerValue' => '<p>The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.</p>', ], ], 'InternalServiceErrorException' => [ 'base' => '<p>An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.</p>', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '<p>One or more parameters in your request was invalid.</p>', 'refs' => [], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Entitlement$Dimension' => '<p>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.</p>', 'Entitlement$CustomerIdentifier' => '<p>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.</p>', 'Entitlement$CustomerAWSAccountId' => '<p> The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer. </p>', 'GetEntitlementsRequest$NextToken' => '<p>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.</p>', 'GetEntitlementsResult$NextToken' => '<p>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.</p>', ], ], 'PageSizeInteger' => [ 'base' => NULL, 'refs' => [ 'GetEntitlementsRequest$MaxResults' => '<p>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.</p>', ], ], 'ProductCode' => [ 'base' => NULL, 'refs' => [ 'Entitlement$ProductCode' => '<p>The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.</p>', 'GetEntitlementsRequest$ProductCode' => '<p>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.</p>', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'EntitlementValue$StringValue' => '<p>The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.</p>', ], ], 'ThrottlingException' => [ 'base' => '<p>The calls to the GetEntitlements API are throttled.</p>', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Entitlement$ExpirationDate' => '<p>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.</p>', ], ], ],];
