@aws-sdk/client-marketplace-metering 3.774.0 → 3.777.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,71 +6,146 @@
6
6
 
7
7
  AWS SDK for JavaScript MarketplaceMetering Client for Node.js, Browser and React Native.
8
8
 
9
- <fullname>AWS Marketplace Metering Service</fullname>
9
+ <fullname>Amazon Web Services Marketplace Metering Service</fullname>
10
10
 
11
- <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
12
- API.</p>
13
- <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
11
+ <p>This reference provides descriptions of the low-level Marketplace Metering Service API.</p>
12
+ <p>Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
14
13
  dimensions.</p>
15
- <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html">AWS Marketplace metering and entitlement API permissions</a> in the
16
- <i>AWS Marketplace Seller Guide.</i>
14
+ <p>For information about the permissions that you need to use this API, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html">Amazon Web Services Marketplace metering and entitlement API permissions</a> in the <i>Amazon Web Services Marketplace
15
+ Seller Guide.</i>
17
16
  </p>
18
17
  <p>
19
- <b>Submitting Metering Records</b>
18
+ <b>Submitting metering records</b>
19
+ </p>
20
+ <p>
21
+ <i>MeterUsage</i>
20
22
  </p>
21
23
  <ul>
22
24
  <li>
23
- <p>
24
- <i>MeterUsage</i> - Submits the metering record for an AWS
25
- Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
26
- container running on EKS or ECS.</p>
25
+ <p>Submits the metering record for an Amazon Web Services Marketplace product.</p>
26
+ </li>
27
+ <li>
28
+ <p>Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
29
+ Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)</p>
30
+ </li>
31
+ <li>
32
+ <p>Supported product types: Amazon Machine Images (AMIs) and containers</p>
27
33
  </li>
28
34
  <li>
35
+ <p>Vendor-metered tagging: Supported allocation tagging</p>
36
+ </li>
37
+ </ul>
29
38
  <p>
30
- <i>BatchMeterUsage</i> - Submits the metering record for a set of
31
- customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
32
- (SaaS) application.</p>
39
+ <i>BatchMeterUsage</i>
40
+ </p>
41
+ <ul>
42
+ <li>
43
+ <p>Submits the metering record for a set of customers.
44
+ <code>BatchMeterUsage</code> API calls are captured by CloudTrail. You can use
45
+ CloudTrail to verify that the software as a subscription (SaaS) metering records that
46
+ you sent are accurate by searching for records with the <code>eventName</code>
47
+ of <code>BatchMeterUsage</code>. You can also use CloudTrail to audit records over
48
+ time. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">CloudTrail User
49
+ Guide</a>.</p>
50
+ </li>
51
+ <li>
52
+ <p>Called from: SaaS applications</p>
53
+ </li>
54
+ <li>
55
+ <p>Supported product type: SaaS</p>
56
+ </li>
57
+ <li>
58
+ <p>Vendor-metered tagging: Supports allocation tagging</p>
33
59
  </li>
34
60
  </ul>
35
61
  <p>
36
- <b>Accepting New Customers</b>
62
+ <b>Accepting new customers</b>
63
+ </p>
64
+ <p>
65
+ <i>ResolveCustomer</i>
37
66
  </p>
38
67
  <ul>
39
68
  <li>
69
+ <p>Resolves the registration token that the buyer submits through the browser
70
+ during the registration process. Obtains a <code>CustomerIdentifier</code> along
71
+ with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
72
+ </li>
73
+ <li>
74
+ <p>Called from: SaaS application during the registration process</p>
75
+ </li>
76
+ <li>
77
+ <p>Supported product type: SaaS</p>
78
+ </li>
79
+ <li>
80
+ <p>Vendor-metered tagging: Not applicable</p>
81
+ </li>
82
+ </ul>
40
83
  <p>
