Skip to content

Commit b884b35

Browse files
author
awstools
committed
feat(client-marketplace-entitlement-service): Added License Arn as a new optional filter for GetEntitlements and LicenseArn field in each entitlement in the response.
1 parent f5f5c09 commit b884b35

5 files changed

Lines changed: 32 additions & 14 deletions

File tree

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,7 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
3232

3333
/**
3434
* <p>GetEntitlements retrieves entitlement values for a given product. The results can be
35-
* filtered based on customer identifier, AWS account ID, or product dimensions.</p>
36-
* <important>
37-
* <p>
38-
* The <code>CustomerIdentifier</code> parameter is on path for deprecation. Use <code>CustomerAWSAccountID</code> instead.</p>
39-
* <p>These parameters are mutually exclusive. You can't specify both <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> in the same request.
40-
* </p>
41-
* </important>
35+
* filtered based on customer identifier, AWS account ID, license ARN, or product dimensions.</p>
4236
* @example
4337
* Use a bare-bones client and the command you need to make an API call.
4438
* ```javascript
@@ -73,6 +67,7 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M
7367
* // StringValue: "STRING_VALUE",
7468
* // },
7569
* // ExpirationDate: new Date("TIMESTAMP"),
70+
* // LicenseArn: "STRING_VALUE",
7671
* // },
7772
* // ],
7873
* // NextToken: "STRING_VALUE",

‎clients/client-marketplace-entitlement-service/src/models/enums.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ export const GetEntitlementFilterName = {
77
CUSTOMER_AWS_ACCOUNT_ID: "CUSTOMER_AWS_ACCOUNT_ID",
88
CUSTOMER_IDENTIFIER: "CUSTOMER_IDENTIFIER",
99
DIMENSION: "DIMENSION",
10+
LICENSE_ARN: "LICENSE_ARN",
1011
} as const;
1112
/**
1213
* @public

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@ export interface GetEntitlementsRequest {
2020
* <i>unioned</i> for each value in the value list, and then
2121
* <i>intersected</i> for each filter key.</p>
2222
* <p>
23-
* <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> are mutually exclusive. You can't specify both in the same request.
23+
* <code>CustomerIdentifier</code> and <code>CustomerAWSAccountId</code> are mutually exclusive parameters. You must use one or the other, but not both in the same request.
2424
* </p>
25+
* <note>
26+
* <p>If you're migrating an existing integration, use <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-account.html">Account Feeds</a> to map <code>CustomerIdentifier</code> to <code>CustomerAWSAccountId</code>, and <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-agreements.html">Agreements Feeds</a> to map <code>CustomerAWSAccountId</code> and <code>LicenseArn</code>.</p>
27+
* </note>
2528
* @public
2629
*/
2730
Filter?: Partial<Record<GetEntitlementFilterName, string[]>> | undefined;
@@ -108,7 +111,7 @@ export interface Entitlement {
108111

109112
/**
110113
* <p>
111-
* The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer.
114+
* The <code>CustomerAWSAccountId</code> parameter specifies the AWS account ID of the buyer.
112115
* </p>
113116
* @public
114117
*/
@@ -129,6 +132,12 @@ export interface Entitlement {
129132
* @public
130133
*/
131134
ExpirationDate?: Date | undefined;
135+
136+
/**
137+
* <p>The <code>LicenseArn</code> is a unique identifier for a specific granted license. These are used for software purchased through AWS Marketplace.</p>
138+
* @public
139+
*/
140+
LicenseArn?: string | undefined;
132141
}
133142

134143
/**

‎clients/client-marketplace-entitlement-service/src/schemas/schemas_0.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const _GERe = "GetEntitlementsResult";
1616
const _IPE = "InvalidParameterException";
1717
const _ISEE = "InternalServiceErrorException";
1818
const _IV = "IntegerValue";
19+
const _LA = "LicenseArn";
1920
const _MR = "MaxResults";
2021
const _NT = "NextToken";
2122
const _PC = "ProductCode";
@@ -76,8 +77,8 @@ export const errorTypeRegistries = [
7677
]
7778
export var Entitlement$: StaticStructureSchema = [3, n0, _E,
7879
0,
79-
[_PC, _D, _CI, _CAWSAI, _V, _ED],
80-
[0, 0, 0, 0, () => EntitlementValue$, 4]
80+
[_PC, _D, _CI, _CAWSAI, _V, _ED, _LA],
81+
[0, 0, 0, 0, () => EntitlementValue$, 4, 0]
8182
];
8283
export var EntitlementValue$: StaticStructureSchema = [3, n0, _EV,
8384
0,

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -930,7 +930,7 @@
930930
"CustomerAWSAccountId": {
931931
"target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString",
932932
"traits": {
933-
"smithy.api#documentation": "<p>\n The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer.\n </p>"
933+
"smithy.api#documentation": "<p>\n The <code>CustomerAWSAccountId</code> parameter specifies the AWS account ID of the buyer.\n </p>"
934934
}
935935
},
936936
"Value": {
@@ -944,6 +944,12 @@
944944
"traits": {
945945
"smithy.api#documentation": "<p>The expiration date represents the minimum date through which this entitlement is\n expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date\n is the date at which the customer will renew or cancel their contract. Customers who are opting\n to renew their contract will still have entitlements with an expiration date.</p>"
946946
}
947+
},
948+
"LicenseArn": {
949+
"target": "com.amazonaws.marketplaceentitlementservice#String",
950+
"traits": {
951+
"smithy.api#documentation": "<p>The <code>LicenseArn</code> is a unique identifier for a specific granted license. These are used for software purchased through AWS Marketplace.</p>"
952+
}
947953
}
948954
},
949955
"traits": {
@@ -1030,6 +1036,12 @@
10301036
"traits": {
10311037
"smithy.api#enumValue": "CUSTOMER_AWS_ACCOUNT_ID"
10321038
}
1039+
},
1040+
"LICENSE_ARN": {
1041+
"target": "smithy.api#Unit",
1042+
"traits": {
1043+
"smithy.api#enumValue": "LICENSE_ARN"
1044+
}
10331045
}
10341046
}
10351047
},
@@ -1062,7 +1074,7 @@
10621074
}
10631075
],
10641076
"traits": {
1065-
"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>",
1077+
"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, license ARN, or product dimensions.</p>",
10661078
"smithy.api#paginated": {
10671079
"inputToken": "NextToken",
10681080
"outputToken": "NextToken",
@@ -1083,7 +1095,7 @@
10831095
"Filter": {
10841096
"target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters",
10851097
"traits": {
1086-
"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>"
1098+
"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 parameters. You must use one or the other, but not both in the same request.\n </p>\n <note>\n <p>If you're migrating an existing integration, use <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-account.html\">Account Feeds</a> to map <code>CustomerIdentifier</code> to <code>CustomerAWSAccountId</code>, and <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-agreements.html\">Agreements Feeds</a> to map <code>CustomerAWSAccountId</code> and <code>LicenseArn</code>.</p>\n </note>"
10871099
}
10881100
},
10891101
"NextToken": {

0 commit comments

Comments
 (0)