aws-sdk-marketplacemetering 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba337e785c1a10722f5858c06c235bcb7c591bcc
-  data.tar.gz: e761c8ef36ccebec9a43fb27aad94bf891808327
+  metadata.gz: 6b3a0492ba176ab7f68947ff8ca764d37ae6d645
+  data.tar.gz: ecc3783ee5d5ee7b3591d386ac2ef2c562bf02e6
 SHA512:
-  metadata.gz: bc422bb7adad560d516ee3367d5a8bc34f7c483ba765e29787cba157ee533456e2f980fabe606e0082b6a91573ade4ea744a84ba117f42711f8de06c9258f0fe
-  data.tar.gz: 9cf611d167a9505fc0e611175a0fc5d57f96011f8854e148529d5258f726a9dcc91481c74a344f13a3d69e6865422e41b8804cf6997ba66029c48b253597fe46
+  metadata.gz: 0fac547094b0fd42d37c13ad2c0030d3f388142ca96c3b461589f6c511b1aedd9cc7f196c3491ba113fbcc28dde5a788f9f49ccbef94345337b0b4a1dd3ab35b
+  data.tar.gz: dedab45d824cb5fe4a4f0fe129060bf546cae5e23588f3728e79d67418779af5cba3e7bd3057cc2abc634fc77457a8802734670a0f2f1022ef5991043399f670

data/lib/aws-sdk-marketplacemetering.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-marketplacemetering/customizations'
 # @service
 module Aws::MarketplaceMetering
 
-  GEM_VERSION = '1.6.0'
+  GEM_VERSION = '1.7.0'
 
 end

data/lib/aws-sdk-marketplacemetering/client.rb

@@ -333,6 +333,81 @@ module Aws::MarketplaceMetering
       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. Calling
+    # RegisterUsage from containers running outside of ECS is not currently
+    # supported. Free and BYOL products for ECS 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) will not
+    #   throw a CustomerNotSubscribedException, even if the customer
+    #   unsubscribes while the Amazon ECS task is still running.
+    #
+    # * *Metering*\: RegisterUsage meters software use per ECS task, per
+    #   hour, 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 ECS cluster and creates an ECS service
+    #   configured as a Daemon Set, then ECS 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, 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 http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsage AWS API Documentation
+    #
+    # @overload register_usage(params = {})
+    # @param [Hash] params ({})
+    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
@@ -383,7 +458,7 @@ module Aws::MarketplaceMetering
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-marketplacemetering'
-      context[:gem_version] = '1.6.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-marketplacemetering/client_api.rb

@@ -15,18 +15,26 @@ module Aws::MarketplaceMetering
     BatchMeterUsageResult = Shapes::StructureShape.new(name: 'BatchMeterUsageResult')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     CustomerIdentifier = Shapes::StringShape.new(name: 'CustomerIdentifier')
+    CustomerNotEntitledException = Shapes::StructureShape.new(name: 'CustomerNotEntitledException')
+    DisabledApiException = Shapes::StructureShape.new(name: 'DisabledApiException')
     DuplicateRequestException = Shapes::StructureShape.new(name: 'DuplicateRequestException')
     ExpiredTokenException = Shapes::StructureShape.new(name: 'ExpiredTokenException')
     InternalServiceErrorException = Shapes::StructureShape.new(name: 'InternalServiceErrorException')
     InvalidCustomerIdentifierException = Shapes::StructureShape.new(name: 'InvalidCustomerIdentifierException')
     InvalidEndpointRegionException = Shapes::StructureShape.new(name: 'InvalidEndpointRegionException')
     InvalidProductCodeException = Shapes::StructureShape.new(name: 'InvalidProductCodeException')
+    InvalidPublicKeyVersionException = Shapes::StructureShape.new(name: 'InvalidPublicKeyVersionException')
+    InvalidRegionException = Shapes::StructureShape.new(name: 'InvalidRegionException')
     InvalidTokenException = Shapes::StructureShape.new(name: 'InvalidTokenException')
     InvalidUsageDimensionException = Shapes::StructureShape.new(name: 'InvalidUsageDimensionException')
     MeterUsageRequest = Shapes::StructureShape.new(name: 'MeterUsageRequest')
     MeterUsageResult = Shapes::StructureShape.new(name: 'MeterUsageResult')
     NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
+    Nonce = Shapes::StringShape.new(name: 'Nonce')
+    PlatformNotSupportedException = Shapes::StructureShape.new(name: 'PlatformNotSupportedException')
     ProductCode = Shapes::StringShape.new(name: 'ProductCode')
+    RegisterUsageRequest = Shapes::StructureShape.new(name: 'RegisterUsageRequest')
+    RegisterUsageResult = Shapes::StructureShape.new(name: 'RegisterUsageResult')
     ResolveCustomerRequest = Shapes::StructureShape.new(name: 'ResolveCustomerRequest')
     ResolveCustomerResult = Shapes::StructureShape.new(name: 'ResolveCustomerResult')
     String = Shapes::StringShape.new(name: 'String')
