@datafire/amazonaws_entitlement_marketplace

Client library for AWS Marketplace Entitlement Service

Installation and Usage

npm install --save @datafire/amazonaws_entitlement_marketplace

let amazonaws_entitlement_marketplace = require('@datafire/amazonaws_entitlement_marketplace').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_entitlement_marketplace.GetEntitlements({
  "ProductCode": ""
}).then(data => {
  console.log(data);
});

Description

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.

Actions

GetEntitlements

amazonaws_entitlement_marketplace.GetEntitlements({
  "ProductCode": ""
}, context)

Input

• input object
  • Filter GetEntitlementFilters
  • MaxResults Integer
  • NextToken NonEmptyString
  • ProductCode required ProductCode

Output

• output GetEntitlementsResult

Definitions

Boolean

• Boolean boolean

Double

• Double number

Entitlement

• Entitlement object: 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.
  • CustomerIdentifier NonEmptyString
  • Dimension NonEmptyString
  • ExpirationDate Timestamp
  • ProductCode ProductCode
  • Value EntitlementValue

EntitlementList

• EntitlementList array
  • items Entitlement

EntitlementValue

• EntitlementValue object: The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
  • BooleanValue Boolean
  • DoubleValue Double
  • IntegerValue Integer
  • StringValue String

ErrorMessage

• ErrorMessage string

FilterValue

• FilterValue string

FilterValueList

• FilterValueList array
  • items FilterValue

GetEntitlementFilterName

• GetEntitlementFilterName string (values: CUSTOMER_IDENTIFIER, DIMENSION)

GetEntitlementFilters

• GetEntitlementFilters array
  • items object
    • key GetEntitlementFilterName
    • value FilterValueList

GetEntitlementsRequest

• GetEntitlementsRequest object: The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
  • Filter GetEntitlementFilters
  • MaxResults Integer
  • NextToken NonEmptyString
  • ProductCode required ProductCode

GetEntitlementsResult

• GetEntitlementsResult object: The GetEntitlementsRequest contains results from the GetEntitlements operation.
  • Entitlements EntitlementList
  • NextToken NonEmptyString

Integer

• Integer integer

InternalServiceErrorException

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

InvalidParameterException

• InvalidParameterException object: One or more parameters in your request was invalid.
  • message ErrorMessage

NonEmptyString

• NonEmptyString string

ProductCode

• ProductCode string

String

• String string

ThrottlingException

• ThrottlingException object: The calls to the GetEntitlements API are throttled.
  • message ErrorMessage

Timestamp

• Timestamp string