github.com/aavshr/aws-sdk-go@v1.41.3/service/marketplacemetering/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package marketplacemetering provides the client and types for making API
     4  // requests to AWSMarketplace Metering.
     5  //
     6  // This reference provides descriptions of the low-level AWS Marketplace Metering
     7  // Service API.
     8  //
     9  // AWS Marketplace sellers can use this API to submit usage data for custom
    10  // usage dimensions.
    11  //
    12  // For information on the permissions you need to use this API, see AWS Marketing
    13  // metering and entitlement API permissions (https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html)
    14  // in the AWS Marketplace Seller Guide.
    15  //
    16  // Submitting Metering Records
    17  //
    18  //    * MeterUsage- Submits the metering record for a Marketplace product. MeterUsage
    19  //    is called from an EC2 instance or a container running on EKS or ECS.
    20  //
    21  //    * BatchMeterUsage- Submits the metering record for a set of customers.
    22  //    BatchMeterUsage is called from a software-as-a-service (SaaS) application.
    23  //
    24  // Accepting New Customers
    25  //
    26  //    * ResolveCustomer- Called by a SaaS application during the registration
    27  //    process. When a buyer visits your website during the registration process,
    28  //    the buyer submits a Registration Token through the browser. The Registration
    29  //    Token is resolved through this API to obtain a CustomerIdentifier and
    30  //    Product Code.
    31  //
    32  // Entitlement and Metering for Paid Container Products
    33  //
    34  //    * Paid container software products sold through AWS Marketplace must integrate
    35  //    with the AWS Marketplace Metering Service and call the RegisterUsage operation
    36  //    for software entitlement and metering. Free and BYOL products for Amazon
    37  //    ECS or Amazon EKS aren't required to call RegisterUsage, but you can do
    38  //    so if you want to receive usage data in your seller reports. For more
    39  //    information on using the RegisterUsage operation, see Container-Based
    40  //    Products (https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html).
    41  //
    42  // BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail
    43  // to verify that the SaaS metering records that you sent are accurate by searching
    44  // for records with the eventName of BatchMeterUsage. You can also use CloudTrail
    45  // to audit records over time. For more information, see the AWS CloudTrail
    46  // User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html) .
    47  //
    48  // See https://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14 for more information on this service.
    49  //
    50  // See marketplacemetering package documentation for more information.
    51  // https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacemetering/
    52  //
    53  // Using the Client
    54  //
    55  // To contact AWSMarketplace Metering with the SDK use the New function to create
    56  // a new service client. With that client you can make API requests to the service.
    57  // These clients are safe to use concurrently.
    58  //
    59  // See the SDK's documentation for more information on how to use the SDK.
    60  // https://docs.aws.amazon.com/sdk-for-go/api/
    61  //
    62  // See aws.Config documentation for more information on configuring SDK clients.
    63  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    64  //
    65  // See the AWSMarketplace Metering client MarketplaceMetering for more
    66  // information on creating client for this service.
    67  // https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacemetering/#New
    68  package marketplacemetering