marketplacemetering

package
v1.38.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 47

Documentation

Overview

Package marketplacemetering provides the client and types for making API requests to AWSMarketplace Metering.

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

See https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14 for more information on this service.

See marketplacemetering package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacemetering/

Using the Client

To contact AWSMarketplace Metering with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWSMarketplace Metering client MarketplaceMetering for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacemetering/#New

Index

Constants

View Source 
const (
	// UsageRecordResultStatusSuccess is a UsageRecordResultStatus enum value
	UsageRecordResultStatusSuccess = "Success"

	// UsageRecordResultStatusCustomerNotSubscribed is a UsageRecordResultStatus enum value
	UsageRecordResultStatusCustomerNotSubscribed = "CustomerNotSubscribed"

	// UsageRecordResultStatusDuplicateRecord is a UsageRecordResultStatus enum value
	UsageRecordResultStatusDuplicateRecord = "DuplicateRecord"
)
View Source 
const (

	// ErrCodeCustomerNotEntitledException for service response error code
	// "CustomerNotEntitledException".
	//
	// Exception thrown when the customer does not have a valid subscription for
	// the product.
	ErrCodeCustomerNotEntitledException = "CustomerNotEntitledException"

	// ErrCodeDisabledApiException for service response error code
	// "DisabledApiException".
	//
	// The API is disabled in the Region.
	ErrCodeDisabledApiException = "DisabledApiException"

	// ErrCodeDuplicateRequestException for service response error code
	// "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.
	ErrCodeDuplicateRequestException = "DuplicateRequestException"

	// ErrCodeExpiredTokenException for service response error code
	// "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.
	ErrCodeExpiredTokenException = "ExpiredTokenException"

	// ErrCodeInternalServiceErrorException for service response error code
	// "InternalServiceErrorException".
	//
	// An internal error has occurred. Retry your request. If the problem persists,
	// post a message with details on the AWS forums.
	ErrCodeInternalServiceErrorException = "InternalServiceErrorException"

	// ErrCodeInvalidCustomerIdentifierException for service response error code
	// "InvalidCustomerIdentifierException".
	//
	// You have metered usage for a CustomerIdentifier that does not exist.
	ErrCodeInvalidCustomerIdentifierException = "InvalidCustomerIdentifierException"

	// ErrCodeInvalidEndpointRegionException for service response error code
	// "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.
	ErrCodeInvalidEndpointRegionException = "InvalidEndpointRegionException"

	// ErrCodeInvalidProductCodeException for service response error code
	// "InvalidProductCodeException".
	//
	// The product code passed does not match the product code used for publishing
	// the product.
	ErrCodeInvalidProductCodeException = "InvalidProductCodeException"

	// ErrCodeInvalidPublicKeyVersionException for service response error code
	// "InvalidPublicKeyVersionException".
	//
	// Public Key version is invalid.
	ErrCodeInvalidPublicKeyVersionException = "InvalidPublicKeyVersionException"

	// ErrCodeInvalidRegionException for service response error code
	// "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.
	ErrCodeInvalidRegionException = "InvalidRegionException"

	// ErrCodeInvalidTagException for service response error code
	// "InvalidTagException".
	//
	// The tag is invalid, or the number of tags is greater than 5.
	ErrCodeInvalidTagException = "InvalidTagException"

	// ErrCodeInvalidTokenException for service response error code
	// "InvalidTokenException".
	//
	// Registration token is invalid.
	ErrCodeInvalidTokenException = "InvalidTokenException"

	// ErrCodeInvalidUsageAllocationsException for service response error code
	// "InvalidUsageAllocationsException".
	//
	// The usage allocation objects are invalid, or the number of allocations is
	// greater than 500 for a single usage record.
	ErrCodeInvalidUsageAllocationsException = "InvalidUsageAllocationsException"

	// ErrCodeInvalidUsageDimensionException for service response error code
	// "InvalidUsageDimensionException".
	//
	// The usage dimension does not match one of the UsageDimensions associated
	// with products.
	ErrCodeInvalidUsageDimensionException = "InvalidUsageDimensionException"

	// ErrCodePlatformNotSupportedException for service response error code
	// "PlatformNotSupportedException".
	//
	// AWS Marketplace does not support metering usage from the underlying platform.
	// Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.
	ErrCodePlatformNotSupportedException = "PlatformNotSupportedException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The calls to the API are throttled.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTimestampOutOfBoundsException for service response error code
	// "TimestampOutOfBoundsException".
	//
	// The timestamp value passed in the meterUsage() is out of allowed range.
	ErrCodeTimestampOutOfBoundsException = "TimestampOutOfBoundsException"
)
View Source 
const (
	ServiceName = "metering.marketplace" // Name of service.
	EndpointsID = ServiceName            // ID to lookup a service endpoint with.
	ServiceID   = "Marketplace Metering" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func UsageRecordResultStatus_Values added in v1.34.3 

func UsageRecordResultStatus_Values() []string

UsageRecordResultStatus_Values returns all elements of the UsageRecordResultStatus enum

Types

type BatchMeterUsageInput added in v1.5.7 

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.
	//
	// ProductCode is a required field
	ProductCode *string `min:"1" type:"string" required:"true"`

	// The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords
	// at a time.
	//
	// UsageRecords is a required field
	UsageRecords []*UsageRecord `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (BatchMeterUsageInput) GoString added in v1.5.7 

func (s BatchMeterUsageInput) GoString() string

GoString returns the string representation

func (*BatchMeterUsageInput) SetProductCode added in v1.5.7 

func (s *BatchMeterUsageInput) SetProductCode(v string) *BatchMeterUsageInput

SetProductCode sets the ProductCode field's value.

func (*BatchMeterUsageInput) SetUsageRecords added in v1.5.7 

func (s *BatchMeterUsageInput) SetUsageRecords(v []*UsageRecord) *BatchMeterUsageInput

SetUsageRecords sets the UsageRecords field's value.

func (BatchMeterUsageInput) String added in v1.5.7 

func (s BatchMeterUsageInput) String() string

String returns the string representation

func (*BatchMeterUsageInput) Validate added in v1.5.7 

func (s *BatchMeterUsageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchMeterUsageOutput added in v1.5.7 

type BatchMeterUsageOutput struct {

	// Contains all UsageRecords processed by BatchMeterUsage. These records were
	// either honored by AWS Marketplace Metering Service or were invalid.
	Results []*UsageRecordResult `type:"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.
	UnprocessedRecords []*UsageRecord `type:"list"`
	// contains filtered or unexported fields
}

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

func (BatchMeterUsageOutput) GoString added in v1.5.7 

func (s BatchMeterUsageOutput) GoString() string

GoString returns the string representation

func (*BatchMeterUsageOutput) SetResults added in v1.5.7 

func (s *BatchMeterUsageOutput) SetResults(v []*UsageRecordResult) *BatchMeterUsageOutput

SetResults sets the Results field's value.

func (*BatchMeterUsageOutput) SetUnprocessedRecords added in v1.5.7 

func (s *BatchMeterUsageOutput) SetUnprocessedRecords(v []*UsageRecord) *BatchMeterUsageOutput

SetUnprocessedRecords sets the UnprocessedRecords field's value.

func (BatchMeterUsageOutput) String added in v1.5.7 

func (s BatchMeterUsageOutput) String() string

String returns the string representation

type CustomerNotEntitledException added in v1.28.0 

type CustomerNotEntitledException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*CustomerNotEntitledException) Code added in v1.28.0 

func (s *CustomerNotEntitledException) Code() string

Code returns the exception type name.

func (*CustomerNotEntitledException) Error added in v1.28.0 

func (s *CustomerNotEntitledException) Error() string

func (CustomerNotEntitledException) GoString added in v1.28.0 

func (s CustomerNotEntitledException) GoString() string

GoString returns the string representation

func (*CustomerNotEntitledException) Message added in v1.28.0 

func (s *CustomerNotEntitledException) Message() string

Message returns the exception's message.

func (*CustomerNotEntitledException) OrigErr added in v1.28.0 

func (s *CustomerNotEntitledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomerNotEntitledException) RequestID added in v1.28.0 

func (s *CustomerNotEntitledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomerNotEntitledException) StatusCode added in v1.28.0 

func (s *CustomerNotEntitledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomerNotEntitledException) String added in v1.28.0 

func (s CustomerNotEntitledException) String() string

String returns the string representation

type DisabledApiException added in v1.28.0 

type DisabledApiException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The API is disabled in the Region.

func (*DisabledApiException) Code added in v1.28.0 

func (s *DisabledApiException) Code() string

Code returns the exception type name.

func (*DisabledApiException) Error added in v1.28.0 

func (s *DisabledApiException) Error() string

func (DisabledApiException) GoString added in v1.28.0 

func (s DisabledApiException) GoString() string

GoString returns the string representation

func (*DisabledApiException) Message added in v1.28.0 

func (s *DisabledApiException) Message() string

Message returns the exception's message.

func (*DisabledApiException) OrigErr added in v1.28.0 

func (s *DisabledApiException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DisabledApiException) RequestID added in v1.28.0 

func (s *DisabledApiException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DisabledApiException) StatusCode added in v1.28.0 

func (s *DisabledApiException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DisabledApiException) String added in v1.28.0 

func (s DisabledApiException) String() string

String returns the string representation

type DuplicateRequestException added in v1.28.0 

type DuplicateRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*DuplicateRequestException) Code added in v1.28.0 

func (s *DuplicateRequestException) Code() string

Code returns the exception type name.

func (*DuplicateRequestException) Error added in v1.28.0 

func (s *DuplicateRequestException) Error() string

func (DuplicateRequestException) GoString added in v1.28.0 

func (s DuplicateRequestException) GoString() string

GoString returns the string representation

func (*DuplicateRequestException) Message added in v1.28.0 

func (s *DuplicateRequestException) Message() string

Message returns the exception's message.

func (*DuplicateRequestException) OrigErr added in v1.28.0 

func (s *DuplicateRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DuplicateRequestException) RequestID added in v1.28.0 

func (s *DuplicateRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DuplicateRequestException) StatusCode added in v1.28.0 

func (s *DuplicateRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DuplicateRequestException) String added in v1.28.0 

func (s DuplicateRequestException) String() string

String returns the string representation

type ExpiredTokenException added in v1.28.0 

type ExpiredTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*ExpiredTokenException) Code added in v1.28.0 

func (s *ExpiredTokenException) Code() string

Code returns the exception type name.

