AWS Marketplace Catalog Service Update: Added three new APIs to support tagging and tag-based authorization: TagResource, UntagResource, and ListTagsForResource. Added optional parameters to the StartChangeSet API to support tagging a resource while making a request to create it.

AWS · AWS · commit b8bf84f22b4a · 2022-11-11T19:50:46.000Z
diff --git a/.changes/next-release/feature-AWSMarketplaceCatalogService-edafead.json b/.changes/next-release/feature-AWSMarketplaceCatalogService-edafead.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS Marketplace Catalog Service",
+    "contributor": "",
+    "description": "Added three new APIs to support tagging and tag-based authorization: TagResource, UntagResource, and ListTagsForResource. Added optional parameters to the StartChangeSet API to support tagging a resource while making a request to create it."
+}
diff --git a/services/marketplacecatalog/src/main/resources/codegen-resources/endpoint-tests.json b/services/marketplacecatalog/src/main/resources/codegen-resources/endpoint-tests.json
@@ -8,9 +8,9 @@
                 }
             },
             "params": {
-                "UseDualStack": true,
+                "UseFIPS": true,
                 "Region": "us-west-2",
-                "UseFIPS": true
+                "UseDualStack": true
             }
         },
         {
@@ -21,9 +21,9 @@
                 }
             },
             "params": {
-                "UseDualStack": false,
+                "UseFIPS": true,
                 "Region": "us-west-2",
-                "UseFIPS": true
+                "UseDualStack": false
             }
         },
         {
@@ -34,9 +34,9 @@
                 }
             },
             "params": {
-                "UseDualStack": true,
+                "UseFIPS": false,
                 "Region": "us-west-2",
-                "UseFIPS": false
+                "UseDualStack": true
             }
         },
         {
@@ -47,9 +47,9 @@
                 }
             },
             "params": {
-                "UseDualStack": false,
+                "UseFIPS": false,
                 "Region": "us-west-2",
-                "UseFIPS": false
+                "UseDualStack": false
             }
         },
         {
@@ -60,9 +60,9 @@
                 }
             },
             "params": {
-                "UseDualStack": true,
+                "UseFIPS": true,
                 "Region": "us-east-1",
-                "UseFIPS": true
+                "UseDualStack": true
             }
         },
         {
@@ -73,9 +73,9 @@
                 }
             },
             "params": {
-                "UseDualStack": false,
+                "UseFIPS": true,
                 "Region": "us-east-1",
-                "UseFIPS": true
+                "UseDualStack": false
             }
         },
         {
@@ -86,9 +86,9 @@
                 }
             },
             "params": {
-                "UseDualStack": true,
+                "UseFIPS": false,
                 "Region": "us-east-1",
-                "UseFIPS": false
+                "UseDualStack": true
             }
         },
         {
@@ -99,9 +99,9 @@
                 }
             },
             "params": {
-                "UseDualStack": false,
+                "UseFIPS": false,
                 "Region": "us-east-1",
-                "UseFIPS": false
+                "UseDualStack": false
             }
         },
         {
@@ -112,9 +112,9 @@
                 }
             },
             "params": {
-                "UseDualStack": false,
-                "Region": "us-east-1",
                 "UseFIPS": false,
+                "Region": "us-east-1",
+                "UseDualStack": false,
                 "Endpoint": "https://example.com"
             }
         },
@@ -124,9 +124,9 @@
                 "error": "Invalid Configuration: FIPS and custom endpoint are not supported"
             },
             "params": {
-                "UseDualStack": false,
-                "Region": "us-east-1",
                 "UseFIPS": true,
+                "Region": "us-east-1",
+                "UseDualStack": false,
                 "Endpoint": "https://example.com"
             }
         },
@@ -136,9 +136,9 @@
                 "error": "Invalid Configuration: Dualstack and custom endpoint are not supported"
             },
             "params": {
-                "UseDualStack": true,
-                "Region": "us-east-1",
                 "UseFIPS": false,
+                "Region": "us-east-1",
+                "UseDualStack": true,
                 "Endpoint": "https://example.com"
             }
         }
diff --git a/services/marketplacecatalog/src/main/resources/codegen-resources/service-2.json b/services/marketplacecatalog/src/main/resources/codegen-resources/service-2.json
@@ -99,6 +99,23 @@
       ],
       "documentation":"<p>Provides the list of entities of a given type.</p>"
     },
