@aws-sdk/client-launch-wizard 3.775.0 → 3.782.0

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

@@ -79,6 +79,71 @@ declare const CreateDeploymentCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Deploy a given workload with given settings.
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentPatternName: "SapHanaSingle",
+ *   dryRun: false,
+ *   name: "SapHanaSingleForTest",
+ *   specifications: {
+ *     DisableDeploymentRollback: "true",
+ *     Encryption: "Yes",
+ *     KeyName: "testLinuxInstance",
+ *     SAPTZ: "America/Vancouver",
+ *     VPCID: "vpc-1234567",
+ *     applicationName: "SapHanaSingleForTest",
+ *     deploymentScenario: "SapHanaSingle",
+ *     environmentType: "production",
+ *     saveArtifactsS3Uri: "s3://testbucket",
+ *     saveDeploymentArtifacts: "Yes"
+ *   },
+ *   workloadName: "SAP"
+ * };
+ * const command = new CreateDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   deploymentId: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Deploy a given workload with given settings and passing tags for Launch Wizard deployment resource.
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentPatternName: "SapHanaSingle",
+ *   dryRun: false,
+ *   name: "SapHanaSingleForTest",
+ *   specifications: {
+ *     DisableDeploymentRollback: "true",
+ *     Encryption: "Yes",
+ *     KeyName: "testLinuxInstance",
+ *     SAPTZ: "America/Vancouver",
+ *     VPCID: "vpc-1234567",
+ *     applicationName: "SapHanaSingleForTest",
+ *     deploymentScenario: "SapHanaSingle",
+ *     environmentType: "production",
+ *     saveArtifactsS3Uri: "s3://testbucket",
+ *     saveDeploymentArtifacts: "Yes"
+ *   },
+ *   tags: {
+ *     key1: "val1",
+ *     key2: "val2"
+ *   },
+ *   workloadName: "SAP"
+ * };
+ * const command = new CreateDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   deploymentId: "1111111-1111-1111-1111-111111111111"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CreateDeploymentCommand extends CreateDeploymentCommand_base {

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

@@ -69,6 +69,23 @@ declare const DeleteDeploymentCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Delete a deployment.
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentId: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d"
+ * };
+ * const command = new DeleteDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   status: "DELETED",
+ *   statusReason: "Finished processing DeleteApp request"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DeleteDeploymentCommand extends DeleteDeploymentCommand_base {

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

@@ -80,6 +80,45 @@ declare const GetDeploymentCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Get details about a given deployment.
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentId: "1111111-1111-1111-1111-111111111111"
+ * };
+ * const command = new GetDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   deployment: {
+ *     createdAt: "2023-04-24T13:10:09.857Z",
+ *     deploymentArn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/1111111-1111-1111-1111-111111111111",
+ *     id: "1111111-1111-1111-1111-111111111111",
+ *     name: "SapHanaSingleForTest",
+ *     specifications: {
+ *       DisableDeploymentRollback: "true",
+ *       Encryption: "Yes",
+ *       KeyName: "testLinuxInstance",
+ *       SAPTZ: "America/Vancouver",
+ *       VPCID: "vpc-1234567",
+ *       applicationName: "SapHanaSingleForTest",
+ *       deploymentScenario: "SapHanaSingle",
+ *       environmentType: "production",
+ *       saveArtifactsS3Uri: "s3://testbucket",
+ *       saveDeploymentArtifacts: "Yes"
+ *     },
+ *     status: "FAILED",
+ *     tags: {
+ *       key1: "val1",
+ *       key2: "val2"
+ *     },
+ *     workloadName: "SapHanaSingle"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetDeploymentCommand extends GetDeploymentCommand_base {

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

@@ -72,6 +72,29 @@ declare const GetWorkloadCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Get details about a specific workload.
+ * ```javascript
+ * //
+ * const input = {
+ *   workloadName: "SAP"
+ * };
+ * const command = new GetWorkloadCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   workload: {
+ *     description: "Workload Description",
+ *     displayName: "SAP",
+ *     documentationUrl: "https://docs.aws.amazon.com/launchwizard/latest/userguide/launch-wizard-sap.html",
+ *     iconUrl: "https://aws-lw-workload-assets-test-us-east-1.s3.amazonaws.com/amazon/SAP/icon.png?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAUaCXVzLWVhc3QtMSJHMEUCIC4l3GCH4o%2Bgq3pJzcD1YJmtrmyNCoEgG2RIayjDWf9kAiEAnMK5nYixaZLuF1s1UVoNd7xIbDrOQ8EAbhcZWexMp9cq7wIIrf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAEGgw1ODI1NTgxMjEyMDYiDHxMN%2BZ8CoPORzvo4yrDAtkVZlBVxLwnFmwHw005vo13LOUUbyajEpp3HNh%2BaBL8K2DLx7Kzi0UPPD6z8pL1eiFLHAQ9zZgVc7pLVQjBKOdcw1GmIADDepqYEb%2B8zLi7zwWP1JT72YbT6ZXSoWpb5NCqcyAvdK47b0Ae586s6VkWzoeJ65jR%2FgbJMhRpFpqVSP2XI6Rf6yA3%2BkQyUCk3RdyF4ljIL8Nf5nIFb%2BOMK2PZ8aJX85l1j7UpJE1rfNb1PitVcQz3KlW5xkiXfcWRKeVhgHRyuCEL3FY0DyPFdqe3NxcA0%2FzPgBq6Y9B41kM6af5u2kQRfQOjWejDpzpG7w40eaIKAYnhBkjIA9550geSLB7O%2FuAPQLI9fI2lVowIBUKsKVOr0%2FFGIzW3WM7%2BbEx%2FZ0mDkP1IhcpZdP7owC77K8O%2BXDgBCabAy48K3ndi%2BQKQMPXjz6YGOp4Bbgv9mVc3sE4KvXZv1skhnOYcOKGdCncIKLne0W%2BgO3URxyDQiyO2FhM3OekXDH83CNCyDVIpkgpWkvgXDSaZiD5mj0T9iqEeJzfh6uQvX1dRN%2BxI1eV0M7HKY2e7F%2BKNjeLhzKgKpSpDqFIUSjLeBlLLyQCNKuUiO3DMiy3rB89aX4b9wyC8au0SfGb72YyNLXjh6M1whcj1VNGePyw%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230809T202649Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAYPIZLPT3GGDNTHTI%2F20230809%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6a37e41e47208b426a5e7d32392d0815388cd0231187652204836943c37ad86a",
+ *     status: "ACTIVE",
+ *     workloadName: "SAP"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetWorkloadCommand extends GetWorkloadCommand_base {

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

@@ -93,6 +93,47 @@ declare const GetWorkloadDeploymentPatternCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Get details about a specific Workload deployment pattern
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentPatternName: "adSelfManagedNewVpc",
+ *   workloadName: "MicrosoftActiveDirectory"
+ * };
+ * const command = new GetWorkloadDeploymentPatternCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   workloadDeploymentPattern: {
+ *     deploymentPatternName: "adSelfManagedNewVpc",
+ *     description: "Builds a new AWS environment (VPC and other components), and deploys AD DS into this new VPC.",
+ *     displayName: "Self-managed AD - new VPC",
+ *     specifications: [
+ *       {
+ *         description: "Number of Availability Zones to use in the VPC.",
+ *         name: "NumberOfAZs",
+ *         required: "Yes"
+ *       },
+ *       {
+ *         description: "List of Availability Zones (AZs) to use for the subnets in the VPC.",
+ *         name: "AvailabilityZones",
+ *         required: "Yes"
+ *       },
+ *       {
+ *         description: "CIDR block for the VPC.",
+ *         name: "VPCCIDR",
+ *         required: "Yes"
+ *       }
+ *     ],
+ *     status: "ACTIVE",
+ *     workloadName: "MicrosoftActiveDirectory",
+ *     workloadVersionName: "2024-03-19-14-00-09"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetWorkloadDeploymentPatternCommand extends GetWorkloadDeploymentPatternCommand_base {

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

@@ -75,6 +75,37 @@ declare const ListDeploymentEventsCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example List all actions taken during a deployment.
+ * ```javascript
+ * //
+ * const input = {
+ *   deploymentId: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d"
+ * };
+ * const command = new ListDeploymentEventsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   deploymentEvents: [
+ *     {
+ *       description: "Creates a new secure parameter",
+ *       name: "Create secure parameter",
+ *       status: "COMPLETED",
+ *       statusReason: "",
+ *       timestamp: "2023-04-24T13:10:39.123Z"
+ *     },
+ *     {
+ *       description: "Creates a resource group with all the application resources",
+ *       name: "Create resource group",
+ *       status: "COMPLETED",
+ *       statusReason: "",
+ *       timestamp: "2023-04-24T13:10:42.238Z"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListDeploymentEventsCommand extends ListDeploymentEventsCommand_base {

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

@@ -80,6 +80,38 @@ declare const ListDeploymentsCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example List deployments in the account with filters.
+ * ```javascript
+ * //
+ * const input = {
+ *   filters: [
+ *     {
+ *       name: "DEPLOYMENT_STATUS",
+ *       values: [
+ *         "IN_PROGRESS"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new ListDeploymentsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   deployments: [
+ *     {
+ *       createdAt: "2023-04-24T13:10:09.857Z",
+ *       id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d",
+ *       name: "SapHanaSingleForTest",
+ *       patternName: "SapHanaSingle",
+ *       status: "IN_PROGRESS",
+ *       workloadName: "SAP"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListDeploymentsCommand extends ListDeploymentsCommand_base {

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

@@ -66,6 +66,25 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Listing tags on a Launch Wizard deployment resource.
+ * ```javascript
+ * //
+ * const input = {
+ *   resourceArn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   tags: {
+ *     key1: "value1",
+ *     key2: "value2"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

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

@@ -77,6 +77,39 @@ declare const ListWorkloadDeploymentPatternsCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example List all available workloads supported by AWS Launch Wizard.
+ * ```javascript
+ * //
+ * const input = {
+ *   workloadName: "SAP"
+ * };
+ * const command = new ListWorkloadDeploymentPatternsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   workloadDeploymentPatterns: [
+ *     {
+ *       deploymentPatternName: "SapHanaHA",
+ *       description: "Deployment Option Description",
+ *       displayName: "Deployment Option Display Name",
+ *       status: "ACTIVE",
+ *       workloadName: "SAP",
+ *       workloadVersionName: "2023-08-02-01-00-00"
+ *     },
+ *     {
+ *       deploymentPatternName: "SapHanaMulti",
+ *       description: "Deployment Option Description",
+ *       displayName: "Deployment Option Display Name",
+ *       status: "ACTIVE",
+ *       workloadName: "SAP",
+ *       workloadVersionName: "2023-08-02-01-00-00"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListWorkloadDeploymentPatternsCommand extends ListWorkloadDeploymentPatternsCommand_base {

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

@@ -68,6 +68,29 @@ declare const ListWorkloadsCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example List all available workloads supported by AWS Launch Wizard.
+ * ```javascript
+ * //
+ * const input = { /* empty *\/ };
+ * const command = new ListWorkloadsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   workloads: [
+ *     {
+ *       displayName: "SAP",
+ *       workloadName: "SAP"
+ *     },
+ *     {
+ *       displayName: "MS SQL Server",
+ *       workloadName: "SQL"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListWorkloadsCommand extends ListWorkloadsCommand_base {

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

@@ -65,6 +65,24 @@ declare const TagResourceCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Adding tags to a Launch Wizard deployment resource.
+ * ```javascript
+ * //
+ * const input = {
+ *   resourceArn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111",
+ *   tags: {
+ *     key1: "value1",
+ *     key2: "value2"
+ *   }
+ * };
+ * 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

@@ -65,6 +65,24 @@ declare const UntagResourceCommand_base: {
  * @throws {@link LaunchWizardServiceException}
  * <p>Base exception class for all service exceptions from LaunchWizard service.</p>
  *
+ *
+ * @example Removing tags on a Launch Wizard deployment resource.
+ * ```javascript
+ * //
+ * const input = {
+ *   resourceArn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111",
+ *   tagKeys: [
+ *     "key1",
+ *     "key2"
+ *   ]
+ * };
+ * 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-launch-wizard",
   "description": "AWS SDK for JavaScript Launch Wizard 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-launch-wizard",
@@ -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",