func (*ExpiredTokenException) Error added in v1.28.0 

func (s *ExpiredTokenException) Error() string

func (ExpiredTokenException) GoString added in v1.28.0 

func (s ExpiredTokenException) GoString() string

GoString returns the string representation

func (*ExpiredTokenException) Message added in v1.28.0 

func (s *ExpiredTokenException) Message() string

Message returns the exception's message.

func (*ExpiredTokenException) OrigErr added in v1.28.0 

func (s *ExpiredTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExpiredTokenException) RequestID added in v1.28.0 

func (s *ExpiredTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExpiredTokenException) StatusCode added in v1.28.0 

func (s *ExpiredTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExpiredTokenException) String added in v1.28.0 

func (s ExpiredTokenException) String() string

String returns the string representation

type InternalServiceErrorException added in v1.28.0 

type InternalServiceErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServiceErrorException) Code added in v1.28.0 

func (s *InternalServiceErrorException) Code() string

Code returns the exception type name.

func (*InternalServiceErrorException) Error added in v1.28.0 

func (s *InternalServiceErrorException) Error() string

func (InternalServiceErrorException) GoString added in v1.28.0 

func (s InternalServiceErrorException) GoString() string

GoString returns the string representation

func (*InternalServiceErrorException) Message added in v1.28.0 

func (s *InternalServiceErrorException) Message() string

Message returns the exception's message.

func (*InternalServiceErrorException) OrigErr added in v1.28.0 

func (s *InternalServiceErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceErrorException) RequestID added in v1.28.0 

func (s *InternalServiceErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceErrorException) StatusCode added in v1.28.0 

func (s *InternalServiceErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceErrorException) String added in v1.28.0 

func (s InternalServiceErrorException) String() string

String returns the string representation

type InvalidCustomerIdentifierException added in v1.28.0 

type InvalidCustomerIdentifierException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidCustomerIdentifierException) Code added in v1.28.0 

func (s *InvalidCustomerIdentifierException) Code() string

Code returns the exception type name.

func (*InvalidCustomerIdentifierException) Error added in v1.28.0 

func (s *InvalidCustomerIdentifierException) Error() string

func (InvalidCustomerIdentifierException) GoString added in v1.28.0 

func (s InvalidCustomerIdentifierException) GoString() string

GoString returns the string representation

func (*InvalidCustomerIdentifierException) Message added in v1.28.0 

func (s *InvalidCustomerIdentifierException) Message() string

Message returns the exception's message.

func (*InvalidCustomerIdentifierException) OrigErr added in v1.28.0 

func (s *InvalidCustomerIdentifierException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCustomerIdentifierException) RequestID added in v1.28.0 

func (s *InvalidCustomerIdentifierException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCustomerIdentifierException) StatusCode added in v1.28.0 

func (s *InvalidCustomerIdentifierException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidCustomerIdentifierException) String added in v1.28.0 

func (s InvalidCustomerIdentifierException) String() string

String returns the string representation

type InvalidEndpointRegionException added in v1.28.0 

type InvalidEndpointRegionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidEndpointRegionException) Code added in v1.28.0 

func (s *InvalidEndpointRegionException) Code() string

Code returns the exception type name.

func (*InvalidEndpointRegionException) Error added in v1.28.0 

func (s *InvalidEndpointRegionException) Error() string

func (InvalidEndpointRegionException) GoString added in v1.28.0 

func (s InvalidEndpointRegionException) GoString() string

GoString returns the string representation

func (*InvalidEndpointRegionException) Message added in v1.28.0 

func (s *InvalidEndpointRegionException) Message() string

Message returns the exception's message.

func (*InvalidEndpointRegionException) OrigErr added in v1.28.0 

func (s *InvalidEndpointRegionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEndpointRegionException) RequestID added in v1.28.0 

func (s *InvalidEndpointRegionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEndpointRegionException) StatusCode added in v1.28.0 

func (s *InvalidEndpointRegionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidEndpointRegionException) String added in v1.28.0 

func (s InvalidEndpointRegionException) String() string

String returns the string representation

type InvalidProductCodeException added in v1.28.0 

type InvalidProductCodeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidProductCodeException) Code added in v1.28.0 

func (s *InvalidProductCodeException) Code() string

Code returns the exception type name.

func (*InvalidProductCodeException) Error added in v1.28.0 

func (s *InvalidProductCodeException) Error() string

func (InvalidProductCodeException) GoString added in v1.28.0 

func (s InvalidProductCodeException) GoString() string

GoString returns the string representation

func (*InvalidProductCodeException) Message added in v1.28.0 

func (s *InvalidProductCodeException) Message() string

Message returns the exception's message.

func (*InvalidProductCodeException) OrigErr added in v1.28.0 

func (s *InvalidProductCodeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidProductCodeException) RequestID added in v1.28.0 

func (s *InvalidProductCodeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidProductCodeException) StatusCode added in v1.28.0 

func (s *InvalidProductCodeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidProductCodeException) String added in v1.28.0 

func (s InvalidProductCodeException) String() string

String returns the string representation

type InvalidPublicKeyVersionException added in v1.28.0 

type InvalidPublicKeyVersionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Public Key version is invalid.

func (*InvalidPublicKeyVersionException) Code added in v1.28.0 

func (s *InvalidPublicKeyVersionException) Code() string