+    "ListTagsForResource":{
+      "name":"ListTagsForResource",
+      "http":{
+        "method":"POST",
+        "requestUri":"/ListTagsForResource"
+      },
+      "input":{"shape":"ListTagsForResourceRequest"},
+      "output":{"shape":"ListTagsForResourceResponse"},
+      "errors":[
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"InternalServiceException"},
+        {"shape":"AccessDeniedException"},
+        {"shape":"ValidationException"},
+        {"shape":"ThrottlingException"}
+      ],
+      "documentation":"<p>Lists all tags that have been added to a resource (either an <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities\">entity</a> or <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\">change set</a>).</p>"
+    },
     "StartChangeSet":{
       "name":"StartChangeSet",
       "http":{
@@ -116,7 +133,41 @@
         {"shape":"ThrottlingException"},
         {"shape":"ServiceQuotaExceededException"}
       ],
-      "documentation":"<p>This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a <code>ResourceInUseException</code>.</p> <p>For example, you cannot start the ChangeSet described in the <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples\">example</a> later in this topic, because it contains two changes to execute the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1)</code>.</p> <p>For more information about working with change sets, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\"> Working with change sets</a>.</p>"
+      "documentation":"<p>Allows you to request changes for your entities. Within a single <code>ChangeSet</code>, you can't start the same change type against the same entity multiple times. Additionally, when a <code>ChangeSet</code> is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a <code>ResourceInUseException</code> error.</p> <p>For example, you can't start the <code>ChangeSet</code> described in the <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples\">example</a> later in this topic because it contains two changes to run the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1</code>).</p> <p>For more information about working with change sets, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\"> Working with change sets</a>.</p>"
+    },
+    "TagResource":{
+      "name":"TagResource",
+      "http":{
+        "method":"POST",
+        "requestUri":"/TagResource"
+      },
+      "input":{"shape":"TagResourceRequest"},
+      "output":{"shape":"TagResourceResponse"},
+      "errors":[
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"InternalServiceException"},
+        {"shape":"AccessDeniedException"},
+        {"shape":"ValidationException"},
+        {"shape":"ThrottlingException"}
+      ],
+      "documentation":"<p>Tags a resource (either an <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities\">entity</a> or <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\">change set</a>).</p>"
+    },
+    "UntagResource":{
+      "name":"UntagResource",
+      "http":{
+        "method":"POST",
+        "requestUri":"/UntagResource"
+      },
+      "input":{"shape":"UntagResourceRequest"},
+      "output":{"shape":"UntagResourceResponse"},
+      "errors":[
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"InternalServiceException"},
+        {"shape":"AccessDeniedException"},
+        {"shape":"ValidationException"},
+        {"shape":"ThrottlingException"}
+      ],
+      "documentation":"<p>Removes a tag or list of tags from a resource (either an <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities\">entity</a> or <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\">change set</a>).</p>"
     }
   },
   "shapes":{
@@ -192,6 +243,10 @@
           "shape":"Entity",
           "documentation":"<p>The entity to be changed.</p>"
         },
+        "EntityTags":{
+          "shape":"TagList",
+          "documentation":"<p>The tags associated with the change.</p>"
+        },
         "Details":{
           "shape":"Json",
           "documentation":"<p>This object contains details specific to the change type of the requested change.</p>"
@@ -305,9 +360,9 @@
     },
     "ClientRequestToken":{
       "type":"string",
-      "max":36,
+      "max":64,
       "min":1,
-      "pattern":"^[\\w\\-]+$"
+      "pattern":"^[!-~]+$"
     },
     "DateTimeISO8601":{
       "type":"string",
@@ -660,6 +715,29 @@
         }
       }
     },
+    "ListTagsForResourceRequest":{
+      "type":"structure",
+      "required":["ResourceArn"],
+      "members":{
+        "ResourceArn":{
+          "shape":"ResourceARN",
+          "documentation":"<p>Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.</p>"
+        }
+      }
+    },
+    "ListTagsForResourceResponse":{
+      "type":"structure",
+      "members":{
+        "ResourceArn":{
+          "shape":"ResourceARN",
+          "documentation":"<p>Required. The ARN associated with the resource you want to list tags on.</p>"
+        },
+        "Tags":{
+          "shape":"TagList",
+          "documentation":"<p>Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.</p>"
+        }
+      }
+    },
     "MaxResultInteger":{
       "type":"integer",
       "box":true,
@@ -678,6 +756,12 @@
       "max":20,
       "min":1
     },
