Serialized Form

Package com.amazonaws.services.marketplacemetering.model

Class com.amazonaws.services.marketplacemetering.model.AWSMarketplaceMeteringException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.BatchMeterUsageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

usageRecords

List<E> usageRecords

The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

productCode

String productCode

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.

Class com.amazonaws.services.marketplacemetering.model.BatchMeterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

results

List<E> results

Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted.

unprocessedRecords

List<E> unprocessedRecords

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.

Class com.amazonaws.services.marketplacemetering.model.CustomerNotEntitledException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.DisabledApiException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.DuplicateRequestException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.ExpiredTokenException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InternalServiceErrorException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidCustomerIdentifierException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidEndpointRegionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidProductCodeException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidPublicKeyVersionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidRegionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidTagException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidTokenException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidUsageAllocationsException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.InvalidUsageDimensionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.MeterUsageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

productCode

String productCode

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

timestamp

Date timestamp

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

usageDimension

String usageDimension

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

usageQuantity

Integer usageQuantity

Consumption value for the hour. Defaults to 0 if not specified.

dryRun

Boolean dryRun

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.

usageAllocations

List<E> usageAllocations

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

Class com.amazonaws.services.marketplacemetering.model.MeterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

meteringRecordId

String meteringRecordId

Metering record id.

Class com.amazonaws.services.marketplacemetering.model.PlatformNotSupportedException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.RegisterUsageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

productCode

String productCode

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

publicKeyVersion

Integer publicKeyVersion

Public Key Version provided by AWS Marketplace

nonce

String nonce

(Optional) To scope down the registration to a specific running software instance and guard against replay attacks.

Class com.amazonaws.services.marketplacemetering.model.RegisterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

publicKeyRotationTimestamp

Date publicKeyRotationTimestamp

(Optional) Only included when public key version has expired

signature

String signature

JWT Token

Class com.amazonaws.services.marketplacemetering.model.ResolveCustomerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

registrationToken

String registrationToken

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 along with the CustomerAWSAccountId and ProductCode.

Class com.amazonaws.services.marketplacemetering.model.ResolveCustomerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

customerIdentifier

String customerIdentifier

The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

productCode

String productCode

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.

customerAWSAccountId

String customerAWSAccountId

The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.

Class com.amazonaws.services.marketplacemetering.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

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.

value

String value

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.

Class com.amazonaws.services.marketplacemetering.model.ThrottlingException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.TimestampOutOfBoundsException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.UsageAllocation extends Object implements Serializable

Serialized Fields

allocatedUsageQuantity

Integer allocatedUsageQuantity

The total quantity allocated to this bucket of usage.

tags

List<E> tags

The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

Class com.amazonaws.services.marketplacemetering.model.UsageRecord extends Object implements Serializable

Serialized Fields

timestamp

Date timestamp

Timestamp, in UTC, for which the usage is being reported.

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

customerIdentifier

String customerIdentifier

The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

dimension

String dimension

During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

quantity

Integer quantity

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

usageAllocations

List<E> usageAllocations

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

Class com.amazonaws.services.marketplacemetering.model.UsageRecordResult extends Object implements Serializable

Serialized Fields

usageRecord

UsageRecord usageRecord

The UsageRecord that was part of the BatchMeterUsage request.

meteringRecordId

String meteringRecordId

The MeteringRecordId is a unique identifier for this metering event.

status

String status

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 able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.

  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • The customer's AWS account was suspended.

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