@aws-sdk/client-marketplace-deployment 3.775.0 → 3.782.0

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -71,6 +71,25 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link MarketplaceDeploymentServiceException}
  * <p>Base exception class for all service exceptions from MarketplaceDeployment service.</p>
  *
+ *
+ * @example Listing tags for a deployment parameter
+ * ```javascript
+ * // The following example demonstrates listing the tags for a deployment parameter. If no tags are present, the API will return an empty map.
+ * const input = {
+ *   resourceArn: "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   tags: {
+ *     FooKey: "BarValue",
+ *     HelloKey: "WorldValue"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

package/dist-types/commands/PutDeploymentParameterCommand.d.ts

@@ -91,6 +91,65 @@ declare const PutDeploymentParameterCommand_base: {
  * @throws {@link MarketplaceDeploymentServiceException}
  * <p>Base exception class for all service exceptions from MarketplaceDeployment service.</p>
  *
+ *
+ * @example Creating or updating a deployment parameter
+ * ```javascript
+ * // The following example demonstrates creating or updating a deployment parameter named "ExampleDeploymentParameterName". The secret will be saved in the Buyer account associated with the passed `agreementId`, with the value set to the provided `secretString`. Note that the deployment parameter `secretString` can be passed in JSON string format, allowing [json-key specific CloudFormation dynamic references](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) from a single deployment parameter.
+ * const input = {
+ *   agreementId: "agmt-1234",
+ *   catalog: "AWSMarketplace",
+ *   clientToken: "some-unique-uuid-between-32-and-64-characters",
+ *   deploymentParameter: {
+ *     name: "ExampleDeploymentParameterName",
+ *     secretString: `{"apiKey": "helloWorldApiKey", "entityId": "fooBarEntityId"}`
+ *   },
+ *   productId: "product-1234"
+ * };
+ * const command = new PutDeploymentParameterCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   agreementId: "agmt-1234",
+ *   deploymentParameterId: "dp-uniqueidentifier",
+ *   resourceArn: "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier",
+ *   tags:   { /* empty *\/ }
+ * }
+ * *\/
+ * ```
+ *
+ * @example Creating a simple deployment parameter, with tags and expiration.
+ * ```javascript
+ * // The following example demonstrates creating a simple deployment parameter named "ExampleSimpleDeploymentParameterName". If multiple secrets are not required, the `secretString` may be provided in String format. The provided tags are only applied on resource creation and will be ignored if the operation results in an update. The API response includes the tags present on the resource after completion of the operation.
+ * const input = {
+ *   agreementId: "agmt-1234",
+ *   catalog: "AWSMarketplace",
+ *   clientToken: "some-unique-uuid-between-32-and-64-characters",
+ *   deploymentParameter: {
+ *     name: "ExampleSimpleDeploymentParameterName",
+ *     secretString: "MySimpleValue"
+ *   },
+ *   expirationDate: "2099-11-18T08:52:46.397Z",
+ *   productId: "product-1234",
+ *   tags: {
+ *     FooKey: "BarValue",
+ *     HelloKey: "WorldValue"
+ *   }
+ * };
+ * const command = new PutDeploymentParameterCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   agreementId: "agmt-1234",
+ *   deploymentParameterId: "dp-uniqueidentifier",
+ *   resourceArn: "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier",
+ *   tags: {
+ *     FooKey: "BarValue",
+ *     HelloKey: "WorldValue"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class PutDeploymentParameterCommand extends PutDeploymentParameterCommand_base {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -73,6 +73,24 @@ declare const TagResourceCommand_base: {
  * @throws {@link MarketplaceDeploymentServiceException}
  * <p>Base exception class for all service exceptions from MarketplaceDeployment service.</p>
  *
+ *
+ * @example Adding tags to a deployment parameter
+ * ```javascript
+ * // The following example demonstrates adding two tags to a deployment parameter. There is no output from this API.
+ * const input = {
+ *   resourceArn: "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier",
+ *   tags: {
+ *     FooKey: "BarValue",
+ *     HelloKey: "WorldValue"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -73,6 +73,24 @@ declare const UntagResourceCommand_base: {
  * @throws {@link MarketplaceDeploymentServiceException}
  * <p>Base exception class for all service exceptions from MarketplaceDeployment service.</p>
  *
+ *
+ * @example Removing tags from a deployment parameter
+ * ```javascript
+ * // The following example demonstrates removing two tags from a deployment parameter. For each, both the tag and the associated value are removed. There is no output from this API.
+ * const input = {
+ *   resourceArn: "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier",
+ *   tagKeys: [
+ *     "FooKey",
+ *     "HelloKey"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-marketplace-deployment",
   "description": "AWS SDK for JavaScript Marketplace Deployment Client for Node.js, Browser and React Native",
-  "version": "3.775.0",
+  "version": "3.782.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-marketplace-deployment",
@@ -21,16 +21,16 @@
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
     "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.775.0",
+    "@aws-sdk/credential-provider-node": "3.782.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",
-    "@aws-sdk/middleware-user-agent": "3.775.0",
+    "@aws-sdk/middleware-user-agent": "3.782.0",
     "@aws-sdk/region-config-resolver": "3.775.0",
     "@aws-sdk/types": "3.775.0",
-    "@aws-sdk/util-endpoints": "3.775.0",
+    "@aws-sdk/util-endpoints": "3.782.0",
     "@aws-sdk/util-user-agent-browser": "3.775.0",
-    "@aws-sdk/util-user-agent-node": "3.775.0",
+    "@aws-sdk/util-user-agent-node": "3.782.0",
     "@smithy/config-resolver": "^4.1.0",
     "@smithy/core": "^3.2.0",
     "@smithy/fetch-http-handler": "^5.0.2",