Documentation

Overview

Package marketplacemetering provides the API client, operations, and parameter types for AWSMarketplace Metering.

AWS Marketplace Metering Service This reference provides descriptions of the low-level AWS Marketplace Metering Service API. AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions. For information on the permissions you need to use this API, see AWS Marketing metering and entitlement API permissions (https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html) in the AWS Marketplace Seller Guide. Submitting Metering Records

* MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance or a container running on EKS or ECS.

* BatchMeterUsage- Submits the metering record for a set of customers. BatchMeterUsage is called from a software-as-a-service (SaaS) application.

Accepting New Customers

* ResolveCustomer- 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 the browser. The Registration Token is resolved through this API to obtain a CustomerIdentifier and Product Code.

Entitlement and Metering for Paid Container Products

* 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 can do so if you want to receive usage data in your seller reports. For more information on using the RegisterUsage operation, see Container-Based Products (https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html).

BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to verify that the SaaS metering records that you sent are accurate by searching for records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit records over time. For more information, see the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html) .

Index

Constants

View Source
const ServiceAPIVersion = "2016-01-14"
View Source
const ServiceID = "Marketplace Metering"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

    NewDefaultEndpointResolver constructs a new service endpoint resolver

    func WithAPIOptions

    func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

      WithAPIOptions returns a functional option for setting the Client's APIOptions option.

      func WithEndpointResolver

      func WithEndpointResolver(v EndpointResolver) func(*Options)

        WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

        Types

        type BatchMeterUsageInput

        type BatchMeterUsageInput struct {
        
        	// 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.
        	//
        	// This member is required.
        	ProductCode *string
        
        	// The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords
        	// at a time.
        	//
        	// This member is required.
        	UsageRecords []types.UsageRecord
        }

          A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

          type BatchMeterUsageOutput

          type BatchMeterUsageOutput struct {
          
          	// Contains all UsageRecords processed by BatchMeterUsage. These records were
          	// either honored by AWS Marketplace Metering Service or were invalid.
          	Results []types.UsageRecordResult
          
          	// 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.
          	UnprocessedRecords []types.UsageRecord
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

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

            type Client

            type Client struct {
            	// contains filtered or unexported fields
            }

              Client provides the API client to make operations call for AWSMarketplace Metering.

              func New

              func New(options Options, optFns ...func(*Options)) *Client

                New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

                func NewFromConfig

                func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                  NewFromConfig returns a new client from the provided config.

                  func (*Client) BatchMeterUsage

                  func (c *Client) BatchMeterUsage(ctx context.Context, params *BatchMeterUsageInput, optFns ...func(*Options)) (*BatchMeterUsageOutput, error)

                    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. A UsageRecord can optionally include multiple usage allocations, to provide customers with usagedata split into buckets by tags that you define (or allow the customer to define). BatchMeterUsage requests must be less than 1MB in size.

                    func (*Client) MeterUsage

                    func (c *Client) MeterUsage(ctx context.Context, params *MeterUsageInput, optFns ...func(*Options)) (*MeterUsageOutput, error)

                      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. MeterUsage can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).

                      func (*Client) RegisterUsage

                      func (c *Client) RegisterUsage(ctx context.Context, params *RegisterUsageInput, optFns ...func(*Options)) (*RegisterUsageOutput, error)

                        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.

                        func (*Client) ResolveCustomer

                        func (c *Client) ResolveCustomer(ctx context.Context, params *ResolveCustomerInput, optFns ...func(*Options)) (*ResolveCustomerOutput, error)

                          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.

                          type EndpointResolver

                          type EndpointResolver interface {
                          	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                          }

                            EndpointResolver interface for resolving service endpoints.

                            func EndpointResolverFromURL

                            func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                              EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                              type EndpointResolverFunc

                              type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                func (EndpointResolverFunc) ResolveEndpoint

                                func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                type EndpointResolverOptions

                                type EndpointResolverOptions = internalendpoints.Options

                                  EndpointResolverOptions is the service endpoint resolver options

                                  type HTTPClient

                                  type HTTPClient interface {
                                  	Do(*http.Request) (*http.Response, error)
                                  }

                                  type HTTPSignerV4

                                  type HTTPSignerV4 interface {
                                  	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                  }

                                  type MeterUsageInput

                                  type MeterUsageInput struct {
                                  
                                  	// 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.
                                  	//
                                  	// This member is required.
                                  	ProductCode *string
                                  
                                  	// 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.
                                  	//
                                  	// This member is required.
                                  	Timestamp *time.Time
                                  
                                  	// It will be one of the fcp dimension name provided during the publishing of the
                                  	// product.
                                  	//
                                  	// This member is required.
                                  	UsageDimension *string
                                  
                                  	// 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.
                                  	DryRun *bool
                                  
                                  	// The set of UsageAllocations to submit. The sum of all UsageAllocation quantities
                                  	// must equal the UsageQuantity of the MeterUsage request, and each UsageAllocation
                                  	// must have a unique set of tags (include no tags).
                                  	UsageAllocations []types.UsageAllocation
                                  
                                  	// Consumption value for the hour. Defaults to 0 if not specified.
                                  	UsageQuantity *int32
                                  }

                                  type MeterUsageOutput

                                  type MeterUsageOutput struct {
                                  
                                  	// Metering record id.
                                  	MeteringRecordId *string
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type Options

                                  type Options struct {
                                  	// Set of options to modify how an operation is invoked. These apply to all
                                  	// operations invoked for this client. Use functional options on operation call to
                                  	// modify this list for per operation behavior.
                                  	APIOptions []func(*middleware.Stack) error
                                  
                                  	// Configures the events that will be sent to the configured logger.
                                  	ClientLogMode aws.ClientLogMode
                                  
                                  	// The credentials object to use when signing requests.
                                  	Credentials aws.CredentialsProvider
                                  
                                  	// The endpoint options to be used when attempting to resolve an endpoint.
                                  	EndpointOptions EndpointResolverOptions
                                  
                                  	// The service endpoint resolver.
                                  	EndpointResolver EndpointResolver
                                  
                                  	// Signature Version 4 (SigV4) Signer
                                  	HTTPSignerV4 HTTPSignerV4
                                  
                                  	// The logger writer interface to write logging messages to.
                                  	Logger logging.Logger
                                  
                                  	// The region to send requests to. (Required)
                                  	Region string
                                  
                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                  	// failures. When nil the API client will use a default retryer.
                                  	Retryer aws.Retryer
                                  
                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                  	// implementation if nil.
                                  	HTTPClient HTTPClient
                                  }

                                  func (Options) Copy

                                  func (o Options) Copy() Options

                                    Copy creates a clone where the APIOptions list is deep copied.

                                    type RegisterUsageInput

                                    type RegisterUsageInput struct {
                                    
                                    	// 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.
                                    	//
                                    	// This member is required.
                                    	ProductCode *string
                                    
                                    	// Public Key Version provided by AWS Marketplace
                                    	//
                                    	// This member is required.
                                    	PublicKeyVersion *int32
                                    
                                    	// (Optional) To scope down the registration to a specific running software
                                    	// instance and guard against replay attacks.
                                    	Nonce *string
                                    }

                                    type RegisterUsageOutput

                                    type RegisterUsageOutput struct {
                                    
                                    	// (Optional) Only included when public key version has expired
                                    	PublicKeyRotationTimestamp *time.Time
                                    
                                    	// JWT Token
                                    	Signature *string
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type ResolveCustomerInput

                                    type ResolveCustomerInput struct {
                                    
                                    	// 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.
                                    	//
                                    	// This member is required.
                                    	RegistrationToken *string
                                    }

                                      Contains input to the ResolveCustomer operation.

                                      type ResolveCustomerOutput

                                      type ResolveCustomerOutput struct {
                                      
                                      	// The CustomerIdentifier is used to identify an individual customer in your
                                      	// application. Calls to BatchMeterUsage require CustomerIdentifiers for each
                                      	// UsageRecord.
                                      	CustomerIdentifier *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.
                                      	ProductCode *string
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

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

                                        type ResolveEndpoint

                                        type ResolveEndpoint struct {
                                        	Resolver EndpointResolver
                                        	Options  EndpointResolverOptions
                                        }

                                        func (*ResolveEndpoint) HandleSerialize

                                        func (*ResolveEndpoint) ID

                                        func (*ResolveEndpoint) ID() string

                                        Directories

                                        Path Synopsis
                                        internal