amazonka-marketplace-metering-2.0: Amazon Marketplace Metering SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MarketplaceMetering.ResolveCustomer

Description

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 and ProductCode.

The API needs to called from the seller account id used to publish the SaaS application to successfully resolve the token.

For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller Guide.

Synopsis

Creating a Request

data ResolveCustomer Source #

Contains input to the ResolveCustomer operation.

See: newResolveCustomer smart constructor.

Constructors

ResolveCustomer' 

Fields

  • registrationToken :: Text

    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 and ProductCode.

Instances

Instances details
ToJSON ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

ToHeaders ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

ToPath ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

ToQuery ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

AWSRequest ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Associated Types

type AWSResponse ResolveCustomer #

Generic ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Associated Types

type Rep ResolveCustomer :: Type -> Type #

Read ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Show ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

NFData ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Methods

rnf :: ResolveCustomer -> () #

Eq ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Hashable ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

type AWSResponse ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

type Rep ResolveCustomer Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

type Rep ResolveCustomer = D1 ('MetaData "ResolveCustomer" "Amazonka.MarketplaceMetering.ResolveCustomer" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "ResolveCustomer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registrationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResolveCustomer Source #

Create a value of ResolveCustomer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:registrationToken:ResolveCustomer', resolveCustomer_registrationToken - 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 and ProductCode.

Request Lenses

resolveCustomer_registrationToken :: Lens' ResolveCustomer Text Source #

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 and ProductCode.

Destructuring the Response

data ResolveCustomerResponse Source #

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

See: newResolveCustomerResponse smart constructor.

Constructors

ResolveCustomerResponse' 

Fields

  • customerAWSAccountId :: Maybe Text

    The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.

  • customerIdentifier :: Maybe Text

    The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

  • productCode :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Associated Types

type Rep ResolveCustomerResponse :: Type -> Type #

Read ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Show ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

NFData ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

Methods

rnf :: ResolveCustomerResponse -> () #

Eq ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

type Rep ResolveCustomerResponse Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.ResolveCustomer

type Rep ResolveCustomerResponse = D1 ('MetaData "ResolveCustomerResponse" "Amazonka.MarketplaceMetering.ResolveCustomer" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "ResolveCustomerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customerAWSAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newResolveCustomerResponse Source #

Create a value of ResolveCustomerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customerAWSAccountId:ResolveCustomerResponse', resolveCustomerResponse_customerAWSAccountId - The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.

ResolveCustomerResponse, resolveCustomerResponse_customerIdentifier - The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

$sel:productCode:ResolveCustomerResponse', resolveCustomerResponse_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.

$sel:httpStatus:ResolveCustomerResponse', resolveCustomerResponse_httpStatus - The response's http status code.

Response Lenses

resolveCustomerResponse_customerAWSAccountId :: Lens' ResolveCustomerResponse (Maybe Text) Source #

The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.

resolveCustomerResponse_customerIdentifier :: Lens' ResolveCustomerResponse (Maybe Text) Source #

The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

resolveCustomerResponse_productCode :: Lens' ResolveCustomerResponse (Maybe Text) Source #

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.