AWSMarketplace Metering

{'Metadata': {'AgreementId': 'string'}}

ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn.

Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the aws-marketplace:ResolveCustomer action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference.

For Amazon Web Services Regions that support ResolveCustomer, see ResolveCustomer Region support.

See also: AWS API Documentation

Request Syntax

client.resolve_customer(
    RegistrationToken='string'
)

type RegistrationToken:

string

param RegistrationToken:

[REQUIRED]

When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn.

rtype:

dict

returns:

Response Syntax

{
    'CustomerIdentifier': 'string',
    'ProductCode': 'string',
    'CustomerAWSAccountId': 'string',
    'LicenseArn': 'string',
    'Metadata': {
        'AgreementId': 'string'
    }
}

Response Structure

• (dict) --

  The result of the ResolveCustomer operation. Contains the CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, LicenseArn, and Metadata.

  • CustomerIdentifier (string) --

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

  • ProductCode (string) --

    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.

  • CustomerAWSAccountId (string) --

    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.

  • LicenseArn (string) --

    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.

  • Metadata (dict) --

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

    • AgreementId (string) --

      The unique identifier of the Amazon Web Services Marketplace agreement the customer accepted. Use it to call Amazon Web Services Marketplace Agreement APIs.