+    "ResourceARN":{
+      "type":"string",
+      "max":255,
+      "min":1,
+      "pattern":"^arn:[\\w+=/,.@-]+:aws-marketplace:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$"
+    },
     "ResourceId":{
       "type":"string",
       "max":255,
@@ -778,6 +862,10 @@
           "shape":"ClientRequestToken",
           "documentation":"<p>A unique token to identify the request to ensure idempotency.</p>",
           "idempotencyToken":true
+        },
+        "ChangeSetTags":{
+          "shape":"TagList",
+          "documentation":"<p>A list of objects specifying each key name and value for the <code>ChangeSetTags</code> property.</p>"
         }
       }
     },
@@ -794,6 +882,70 @@
         }
       }
     },
+    "Tag":{
+      "type":"structure",
+      "required":[
+        "Key",
+        "Value"
+      ],
+      "members":{
+        "Key":{
+          "shape":"TagKey",
+          "documentation":"<p>The key associated with the tag.</p>"
+        },
+        "Value":{
+          "shape":"TagValue",
+          "documentation":"<p>The value associated with the tag.</p>"
+        }
+      },
+      "documentation":"<p>A list of objects specifying each key name and value.</p>"
+    },
+    "TagKey":{
+      "type":"string",
+      "max":128,
+      "min":1,
+      "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
+    },
+    "TagKeyList":{
+      "type":"list",
+      "member":{"shape":"TagKey"},
+      "max":50,
+      "min":1
+    },
+    "TagList":{
+      "type":"list",
+      "member":{"shape":"Tag"},
+      "max":50,
+      "min":1
+    },
+    "TagResourceRequest":{
+      "type":"structure",
+      "required":[
+        "ResourceArn",
+        "Tags"
+      ],
+      "members":{
+        "ResourceArn":{
+          "shape":"ResourceARN",
+          "documentation":"<p>Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.</p>"
+        },
+        "Tags":{
+          "shape":"TagList",
+          "documentation":"<p>Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.</p>"
+        }
+      }
+    },
+    "TagResourceResponse":{
+      "type":"structure",
+      "members":{
+      }
+    },
+    "TagValue":{
+      "type":"string",
+      "max":256,
+      "min":0,
+      "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
+    },
     "ThrottlingException":{
       "type":"structure",
       "members":{
@@ -804,6 +956,28 @@
       "exception":true,
       "synthetic":true
     },
+    "UntagResourceRequest":{
+      "type":"structure",
+      "required":[
+        "ResourceArn",
+        "TagKeys"
+      ],
+      "members":{
+        "ResourceArn":{
+          "shape":"ResourceARN",
+          "documentation":"<p>Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.</p>"
+        },
+        "TagKeys":{
+          "shape":"TagKeyList",
+          "documentation":"<p>Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.</p>"
+        }
+      }
+    },
+    "UntagResourceResponse":{
+      "type":"structure",
+      "members":{
+      }
+    },
     "ValidationException":{
       "type":"structure",
       "members":{

Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@`
`8`	`8`	`}`
`9`	`9`	`},`
`10`	`10`	`"params": {`
`11`		`- "UseDualStack": true,`
	`11`	`+ "UseFIPS": true,`
`12`	`12`	`"Region": "us-west-2",`
`13`		`- "UseFIPS": true`
	`13`	`+ "UseDualStack": true`
`14`	`14`	`}`
`15`	`15`	`},`
`16`	`16`	`{`
`@@ -21,9 +21,9 @@`
`21`	`21`	`}`
`22`	`22`	`},`
`23`	`23`	`"params": {`
`24`		`- "UseDualStack": false,`
	`24`	`+ "UseFIPS": true,`
`25`	`25`	`"Region": "us-west-2",`
`26`		`- "UseFIPS": true`
	`26`	`+ "UseDualStack": false`
`27`	`27`	`}`
`28`	`28`	`},`
`29`	`29`	`{`
`@@ -34,9 +34,9 @@`
`34`	`34`	`}`
`35`	`35`	`},`
`36`	`36`	`"params": {`
`37`		`- "UseDualStack": true,`
	`37`	`+ "UseFIPS": false,`
`38`	`38`	`"Region": "us-west-2",`
`39`		`- "UseFIPS": false`
	`39`	`+ "UseDualStack": true`
`40`	`40`	`}`
`41`	`41`	`},`
`42`	`42`	`{`
`@@ -47,9 +47,9 @@`
`47`	`47`	`}`
`48`	`48`	`},`
`49`	`49`	`"params": {`
`50`		`- "UseDualStack": false,`
	`50`	`+ "UseFIPS": false,`
`51`	`51`	`"Region": "us-west-2",`
`52`		`- "UseFIPS": false`
	`52`	`+ "UseDualStack": false`
`53`	`53`	`}`
`54`	`54`	`},`
`55`	`55`	`{`
`@@ -60,9 +60,9 @@`
`60`	`60`	`}`
`61`	`61`	`},`
`62`	`62`	`"params": {`
`63`		`- "UseDualStack": true,`
	`63`	`+ "UseFIPS": true,`
`64`	`64`	`"Region": "us-east-1",`
`65`		`- "UseFIPS": true`
	`65`	`+ "UseDualStack": true`
`66`	`66`	`}`
`67`	`67`	`},`
`68`	`68`	`{`
`@@ -73,9 +73,9 @@`
`73`	`73`	`}`
`74`	`74`	`},`
`75`	`75`	`"params": {`
`76`		`- "UseDualStack": false,`
	`76`	`+ "UseFIPS": true,`
`77`	`77`	`"Region": "us-east-1",`
`78`		`- "UseFIPS": true`
	`78`	`+ "UseDualStack": false`
`79`	`79`	`}`
`80`	`80`	`},`
`81`	`81`	`{`
`@@ -86,9 +86,9 @@`
`86`	`86`	`}`
`87`	`87`	`},`
`88`	`88`	`"params": {`
`89`		`- "UseDualStack": true,`
	`89`	`+ "UseFIPS": false,`
`90`	`90`	`"Region": "us-east-1",`
`91`		`- "UseFIPS": false`
	`91`	`+ "UseDualStack": true`
`92`	`92`	`}`
`93`	`93`	`},`
`94`	`94`	`{`
`@@ -99,9 +99,9 @@`
`99`	`99`	`}`
`100`	`100`	`},`
`101`	`101`	`"params": {`
`102`		`- "UseDualStack": false,`
	`102`	`+ "UseFIPS": false,`
`103`	`103`	`"Region": "us-east-1",`
`104`		`- "UseFIPS": false`
	`104`	`+ "UseDualStack": false`
`105`	`105`	`}`
`106`	`106`	`},`
`107`	`107`	`{`
`@@ -112,9 +112,9 @@`
`112`	`112`	`}`
`113`	`113`	`},`
`114`	`114`	`"params": {`
`115`		`- "UseDualStack": false,`
`116`		`- "Region": "us-east-1",`
`117`	`115`	`"UseFIPS": false,`
	`116`	`+ "Region": "us-east-1",`
	`117`	`+ "UseDualStack": false,`
`118`	`118`	`"Endpoint": "https://example.com"`
`119`	`119`	`}`
`120`	`120`	`},`
`@@ -124,9 +124,9 @@`
`124`	`124`	`"error": "Invalid Configuration: FIPS and custom endpoint are not supported"`
`125`	`125`	`},`
`126`	`126`	`"params": {`
`127`		`- "UseDualStack": false,`
`128`		`- "Region": "us-east-1",`
`129`	`127`	`"UseFIPS": true,`
	`128`	`+ "Region": "us-east-1",`
	`129`	`+ "UseDualStack": false,`
`130`	`130`	`"Endpoint": "https://example.com"`
`131`	`131`	`}`
`132`	`132`	`},`
`@@ -136,9 +136,9 @@`
`136`	`136`	`"error": "Invalid Configuration: Dualstack and custom endpoint are not supported"`
`137`	`137`	`},`
`138`	`138`	`"params": {`
`139`		`- "UseDualStack": true,`
`140`		`- "Region": "us-east-1",`
`141`	`139`	`"UseFIPS": false,`
	`140`	`+ "Region": "us-east-1",`
	`141`	`+ "UseDualStack": true,`
`142`	`142`	`"Endpoint": "https://example.com"`
`143`	`143`	`}`
`144`	`144`	`}`