MarketplaceMetering

Client

class MarketplaceMetering.Client

A low-level client representing AWSMarketplace Metering:

client = session.create_client('meteringmarketplace')

These are the available methods:

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, in UTC, for which the usage is being reported.

        Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

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

        The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

  • 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, in UTC, for which the usage is being reported.

            Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

          • 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. Defaults to 0 if not specified.

        • 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, in UTC, for which the usage is being reported.

          Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

        • 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. Defaults to 0 if not specified.

Exceptions

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 using credentials from the EC2 instance, ECS task, or EKS pod.

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, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

  • UsageDimension (string) --

    [REQUIRED]

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

  • UsageQuantity (integer) -- Consumption value for the hour. Defaults to 0 if not specified.
  • DryRun (boolean) -- 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. Defaults to false if not specified.
Return type

dict

Returns

Response Syntax

{
    'MeteringRecordId': 'string'
}

Response Structure

  • (dict) --

    • MeteringRecordId (string) --

      Metering record id.

Exceptions

register_usage(**kwargs)

Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement.

  • Entitlement : RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is still running.
  • Metering : RegisterUsage meters software use per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks and Amazon EKS pods, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime.

See also: AWS API Documentation

Request Syntax

response = client.register_usage(
    ProductCode='string',
    PublicKeyVersion=123,
    Nonce='string'
)
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.

  • PublicKeyVersion (integer) --

    [REQUIRED]

    Public Key Version provided by AWS Marketplace

  • Nonce (string) -- (Optional) To scope down the registration to a specific running software instance and guard against replay attacks.
Return type

dict

Returns

Response Syntax

{
    'PublicKeyRotationTimestamp': datetime(2015, 1, 1),
    'Signature': 'string'
}

Response Structure

  • (dict) --

    • PublicKeyRotationTimestamp (datetime) --

      (Optional) Only included when public key version has expired

    • Signature (string) --

      JWT Token

Exceptions

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.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class MarketplaceMetering.Client.exceptions.CustomerNotEntitledException

Exception thrown when the customer does not have a valid subscription for the product.

Example

try:
  ...
except client.exceptions.CustomerNotEntitledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown when the customer does not have a valid subscription for the product.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.DisabledApiException

The API is disabled in the Region.

Example

try:
  ...
except client.exceptions.DisabledApiException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The API is disabled in the Region.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.DuplicateRequestException

A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp} with a different usageQuantity.

Example

try:
  ...
except client.exceptions.DuplicateRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp} with a different usageQuantity.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.ExpiredTokenException

The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

Example

try:
  ...
except client.exceptions.ExpiredTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InternalServiceErrorException

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

Example

try:
  ...
except client.exceptions.InternalServiceErrorException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidCustomerIdentifierException

You have metered usage for a CustomerIdentifier that does not exist.

Example

try:
  ...
except client.exceptions.InvalidCustomerIdentifierException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You have metered usage for a CustomerIdentifier that does not exist.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidEndpointRegionException

The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS Region of the resource must match.

Example

try:
  ...
except client.exceptions.InvalidEndpointRegionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS Region of the resource must match.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidProductCodeException

The product code passed does not match the product code used for publishing the product.

Example

try:
  ...
except client.exceptions.InvalidProductCodeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The product code passed does not match the product code used for publishing the product.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidPublicKeyVersionException

Public Key version is invalid.

Example

try:
  ...
except client.exceptions.InvalidPublicKeyVersionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Public Key version is invalid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidRegionException

RegisterUsage must be called in the same AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.

Example

try:
  ...
except client.exceptions.InvalidRegionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    RegisterUsage must be called in the same AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidTokenException

Registration token is invalid.

Example

try:
  ...
except client.exceptions.InvalidTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Registration token is invalid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.InvalidUsageDimensionException

The usage dimension does not match one of the UsageDimensions associated with products.

Example

try:
  ...
except client.exceptions.InvalidUsageDimensionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The usage dimension does not match one of the UsageDimensions associated with products.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.PlatformNotSupportedException

AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.

Example

try:
  ...
except client.exceptions.PlatformNotSupportedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.ThrottlingException

The calls to the API are throttled.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The calls to the API are throttled.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MarketplaceMetering.Client.exceptions.TimestampOutOfBoundsException

The timestamp value passed in the meterUsage() is out of allowed range.

Example

try:
  ...
except client.exceptions.TimestampOutOfBoundsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The timestamp value passed in the meterUsage() is out of allowed range.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: