marketplacemetering

package
v1.12.36 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

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.

Submitting Metering Records

  • MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance.

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

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 (

	// ErrCodeDuplicateRequestException for service response error code
	// "DuplicateRequestException".
	//
	// A metering record has already been emitted by the same EC2 instance 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 region different from your EC2 instance.
	// The region of the Metering service endpoint and the region of the EC2 instance
	// 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"

	// ErrCodeInvalidTokenException for service response error code
	// "InvalidTokenException".
	ErrCodeInvalidTokenException = "InvalidTokenException"

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

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The calls to the MeterUsage 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" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName            // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsageRequest

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsageResult

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 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: 

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

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 Codes:

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

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

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

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

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

  • ErrCodeThrottlingException "ThrottlingException" The calls to the MeterUsage API are throttled.

Please also see 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 complets successfuly.

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

Please also see 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, generally when running from an EC2 instance on the AWS Marketplace.

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 Codes:

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

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

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

  • ErrCodeInvalidEndpointRegionException "InvalidEndpointRegionException" The endpoint being called is in a region different from your EC2 instance. The region of the Metering service endpoint and the region of the EC2 instance must match.

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

  • ErrCodeDuplicateRequestException "DuplicateRequestException" A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.

  • ErrCodeThrottlingException "ThrottlingException" The calls to the MeterUsage API are throttled.

Please also see 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 complets successfuly.

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

Please also see 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) 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 Codes:

  • ErrCodeInvalidTokenException "InvalidTokenException"

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

  • ErrCodeThrottlingException "ThrottlingException" The calls to the MeterUsage API are throttled.

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

Please also see 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 complets successfuly.

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

Please also see 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.
	//
	// DryRun is a required field
	DryRun *bool `type:"boolean" required:"true"`

	// 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 of the hour, recorded in UTC. The seconds and milliseconds portions
	// of the timestamp will be ignored.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsageRequest

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) 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 {
	MeteringRecordId *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsageResult

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerRequest

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerResult

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 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.
	//
	// Quantity is a required field
	Quantity *int64 `type:"integer" required:"true"`

	// Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions
	// of the timestamp will be ignored.
	//
	// Your application can meter usage for up to one hour in the past.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/UsageRecord

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) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/UsageRecordResult

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.