Code returns the exception type name.

func (*InvalidPublicKeyVersionException) Error added in v1.28.0 

func (s *InvalidPublicKeyVersionException) Error() string

func (InvalidPublicKeyVersionException) GoString added in v1.28.0 

func (s InvalidPublicKeyVersionException) GoString() string

GoString returns the string representation

func (*InvalidPublicKeyVersionException) Message added in v1.28.0 

func (s *InvalidPublicKeyVersionException) Message() string

Message returns the exception's message.

func (*InvalidPublicKeyVersionException) OrigErr added in v1.28.0 

func (s *InvalidPublicKeyVersionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPublicKeyVersionException) RequestID added in v1.28.0 

func (s *InvalidPublicKeyVersionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPublicKeyVersionException) StatusCode added in v1.28.0 

func (s *InvalidPublicKeyVersionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPublicKeyVersionException) String added in v1.28.0 

func (s InvalidPublicKeyVersionException) String() string

String returns the string representation

type InvalidRegionException added in v1.28.0 

type InvalidRegionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidRegionException) Code added in v1.28.0 

func (s *InvalidRegionException) Code() string

Code returns the exception type name.

func (*InvalidRegionException) Error added in v1.28.0 

func (s *InvalidRegionException) Error() string

func (InvalidRegionException) GoString added in v1.28.0 

func (s InvalidRegionException) GoString() string

GoString returns the string representation

func (*InvalidRegionException) Message added in v1.28.0 

func (s *InvalidRegionException) Message() string

Message returns the exception's message.

func (*InvalidRegionException) OrigErr added in v1.28.0 

func (s *InvalidRegionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRegionException) RequestID added in v1.28.0 

func (s *InvalidRegionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRegionException) StatusCode added in v1.28.0 

func (s *InvalidRegionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRegionException) String added in v1.28.0 

func (s InvalidRegionException) String() string

String returns the string representation

type InvalidTagException added in v1.35.21 

type InvalidTagException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The tag is invalid, or the number of tags is greater than 5.

func (*InvalidTagException) Code added in v1.35.21 

func (s *InvalidTagException) Code() string

Code returns the exception type name.

func (*InvalidTagException) Error added in v1.35.21 

func (s *InvalidTagException) Error() string

func (InvalidTagException) GoString added in v1.35.21 

func (s InvalidTagException) GoString() string

GoString returns the string representation

func (*InvalidTagException) Message added in v1.35.21 

func (s *InvalidTagException) Message() string

Message returns the exception's message.

func (*InvalidTagException) OrigErr added in v1.35.21 

func (s *InvalidTagException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTagException) RequestID added in v1.35.21 

func (s *InvalidTagException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTagException) StatusCode added in v1.35.21 

func (s *InvalidTagException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTagException) String added in v1.35.21 

func (s InvalidTagException) String() string

String returns the string representation

type InvalidTokenException added in v1.28.0 

type InvalidTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Registration token is invalid.

func (*InvalidTokenException) Code added in v1.28.0 

func (s *InvalidTokenException) Code() string

Code returns the exception type name.

func (*InvalidTokenException) Error added in v1.28.0 

func (s *InvalidTokenException) Error() string

func (InvalidTokenException) GoString added in v1.28.0 

func (s InvalidTokenException) GoString() string

GoString returns the string representation

func (*InvalidTokenException) Message added in v1.28.0 

func (s *InvalidTokenException) Message() string

Message returns the exception's message.

func (*InvalidTokenException) OrigErr added in v1.28.0 

func (s *InvalidTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTokenException) RequestID added in v1.28.0 

func (s *InvalidTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTokenException) StatusCode added in v1.28.0 

func (s *InvalidTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTokenException) String added in v1.28.0 

func (s InvalidTokenException) String() string

String returns the string representation

type InvalidUsageAllocationsException added in v1.35.21 

type InvalidUsageAllocationsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

func (*InvalidUsageAllocationsException) Code added in v1.35.21 

func (s *InvalidUsageAllocationsException) Code() string

Code returns the exception type name.

func (*InvalidUsageAllocationsException) Error added in v1.35.21 

func (s *InvalidUsageAllocationsException) Error() string

func (InvalidUsageAllocationsException) GoString added in v1.35.21 

func (s InvalidUsageAllocationsException) GoString() string

GoString returns the string representation

func (*InvalidUsageAllocationsException) Message added in v1.35.21 

func (s *InvalidUsageAllocationsException) Message() string

Message returns the exception's message.

func (*InvalidUsageAllocationsException) OrigErr added in v1.35.21 

func (s *InvalidUsageAllocationsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidUsageAllocationsException) RequestID added in v1.35.21 

func (s *InvalidUsageAllocationsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidUsageAllocationsException) StatusCode added in v1.35.21 

func (s *InvalidUsageAllocationsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidUsageAllocationsException) String added in v1.35.21 

func (s InvalidUsageAllocationsException) String() string

String returns the string representation

type InvalidUsageDimensionException added in v1.28.0 

type InvalidUsageDimensionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidUsageDimensionException) Code added in v1.28.0 

func (s *InvalidUsageDimensionException) Code() string

Code returns the exception type name.

func (*InvalidUsageDimensionException) Error added in v1.28.0 

func (s *InvalidUsageDimensionException) Error() string

