Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CustomerNotEntitledException

type CustomerNotEntitledException struct {
	Message *string
}

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

    func (*CustomerNotEntitledException) Error

    func (*CustomerNotEntitledException) ErrorCode

    func (e *CustomerNotEntitledException) ErrorCode() string

    func (*CustomerNotEntitledException) ErrorFault

    func (*CustomerNotEntitledException) ErrorMessage

    func (e *CustomerNotEntitledException) ErrorMessage() string

    type DisabledApiException

    type DisabledApiException struct {
    	Message *string
    }

      The API is disabled in the Region.

      func (*DisabledApiException) Error

      func (e *DisabledApiException) Error() string

      func (*DisabledApiException) ErrorCode

      func (e *DisabledApiException) ErrorCode() string

      func (*DisabledApiException) ErrorFault

      func (e *DisabledApiException) ErrorFault() smithy.ErrorFault

      func (*DisabledApiException) ErrorMessage

      func (e *DisabledApiException) ErrorMessage() string

      type DuplicateRequestException

      type DuplicateRequestException struct {
      	Message *string
      }

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

        func (e *DuplicateRequestException) Error() string

        func (*DuplicateRequestException) ErrorCode

        func (e *DuplicateRequestException) ErrorCode() string

        func (*DuplicateRequestException) ErrorFault

        func (*DuplicateRequestException) ErrorMessage

        func (e *DuplicateRequestException) ErrorMessage() string

        type ExpiredTokenException

        type ExpiredTokenException struct {
        	Message *string
        }

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

          func (e *ExpiredTokenException) Error() string

          func (*ExpiredTokenException) ErrorCode

          func (e *ExpiredTokenException) ErrorCode() string

          func (*ExpiredTokenException) ErrorFault

          func (e *ExpiredTokenException) ErrorFault() smithy.ErrorFault

          func (*ExpiredTokenException) ErrorMessage

          func (e *ExpiredTokenException) ErrorMessage() string

          type InternalServiceErrorException

          type InternalServiceErrorException struct {
          	Message *string
          }

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

            func (*InternalServiceErrorException) Error

            func (*InternalServiceErrorException) ErrorCode

            func (e *InternalServiceErrorException) ErrorCode() string

            func (*InternalServiceErrorException) ErrorFault

            func (*InternalServiceErrorException) ErrorMessage

            func (e *InternalServiceErrorException) ErrorMessage() string

            type InvalidCustomerIdentifierException

            type InvalidCustomerIdentifierException struct {
            	Message *string
            }

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

              func (*InvalidCustomerIdentifierException) Error

              func (*InvalidCustomerIdentifierException) ErrorCode

              func (*InvalidCustomerIdentifierException) ErrorFault

              func (*InvalidCustomerIdentifierException) ErrorMessage

              func (e *InvalidCustomerIdentifierException) ErrorMessage() string

              type InvalidEndpointRegionException

              type InvalidEndpointRegionException struct {
              	Message *string
              }

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

                func (*InvalidEndpointRegionException) ErrorCode

                func (e *InvalidEndpointRegionException) ErrorCode() string

                func (*InvalidEndpointRegionException) ErrorFault

                func (*InvalidEndpointRegionException) ErrorMessage

                func (e *InvalidEndpointRegionException) ErrorMessage() string

                type InvalidProductCodeException

                type InvalidProductCodeException struct {
                	Message *string
                }

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

                  func (*InvalidProductCodeException) Error

                  func (*InvalidProductCodeException) ErrorCode

                  func (e *InvalidProductCodeException) ErrorCode() string

                  func (*InvalidProductCodeException) ErrorFault

                  func (*InvalidProductCodeException) ErrorMessage

                  func (e *InvalidProductCodeException) ErrorMessage() string

                  type InvalidPublicKeyVersionException

                  type InvalidPublicKeyVersionException struct {
                  	Message *string
                  }

                    Public Key version is invalid.

                    func (*InvalidPublicKeyVersionException) Error

                    func (*InvalidPublicKeyVersionException) ErrorCode

                    func (*InvalidPublicKeyVersionException) ErrorFault

                    func (*InvalidPublicKeyVersionException) ErrorMessage

                    func (e *InvalidPublicKeyVersionException) ErrorMessage() string

                    type InvalidRegionException

                    type InvalidRegionException struct {
                    	Message *string
                    }

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

                      func (e *InvalidRegionException) Error() string

                      func (*InvalidRegionException) ErrorCode

                      func (e *InvalidRegionException) ErrorCode() string

                      func (*InvalidRegionException) ErrorFault

                      func (e *InvalidRegionException) ErrorFault() smithy.ErrorFault

                      func (*InvalidRegionException) ErrorMessage

                      func (e *InvalidRegionException) ErrorMessage() string

                      type InvalidTagException

                      type InvalidTagException struct {
                      	Message *string
                      }

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

                        func (*InvalidTagException) Error

                        func (e *InvalidTagException) Error() string

                        func (*InvalidTagException) ErrorCode

                        func (e *InvalidTagException) ErrorCode() string

                        func (*InvalidTagException) ErrorFault

                        func (e *InvalidTagException) ErrorFault() smithy.ErrorFault

                        func (*InvalidTagException) ErrorMessage

                        func (e *InvalidTagException) ErrorMessage() string

                        type InvalidTokenException

                        type InvalidTokenException struct {
                        	Message *string
                        }

                          Registration token is invalid.

                          func (*InvalidTokenException) Error

                          func (e *InvalidTokenException) Error() string

                          func (*InvalidTokenException) ErrorCode

                          func (e *InvalidTokenException) ErrorCode() string

                          func (*InvalidTokenException) ErrorFault

                          func (e *InvalidTokenException) ErrorFault() smithy.ErrorFault

                          func (*InvalidTokenException) ErrorMessage

                          func (e *InvalidTokenException) ErrorMessage() string

                          type InvalidUsageAllocationsException

                          type InvalidUsageAllocationsException struct {
                          	Message *string
                          }

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

                            func (*InvalidUsageAllocationsException) Error

                            func (*InvalidUsageAllocationsException) ErrorCode

                            func (*InvalidUsageAllocationsException) ErrorFault

                            func (*InvalidUsageAllocationsException) ErrorMessage

                            func (e *InvalidUsageAllocationsException) ErrorMessage() string

                            type InvalidUsageDimensionException

                            type InvalidUsageDimensionException struct {
                            	Message *string
                            }

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

                              func (*InvalidUsageDimensionException) Error

                              func (*InvalidUsageDimensionException) ErrorCode

                              func (e *InvalidUsageDimensionException) ErrorCode() string

                              func (*InvalidUsageDimensionException) ErrorFault

                              func (*InvalidUsageDimensionException) ErrorMessage

                              func (e *InvalidUsageDimensionException) ErrorMessage() string

                              type PlatformNotSupportedException

                              type PlatformNotSupportedException struct {
                              	Message *string
                              }

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

                                func (*PlatformNotSupportedException) Error

                                func (*PlatformNotSupportedException) ErrorCode

                                func (e *PlatformNotSupportedException) ErrorCode() string

                                func (*PlatformNotSupportedException) ErrorFault

                                func (*PlatformNotSupportedException) ErrorMessage

                                func (e *PlatformNotSupportedException) ErrorMessage() string

                                type Tag

                                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.
                                	//
                                	// This member is required.
                                	Key *string
                                
                                	// 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.
                                	//
                                	// This member is required.
                                	Value *string
                                }

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

                                  type ThrottlingException

                                  type ThrottlingException struct {
                                  	Message *string
                                  }

                                    The calls to the API are throttled.

                                    func (*ThrottlingException) Error

                                    func (e *ThrottlingException) Error() string

                                    func (*ThrottlingException) ErrorCode

                                    func (e *ThrottlingException) ErrorCode() string

                                    func (*ThrottlingException) ErrorFault

                                    func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

                                    func (*ThrottlingException) ErrorMessage

                                    func (e *ThrottlingException) ErrorMessage() string

                                    type TimestampOutOfBoundsException

                                    type TimestampOutOfBoundsException struct {
                                    	Message *string
                                    }

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

                                      func (*TimestampOutOfBoundsException) Error

                                      func (*TimestampOutOfBoundsException) ErrorCode

                                      func (e *TimestampOutOfBoundsException) ErrorCode() string

                                      func (*TimestampOutOfBoundsException) ErrorFault

                                      func (*TimestampOutOfBoundsException) ErrorMessage

                                      func (e *TimestampOutOfBoundsException) ErrorMessage() string

                                      type UsageAllocation

                                      type UsageAllocation struct {
                                      
                                      	// The total quantity allocated to this bucket of usage.
                                      	//
                                      	// This member is required.
                                      	AllocatedUsageQuantity *int32
                                      
                                      	// 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
                                      }

                                        Usage allocations allow you to split usage into buckets by tags. Each UsageAllocation indicates the usage quantity for a specific set of tags.

                                        type UsageRecord

                                        type UsageRecord struct {
                                        
                                        	// The CustomerIdentifier is obtained through the ResolveCustomer operation and
                                        	// represents an individual buyer in your application.
                                        	//
                                        	// This member is required.
                                        	CustomerIdentifier *string
                                        
                                        	// During the process of registering a product on AWS Marketplace, up to eight
                                        	// dimensions are specified. These represent different units of value in your
                                        	// application.
                                        	//
                                        	// This member is required.
                                        	Dimension *string
                                        
                                        	// Timestamp, in UTC, for which the usage is being reported. Your application can
                                        	// meter usage for up to one hour in the past. Make sure the timestamp value is not
                                        	// before the start of the software usage.
                                        	//
                                        	// This member is required.
                                        	Timestamp *time.Time
                                        
                                        	// The quantity of usage consumed by the customer for the given dimension and time.
                                        	// Defaults to 0 if not specified.
                                        	Quantity *int32
                                        
                                        	// The set of UsageAllocations to submit. The sum of all UsageAllocation quantities
                                        	// must equal the Quantity of the UsageRecord.
                                        	UsageAllocations []UsageAllocation
                                        }

                                          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.

                                          type UsageRecordResult

                                          type UsageRecordResult struct {
                                          
                                          	// The MeteringRecordId is a unique identifier for this metering event.
                                          	MeteringRecordId *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 UsageRecordResultStatus
                                          
                                          	// The UsageRecord that was part of the BatchMeterUsage request.
                                          	UsageRecord *UsageRecord
                                          }

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

                                            type UsageRecordResultStatus

                                            type UsageRecordResultStatus string
                                            const (
                                            	UsageRecordResultStatusSuccess               UsageRecordResultStatus = "Success"
                                            	UsageRecordResultStatusCustomerNotSubscribed UsageRecordResultStatus = "CustomerNotSubscribed"
                                            	UsageRecordResultStatusDuplicateRecord       UsageRecordResultStatus = "DuplicateRecord"
                                            )

                                              Enum values for UsageRecordResultStatus

                                              func (UsageRecordResultStatus) Values

                                                Values returns all known values for UsageRecordResultStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.