feat(client-marketplace-catalog): 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.

Author: awstools

clients/client-marketplace-catalog/README.md

@@ -9,9 +9,8 @@
 
 AWS SDK for JavaScript MarketplaceCatalog Client for Node.js, Browser and React Native.
 
-<p>Catalog API actions allow you to manage your entities through list, describe, and update
-capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
-
+<p>Catalog API actions allow you to manage your entities through list, describe, and
+update capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
 <p>You can automate your entity update process by integrating the AWS Marketplace Catalog
 API with your AWS Marketplace product build or deployment pipelines. You can also create
 your own applications on top of the Catalog API to manage your products on AWS

clients/client-marketplace-catalog/src/MarketplaceCatalog.ts

@@ -26,17 +26,27 @@ import {
   ListEntitiesCommandInput,
   ListEntitiesCommandOutput,
 } from "./commands/ListEntitiesCommand";
+import {
+  ListTagsForResourceCommand,
+  ListTagsForResourceCommandInput,
+  ListTagsForResourceCommandOutput,
+} from "./commands/ListTagsForResourceCommand";
 import {
   StartChangeSetCommand,
   StartChangeSetCommandInput,
   StartChangeSetCommandOutput,
 } from "./commands/StartChangeSetCommand";
+import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
+import {
+  UntagResourceCommand,
+  UntagResourceCommandInput,
+  UntagResourceCommandOutput,
+} from "./commands/UntagResourceCommand";
 import { MarketplaceCatalogClient } from "./MarketplaceCatalogClient";
 
 /**
- * <p>Catalog API actions allow you to manage your entities through list, describe, and update
- *             capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
- *
+ * <p>Catalog API actions allow you to manage your entities through list, describe, and
+ *             update capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
  *         <p>You can automate your entity update process by integrating the AWS Marketplace Catalog
  *             API with your AWS Marketplace product build or deployment pipelines. You can also create
  *             your own applications on top of the Catalog API to manage your products on AWS
@@ -147,7 +157,6 @@ export class MarketplaceCatalog extends MarketplaceCatalogClient {
    *             can filter this list by providing any combination of <code>entityId</code>,
    *                 <code>ChangeSetName</code>, and status. If you provide more than one filter, the API
    *             operation applies a logical AND between the filters.</p>
-   *
    *         <p>You can describe a change during the 60-day request history retention period for API
    *             calls.</p>
    */
@@ -210,19 +219,49 @@ export class MarketplaceCatalog extends MarketplaceCatalogClient {
   }
 
   /**
-   * <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>
+   * <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>
+   */
+  public listTagsForResource(
+    args: ListTagsForResourceCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListTagsForResourceCommandOutput>;
+  public listTagsForResource(
+    args: ListTagsForResourceCommandInput,
+    cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
+  ): void;
+  public listTagsForResource(
+    args: ListTagsForResourceCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
+  ): void;
+  public listTagsForResource(
+    args: ListTagsForResourceCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void),
+    cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void
+  ): Promise<ListTagsForResourceCommandOutput> | void {
+    const command = new ListTagsForResourceCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
+  /**
+   * <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>
    */
   public startChangeSet(
     args: StartChangeSetCommandInput,
@@ -252,4 +291,62 @@ export class MarketplaceCatalog extends MarketplaceCatalogClient {
       return this.send(command, optionsOrCb);
     }
   }
+
+  /**
+   * <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>
+   */
+  public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
+  public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
+  public tagResource(
+    args: TagResourceCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: TagResourceCommandOutput) => void
+  ): void;
+  public tagResource(
+    args: TagResourceCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void),
+    cb?: (err: any, data?: TagResourceCommandOutput) => void
+  ): Promise<TagResourceCommandOutput> | void {
+    const command = new TagResourceCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
+  /**
+   * <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>
+   */
+  public untagResource(
+    args: UntagResourceCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UntagResourceCommandOutput>;
+  public untagResource(
+    args: UntagResourceCommandInput,
+    cb: (err: any, data?: UntagResourceCommandOutput) => void
+  ): void;
+  public untagResource(
+    args: UntagResourceCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UntagResourceCommandOutput) => void
+  ): void;
+  public untagResource(
+    args: UntagResourceCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void),
+    cb?: (err: any, data?: UntagResourceCommandOutput) => void
+  ): Promise<UntagResourceCommandOutput> | void {
+    const command = new UntagResourceCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
 }

clients/client-marketplace-catalog/src/MarketplaceCatalogClient.ts

@@ -52,7 +52,13 @@ import { DescribeChangeSetCommandInput, DescribeChangeSetCommandOutput } from ".
 import { DescribeEntityCommandInput, DescribeEntityCommandOutput } from "./commands/DescribeEntityCommand";
 import { ListChangeSetsCommandInput, ListChangeSetsCommandOutput } from "./commands/ListChangeSetsCommand";
 import { ListEntitiesCommandInput, ListEntitiesCommandOutput } from "./commands/ListEntitiesCommand";
