public interface AWSMarketplaceMetering
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.
Modifier and Type | Method and Description |
---|---|
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.
|
MeterUsageResult |
meterUsage(MeterUsageRequest meterUsageRequest)
API to emit metering records.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("https://metering.marketplace.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) ,
sets the regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void setEndpoint(String endpoint)
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.
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.void setRegion(Region region)
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.
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
MeterUsageResult meterUsage(MeterUsageRequest meterUsageRequest)
API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.
meterUsageRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2018. All rights reserved.