func (InvalidUsageDimensionException) GoString added in v1.28.0 

func (s InvalidUsageDimensionException) GoString() string

GoString returns the string representation

func (*InvalidUsageDimensionException) Message added in v1.28.0 

func (s *InvalidUsageDimensionException) Message() string

Message returns the exception's message.

func (*InvalidUsageDimensionException) OrigErr added in v1.28.0 

func (s *InvalidUsageDimensionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidUsageDimensionException) RequestID added in v1.28.0 

func (s *InvalidUsageDimensionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidUsageDimensionException) StatusCode added in v1.28.0 

func (s *InvalidUsageDimensionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidUsageDimensionException) String added in v1.28.0 

func (s InvalidUsageDimensionException) String() string

String returns the string representation

type MarketplaceMetering 

type MarketplaceMetering struct {
	*client.Client
}

MarketplaceMetering provides the API operation methods for making requests to AWSMarketplace Metering. See this package's package overview docs for details on the service.

MarketplaceMetering methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *MarketplaceMetering

New creates a new instance of the MarketplaceMetering client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a MarketplaceMetering client from just a session.
svc := marketplacemetering.New(mySession)

// Create a MarketplaceMetering client with additional configuration
svc := marketplacemetering.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*MarketplaceMetering) BatchMeterUsage added in v1.5.7 

func (c *MarketplaceMetering) BatchMeterUsage(input *BatchMeterUsageInput) (*BatchMeterUsageOutput, error)

BatchMeterUsage API operation for AWSMarketplace Metering.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSMarketplace Metering's API operation BatchMeterUsage for usage and error information.

Returned Error Types:

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

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

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

  • InvalidTagException The tag is invalid, or the number of tags is greater than 5.

  • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

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

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

  • ThrottlingException The calls to the API are throttled.

  • DisabledApiException The API is disabled in the Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsage

func (*MarketplaceMetering) BatchMeterUsageRequest added in v1.5.7 

func (c *MarketplaceMetering) BatchMeterUsageRequest(input *BatchMeterUsageInput) (req *request.Request, output *BatchMeterUsageOutput)

BatchMeterUsageRequest generates a "aws/request.Request" representing the client's request for the BatchMeterUsage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchMeterUsage for more information on using the BatchMeterUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchMeterUsageRequest method.
req, resp := client.BatchMeterUsageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsage

func (*MarketplaceMetering) BatchMeterUsageWithContext added in v1.8.0 

func (c *MarketplaceMetering) BatchMeterUsageWithContext(ctx aws.Context, input *BatchMeterUsageInput, opts ...request.Option) (*BatchMeterUsageOutput, error)

BatchMeterUsageWithContext is the same as BatchMeterUsage with the addition of the ability to pass a context and additional request options.

See BatchMeterUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceMetering) MeterUsage 

func (c *MarketplaceMetering) MeterUsage(input *MeterUsageInput) (*MeterUsageOutput, error)

MeterUsage API operation for AWSMarketplace Metering.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSMarketplace Metering's API operation MeterUsage for usage and error information.

Returned Error Types:

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

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

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

  • InvalidTagException The tag is invalid, or the number of tags is greater than 5.

  • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

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

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

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

  • ThrottlingException The calls to the API are throttled.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsage

func (*MarketplaceMetering) MeterUsageRequest 

func (c *MarketplaceMetering) MeterUsageRequest(input *MeterUsageInput) (req *request.Request, output *MeterUsageOutput)

MeterUsageRequest generates a "aws/request.Request" representing the client's request for the MeterUsage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See MeterUsage for more information on using the MeterUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the MeterUsageRequest method.
req, resp := client.MeterUsageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsage

func (*MarketplaceMetering) MeterUsageWithContext added in v1.8.0 

func (c *MarketplaceMetering) MeterUsageWithContext(ctx aws.Context, input *MeterUsageInput, opts ...request.Option) (*MeterUsageOutput, error)

MeterUsageWithContext is the same as MeterUsage with the addition of the ability to pass a context and additional request options.

See MeterUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceMetering) RegisterUsage added in v1.15.84 

func (c *MarketplaceMetering) RegisterUsage(input *RegisterUsageInput) (*RegisterUsageOutput, error)

RegisterUsage API operation for AWSMarketplace Metering.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSMarketplace Metering's API operation RegisterUsage for usage and error information.

Returned Error Types:

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

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

  • InvalidPublicKeyVersionException Public Key version is invalid.

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

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

  • ThrottlingException The calls to the API are throttled.

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

  • DisabledApiException The API is disabled in the Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsage

func (*MarketplaceMetering) RegisterUsageRequest added in v1.15.84 

func (c *MarketplaceMetering) RegisterUsageRequest(input *RegisterUsageInput) (req *request.Request, output *RegisterUsageOutput)

RegisterUsageRequest generates a "aws/request.Request" representing the client's request for the RegisterUsage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterUsage for more information on using the RegisterUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterUsageRequest method.
req, resp := client.RegisterUsageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsage

func (*MarketplaceMetering) RegisterUsageWithContext added in v1.15.84 

func (c *MarketplaceMetering) RegisterUsageWithContext(ctx aws.Context, input *RegisterUsageInput, opts ...request.Option) (*RegisterUsageOutput, error)

RegisterUsageWithContext is the same as RegisterUsage with the addition of the ability to pass a context and additional request options.

See RegisterUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MarketplaceMetering) ResolveCustomer added in v1.5.7 

func (c *MarketplaceMetering) ResolveCustomer(input *ResolveCustomerInput) (*ResolveCustomerOutput, error)

ResolveCustomer API operation for AWSMarketplace Metering.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSMarketplace Metering's API operation ResolveCustomer for usage and error information.

Returned Error Types:

  • InvalidTokenException Registration token is invalid.

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

  • ThrottlingException The calls to the API are throttled.

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

  • DisabledApiException The API is disabled in the Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomer

func (*MarketplaceMetering) ResolveCustomerRequest added in v1.5.7 

func (c *MarketplaceMetering) ResolveCustomerRequest(input *ResolveCustomerInput) (req *request.Request, output *ResolveCustomerOutput)

ResolveCustomerRequest generates a "aws/request.Request" representing the client's request for the ResolveCustomer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResolveCustomer for more information on using the ResolveCustomer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ResolveCustomerRequest method.
req, resp := client.ResolveCustomerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomer

func (*MarketplaceMetering) ResolveCustomerWithContext added in v1.8.0 

func (c *MarketplaceMetering) ResolveCustomerWithContext(ctx aws.Context, input *ResolveCustomerInput, opts ...request.Option) (*ResolveCustomerOutput, error)

ResolveCustomerWithContext is the same as ResolveCustomer with the addition of the ability to pass a context and additional request options.

See ResolveCustomer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type MeterUsageInput 

type MeterUsageInput struct {

	// 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 `type:"boolean"`

	// 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.
	//
	// ProductCode is a required field
	ProductCode *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`

	// 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 []*UsageAllocation `min:"1" type:"list"`

	// It will be one of the fcp dimension name provided during the publishing of
	// the product.
	//
	// UsageDimension is a required field
	UsageDimension *string `min:"1" type:"string" required:"true"`

	// Consumption value for the hour. Defaults to 0 if not specified.
	UsageQuantity *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (MeterUsageInput) GoString 

func (s MeterUsageInput) GoString() string

GoString returns the string representation

func (*MeterUsageInput) SetDryRun added in v1.5.0 

func (s *MeterUsageInput) SetDryRun(v bool) *MeterUsageInput

SetDryRun sets the DryRun field's value.

func (*MeterUsageInput) SetProductCode added in v1.5.0 

func (s *MeterUsageInput) SetProductCode(v string) *MeterUsageInput

SetProductCode sets the ProductCode field's value.

func (*MeterUsageInput) SetTimestamp added in v1.5.0 

func (s *MeterUsageInput) SetTimestamp(v time.Time) *MeterUsageInput

SetTimestamp sets the Timestamp field's value.

func (*MeterUsageInput) SetUsageAllocations added in v1.35.21 

func (s *MeterUsageInput) SetUsageAllocations(v []*UsageAllocation) *MeterUsageInput

SetUsageAllocations sets the UsageAllocations field's value.

func (*MeterUsageInput) SetUsageDimension added in v1.5.0 

func (s *MeterUsageInput) SetUsageDimension(v string) *MeterUsageInput

SetUsageDimension sets the UsageDimension field's value.

func (*MeterUsageInput) SetUsageQuantity added in v1.5.0 

func (s *MeterUsageInput) SetUsageQuantity(v int64) *MeterUsageInput

SetUsageQuantity sets the UsageQuantity field's value.

func (MeterUsageInput) String 

func (s MeterUsageInput) String() string

String returns the string representation

func (*MeterUsageInput) Validate added in v1.1.21 

func (s *MeterUsageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MeterUsageOutput 

type MeterUsageOutput struct {

	// Metering record id.
	MeteringRecordId *string `type:"string"`
	// contains filtered or unexported fields
}

func (MeterUsageOutput) GoString 

func (s MeterUsageOutput) GoString() string

GoString returns the string representation

func (*MeterUsageOutput) SetMeteringRecordId added in v1.5.0 

func (s *MeterUsageOutput) SetMeteringRecordId(v string) *MeterUsageOutput

SetMeteringRecordId sets the MeteringRecordId field's value.

func (MeterUsageOutput) String 

func (s MeterUsageOutput) String() string

String returns the string representation

type PlatformNotSupportedException added in v1.28.0 

type PlatformNotSupportedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*PlatformNotSupportedException) Code added in v1.28.0 

func (s *PlatformNotSupportedException) Code() string

Code returns the exception type name.

func (*PlatformNotSupportedException) Error added in v1.28.0 

func (s *PlatformNotSupportedException) Error() string

func (PlatformNotSupportedException) GoString added in v1.28.0 

func (s PlatformNotSupportedException) GoString() string

GoString returns the string representation

func (*PlatformNotSupportedException) Message added in v1.28.0 

func (s *PlatformNotSupportedException) Message() string

Message returns the exception's message.

func (*PlatformNotSupportedException) OrigErr added in v1.28.0 

func (s *PlatformNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PlatformNotSupportedException) RequestID added in v1.28.0 

func (s *PlatformNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PlatformNotSupportedException) StatusCode added in v1.28.0 

func (s *PlatformNotSupportedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PlatformNotSupportedException) String added in v1.28.0 

func (s PlatformNotSupportedException) String() string

String returns the string representation

type RegisterUsageInput added in v1.15.84 

type RegisterUsageInput struct {

	// (Optional) To scope down the registration to a specific running software
	// instance and guard against replay attacks.
	Nonce *string `type:"string"`

	// 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.
	//
	// ProductCode is a required field
	ProductCode *string `min:"1" type:"string" required:"true"`

	// Public Key Version provided by AWS Marketplace
	//
	// PublicKeyVersion is a required field
	PublicKeyVersion *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterUsageInput) GoString added in v1.15.84 

func (s RegisterUsageInput) GoString() string

GoString returns the string representation

func (*RegisterUsageInput) SetNonce added in v1.15.84 

func (s *RegisterUsageInput) SetNonce(v string) *RegisterUsageInput

SetNonce sets the Nonce field's value.

func (*RegisterUsageInput) SetProductCode added in v1.15.84 

func (s *RegisterUsageInput) SetProductCode(v string) *RegisterUsageInput

SetProductCode sets the ProductCode field's value.

func (*RegisterUsageInput) SetPublicKeyVersion added in v1.15.84 

func (s *RegisterUsageInput) SetPublicKeyVersion(v int64) *RegisterUsageInput

SetPublicKeyVersion sets the PublicKeyVersion field's value.

func (RegisterUsageInput) String added in v1.15.84 

func (s RegisterUsageInput) String() string

String returns the string representation

func (*RegisterUsageInput) Validate added in v1.15.84 

func (s *RegisterUsageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterUsageOutput added in v1.15.84 

type RegisterUsageOutput struct {

	// (Optional) Only included when public key version has expired
	PublicKeyRotationTimestamp *time.Time `type:"timestamp"`

	// JWT Token
	Signature *string `type:"string"`
	// contains filtered or unexported fields
}

func (RegisterUsageOutput) GoString added in v1.15.84 

func (s RegisterUsageOutput) GoString() string

GoString returns the string representation

func (*RegisterUsageOutput) SetPublicKeyRotationTimestamp added in v1.15.84 

func (s *RegisterUsageOutput) SetPublicKeyRotationTimestamp(v time.Time) *RegisterUsageOutput

SetPublicKeyRotationTimestamp sets the PublicKeyRotationTimestamp field's value.

func (*RegisterUsageOutput) SetSignature added in v1.15.84 

func (s *RegisterUsageOutput) SetSignature(v string) *RegisterUsageOutput

SetSignature sets the Signature field's value.

func (RegisterUsageOutput) String added in v1.15.84 

func (s RegisterUsageOutput) String() string

String returns the string representation

type ResolveCustomerInput added in v1.5.7 

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.
	//
	// RegistrationToken is a required field
	RegistrationToken *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains input to the ResolveCustomer operation.

func (ResolveCustomerInput) GoString added in v1.5.7 

func (s ResolveCustomerInput) GoString() string

GoString returns the string representation

func (*ResolveCustomerInput) SetRegistrationToken added in v1.5.7 

func (s *ResolveCustomerInput) SetRegistrationToken(v string) *ResolveCustomerInput

SetRegistrationToken sets the RegistrationToken field's value.

func (ResolveCustomerInput) String added in v1.5.7 

func (s ResolveCustomerInput) String() string

String returns the string representation

func (*ResolveCustomerInput) Validate added in v1.5.7 

func (s *ResolveCustomerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResolveCustomerOutput added in v1.5.7 

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 `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ResolveCustomerOutput) GoString added in v1.5.7 