+import {
+  ListTagsForResourceCommandInput,
+  ListTagsForResourceCommandOutput,
+} from "./commands/ListTagsForResourceCommand";
 import { StartChangeSetCommandInput, StartChangeSetCommandOutput } from "./commands/StartChangeSetCommand";
+import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
+import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -67,15 +73,21 @@ export type ServiceInputTypes =
   | DescribeEntityCommandInput
   | ListChangeSetsCommandInput
   | ListEntitiesCommandInput
-  | StartChangeSetCommandInput;
+  | ListTagsForResourceCommandInput
+  | StartChangeSetCommandInput
+  | TagResourceCommandInput
+  | UntagResourceCommandInput;
 
 export type ServiceOutputTypes =
   | CancelChangeSetCommandOutput
   | DescribeChangeSetCommandOutput
   | DescribeEntityCommandOutput
   | ListChangeSetsCommandOutput
   | ListEntitiesCommandOutput
-  | StartChangeSetCommandOutput;
+  | ListTagsForResourceCommandOutput
+  | StartChangeSetCommandOutput
+  | TagResourceCommandOutput
+  | UntagResourceCommandOutput;
 
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
   /**
@@ -227,9 +239,8 @@ type MarketplaceCatalogClientResolvedConfigType = __SmithyResolvedConfiguration<
 export interface MarketplaceCatalogClientResolvedConfig extends MarketplaceCatalogClientResolvedConfigType {}
 
 /**
- * <p>Catalog API actions allow you to manage your entities through list, describe, and update
- *             capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
- *
+ * <p>Catalog API actions allow you to manage your entities through list, describe, and
+ *             update capabilities. An entity can be a product or an offer on AWS Marketplace. </p>
  *         <p>You can automate your entity update process by integrating the AWS Marketplace Catalog
  *             API with your AWS Marketplace product build or deployment pipelines. You can also create
  *             your own applications on top of the Catalog API to manage your products on AWS

clients/client-marketplace-catalog/src/commands/ListChangeSetsCommand.ts

@@ -37,7 +37,6 @@ export interface ListChangeSetsCommandOutput extends ListChangeSetsResponse, __M
  *             can filter this list by providing any combination of <code>entityId</code>,
  *                 <code>ChangeSetName</code>, and status. If you provide more than one filter, the API
  *             operation applies a logical AND between the filters.</p>
- *
  *         <p>You can describe a change during the 60-day request history retention period for API
  *             calls.</p>
  * @example

clients/client-marketplace-catalog/src/commands/ListTagsForResourceCommand.ts

@@ -0,0 +1,118 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import {
+  MarketplaceCatalogClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../MarketplaceCatalogClient";
+import {
+  ListTagsForResourceRequest,
+  ListTagsForResourceRequestFilterSensitiveLog,
+  ListTagsForResourceResponse,
+  ListTagsForResourceResponseFilterSensitiveLog,
+} from "../models/models_0";
+import {
+  deserializeAws_restJson1ListTagsForResourceCommand,
+  serializeAws_restJson1ListTagsForResourceCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {}
+export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}
+
+/**
+ * <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MarketplaceCatalogClient, ListTagsForResourceCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import
+ * // const { MarketplaceCatalogClient, ListTagsForResourceCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import
+ * const client = new MarketplaceCatalogClient(config);
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
+ * @see {@link MarketplaceCatalogClientResolvedConfig | config} for MarketplaceCatalogClient's `config` shape.
+ *
+ */
+export class ListTagsForResourceCommand extends $Command<
+  ListTagsForResourceCommandInput,
+  ListTagsForResourceCommandOutput,
+  MarketplaceCatalogClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  public static getEndpointParameterInstructions(): EndpointParameterInstructions {
+    return {
+      UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
+      Endpoint: { type: "builtInParams", name: "endpoint" },
+      Region: { type: "builtInParams", name: "region" },
+      UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
+    };
+  }
+
+  constructor(readonly input: ListTagsForResourceCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: MarketplaceCatalogClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+    this.middlewareStack.use(
+      getEndpointPlugin(configuration, ListTagsForResourceCommand.getEndpointParameterInstructions())
+    );
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "MarketplaceCatalogClient";
+    const commandName = "ListTagsForResourceCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: ListTagsForResourceRequestFilterSensitiveLog,
+      outputFilterSensitiveLog: ListTagsForResourceResponseFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: ListTagsForResourceCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1ListTagsForResourceCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<ListTagsForResourceCommandOutput> {
+    return deserializeAws_restJson1ListTagsForResourceCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}