MarketplaceMetering

Table of Contents

• MarketplaceMetering
  • Client

Client

class MarketplaceMetering.Client

A low-level client representing AWSMarketplace Metering:

client = session.create_client('meteringmarketplace')

These are the available methods:

• batch_meter_usage()
• can_paginate()
• generate_presigned_url()
• get_paginator()
• get_waiter()
• meter_usage()
• resolve_customer()

batch_meter_usage(**kwargs)

BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

BatchMeterUsage can process up to 25 UsageRecords at a time.

See also: AWS API Documentation

Request Syntax

response = client.batch_meter_usage(
    UsageRecords=[
        {
            'Timestamp': datetime(2015, 1, 1),
            'CustomerIdentifier': 'string',
            'Dimension': 'string',
            'Quantity': 123
        },
    ],
    ProductCode='string'
)

Parameters

• UsageRecords (list) --

  [REQUIRED]

  The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

  • (dict) --

    A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

    Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

    • Timestamp (datetime) -- [REQUIRED]

      Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

      Your application can meter usage for up to one hour in the past.

    • CustomerIdentifier (string) -- [REQUIRED]

      The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

    • Dimension (string) -- [REQUIRED]

      During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.

    • Quantity (integer) -- [REQUIRED]

      The quantity of usage consumed by the customer for the given dimension and time.

• ProductCode (string) --

  [REQUIRED]

  Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

Return type

dict

Returns

Response Syntax

{
    'Results': [
        {
            'UsageRecord': {
                'Timestamp': datetime(2015, 1, 1),
                'CustomerIdentifier': 'string',
                'Dimension': 'string',
                'Quantity': 123
            },
            'MeteringRecordId': 'string',
            'Status': 'Success'|'CustomerNotSubscribed'|'DuplicateRecord'
        },
    ],
    'UnprocessedRecords': [
        {
            'Timestamp': datetime(2015, 1, 1),
            'CustomerIdentifier': 'string',
            'Dimension': 'string',
            'Quantity': 123
        },
    ]
}

Response Structure

• (dict) --

  Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.

  • Results (list) --

    Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.

    • (dict) --

      A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.

      • UsageRecord (dict) --

        The UsageRecord that was part of the BatchMeterUsage request.

        • Timestamp (datetime) --

          Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

          Your application can meter usage for up to one hour in the past.

        • CustomerIdentifier (string) --

          The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

        • Dimension (string) --

          During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.

        • Quantity (integer) --

          The quantity of usage consumed by the customer for the given dimension and time.

      • MeteringRecordId (string) --

        The MeteringRecordId is a unique identifier for this metering event.

      • Status (string) --

        The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

        • Success - The UsageRecord was accepted and honored by BatchMeterUsage.
        • CustomerNotSubscribed - The CustomerIdentifier specified is not subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.
        • DuplicateRecord - Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

  • UnprocessedRecords (list) --

    Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.

    • (dict) --

      A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

      Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

      • Timestamp (datetime) --

        Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

        Your application can meter usage for up to one hour in the past.

      • CustomerIdentifier (string) --

        The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

      • Dimension (string) --

        During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.

      • Quantity (integer) --

        The quantity of usage consumed by the customer for the given dimension and time.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Returns

True if the operation can be paginated, False otherwise.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters

• ClientMethod (string) -- The client method to presign for
• Params (dict) -- The parameters normally passed to ClientMethod.
• ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
• HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.

Return type

L{botocore.paginate.Paginator}

Returns

A paginator object.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

meter_usage(**kwargs)

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace.

See also: AWS API Documentation

Request Syntax

response = client.meter_usage(
    ProductCode='string',
    Timestamp=datetime(2015, 1, 1),
    UsageDimension='string',
    UsageQuantity=123,
    DryRun=True|False
)

Parameters

• ProductCode (string) --

  [REQUIRED]

  Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

• Timestamp (datetime) --

  [REQUIRED]

  Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

• UsageDimension (string) --

  [REQUIRED]

  It will be one of the fcp dimension name provided during the publishing of the product.

• UsageQuantity (integer) --

  [REQUIRED]

  Consumption value for the hour.

• DryRun (boolean) --

  [REQUIRED]

  Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException.

Return type

dict

Returns

Response Syntax

{
    'MeteringRecordId': 'string'
}

Response Structure

• (dict) --
  • MeteringRecordId (string) --

resolve_customer(**kwargs)

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 and product code.

See also: AWS API Documentation

Request Syntax

response = client.resolve_customer(
    RegistrationToken='string'
)

Parameters

RegistrationToken (string) --

[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 and product code.

Return type

dict

Returns

Response Syntax

{
    'CustomerIdentifier': 'string',
    'ProductCode': 'string'
}

Response Structure

• (dict) --

  The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.

  • CustomerIdentifier (string) --

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

  • 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.