func (s ResolveCustomerOutput) GoString() string

GoString returns the string representation

func (*ResolveCustomerOutput) SetCustomerIdentifier added in v1.5.7 

func (s *ResolveCustomerOutput) SetCustomerIdentifier(v string) *ResolveCustomerOutput

SetCustomerIdentifier sets the CustomerIdentifier field's value.

func (*ResolveCustomerOutput) SetProductCode added in v1.5.7 

func (s *ResolveCustomerOutput) SetProductCode(v string) *ResolveCustomerOutput

SetProductCode sets the ProductCode field's value.

func (ResolveCustomerOutput) String added in v1.5.7 

func (s ResolveCustomerOutput) String() string

String returns the string representation

type Tag added in v1.35.21 

type Tag struct {

	// One part of a key-value pair that makes up a tag. A key is a label that acts
	// like a category for the specific tag values.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// One part of a key-value pair that makes up a tag. A value acts as a descriptor
	// within a tag category (key). The value can be empty or null.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata assigned to an allocation. Each tag is made up of a key and a value.

func (Tag) GoString added in v1.35.21 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.35.21 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.35.21 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.35.21 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.35.21 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The calls to the API are throttled.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation

type TimestampOutOfBoundsException added in v1.28.0 

type TimestampOutOfBoundsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TimestampOutOfBoundsException) Code added in v1.28.0 

func (s *TimestampOutOfBoundsException) Code() string

Code returns the exception type name.

func (*TimestampOutOfBoundsException) Error added in v1.28.0 

func (s *TimestampOutOfBoundsException) Error() string

func (TimestampOutOfBoundsException) GoString added in v1.28.0 

func (s TimestampOutOfBoundsException) GoString() string

GoString returns the string representation

func (*TimestampOutOfBoundsException) Message added in v1.28.0 

func (s *TimestampOutOfBoundsException) Message() string

Message returns the exception's message.

