@aws-sdk/client-synthetics 3.686.0 → 3.687.0

package/dist-cjs/index.js

@@ -47,6 +47,7 @@ __export(src_exports, {
   ListGroupsCommand: () => ListGroupsCommand,
   ListTagsForResourceCommand: () => ListTagsForResourceCommand,
   NotFoundException: () => NotFoundException,
+  ProvisionedResourceCleanupSetting: () => ProvisionedResourceCleanupSetting,
   RequestEntityTooLargeException: () => RequestEntityTooLargeException,
   ResourceNotFoundException: () => ResourceNotFoundException,
   ResourceToTag: () => ResourceToTag,
@@ -349,6 +350,10 @@ var _BadRequestException = class _BadRequestException extends SyntheticsServiceE
 };
 __name(_BadRequestException, "BadRequestException");
 var BadRequestException = _BadRequestException;
+var ProvisionedResourceCleanupSetting = {
+  AUTOMATIC: "AUTOMATIC",
+  OFF: "OFF"
+};
 var CanaryState = {
   CREATING: "CREATING",
   DELETING: "DELETING",
@@ -491,6 +496,7 @@ var se_CreateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
       ExecutionRoleArn: [],
       FailureRetentionPeriodInDays: [],
       Name: [],
+      ProvisionedResourceCleanup: [],
       ResourcesToReplicateTags: (_) => (0, import_smithy_client._json)(_),
       RunConfig: (_) => (0, import_smithy_client._json)(_),
       RuntimeVersion: [],
@@ -761,6 +767,7 @@ var se_UpdateCanaryCommand = /* @__PURE__ */ __name(async (input, context) => {
       Code: (_) => se_CanaryCodeInput(_, context),
       ExecutionRoleArn: [],
       FailureRetentionPeriodInDays: [],
+      ProvisionedResourceCleanup: [],
       RunConfig: (_) => (0, import_smithy_client._json)(_),
       RuntimeVersion: [],
       Schedule: (_) => (0, import_smithy_client._json)(_),
@@ -1245,6 +1252,7 @@ var de_Canary = /* @__PURE__ */ __name((output, context) => {
     FailureRetentionPeriodInDays: import_smithy_client.expectInt32,
     Id: import_smithy_client.expectString,
     Name: import_smithy_client.expectString,
+    ProvisionedResourceCleanup: import_smithy_client.expectString,
     RunConfig: import_smithy_client._json,
     RuntimeVersion: import_smithy_client.expectString,
     Schedule: import_smithy_client._json,
@@ -1717,6 +1725,7 @@ var paginateListGroups = (0, import_core.createPaginator)(SyntheticsClient, List
   ServiceQuotaExceededException,
   ValidationException,
   BadRequestException,
+  ProvisionedResourceCleanupSetting,
   CanaryState,
   CanaryStateReasonCode,
   CanaryRunState,

package/dist-es/models/models_0.js

@@ -81,6 +81,10 @@ export class BadRequestException extends __BaseException {
         this.Message = opts.Message;
     }
 }
+export const ProvisionedResourceCleanupSetting = {
+    AUTOMATIC: "AUTOMATIC",
+    OFF: "OFF",
+};
 export const CanaryState = {
     CREATING: "CREATING",
     DELETING: "DELETING",

package/dist-es/protocols/Aws_restJson1.js

@@ -31,6 +31,7 @@ export const se_CreateCanaryCommand = async (input, context) => {
         ExecutionRoleArn: [],
         FailureRetentionPeriodInDays: [],
         Name: [],
+        ProvisionedResourceCleanup: [],
         ResourcesToReplicateTags: (_) => _json(_),
         RunConfig: (_) => _json(_),
         RuntimeVersion: [],
@@ -279,6 +280,7 @@ export const se_UpdateCanaryCommand = async (input, context) => {
         Code: (_) => se_CanaryCodeInput(_, context),
         ExecutionRoleArn: [],
         FailureRetentionPeriodInDays: [],
+        ProvisionedResourceCleanup: [],
         RunConfig: (_) => _json(_),
         RuntimeVersion: [],
         Schedule: (_) => _json(_),
@@ -766,6 +768,7 @@ const de_Canary = (output, context) => {
         FailureRetentionPeriodInDays: __expectInt32,
         Id: __expectString,
         Name: __expectString,
+        ProvisionedResourceCleanup: __expectString,
         RunConfig: _json,
         RuntimeVersion: __expectString,
         Schedule: _json,

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

@@ -84,6 +84,7 @@ declare const CreateCanaryCommand_base: {
  *   ResourcesToReplicateTags: [ // ResourceList
  *     "lambda-function",
  *   ],
+ *   ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  *   Tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
@@ -150,6 +151,7 @@ declare const CreateCanaryCommand_base: {
  * //       ],
  * //       BaseCanaryRunId: "STRING_VALUE",
  * //     },
+ * //     ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  * //     Tags: { // TagMap
  * //       "<keys>": "STRING_VALUE",
  * //     },

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

@@ -28,11 +28,11 @@ declare const DeleteCanaryCommand_base: {
 };
 /**
  * <p>Permanently deletes the specified canary.</p>
- *          <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes
+ *          <p>If the canary's <code>ProvisionedResourceCleanup</code> field is set to <code>AUTOMATIC</code>
+ *          or you specify <code>DeleteLambda</code> in this operation as <code>true</code>, CloudWatch Synthetics also deletes
  *          the Lambda functions and layers that are used by the canary.</p>
  *          <p>Other resources used and created by the canary are not automatically deleted.
- *          After you delete a canary that you do not intend to
- *          use again, you
+ *          After you delete a canary, you
  *       should also delete the following:</p>
  *          <ul>
  *             <li>

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

@@ -107,6 +107,7 @@ declare const DescribeCanariesCommand_base: {
  * //         ],
  * //         BaseCanaryRunId: "STRING_VALUE",
  * //       },
+ * //       ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  * //       Tags: { // TagMap
  * //         "<keys>": "STRING_VALUE",
  * //       },

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

@@ -95,6 +95,7 @@ declare const GetCanaryCommand_base: {
  * //       ],
  * //       BaseCanaryRunId: "STRING_VALUE",
  * //     },
+ * //     ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  * //     Tags: { // TagMap
  * //       "<keys>": "STRING_VALUE",
  * //     },

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

@@ -89,6 +89,7 @@ declare const UpdateCanaryCommand_base: {
  *       KmsKeyArn: "STRING_VALUE",
  *     },
  *   },
+ *   ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  * };
  * const command = new UpdateCanaryCommand(input);
  * const response = await client.send(command);

package/dist-types/models/models_0.d.ts

@@ -206,6 +206,18 @@ export interface CanaryCodeOutput {
      */
     Handler?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ProvisionedResourceCleanupSetting: {
+    readonly AUTOMATIC: "AUTOMATIC";
+    readonly OFF: "OFF";
+};
+/**
+ * @public
+ */
+export type ProvisionedResourceCleanupSetting = (typeof ProvisionedResourceCleanupSetting)[keyof typeof ProvisionedResourceCleanupSetting];
 /**
  * <p>A structure that contains information about a canary run.</p>
  * @public
@@ -483,6 +495,16 @@ export interface Canary {
      * @public
      */
     VisualReference?: VisualReferenceOutput;
+    /**
+     * <p>Specifies whether to also delete the Lambda functions and layers used by this canary
+     *          when the canary is deleted. If it is <code>AUTOMATIC</code>, the Lambda functions and layers will be deleted
+     *          when the canary is deleted.</p>
+     *          <p>If the value of this parameter is <code>OFF</code>, then the value of the <code>DeleteLambda</code> parameter
+     *          of the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html">DeleteCanary</a> operation
+     *          determines whether the Lambda functions and layers will be deleted.</p>
+     * @public
+     */
+    ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
     /**
      * <p>The list of key-value pairs that are associated with the canary.</p>
      * @public
@@ -906,10 +928,20 @@ export interface CreateCanaryRequest {
      * <p>To have the tags that you apply to this canary also be applied to the Lambda function that
      *          the canary uses, specify this parameter with the value <code>lambda-function</code>.</p>
      *          <p>If you specify this parameter and don't specify any tags in the <code>Tags</code>
-     *       parameter, the canary creation fails.</p>
+     *          parameter, the canary creation fails.</p>
      * @public
      */
     ResourcesToReplicateTags?: ResourceToTag[];
+    /**
+     * <p>Specifies whether to also delete the Lambda functions and layers used by this canary
+     *       when the canary is deleted. If you omit this parameter, the default of <code>AUTOMATIC</code> is used, which means
+     *          that the Lambda functions and layers will be deleted when the canary is deleted.</p>
+     *          <p>If the value of this parameter is <code>OFF</code>, then the value of the <code>DeleteLambda</code> parameter
+     *          of the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html">DeleteCanary</a> operation
+     *          determines whether the Lambda functions and layers will be deleted.</p>
+     * @public
+     */
+    ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
     /**
      * <p>A list of key-value pairs to associate with the canary.
      *          You can associate as many as 50 tags with a canary.</p>
@@ -1030,7 +1062,10 @@ export interface DeleteCanaryRequest {
     Name: string | undefined;
     /**
      * <p>Specifies whether to also delete the Lambda functions and layers used by this canary. The default
-     *       is false.</p>
+     *       is <code>false</code>.</p>
+     *          <p>Your setting for this parameter is used only if the canary doesn't have <code>AUTOMATIC</code> for its
+     *        <code>ProvisionedResourceCleanup</code> field. If that field is set to <code>AUTOMATIC</code>, then the
+     *        Lambda functions and layers will be deleted when this canary is deleted. </p>
      *          <p>Type: Boolean</p>
      * @public
      */
@@ -1770,6 +1805,15 @@ export interface UpdateCanaryRequest {
      * @public
      */
     ArtifactConfig?: ArtifactConfigInput;
+    /**
+     * <p>Specifies whether to also delete the Lambda functions and layers used by this canary
+     *          when the canary is deleted.</p>
+     *          <p>If the value of this parameter is <code>OFF</code>, then the value of the <code>DeleteLambda</code> parameter
+     *          of the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html">DeleteCanary</a> operation
+     *          determines whether the Lambda functions and layers will be deleted.</p>
+     * @public
+     */
+    ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
 }
 /**
  * @public

package/dist-types/ts3.4/models/models_0.d.ts

@@ -75,6 +75,12 @@ export interface CanaryCodeOutput {
   SourceLocationArn?: string;
   Handler?: string;
 }
+export declare const ProvisionedResourceCleanupSetting: {
+  readonly AUTOMATIC: "AUTOMATIC";
+  readonly OFF: "OFF";
+};
+export type ProvisionedResourceCleanupSetting =
+  (typeof ProvisionedResourceCleanupSetting)[keyof typeof ProvisionedResourceCleanupSetting];
 export interface CanaryRunConfigOutput {
   TimeoutInSeconds?: number;
   MemoryInMB?: number;
@@ -148,6 +154,7 @@ export interface Canary {
   RuntimeVersion?: string;
   VpcConfig?: VpcConfigOutput;
   VisualReference?: VisualReferenceOutput;
+  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
   Tags?: Record<string, string>;
   ArtifactConfig?: ArtifactConfigOutput;
 }
@@ -221,6 +228,7 @@ export interface CreateCanaryRequest {
   RuntimeVersion: string | undefined;
   VpcConfig?: VpcConfigInput;
   ResourcesToReplicateTags?: ResourceToTag[];
+  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
   Tags?: Record<string, string>;
   ArtifactConfig?: ArtifactConfigInput;
 }
@@ -411,5 +419,6 @@ export interface UpdateCanaryRequest {
   VisualReference?: VisualReferenceInput;
   ArtifactS3Location?: string;
   ArtifactConfig?: ArtifactConfigInput;
+  ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting;
 }
 export interface UpdateCanaryResponse {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-synthetics",
   "description": "AWS SDK for JavaScript Synthetics Client for Node.js, Browser and React Native",
-  "version": "3.686.0",
+  "version": "3.687.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-synthetics",
@@ -20,19 +20,19 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.686.0",
-    "@aws-sdk/client-sts": "3.686.0",
+    "@aws-sdk/client-sso-oidc": "3.687.0",
+    "@aws-sdk/client-sts": "3.687.0",
     "@aws-sdk/core": "3.686.0",
-    "@aws-sdk/credential-provider-node": "3.686.0",
+    "@aws-sdk/credential-provider-node": "3.687.0",
     "@aws-sdk/middleware-host-header": "3.686.0",
     "@aws-sdk/middleware-logger": "3.686.0",
     "@aws-sdk/middleware-recursion-detection": "3.686.0",
-    "@aws-sdk/middleware-user-agent": "3.686.0",
+    "@aws-sdk/middleware-user-agent": "3.687.0",
     "@aws-sdk/region-config-resolver": "3.686.0",
     "@aws-sdk/types": "3.686.0",
     "@aws-sdk/util-endpoints": "3.686.0",
     "@aws-sdk/util-user-agent-browser": "3.686.0",
-    "@aws-sdk/util-user-agent-node": "3.686.0",
+    "@aws-sdk/util-user-agent-node": "3.687.0",
     "@smithy/config-resolver": "^3.0.10",
     "@smithy/core": "^2.5.1",
     "@smithy/fetch-http-handler": "^4.0.0",