Skip to content

Commit 17b1041

Browse files
author
awstools
committed
feat(client-marketplace-entitlement-service): This release enhances the GetEntitlements API to support new filter CUSTOMER_AWS_ACCOUNT_ID in request and CustomerAWSAccountId field in response.
1 parent 540d2d0 commit 17b1041

File tree

4 files changed

+35
-3
lines changed

4 files changed

+35
-3
lines changed

clients/client-marketplace-entitlement-service/src/commands/GetEntitlementsCommand.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
3333

3434
/**
3535
* <p>GetEntitlements retrieves entitlement values for a given product. The results can be
36-
* filtered based on customer identifier or product dimensions.</p>
36+
* filtered based on customer identifier, AWS account ID, or product dimensions.</p>
37+
* <important>
38+
* <p>
39+
* The <code>CustomerIdentifier</code> parameter is on path for deprecation. Use <code>CustomerAWSAccountID</code> instead.</p>
40+
* <p>These parameters are mutually exclusive. You can't specify both <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> in the same request.
41+
* </p>
42+
* </important>
3743
* @example
3844
* Use a bare-bones client and the command you need to make an API call.
3945
* ```javascript
@@ -58,6 +64,7 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
5864
* // ProductCode: "STRING_VALUE",
5965
* // Dimension: "STRING_VALUE",
6066
* // CustomerIdentifier: "STRING_VALUE",
67+
* // CustomerAWSAccountId: "STRING_VALUE",
6168
* // Value: { // EntitlementValue
6269
* // IntegerValue: Number("int"),
6370
* // DoubleValue: Number("double"),

clients/client-marketplace-entitlement-service/src/models/models_0.ts

+12
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { MarketplaceEntitlementServiceServiceException as __BaseException } from
88
* @enum
99
*/
1010
export const GetEntitlementFilterName = {
11+
CUSTOMER_AWS_ACCOUNT_ID: "CUSTOMER_AWS_ACCOUNT_ID",
1112
CUSTOMER_IDENTIFIER: "CUSTOMER_IDENTIFIER",
1213
DIMENSION: "DIMENSION",
1314
} as const;
@@ -35,6 +36,9 @@ export interface GetEntitlementsRequest {
3536
* dimension. Filters are described as keys mapped to a lists of values. Filtered requests are
3637
* <i>unioned</i> for each value in the value list, and then
3738
* <i>intersected</i> for each filter key.</p>
39+
* <p>
40+
* <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> are mutually exclusive. You can't specify both in the same request.
41+
* </p>
3842
* @public
3943
*/
4044
Filter?: Partial<Record<GetEntitlementFilterName, string[]>> | undefined;
@@ -119,6 +123,14 @@ export interface Entitlement {
119123
*/
120124
CustomerIdentifier?: string | undefined;
121125

126+
/**
127+
* <p>
128+
* The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer.
129+
* </p>
130+
* @public
131+
*/
132+
CustomerAWSAccountId?: string | undefined;
133+
122134
/**
123135
* <p>The EntitlementValue represents the amount of capacity that the customer is entitled to
124136
* for the product.</p>

clients/client-marketplace-entitlement-service/src/protocols/Aws_json1_1.ts

+1
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ const de_ThrottlingExceptionRes = async (parsedOutput: any, context: __SerdeCont
153153
*/
154154
const de_Entitlement = (output: any, context: __SerdeContext): Entitlement => {
155155
return take(output, {
156+
CustomerAWSAccountId: __expectString,
156157
CustomerIdentifier: __expectString,
157158
Dimension: __expectString,
158159
ExpirationDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),

codegen/sdk-codegen/aws-models/marketplace-entitlement-service.json

+14-2
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,12 @@
766766
"smithy.api#documentation": "<p>The customer identifier is a handle to each unique customer in an application. Customer\n identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering\n Service.</p>"
767767
}
768768
},
769+
"CustomerAWSAccountId": {
770+
"target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString",
771+
"traits": {
772+
"smithy.api#documentation": "<p>\n The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer.\n </p>"
773+
}
774+
},
769775
"Value": {
770776
"target": "com.amazonaws.marketplaceentitlementservice#EntitlementValue",
771777
"traits": {
@@ -857,6 +863,12 @@
857863
"traits": {
858864
"smithy.api#enumValue": "DIMENSION"
859865
}
866+
},
867+
"CUSTOMER_AWS_ACCOUNT_ID": {
868+
"target": "smithy.api#Unit",
869+
"traits": {
870+
"smithy.api#enumValue": "CUSTOMER_AWS_ACCOUNT_ID"
871+
}
860872
}
861873
}
862874
},
@@ -889,7 +901,7 @@
889901
}
890902
],
891903
"traits": {
892-
"smithy.api#documentation": "<p>GetEntitlements retrieves entitlement values for a given product. The results can be\n filtered based on customer identifier or product dimensions.</p>",
904+
"smithy.api#documentation": "<p>GetEntitlements retrieves entitlement values for a given product. The results can be\n filtered based on customer identifier, AWS account ID, or product dimensions.</p>\n <important>\n <p>\n The <code>CustomerIdentifier</code> parameter is on path for deprecation. Use <code>CustomerAWSAccountID</code> instead.</p>\n <p>These parameters are mutually exclusive. You can't specify both <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> in the same request.\n </p>\n </important>",
893905
"smithy.api#paginated": {
894906
"inputToken": "NextToken",
895907
"outputToken": "NextToken",
@@ -910,7 +922,7 @@
910922
"Filter": {
911923
"target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters",
912924
"traits": {
913-
"smithy.api#documentation": "<p>Filter is used to return entitlements for a specific customer or for a specific\n dimension. Filters are described as keys mapped to a lists of values. Filtered requests are\n <i>unioned</i> for each value in the value list, and then\n <i>intersected</i> for each filter key.</p>"
925+
"smithy.api#documentation": "<p>Filter is used to return entitlements for a specific customer or for a specific\n dimension. Filters are described as keys mapped to a lists of values. Filtered requests are\n <i>unioned</i> for each value in the value list, and then\n <i>intersected</i> for each filter key.</p>\n <p>\n <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> are mutually exclusive. You can't specify both in the same request.\n </p>"
914926
}
915927
},
916928
"NextToken": {

0 commit comments

Comments
 (0)