Skip to content

Commit a1c879d

Browse files
author
awstools
committed
feat(client-marketplace-catalog): AWS Marketplace Catalog API now supports setting intent on requests
1 parent 28a14d4 commit a1c879d

File tree

6 files changed

+77
-15
lines changed

6 files changed

+77
-15
lines changed

‎clients/client-marketplace-catalog/src/commands/BatchDescribeEntitiesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface BatchDescribeEntitiesCommandOutput extends BatchDescribeEntitie
3232

3333
/**
3434
* @public
35-
* <p>Returns metadata and content for multiple entities.</p>
35+
* <p>Returns metadata and content for multiple entities. This is the Batch version of the <code>DescribeEntity</code> API and uses the same IAM permission action as <code>DescribeEntity</code> API.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

‎clients/client-marketplace-catalog/src/commands/DescribeChangeSetCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export interface DescribeChangeSetCommandOutput extends DescribeChangeSetRespons
4949
* // ChangeSetId: "STRING_VALUE",
5050
* // ChangeSetArn: "STRING_VALUE",
5151
* // ChangeSetName: "STRING_VALUE",
52+
* // Intent: "VALIDATE" || "APPLY",
5253
* // StartTime: "STRING_VALUE",
5354
* // EndTime: "STRING_VALUE",
5455
* // Status: "PREPARING" || "APPLYING" || "SUCCEEDED" || "CANCELLED" || "FAILED",

‎clients/client-marketplace-catalog/src/commands/StartChangeSetCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ export interface StartChangeSetCommandOutput extends StartChangeSetResponse, __M
7979
* Value: "STRING_VALUE", // required
8080
* },
8181
* ],
82+
* Intent: "VALIDATE" || "APPLY",
8283
* };
8384
* const command = new StartChangeSetCommand(input);
8485
* const response = await client.send(command);

‎clients/client-marketplace-catalog/src/models/models_0.ts

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export interface AmiProductVisibilityFilter {
118118

119119
/**
120120
* @public
121-
* <p>Object containing all the filter fields for AMI products. Client can add a maximum of 8
121+
* <p>Object containing all the filter fields for AMI products. Client can add only one wildcard filter and a maximum of 8
122122
* filters in a single <code>ListEntities</code> request.</p>
123123
*/
124124
export interface AmiProductFilters {
@@ -598,6 +598,20 @@ export const FailureCode = {
598598
*/
599599
export type FailureCode = (typeof FailureCode)[keyof typeof FailureCode];
600600

601+
/**
602+
* @public
603+
* @enum
604+
*/
605+
export const Intent = {
606+
APPLY: "APPLY",
607+
VALIDATE: "VALIDATE",
608+
} as const;
609+
610+
/**
611+
* @public
612+
*/
613+
export type Intent = (typeof Intent)[keyof typeof Intent];
614+
601615
/**
602616
* @public
603617
* @enum
@@ -639,6 +653,13 @@ export interface DescribeChangeSetResponse {
639653
*/
640654
ChangeSetName?: string;
641655

656+
/**
657+
* @public
658+
* <p>The optional intent provided in the <code>StartChangeSet</code> request. If you do not
659+
* provide an intent, <code>APPLY</code> is set by default.</p>
660+
*/
661+
Intent?: Intent;
662+
642663
/**
643664
* @public
644665
* <p>The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
@@ -1090,7 +1111,7 @@ export interface ContainerProductVisibilityFilter {
10901111

10911112
/**
10921113
* @public
1093-
* <p>Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
1114+
* <p>Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
10941115
*/
10951116
export interface ContainerProductFilters {
10961117
/**
@@ -1210,7 +1231,7 @@ export interface DataProductVisibilityFilter {
12101231

12111232
/**
12121233
* @public
1213-
* <p>Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
1234+
* <p>Object containing all the filter fields for data products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
12141235
*/
12151236
export interface DataProductFilters {
12161237
/**
@@ -1438,7 +1459,7 @@ export interface OfferTargetingFilter {
14381459

14391460
/**
14401461
* @public
1441-
* <p>A filter for offers entity.</p>
1462+
* <p>Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
14421463
*/
14431464
export interface OfferFilters {
14441465
/**
@@ -1778,7 +1799,7 @@ export interface ResaleAuthorizationStatusFilter {
17781799

17791800
/**
17801801
* @public
1781-
* <p>A filter for ResaleAuthorization entity.</p>
1802+
* <p>Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
17821803
*/
17831804
export interface ResaleAuthorizationFilters {
17841805
/**
@@ -1951,8 +1972,7 @@ export interface SaaSProductVisibilityFilter {
19511972

19521973
/**
19531974
* @public
1954-
* <p>Object containing all the filter fields for SaaS products. Client can add a maximum of
1955-
* 8 filters in a single <code>ListEntities</code> request.</p>
1975+
* <p>Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>
19561976
*/
19571977
export interface SaaSProductFilters {
19581978
/**
@@ -2984,6 +3004,15 @@ export interface StartChangeSetRequest {
29843004
* <code>ChangeSetTags</code> property.</p>
29853005
*/
29863006
ChangeSetTags?: Tag[];
3007+
3008+
/**
3009+
* @public
3010+
* <p>The intent related to the request. The default is <code>APPLY</code>.
3011+
* To test your request before applying changes to your entities, use <code>VALIDATE</code>.
3012+
* This feature is currently available for adding versions to single-AMI products. For more information, see
3013+
* <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#ami-add-version">Add a new version</a>.</p>
3014+
*/
3015+
Intent?: Intent;
29873016
}
29883017

29893018
/**

‎clients/client-marketplace-catalog/src/protocols/Aws_restJson1.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,7 @@ export const se_StartChangeSetCommand = async (
368368
ChangeSetName: [],
369369
ChangeSetTags: (_) => _json(_),
370370
ClientRequestToken: [true, (_) => _ ?? generateIdempotencyToken()],
371+
Intent: [],
371372
})
372373
);
373374
b.m("POST").h(headers).b(body);
@@ -503,6 +504,7 @@ export const de_DescribeChangeSetCommand = async (
503504
EndTime: __expectString,
504505
FailureCode: __expectString,
505506
FailureDescription: __expectString,
507+
Intent: __expectString,
506508
StartTime: __expectString,
507509
Status: __expectString,
508510
});

‎codegen/sdk-codegen/aws-models/marketplace-catalog.json

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,7 @@
805805
}
806806
},
807807
"traits": {
808-
"smithy.api#documentation": "<p>Object containing all the filter fields for AMI products. Client can add a maximum of 8\n filters in a single <code>ListEntities</code> request.</p>"
808+
"smithy.api#documentation": "<p>Object containing all the filter fields for AMI products. Client can add only one wildcard filter and a maximum of 8\n filters in a single <code>ListEntities</code> request.</p>"
809809
}
810810
},
811811
"com.amazonaws.marketplacecatalog#AmiProductLastModifiedDateFilter": {
@@ -1031,7 +1031,7 @@
10311031
}
10321032
],
10331033
"traits": {
1034-
"smithy.api#documentation": "<p>Returns metadata and content for multiple entities.</p>",
1034+
"smithy.api#documentation": "<p>Returns metadata and content for multiple entities. This is the Batch version of the <code>DescribeEntity</code> API and uses the same IAM permission action as <code>DescribeEntity</code> API.</p>",
10351035
"smithy.api#http": {
10361036
"method": "POST",
10371037
"uri": "/BatchDescribeEntities",
@@ -1503,7 +1503,7 @@
15031503
}
15041504
},
15051505
"traits": {
1506-
"smithy.api#documentation": "<p>Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
1506+
"smithy.api#documentation": "<p>Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
15071507
}
15081508
},
15091509
"com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilter": {
@@ -1771,7 +1771,7 @@
17711771
}
17721772
},
17731773
"traits": {
1774-
"smithy.api#documentation": "<p>Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
1774+
"smithy.api#documentation": "<p>Object containing all the filter fields for data products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
17751775
}
17761776
},
17771777
"com.amazonaws.marketplacecatalog#DataProductLastModifiedDateFilter": {
@@ -2126,6 +2126,12 @@
21262126
"smithy.api#documentation": "<p>The optional name provided in the <code>StartChangeSet</code> request. If you do not\n provide a name, one is set by default.</p>"
21272127
}
21282128
},
2129+
"Intent": {
2130+
"target": "com.amazonaws.marketplacecatalog#Intent",
2131+
"traits": {
2132+
"smithy.api#documentation": "<p>The optional intent provided in the <code>StartChangeSet</code> request. If you do not\n provide an intent, <code>APPLY</code> is set by default.</p>"
2133+
}
2134+
},
21292135
"StartTime": {
21302136
"target": "com.amazonaws.marketplacecatalog#DateTimeISO8601",
21312137
"traits": {
@@ -2776,6 +2782,23 @@
27762782
"smithy.api#pattern": "^[\\w\\-@]+$"
27772783
}
27782784
},
2785+
"com.amazonaws.marketplacecatalog#Intent": {
2786+
"type": "enum",
2787+
"members": {
2788+
"VALIDATE": {
2789+
"target": "smithy.api#Unit",
2790+
"traits": {
2791+
"smithy.api#enumValue": "VALIDATE"
2792+
}
2793+
},
2794+
"APPLY": {
2795+
"target": "smithy.api#Unit",
2796+
"traits": {
2797+
"smithy.api#enumValue": "APPLY"
2798+
}
2799+
}
2800+
}
2801+
},
27792802
"com.amazonaws.marketplacecatalog#InternalServiceException": {
27802803
"type": "structure",
27812804
"members": {
@@ -3294,7 +3317,7 @@
32943317
}
32953318
},
32963319
"traits": {
3297-
"smithy.api#documentation": "<p>A filter for offers entity.</p>"
3320+
"smithy.api#documentation": "<p>Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
32983321
}
32993322
},
33003323
"com.amazonaws.marketplacecatalog#OfferLastModifiedDateFilter": {
@@ -3997,7 +4020,7 @@
39974020
}
39984021
},
39994022
"traits": {
4000-
"smithy.api#documentation": "<p>A filter for ResaleAuthorization entity.</p>"
4023+
"smithy.api#documentation": "<p>Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
40014024
}
40024025
},
40034026
"com.amazonaws.marketplacecatalog#ResaleAuthorizationLastModifiedDateFilter": {
@@ -4800,7 +4823,7 @@
48004823
}
48014824
},
48024825
"traits": {
4803-
"smithy.api#documentation": "<p>Object containing all the filter fields for SaaS products. Client can add a maximum of\n 8 filters in a single <code>ListEntities</code> request.</p>"
4826+
"smithy.api#documentation": "<p>Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single <code>ListEntities</code> request.</p>"
48044827
}
48054828
},
48064829
"com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilter": {
@@ -5138,6 +5161,12 @@
51385161
"traits": {
51395162
"smithy.api#documentation": "<p>A list of objects specifying each key name and value for the\n <code>ChangeSetTags</code> property.</p>"
51405163
}
5164+
},
5165+
"Intent": {
5166+
"target": "com.amazonaws.marketplacecatalog#Intent",
5167+
"traits": {
5168+
"smithy.api#documentation": "<p>The intent related to the request. The default is <code>APPLY</code>.\n To test your request before applying changes to your entities, use <code>VALIDATE</code>.\n This feature is currently available for adding versions to single-AMI products. For more information, see\n <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#ami-add-version\">Add a new version</a>.</p>"
5169+
}
51415170
}
51425171
},
51435172
"traits": {

0 commit comments

Comments
 (0)