Interface AWSMarketplaceMetering

All Known Subinterfaces:
AWSMarketplaceMeteringAsync
All Known Implementing Classes:
AbstractAWSMarketplaceMetering, AbstractAWSMarketplaceMeteringAsync, AWSMarketplaceMeteringAsyncClient, AWSMarketplaceMeteringClient

public interface AWSMarketplaceMetering
Interface for accessing AWSMarketplace Metering.

AWS Marketplace Metering Service

This reference provides descriptions of the low-level AWS Marketplace Metering Service API.

AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.

Submitting Metering Records

  • MeterUsage- Submits the metering record for a Marketplace product.

  • Method Details

    • setEndpoint

      void setEndpoint(String endpoint)
      Overrides the default endpoint for this client ("https://metering.marketplace.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

      Callers can pass in just the endpoint (ex: "metering.marketplace.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://metering.marketplace.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

      For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

      This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Parameters:
      endpoint - The endpoint (ex: "metering.marketplace.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://metering.marketplace.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
    • setRegion

      void setRegion(Region region)
      An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

      By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

      This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Parameters:
      region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
      See Also:
    • meterUsage

      MeterUsageResult meterUsage(MeterUsageRequest meterUsageRequest)

      API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

      Parameters:
      meterUsageRequest -
      Returns:
      Result of the MeterUsage operation returned by the service.
      Throws:
      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.
      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.
      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 for the given {usageDimension, timestamp} with a different usageQuantity.
      ThrottlingException - The calls to the MeterUsage API are throttled.
    • shutdown

      void shutdown()
      Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    • getCachedResponseMetadata

      ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

      Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.