@@ -40,6 +48,7 @@ module Aws::MarketplaceMetering
     UsageRecordResult = Shapes::StructureShape.new(name: 'UsageRecordResult')
     UsageRecordResultList = Shapes::ListShape.new(name: 'UsageRecordResultList')
     UsageRecordResultStatus = Shapes::StringShape.new(name: 'UsageRecordResultStatus')
+    VersionInteger = Shapes::IntegerShape.new(name: 'VersionInteger')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
 
     BatchMeterUsageRequest.add_member(:usage_records, Shapes::ShapeRef.new(shape: UsageRecordList, required: true, location_name: "UsageRecords"))
@@ -60,6 +69,15 @@ module Aws::MarketplaceMetering
     MeterUsageResult.add_member(:metering_record_id, Shapes::ShapeRef.new(shape: String, location_name: "MeteringRecordId"))
     MeterUsageResult.struct_class = Types::MeterUsageResult
 
+    RegisterUsageRequest.add_member(:product_code, Shapes::ShapeRef.new(shape: ProductCode, required: true, location_name: "ProductCode"))
+    RegisterUsageRequest.add_member(:public_key_version, Shapes::ShapeRef.new(shape: VersionInteger, required: true, location_name: "PublicKeyVersion"))
+    RegisterUsageRequest.add_member(:nonce, Shapes::ShapeRef.new(shape: Nonce, location_name: "Nonce"))
+    RegisterUsageRequest.struct_class = Types::RegisterUsageRequest
+
+    RegisterUsageResult.add_member(:public_key_rotation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "PublicKeyRotationTimestamp"))
+    RegisterUsageResult.add_member(:signature, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Signature"))
+    RegisterUsageResult.struct_class = Types::RegisterUsageResult
+
     ResolveCustomerRequest.add_member(:registration_token, Shapes::ShapeRef.new(shape: NonEmptyString, required: true, location_name: "RegistrationToken"))
     ResolveCustomerRequest.struct_class = Types::ResolveCustomerRequest
 
@@ -94,6 +112,7 @@ module Aws::MarketplaceMetering
         "jsonVersion" => "1.1",
         "protocol" => "json",
         "serviceFullName" => "AWSMarketplace Metering",
+        "serviceId" => "Marketplace Metering",
         "signatureVersion" => "v4",
         "signingName" => "aws-marketplace",
         "targetPrefix" => "AWSMPMeteringService",
@@ -112,6 +131,7 @@ module Aws::MarketplaceMetering
         o.errors << Shapes::ShapeRef.new(shape: InvalidCustomerIdentifierException)
         o.errors << Shapes::ShapeRef.new(shape: TimestampOutOfBoundsException)
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: DisabledApiException)
       end)
 
       api.add_operation(:meter_usage, Seahorse::Model::Operation.new.tap do |o|
@@ -129,6 +149,22 @@ module Aws::MarketplaceMetering
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:register_usage, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "RegisterUsage"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: RegisterUsageRequest)
+        o.output = Shapes::ShapeRef.new(shape: RegisterUsageResult)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidProductCodeException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRegionException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidPublicKeyVersionException)
+        o.errors << Shapes::ShapeRef.new(shape: PlatformNotSupportedException)
+        o.errors << Shapes::ShapeRef.new(shape: CustomerNotEntitledException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
+        o.errors << Shapes::ShapeRef.new(shape: DisabledApiException)
+      end)
+
       api.add_operation(:resolve_customer, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ResolveCustomer"
         o.http_method = "POST"
@@ -139,6 +175,7 @@ module Aws::MarketplaceMetering
         o.errors << Shapes::ShapeRef.new(shape: ExpiredTokenException)
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
+        o.errors << Shapes::ShapeRef.new(shape: DisabledApiException)
       end)
     end
 

data/lib/aws-sdk-marketplacemetering/types.rb

@@ -119,6 +119,7 @@ module Aws::MarketplaceMetering
     end
 
     # @!attribute [rw] metering_record_id
+    #   Metering record id.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsageResult AWS API Documentation
@@ -128,6 +129,55 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass RegisterUsageRequest
+    #   data as a hash:
+    #
+    #       {
+    #         product_code: "ProductCode", # required
+    #         public_key_version: 1, # required
+    #         nonce: "Nonce",
+    #       }
+    #
+    # @!attribute [rw] 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 [String]
+    #
+    # @!attribute [rw] public_key_version
+    #   Public Key Version provided by AWS Marketplace
+    #   @return [Integer]
+    #
+    # @!attribute [rw] nonce
+    #   (Optional) To scope down the registration to a specific running
+    #   software instance and guard against replay attacks.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsageRequest AWS API Documentation
+    #
+    class RegisterUsageRequest < Struct.new(
+      :product_code,
+      :public_key_version,
+      :nonce)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] public_key_rotation_timestamp
+    #   (Optional) Only included when public key version has expired
+    #   @return [Time]
+    #
+    # @!attribute [rw] signature
+    #   JWT Token
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/RegisterUsageResult AWS API Documentation
+    #
+    class RegisterUsageResult < Struct.new(
+      :public_key_rotation_timestamp,
+      :signature)
+      include Aws::Structure
+    end
+
     # Contains input to the ResolveCustomer operation.
     #
     # @note When making an API call, you may pass ResolveCustomerRequest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-marketplacemetering
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core