func (*TimestampOutOfBoundsException) OrigErr added in v1.28.0 

func (s *TimestampOutOfBoundsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TimestampOutOfBoundsException) RequestID added in v1.28.0 

func (s *TimestampOutOfBoundsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TimestampOutOfBoundsException) StatusCode added in v1.28.0 

func (s *TimestampOutOfBoundsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TimestampOutOfBoundsException) String added in v1.28.0 

func (s TimestampOutOfBoundsException) String() string

String returns the string representation

type UsageAllocation added in v1.35.21 

type UsageAllocation struct {

	// The total quantity allocated to this bucket of usage.
	//
	// AllocatedUsageQuantity is a required field
	AllocatedUsageQuantity *int64 `type:"integer" required:"true"`

	// The set of tags that define the bucket of usage. For the bucket of items
	// with no tags, this parameter can be left out.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Usage allocations allow you to split usage into buckets by tags.

Each UsageAllocation indicates the usage quantity for a specific set of tags.

func (UsageAllocation) GoString added in v1.35.21 

func (s UsageAllocation) GoString() string

GoString returns the string representation

func (*UsageAllocation) SetAllocatedUsageQuantity added in v1.35.21 

func (s *UsageAllocation) SetAllocatedUsageQuantity(v int64) *UsageAllocation

SetAllocatedUsageQuantity sets the AllocatedUsageQuantity field's value.

func (*UsageAllocation) SetTags added in v1.35.21 

func (s *UsageAllocation) SetTags(v []*Tag) *UsageAllocation

SetTags sets the Tags field's value.

func (UsageAllocation) String added in v1.35.21 

func (s UsageAllocation) String() string

String returns the string representation

func (*UsageAllocation) Validate added in v1.35.21 

func (s *UsageAllocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UsageRecord added in v1.5.7 

type UsageRecord struct {

	// The CustomerIdentifier is obtained through the ResolveCustomer operation
	// and represents an individual buyer in your application.
	//
	// CustomerIdentifier is a required field
	CustomerIdentifier *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Dimension is a required field
	Dimension *string `min:"1" type:"string" required:"true"`

	// The quantity of usage consumed by the customer for the given dimension and
	// time. Defaults to 0 if not specified.
	Quantity *int64 `type:"integer"`

	// 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.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`

	// The set of UsageAllocations to submit. The sum of all UsageAllocation quantities
	// must equal the Quantity of the UsageRecord.
	UsageAllocations []*UsageAllocation `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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.

func (UsageRecord) GoString added in v1.5.7 

func (s UsageRecord) GoString() string

GoString returns the string representation

func (*UsageRecord) SetCustomerIdentifier added in v1.5.7 

func (s *UsageRecord) SetCustomerIdentifier(v string) *UsageRecord

SetCustomerIdentifier sets the CustomerIdentifier field's value.

func (*UsageRecord) SetDimension added in v1.5.7 

func (s *UsageRecord) SetDimension(v string) *UsageRecord

SetDimension sets the Dimension field's value.

func (*UsageRecord) SetQuantity added in v1.5.7 

func (s *UsageRecord) SetQuantity(v int64) *UsageRecord

SetQuantity sets the Quantity field's value.

func (*UsageRecord) SetTimestamp added in v1.5.7 

func (s *UsageRecord) SetTimestamp(v time.Time) *UsageRecord

SetTimestamp sets the Timestamp field's value.

func (*UsageRecord) SetUsageAllocations added in v1.35.21 

func (s *UsageRecord) SetUsageAllocations(v []*UsageAllocation) *UsageRecord

SetUsageAllocations sets the UsageAllocations field's value.

func (UsageRecord) String added in v1.5.7 

func (s UsageRecord) String() string

String returns the string representation

func (*UsageRecord) Validate added in v1.5.7 

func (s *UsageRecord) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UsageRecordResult added in v1.5.7 

type UsageRecordResult struct {

	// The MeteringRecordId is a unique identifier for this metering event.
	MeteringRecordId *string `type:"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.
	Status *string `type:"string" enum:"UsageRecordResultStatus"`

	// The UsageRecord that was part of the BatchMeterUsage request.
	UsageRecord *UsageRecord `type:"structure"`
	// contains filtered or unexported fields
}

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

func (UsageRecordResult) GoString added in v1.5.7 

func (s UsageRecordResult) GoString() string

GoString returns the string representation

func (*UsageRecordResult) SetMeteringRecordId added in v1.5.7 

func (s *UsageRecordResult) SetMeteringRecordId(v string) *UsageRecordResult

SetMeteringRecordId sets the MeteringRecordId field's value.

func (*UsageRecordResult) SetStatus added in v1.5.7 

func (s *UsageRecordResult) SetStatus(v string) *UsageRecordResult

SetStatus sets the Status field's value.

func (*UsageRecordResult) SetUsageRecord added in v1.5.7 

func (s *UsageRecordResult) SetUsageRecord(v *UsageRecord) *UsageRecordResult

SetUsageRecord sets the UsageRecord field's value.

func (UsageRecordResult) String added in v1.5.7 

func (s UsageRecordResult) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package marketplacemeteringiface provides an interface to enable mocking the AWSMarketplace Metering service client for testing your code.
 Package marketplacemeteringiface provides an interface to enable mocking the AWSMarketplace Metering service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.