@aws-sdk/client-marketplace-entitlement-service 3.379.1 → 3.382.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.
@@ -19,11 +19,13 @@ export type GetEntitlementFilterName = (typeof GetEntitlementFilterName)[keyof t
19
19
  */
20
20
  export interface GetEntitlementsRequest {
21
21
  /**
22
+ * @public
22
23
  * <p>Product code is used to uniquely identify a product in AWS Marketplace. The product code
23
24
  * will be provided by AWS Marketplace when the product listing is created.</p>
24
25
  */
25
26
  ProductCode: string | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>Filter is used to return entitlements for a specific customer or for a specific
28
30
  * dimension. Filters are described as keys mapped to a lists of values. Filtered requests are
29
31
  * <i>unioned</i> for each value in the value list, and then
@@ -31,11 +33,13 @@ export interface GetEntitlementsRequest {
31
33
  */
32
34
  Filter?: Record<string, string[]>;
33
35
  /**
36
+ * @public
34
37
  * <p>For paginated calls to GetEntitlements, pass the NextToken from the previous
35
38
  * GetEntitlementsResult.</p>
36
39
  */
37
40
  NextToken?: string;
38
41
  /**
42
+ * @public
39
43
  * <p>The maximum number of items to retrieve from the GetEntitlements operation. For
40
44
  * pagination, use the NextToken field in subsequent calls to GetEntitlements.</p>
41
45
  */
@@ -48,21 +52,25 @@ export interface GetEntitlementsRequest {
48
52
  */
49
53
  export interface EntitlementValue {
50
54
  /**
55
+ * @public
51
56
  * <p>The IntegerValue field will be populated with an integer value when the entitlement is an
52
57
  * integer type. Otherwise, the field will not be set.</p>
53
58
  */
54
59
  IntegerValue?: number;
55
60
  /**
61
+ * @public
56
62
  * <p>The DoubleValue field will be populated with a double value when the entitlement is a
57
63
  * double type. Otherwise, the field will not be set.</p>
58
64
  */
59
65
  DoubleValue?: number;
60
66
  /**
67
+ * @public
61
68
  * <p>The BooleanValue field will be populated with a boolean value when the entitlement is a
62
69
  * boolean type. Otherwise, the field will not be set.</p>
63
70
  */
64
71
  BooleanValue?: boolean;
65
72
  /**
73
+ * @public
66
74
  * <p>The StringValue field will be populated with a string value when the entitlement is a
67
75
  * string type. Otherwise, the field will not be set.</p>
68
76
  */
@@ -76,28 +84,33 @@ export interface EntitlementValue {
76
84
  */
77
85
  export interface Entitlement {
78
86
  /**
87
+ * @public
79
88
  * <p>The product code for which the given entitlement applies. Product codes are provided by
80
89
  * AWS Marketplace when the product listing is created.</p>
81
90
  */
82
91
  ProductCode?: string;
83
92
  /**
93
+ * @public
84
94
  * <p>The dimension for which the given entitlement applies. Dimensions represent categories of
85
95
  * capacity in a product and are specified when the product is listed in AWS
86
96
  * Marketplace.</p>
87
97
  */
88
98
  Dimension?: string;
89
99
  /**
100
+ * @public
90
101
  * <p>The customer identifier is a handle to each unique customer in an application. Customer
91
102
  * identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering
92
103
  * Service.</p>
93
104
  */
94
105
  CustomerIdentifier?: string;
95
106
  /**
107
+ * @public
96
108
  * <p>The EntitlementValue represents the amount of capacity that the customer is entitled to
97
109
  * for the product.</p>
98
110
  */
99
111
  Value?: EntitlementValue;
100
112
  /**
113
+ * @public
101
114
  * <p>The expiration date represents the minimum date through which this entitlement is
102
115
  * expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date
103
116
  * is the date at which the customer will renew or cancel their contract. Customers who are opting
@@ -111,12 +124,14 @@ export interface Entitlement {
111
124
  */
112
125
  export interface GetEntitlementsResult {
113
126
  /**
127
+ * @public
114
128
  * <p>The set of entitlements found through the GetEntitlements operation. If the result
115
129
  * contains an empty set of entitlements, NextToken might still be present and should be
116
130
  * used.</p>
117
131
  */
118
132
  Entitlements?: Entitlement[];
119
133
  /**
134
+ * @public
120
135
  * <p>For paginated results, use NextToken in subsequent calls to GetEntitlements. If the
121
136
  * result contains an empty set of entitlements, NextToken might still be present and should be
122
137
  * used.</p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-marketplace-entitlement-service",
3
3
  "description": "AWS SDK for JavaScript Marketplace Entitlement Service Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",