41
- <i>ResolveCustomer</i> - Called by a SaaS application during the
42
- registration process. When a buyer visits your website during the registration
43
- process, the buyer submits a Registration Token through the browser. The
44
- Registration Token is resolved through this API to obtain a
45
- <code>CustomerIdentifier</code>
46
-
47
- along with the <code>CustomerAWSAccountId</code> and
48
- <code>ProductCode</code>.</p>
49
-
84
+ <b>Entitlement and metering for paid container
85
+ products</b>
86
+ </p>
87
+ <p>
88
+ <i>RegisteredUsage</i>
89
+ </p>
90
+ <ul>
91
+ <li>
92
+ <p>Provides software entitlement and metering. Paid container software products
93
+ sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
94
+ <code>RegisterUsage</code> operation. Free and Bring Your Own License model
95
+ (BYOL) products for Amazon ECS or Amazon EKS aren't required to call
96
+ <code>RegisterUsage</code>. However, you can do so if you want to receive
97
+ usage data in your seller reports. For more information about using the
98
+ <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
99
+ </li>
100
+ <li>
101
+ <p>Called from: Paid container software products</p>
102
+ </li>
103
+ <li>
104
+ <p>Supported product type: Containers</p>
105
+ </li>
106
+ <li>
107
+ <p>Vendor-metered tagging: Not applicable</p>
50
108
  </li>
51
109
  </ul>
52
110
  <p>
53
- <b>Entitlement and Metering for Paid Container Products</b>
111
+ <b>Entitlement custom metering for container
112
+ products</b>
54
113
  </p>
55
114
  <ul>
56
115
  <li>
57
- <p>Paid container software products sold through AWS Marketplace must integrate
58
- with the AWS Marketplace Metering Service and call the
59
- <code>RegisterUsage</code> operation for software entitlement and metering.
60
- Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
61
- <code>RegisterUsage</code>, but you can do so if you want to receive usage
62
- data in your seller reports. For more information on using the
63
- <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
116
+ <p>MeterUsage API is available in GovCloud Regions but only supports AMI
117
+ FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
118
+ products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
119
+ For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
120
+ </li>
121
+ <li>
122
+ <p>Custom metering for container products are called using the
123
+ MeterUsage API. The API is used for FCP AMI and FCP Container product
124
+ metering.</p>
64
125
  </li>
65
126
  </ul>
66
127
  <p>
67
- <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
68
- Cloudtrail to verify that the SaaS metering records that you sent are accurate by
69
- searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
70
- You can also use CloudTrail to audit records over time. For more information, see the
71
- <i>
72
- <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">AWS CloudTrail User Guide</a>.</i>
128
+ <b>Custom metering for Amazon EKS is available in 17
129
+ Amazon Web Services Regions</b>
73
130
  </p>
131
+ <ul>
132
+ <li>
133
+ <p>The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
134
+ (FCP) products using MeterUsage API. Amazon ECS is supported in all
135
+ Amazon Web Services Regions that MeterUsage API is available except for
136
+ GovCloud.</p>
137
+ </li>
138
+ <li>
139
+ <p>Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
140
+ us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
141
+ ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
142
+ ca-central-1, sa-east-1.</p>
143
+ <note>
144
+ <p>For questions about adding Amazon Web Services Regions for metering, contact <a href="mailto://aws.amazon.com/marketplace/management/contact-us/">Amazon Web Services
145
+ Marketplace Seller Operations</a>.</p>
146
+ </note>
147
+ </li>
148
+ </ul>
74
149
 
75
150
  ## Installing
76
151
 
