Skip to content

GetEntitlementsRequest

Source code in docs_src/capo_marketplace_entitlement_service/types/get_entitlements_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class GetEntitlementsRequest(TypedDict, closed=True):
    product_code: "capo_marketplace_entitlement_service.types.product_code.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>"""
    filter: NotRequired[
        "capo_marketplace_entitlement_service.types.get_entitlement_filters.GetEntitlementFilters"
    ]
    """<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 parameters. You must use one or the other, but not both in the same request. </p> <note> <p>If you're migrating an existing integration, use <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-account.html">Account Feeds</a> to map <code>CustomerIdentifier</code> to <code>CustomerAWSAccountId</code>, and <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-agreements.html">Agreements Feeds</a> to map <code>CustomerAWSAccountId</code> and <code>LicenseArn</code>.</p> </note>"""
    next_token: NotRequired[
        "capo_marketplace_entitlement_service.types.non_empty_string.NonEmptyString"
    ]
    """<p>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.</p>"""
    max_results: NotRequired[
        "capo_marketplace_entitlement_service.types.page_size_integer.PageSizeInteger"
    ]
    """<p>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.</p>"""

filter instance-attribute 

filter: NotRequired[GetEntitlementFilters]

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.

CustomerIdentifier and CustomerAWSAccountId are mutually exclusive parameters. You must use one or the other, but not both in the same request.

If you're migrating an existing integration, use Account Feeds to map CustomerIdentifier to CustomerAWSAccountId, and Agreements Feeds to map CustomerAWSAccountId and LicenseArn.

max_results instance-attribute 

max_results: NotRequired[PageSizeInteger]

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

next_token instance-attribute 

next_token: NotRequired[NonEmptyString]

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

product_code instance-attribute 

product_code: ProductCode

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.