Skip to content

ResolveCustomerResult

Source code in docs_src/capo_marketplace_metering/types/resolve_customer_result.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ResolveCustomerResult(TypedDict, closed=True):
    customer_identifier: NotRequired[
        "capo_marketplace_metering.types.customer_identifier.CustomerIdentifier"
    ]
    """<p>The <code>CustomerIdentifier</code> is used to identify an individual customer in your application.</p> <important> <p>For new SaaS product integrations, this field is not populated. Use <code>CustomerAWSAccountId</code> and <code>LicenseArn</code> to identify customers instead.</p> </important>"""
    product_code: NotRequired[
        "capo_marketplace_metering.types.product_code.ProductCode"
    ]
    """<p>The product code is returned to confirm that the buyer is registering for your product. Subsequent <code>BatchMeterUsage</code> calls should be made using this product code.</p>"""
    customer_aws_account_id: NotRequired[
        "capo_marketplace_metering.types.customer_aws_account_id.CustomerAWSAccountId"
    ]
    """<p>The <code>CustomerAWSAccountId</code> provides the Amazon Web Services account ID associated with the <code>CustomerIdentifier</code> for the individual customer. Calls to <code>BatchMeterUsage</code> require <code>CustomerAWSAccountId</code> for each <code>UsageRecord</code>.</p>"""
    license_arn: NotRequired["capo_marketplace_metering.types.license_arn.LicenseArn"]
    """<p>The <code>LicenseArn</code> is a unique identifier for a specific granted license. These are typically used for software purchased through Amazon Web Services Marketplace. Calls to <code>BatchMeterUsage</code> require <code>LicenseArn</code> for each <code>UsageRecord</code>.</p> <note> <p>Once you receive the <code>CustomerAWSAccountId</code> and <code>LicenseArn</code> in the response, store that for future purposes/API calls/integrations.</p> </note>"""
    metadata: NotRequired["capo_marketplace_metering.types.metadata.Metadata"]
    """<p>The metadata associated with the resolved customer, including the <code>AgreementId</code> of the Amazon Web Services Marketplace agreement the customer accepted.</p>"""

customer_aws_account_id instance-attribute 

customer_aws_account_id: NotRequired[CustomerAWSAccountId]

The CustomerAWSAccountId provides the Amazon Web Services account ID associated with the CustomerIdentifier for the individual customer. Calls to BatchMeterUsage require CustomerAWSAccountId for each UsageRecord.

customer_identifier instance-attribute 

customer_identifier: NotRequired[CustomerIdentifier]

The CustomerIdentifier is used to identify an individual customer in your application.

For new SaaS product integrations, this field is not populated. Use CustomerAWSAccountId and LicenseArn to identify customers instead.

license_arn instance-attribute 

license_arn: NotRequired[LicenseArn]

The LicenseArn is a unique identifier for a specific granted license. These are typically used for software purchased through Amazon Web Services Marketplace. Calls to BatchMeterUsage require LicenseArn for each UsageRecord.

Once you receive the CustomerAWSAccountId and LicenseArn in the response, store that for future purposes/API calls/integrations.

metadata instance-attribute 

metadata: NotRequired[Metadata]

The metadata associated with the resolved customer, including the AgreementId of the Amazon Web Services Marketplace agreement the customer accepted.

product_code instance-attribute 

product_code: NotRequired[ProductCode]

The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code.