class Aws::MarketplaceMetering::Client
An API client for MarketplaceMetering
. To construct a client, you need to configure a `:region` and `:credentials`.
client = Aws::MarketplaceMetering::Client.new( region: region_name, credentials: credentials, # ... )
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-marketplacemetering/client.rb, line 651 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures. When `:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-marketplacemetering/client.rb, line 334 def initialize(*args) super end
Public Instance Methods
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.
A UsageRecord can optionally include multiple usage allocations, to provide customers with usagedata split into buckets by tags that you define (or allow the customer to define).
BatchMeterUsage requests must be less than 1MB in size.
@option params [required, Array<Types::UsageRecord>] :usage_records
The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
@option params [required, String] :product_code
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.
@return [Types::BatchMeterUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::BatchMeterUsageResult#results #results} => Array<Types::UsageRecordResult> * {Types::BatchMeterUsageResult#unprocessed_records #unprocessed_records} => Array<Types::UsageRecord>
@example Request syntax with placeholder values
resp = client.batch_meter_usage({ usage_records: [ # required { timestamp: Time.now, # required customer_identifier: "CustomerIdentifier", # required dimension: "UsageDimension", # required quantity: 1, usage_allocations: [ { allocated_usage_quantity: 1, # required tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }, ], }, ], product_code: "ProductCode", # required })
@example Response structure
resp.results #=> Array resp.results[0].usage_record.timestamp #=> Time resp.results[0].usage_record.customer_identifier #=> String resp.results[0].usage_record.dimension #=> String resp.results[0].usage_record.quantity #=> Integer resp.results[0].usage_record.usage_allocations #=> Array resp.results[0].usage_record.usage_allocations[0].allocated_usage_quantity #=> Integer resp.results[0].usage_record.usage_allocations[0].tags #=> Array resp.results[0].usage_record.usage_allocations[0].tags[0].key #=> String resp.results[0].usage_record.usage_allocations[0].tags[0].value #=> String resp.results[0].metering_record_id #=> String resp.results[0].status #=> String, one of "Success", "CustomerNotSubscribed", "DuplicateRecord" resp.unprocessed_records #=> Array resp.unprocessed_records[0].timestamp #=> Time resp.unprocessed_records[0].customer_identifier #=> String resp.unprocessed_records[0].dimension #=> String resp.unprocessed_records[0].quantity #=> Integer resp.unprocessed_records[0].usage_allocations #=> Array resp.unprocessed_records[0].usage_allocations[0].allocated_usage_quantity #=> Integer resp.unprocessed_records[0].usage_allocations[0].tags #=> Array resp.unprocessed_records[0].usage_allocations[0].tags[0].key #=> String resp.unprocessed_records[0].usage_allocations[0].tags[0].value #=> String
@see docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsage AWS API Documentation
@overload batch_meter_usage
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacemetering/client.rb, line 426 def batch_meter_usage(params = {}, options = {}) req = build_request(:batch_meter_usage, params) req.send_request(options) end
@param params ({}) @api private
# File lib/aws-sdk-marketplacemetering/client.rb, line 626 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-marketplacemetering' context[:gem_version] = '1.37.0' Seahorse::Client::Request.new(handlers, context) end
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 using credentials from the EC2 instance, ECS task, or EKS pod.
MeterUsage can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).
@option params [required, String] :product_code
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.
@option params [required, Time,DateTime,Date,Integer,String] :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.
@option params [required, String] :usage_dimension
It will be one of the fcp dimension name provided during the publishing of the product.
@option params [Integer] :usage_quantity
Consumption value for the hour. Defaults to `0` if not specified.
@option params [Boolean] :dry_run
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.
@option params [Array<Types::UsageAllocation>] :usage_allocations
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).
@return [Types::MeterUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::MeterUsageResult#metering_record_id #metering_record_id} => String
@example Request syntax with placeholder values
resp = client.meter_usage({ product_code: "ProductCode", # required timestamp: Time.now, # required usage_dimension: "UsageDimension", # required usage_quantity: 1, dry_run: false, usage_allocations: [ { allocated_usage_quantity: 1, # required tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }, ], })
@example Response structure
resp.metering_record_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsage AWS API Documentation
@overload meter_usage
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacemetering/client.rb, line 504 def meter_usage(params = {}, options = {}) req = build_request(:meter_usage, params) req.send_request(options) end
Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement.
-
Entitlement: RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is still running.
-
Metering: RegisterUsage meters software use per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane – your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks and Amazon EKS pods, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime.
@option params [required, String] :product_code
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.
@option params [required, Integer] :public_key_version
Public Key Version provided by AWS Marketplace
@option params [String] :nonce
(Optional) To scope down the registration to a specific running software instance and guard against replay attacks.
@return [Types::RegisterUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::RegisterUsageResult#public_key_rotation_timestamp #public_key_rotation_timestamp} => Time * {Types::RegisterUsageResult#signature #signature} => String
@example Request syntax with placeholder values
resp = client.register_usage({ product_code: "ProductCode", # required public_key_version: 1, # required nonce: "Nonce", })
@example Response structure
resp.public_key_rotation_timestamp #=> Time resp.signature #=> String
@see docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsage AWS API Documentation
@overload register_usage
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacemetering/client.rb, line 580 def register_usage(params = {}, options = {}) req = build_request(:register_usage, params) req.send_request(options) end
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.
@option params [required, String] :registration_token
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.
@return [Types::ResolveCustomerResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ResolveCustomerResult#customer_identifier #customer_identifier} => String * {Types::ResolveCustomerResult#product_code #product_code} => String
@example Request syntax with placeholder values
resp = client.resolve_customer({ registration_token: "NonEmptyString", # required })
@example Response structure
resp.customer_identifier #=> String resp.product_code #=> String
@see docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomer AWS API Documentation
@overload resolve_customer
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacemetering/client.rb, line 617 def resolve_customer(params = {}, options = {}) req = build_request(:resolve_customer, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-marketplacemetering/client.rb, line 641 def waiter_names [] end