@@ -40,8 +40,6 @@ const defaultMarketplaceMeteringHttpAuthSchemeProvider = (authParameters) => {
40
40
  exports.defaultMarketplaceMeteringHttpAuthSchemeProvider = defaultMarketplaceMeteringHttpAuthSchemeProvider;
41
41
  const resolveHttpAuthSchemeConfig = (config) => {
42
42
  const config_0 = (0, core_1.resolveAwsSdkSigV4Config)(config);
43
- return {
44
- ...config_0,
45
- };
43
+ return Object.assign(config_0, {});
46
44
  };
47
45
  exports.resolveHttpAuthSchemeConfig = resolveHttpAuthSchemeConfig;
package/dist-cjs/index.js CHANGED
@@ -65,12 +65,11 @@ var import_httpAuthSchemeProvider = require("./auth/httpAuthSchemeProvider");
65
65
 
66
66
  // src/endpoint/EndpointParameters.ts
67
67
  var resolveClientEndpointParameters = /* @__PURE__ */ __name((options) => {
68
- return {
69
- ...options,
68
+ return Object.assign(options, {
70
69
  useDualstackEndpoint: options.useDualstackEndpoint ?? false,
71
70
  useFipsEndpoint: options.useFipsEndpoint ?? false,
72
71
  defaultSigningName: "aws-marketplace"
73
- };
72
+ });
74
73
  }, "resolveClientEndpointParameters");
75
74
  var commonParams = {
76
75
  UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
@@ -127,22 +126,21 @@ var resolveHttpAuthRuntimeConfig = /* @__PURE__ */ __name((config) => {
127
126
  }, "resolveHttpAuthRuntimeConfig");
128
127
 
129
128
  // src/runtimeExtensions.ts
130
- var asPartial = /* @__PURE__ */ __name((t) => t, "asPartial");
131
129
  var resolveRuntimeExtensions = /* @__PURE__ */ __name((runtimeConfig, extensions) => {
132
- const extensionConfiguration = {
133
- ...asPartial((0, import_region_config_resolver.getAwsRegionExtensionConfiguration)(runtimeConfig)),
134
- ...asPartial((0, import_smithy_client.getDefaultExtensionConfiguration)(runtimeConfig)),
135
- ...asPartial((0, import_protocol_http.getHttpHandlerExtensionConfiguration)(runtimeConfig)),
136
- ...asPartial(getHttpAuthExtensionConfiguration(runtimeConfig))
137
- };
130
+ const extensionConfiguration = Object.assign(
131
+ (0, import_region_config_resolver.getAwsRegionExtensionConfiguration)(runtimeConfig),
132
+ (0, import_smithy_client.getDefaultExtensionConfiguration)(runtimeConfig),
133
+ (0, import_protocol_http.getHttpHandlerExtensionConfiguration)(runtimeConfig),
134
+ getHttpAuthExtensionConfiguration(runtimeConfig)
135
+ );
138
136
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
139
- return {
140
- ...runtimeConfig,
141
- ...(0, import_region_config_resolver.resolveAwsRegionExtensionConfiguration)(extensionConfiguration),
142
- ...(0, import_smithy_client.resolveDefaultRuntimeConfig)(extensionConfiguration),
143
- ...(0, import_protocol_http.resolveHttpHandlerRuntimeConfig)(extensionConfiguration),
144
- ...resolveHttpAuthRuntimeConfig(extensionConfiguration)
145
- };
137
+ return Object.assign(
138
+ runtimeConfig,
139
+ (0, import_region_config_resolver.resolveAwsRegionExtensionConfiguration)(extensionConfiguration),
140
+ (0, import_smithy_client.resolveDefaultRuntimeConfig)(extensionConfiguration),
141
+ (0, import_protocol_http.resolveHttpHandlerRuntimeConfig)(extensionConfiguration),
142
+ resolveHttpAuthRuntimeConfig(extensionConfiguration)
143
+ );
146
144
  }, "resolveRuntimeExtensions");
147
145
 
148
146
  // src/MarketplaceMeteringClient.ts
@@ -156,6 +154,8 @@ var MarketplaceMeteringClient = class extends import_smithy_client.Client {
156
154
  config;
157
155
  constructor(...[configuration]) {
158
156
  const _config_0 = (0, import_runtimeConfig.getRuntimeConfig)(configuration || {});
157
+ super(_config_0);
158
+ this.initConfig = _config_0;
159
159
  const _config_1 = resolveClientEndpointParameters(_config_0);
160
160
  const _config_2 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_1);
161
161
  const _config_3 = (0, import_middleware_retry.resolveRetryConfig)(_config_2);
@@ -164,7 +164,6 @@ var MarketplaceMeteringClient = class extends import_smithy_client.Client {
164
164
  const _config_6 = (0, import_middleware_endpoint.resolveEndpointConfig)(_config_5);
165
165
  const _config_7 = (0, import_httpAuthSchemeProvider.resolveHttpAuthSchemeConfig)(_config_6);
166
166
  const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
167
- super(_config_8);
168
167
  this.config = _config_8;
169
168
  this.middlewareStack.use((0, import_middleware_user_agent.getUserAgentPlugin)(this.config));
170
169
  this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
@@ -848,6 +847,7 @@ var se_MeterUsageRequest = /* @__PURE__ */ __name((input, context) => {
848
847
  }, "se_MeterUsageRequest");
849
848
  var se_UsageRecord = /* @__PURE__ */ __name((input, context) => {
850
849
  return (0, import_smithy_client.take)(input, {
850
+ CustomerAWSAccountId: [],
851
851
  CustomerIdentifier: [],
852
852
  Dimension: [],
853
853
  Quantity: [],
@@ -874,6 +874,7 @@ var de_RegisterUsageResult = /* @__PURE__ */ __name((output, context) => {
874
874
  }, "de_RegisterUsageResult");
875
875
  var de_UsageRecord = /* @__PURE__ */ __name((output, context) => {
876
876
  return (0, import_smithy_client.take)(output, {
877
+ CustomerAWSAccountId: import_smithy_client.expectString,
877
878
  CustomerIdentifier: import_smithy_client.expectString,
878
879
  Dimension: import_smithy_client.expectString,
879
880
  Quantity: import_smithy_client.expectInt32,
@@ -17,6 +17,8 @@ export class MarketplaceMeteringClient extends __Client {
17
17
  config;
18
18
  constructor(...[configuration]) {
19
19
  const _config_0 = __getRuntimeConfig(configuration || {});
20
+ super(_config_0);
21
+ this.initConfig = _config_0;
20
22
  const _config_1 = resolveClientEndpointParameters(_config_0);
21
23
  const _config_2 = resolveUserAgentConfig(_config_1);
22
24
  const _config_3 = resolveRetryConfig(_config_2);
@@ -25,7 +27,6 @@ export class MarketplaceMeteringClient extends __Client {
25
27
  const _config_6 = resolveEndpointConfig(_config_5);
26
28
  const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
27
29
  const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
28
- super(_config_8);
29
30
  this.config = _config_8;
30
31
  this.middlewareStack.use(getUserAgentPlugin(this.config));
31
32
  this.middlewareStack.use(getRetryPlugin(this.config));
@@ -35,7 +35,5 @@ export const defaultMarketplaceMeteringHttpAuthSchemeProvider = (authParameters)
35
35
  };
36
36
  export const resolveHttpAuthSchemeConfig = (config) => {
37
37
  const config_0 = resolveAwsSdkSigV4Config(config);
38
- return {
39
- ...config_0,
40
- };
38
+ return Object.assign(config_0, {});
41
39
  };
@@ -1,10 +1,9 @@
1
1
  export const resolveClientEndpointParameters = (options) => {
2
- return {
3
- ...options,
2
+ return Object.assign(options, {
4
3
  useDualstackEndpoint: options.useDualstackEndpoint ?? false,
5
4
  useFipsEndpoint: options.useFipsEndpoint ?? false,
6
5
  defaultSigningName: "aws-marketplace",
7
- };
6
+ });
8
7
  };
9
8
  export const commonParams = {
10
9
  UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
@@ -317,6 +317,7 @@ const se_MeterUsageRequest = (input, context) => {
317
317
  };
318
318
  const se_UsageRecord = (input, context) => {
319
319
  return take(input, {
320
+ CustomerAWSAccountId: [],
320
321
  CustomerIdentifier: [],
321
322
  Dimension: [],
322
323
  Quantity: [],
@@ -345,6 +346,7 @@ const de_RegisterUsageResult = (output, context) => {
345
346
  };
346
347
  const de_UsageRecord = (output, context) => {
347
348
  return take(output, {
349
+ CustomerAWSAccountId: __expectString,
348
350
  CustomerIdentifier: __expectString,
349
351
  Dimension: __expectString,
350
352
  Quantity: __expectInt32,
@@ -2,20 +2,8 @@ import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfigurat
2
2
  import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
3
3
  import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
4
4
  import { getHttpAuthExtensionConfiguration, resolveHttpAuthRuntimeConfig } from "./auth/httpAuthExtensionConfiguration";
5
- const asPartial = (t) => t;
6
5
  export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
7
- const extensionConfiguration = {
8
- ...asPartial(getAwsRegionExtensionConfiguration(runtimeConfig)),
9
- ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
10
- ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
11
- ...asPartial(getHttpAuthExtensionConfiguration(runtimeConfig)),
12
- };
6
+ const extensionConfiguration = Object.assign(getAwsRegionExtensionConfiguration(runtimeConfig), getDefaultExtensionConfiguration(runtimeConfig), getHttpHandlerExtensionConfiguration(runtimeConfig), getHttpAuthExtensionConfiguration(runtimeConfig));
13
7
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
14
- return {
15
- ...runtimeConfig,
16
- ...resolveAwsRegionExtensionConfiguration(extensionConfiguration),
17
- ...resolveDefaultRuntimeConfig(extensionConfiguration),
18
- ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
19
- ...resolveHttpAuthRuntimeConfig(extensionConfiguration),
20
- };
8
+ return Object.assign(runtimeConfig, resolveAwsRegionExtensionConfiguration(extensionConfiguration), resolveDefaultRuntimeConfig(extensionConfiguration), resolveHttpHandlerRuntimeConfig(extensionConfiguration), resolveHttpAuthRuntimeConfig(extensionConfiguration));
21
9
  };
@@ -31,69 +31,145 @@ export interface MarketplaceMetering {
31
31
  resolveCustomer(args: ResolveCustomerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveCustomerCommandOutput) => void): void;
32
32
  }
33
33
  /**
34
- * <fullname>AWS Marketplace Metering Service</fullname>
35
- * <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
36
- * API.</p>
37
- * <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
34
+ * <fullname>Amazon Web Services Marketplace Metering Service</fullname>
35
+ * <p>This reference provides descriptions of the low-level Marketplace Metering Service API.</p>
36
+ * <p>Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
38
37
  * dimensions.</p>
39
- * <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html">AWS Marketplace metering and entitlement API permissions</a> in the
40
- * <i>AWS Marketplace Seller Guide.</i>
38
+ * <p>For information about the permissions that you need to use this API, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html">Amazon Web Services Marketplace metering and entitlement API permissions</a> in the <i>Amazon Web Services Marketplace
39
+ * Seller Guide.</i>
41
40
  * </p>
42
41
  * <p>
43
- * <b>Submitting Metering Records</b>
42
+ * <b>Submitting metering records</b>
43
+ * </p>
44
+ * <p>
45
+ * <i>MeterUsage</i>
46
+ * </p>
47
+ * <ul>
48
+ * <li>
49
+ * <p>Submits the metering record for an Amazon Web Services Marketplace product.</p>
50
+ * </li>
51
+ * <li>
52
+ * <p>Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
53
+ * Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)</p>
54
+ * </li>
55
+ * <li>
56
+ * <p>Supported product types: Amazon Machine Images (AMIs) and containers</p>
57
+ * </li>
58
+ * <li>
59
+ * <p>Vendor-metered tagging: Supported allocation tagging</p>
60
+ * </li>
61
+ * </ul>
62
+ * <p>
63
+ * <i>BatchMeterUsage</i>
64
+ * </p>
65
+ * <ul>
66
+ * <li>
67
+ * <p>Submits the metering record for a set of customers.
68
+ * <code>BatchMeterUsage</code> API calls are captured by CloudTrail. You can use
69
+ * CloudTrail to verify that the software as a subscription (SaaS) metering records that
70
+ * you sent are accurate by searching for records with the <code>eventName</code>
71
+ * of <code>BatchMeterUsage</code>. You can also use CloudTrail to audit records over
72
+ * time. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">CloudTrail User
73
+ * Guide</a>.</p>
74
+ * </li>
75
+ * <li>
76
+ * <p>Called from: SaaS applications</p>
77
+ * </li>
78
+ * <li>
79
+ * <p>Supported product type: SaaS</p>
80
+ * </li>
81
+ * <li>
82
+ * <p>Vendor-metered tagging: Supports allocation tagging</p>
83
+ * </li>
84
+ * </ul>
85
+ * <p>
86
+ * <b>Accepting new customers</b>
87
+ * </p>
88
+ * <p>
89
+ * <i>ResolveCustomer</i>
44
90
  * </p>
45
91
  * <ul>
46
92
  * <li>
47
- * <p>
48
- * <i>MeterUsage</i> - Submits the metering record for an AWS
49
- * Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
50
- * container running on EKS or ECS.</p>
93
+ * <p>Resolves the registration token that the buyer submits through the browser
94
+ * during the registration process. Obtains a <code>CustomerIdentifier</code> along
95
+ * with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
96
+ * </li>
97
+ * <li>
98
+ * <p>Called from: SaaS application during the registration process</p>
51
99
  * </li>
52
100
  * <li>
53
- * <p>
54
- * <i>BatchMeterUsage</i> - Submits the metering record for a set of
55
- * customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
56
- * (SaaS) application.</p>
101
+ * <p>Supported product type: SaaS</p>
102
+ * </li>
103
+ * <li>
104
+ * <p>Vendor-metered tagging: Not applicable</p>
57
105
  * </li>
58
106
  * </ul>
59
107
  * <p>
60
- * <b>Accepting New Customers</b>
108
+ * <b>Entitlement and metering for paid container
109
+ * products</b>
110
+ * </p>
111
+ * <p>
112
+ * <i>RegisteredUsage</i>
61
113
  * </p>
62
114
  * <ul>
63
115
  * <li>
64
- * <p>
65
- * <i>ResolveCustomer</i> - Called by a SaaS application during the
66
- * registration process. When a buyer visits your website during the registration
67
- * process, the buyer submits a Registration Token through the browser. The
68
- * Registration Token is resolved through this API to obtain a
69
- * <code>CustomerIdentifier</code>
70
- *
71
- * along with the <code>CustomerAWSAccountId</code> and
72
- * <code>ProductCode</code>.</p>
116
+ * <p>Provides software entitlement and metering. Paid container software products
117
+ * sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
118
+ * <code>RegisterUsage</code> operation. Free and Bring Your Own License model
119
+ * (BYOL) products for Amazon ECS or Amazon EKS aren't required to call
120
+ * <code>RegisterUsage</code>. However, you can do so if you want to receive
121
+ * usage data in your seller reports. For more information about using the
122
+ * <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
123
+ * </li>
124
+ * <li>
125
+ * <p>Called from: Paid container software products</p>
126
+ * </li>
127
+ * <li>
128
+ * <p>Supported product type: Containers</p>
129
+ * </li>
130
+ * <li>
131
+ * <p>Vendor-metered tagging: Not applicable</p>
73
132
  * </li>
74
133
  * </ul>
75
134
  * <p>
76
- * <b>Entitlement and Metering for Paid Container Products</b>
135
+ * <b>Entitlement custom metering for container
136
+ * products</b>
77
137
  * </p>
78
138
  * <ul>
79
139
  * <li>
80
- * <p>Paid container software products sold through AWS Marketplace must integrate
81
- * with the AWS Marketplace Metering Service and call the
82
- * <code>RegisterUsage</code> operation for software entitlement and metering.
83
- * Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
84
- * <code>RegisterUsage</code>, but you can do so if you want to receive usage
85
- * data in your seller reports. For more information on using the
86
- * <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
140
+ * <p>MeterUsage API is available in GovCloud Regions but only supports AMI
141
+ * FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
142
+ * products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
143
+ * For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
144
+ * </li>
145
+ * <li>
146
+ * <p>Custom metering for container products are called using the
147
+ * MeterUsage API. The API is used for FCP AMI and FCP Container product
148
+ * metering.</p>
87
149
  * </li>
88
150
  * </ul>
89
151
  * <p>
90
- * <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
91
- * Cloudtrail to verify that the SaaS metering records that you sent are accurate by
92
- * searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
93
- * You can also use CloudTrail to audit records over time. For more information, see the
94
- * <i>
95
- * <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">AWS CloudTrail User Guide</a>.</i>
152
+ * <b>Custom metering for Amazon EKS is available in 17
153
+ * Amazon Web Services Regions</b>
96
154
  * </p>
155
+ * <ul>
156
+ * <li>
157
+ * <p>The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
158
+ * (FCP) products using MeterUsage API. Amazon ECS is supported in all
159
+ * Amazon Web Services Regions that MeterUsage API is available except for
160
+ * GovCloud.</p>
161
+ * </li>
162
+ * <li>
163
+ * <p>Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
164
+ * us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
165
+ * ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
166
+ * ca-central-1, sa-east-1.</p>
167
+ * <note>
168
+ * <p>For questions about adding Amazon Web Services Regions for metering, contact <a href="mailto://aws.amazon.com/marketplace/management/contact-us/">Amazon Web Services
169
+ * Marketplace Seller Operations</a>.</p>
170
+ * </note>
171
+ * </li>
172
+ * </ul>
97
173
  * @public
98
174
  */
99
175
  export declare class MarketplaceMetering extends MarketplaceMeteringClient implements MarketplaceMetering {