@aws-sdk/client-synthetics 3.686.0 → 3.691.0

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

@@ -30,14 +30,14 @@ export interface S3EncryptionConfig {
      *         </p>
      * @public
      */
-    EncryptionMode?: EncryptionMode;
+    EncryptionMode?: EncryptionMode | undefined;
     /**
      * <p>The ARN of the customer-managed KMS key to use, if you specify <code>SSE-KMS</code>
      *          for <code>EncryptionMode</code>
      *          </p>
      * @public
      */
-    KmsKeyArn?: string;
+    KmsKeyArn?: string | undefined;
 }
 /**
  * <p>A structure that contains the configuration for canary artifacts, including the
@@ -54,7 +54,7 @@ export interface ArtifactConfigInput {
      *          </p>
      * @public
      */
-    S3Encryption?: S3EncryptionConfig;
+    S3Encryption?: S3EncryptionConfig | undefined;
 }
 /**
  * <p>A structure that contains the configuration for canary artifacts, including
@@ -66,7 +66,7 @@ export interface ArtifactConfigOutput {
      * <p>A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3. </p>
      * @public
      */
-    S3Encryption?: S3EncryptionConfig;
+    S3Encryption?: S3EncryptionConfig | undefined;
 }
 /**
  * @public
@@ -96,7 +96,7 @@ export interface AssociateResourceResponse {
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -109,7 +109,7 @@ export declare class ConflictException extends __BaseException {
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
     readonly $fault: "server";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -122,7 +122,7 @@ export declare class InternalServerException extends __BaseException {
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -135,7 +135,7 @@ export declare class ResourceNotFoundException extends __BaseException {
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -148,7 +148,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -161,7 +161,7 @@ export declare class ValidationException extends __BaseException {
 export declare class BadRequestException extends __BaseException {
     readonly name: "BadRequestException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -187,7 +187,7 @@ export interface BaseScreenshot {
      *          </p>
      * @public
      */
-    IgnoreCoordinates?: string[];
+    IgnoreCoordinates?: string[] | undefined;
 }
 /**
  * <p>This structure contains information about the canary's Lambda handler and
@@ -199,13 +199,25 @@ export interface CanaryCodeOutput {
      * <p>The ARN of the Lambda layer where Synthetics stores the canary script code.</p>
      * @public
      */
-    SourceLocationArn?: string;
+    SourceLocationArn?: string | undefined;
     /**
      * <p>The entry point to use for the source code when running the canary.</p>
      * @public
      */
-    Handler?: string;
+    Handler?: string | undefined;
 }
+/**
+ * @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
@@ -215,18 +227,18 @@ export interface CanaryRunConfigOutput {
      * <p>How long the canary is allowed to run before it must stop.</p>
      * @public
      */
-    TimeoutInSeconds?: number;
+    TimeoutInSeconds?: number | undefined;
     /**
      * <p>The maximum amount of memory available to the canary while it is running, in MB. This value
      *          must be a multiple of 64.</p>
      * @public
      */
-    MemoryInMB?: number;
+    MemoryInMB?: number | undefined;
     /**
      * <p>Displays whether this canary run used active X-Ray tracing. </p>
      * @public
      */
-    ActiveTracing?: boolean;
+    ActiveTracing?: boolean | undefined;
 }
 /**
  * <p>How long, in seconds, for the canary to continue making regular runs according to the schedule in the
@@ -251,14 +263,14 @@ export interface CanaryScheduleOutput {
      *             Scheduling canary runs using cron</a>.</p>
      * @public
      */
-    Expression?: string;
+    Expression?: string | undefined;
     /**
      * <p>How long, in seconds, for the canary to continue making regular runs after it
      *          was created. The runs are performed according to the schedule in the
      *          <code>Expression</code> value.</p>
      * @public
      */
-    DurationInSeconds?: number;
+    DurationInSeconds?: number | undefined;
 }
 /**
  * @public
@@ -310,17 +322,17 @@ export interface CanaryStatus {
      * <p>The current state of the canary.</p>
      * @public
      */
-    State?: CanaryState;
+    State?: CanaryState | undefined;
     /**
      * <p>If the canary has insufficient permissions to run, this field provides more details.</p>
      * @public
      */
-    StateReason?: string;
+    StateReason?: string | undefined;
     /**
      * <p>If the canary cannot run or has failed, this field displays the reason.</p>
      * @public
      */
-    StateReasonCode?: CanaryStateReasonCode;
+    StateReasonCode?: CanaryStateReasonCode | undefined;
 }
 /**
  * <p>This structure contains information about when the canary was created and modified.</p>
@@ -331,22 +343,22 @@ export interface CanaryTimeline {
      * <p>The date and time the canary was created.</p>
      * @public
      */
-    Created?: Date;
+    Created?: Date | undefined;
     /**
      * <p>The date and time the canary was most recently modified.</p>
      * @public
      */
-    LastModified?: Date;
+    LastModified?: Date | undefined;
     /**
      * <p>The date and time that the canary's most recent run started.</p>
      * @public
      */
-    LastStarted?: Date;
+    LastStarted?: Date | undefined;
     /**
      * <p>The date and time that the canary's most recent run ended.</p>
      * @public
      */
-    LastStopped?: Date;
+    LastStopped?: Date | undefined;
 }
 /**
  * <p>If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates
@@ -359,13 +371,13 @@ export interface VisualReferenceOutput {
      * <p>An array of screenshots that are used as the baseline for comparisons during visual monitoring.</p>
      * @public
      */
-    BaseScreenshots?: BaseScreenshot[];
+    BaseScreenshots?: BaseScreenshot[] | undefined;
     /**
      * <p>The ID of the canary run that produced the baseline screenshots
      *          that are used for visual monitoring comparisons by this canary.</p>
      * @public
      */
-    BaseCanaryRunId?: string;
+    BaseCanaryRunId?: string | undefined;
 }
 /**
  * <p>If this canary is to test an endpoint in a VPC, this structure contains
@@ -379,17 +391,17 @@ export interface VpcConfigOutput {
      * <p>The IDs of the VPC where this canary is to run.</p>
      * @public
      */
-    VpcId?: string;
+    VpcId?: string | undefined;
     /**
      * <p>The IDs of the subnets where this canary is to run.</p>
      * @public
      */
-    SubnetIds?: string[];
+    SubnetIds?: string[] | undefined;
     /**
      * <p>The IDs of the security groups for this canary.</p>
      * @public
      */
-    SecurityGroupIds?: string[];
+    SecurityGroupIds?: string[] | undefined;
 }
 /**
  * <p>This structure contains all information about one canary in your account.</p>
@@ -400,75 +412,75 @@ export interface Canary {
      * <p>The unique ID of this canary.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The name of the canary.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>This structure contains information about the canary's Lambda handler and
      *       where its code is stored by CloudWatch Synthetics.</p>
      * @public
      */
-    Code?: CanaryCodeOutput;
+    Code?: CanaryCodeOutput | undefined;
     /**
      * <p>The ARN of the IAM role used to run the canary. This role must include <code>lambda.amazonaws.com</code> as a principal in the trust
      *          policy.</p>
      * @public
      */
-    ExecutionRoleArn?: string;
+    ExecutionRoleArn?: string | undefined;
     /**
      * <p>A structure that contains information about how often the canary is to run, and when
      *          these runs are to stop.</p>
      * @public
      */
-    Schedule?: CanaryScheduleOutput;
+    Schedule?: CanaryScheduleOutput | undefined;
     /**
      * <p>A structure that contains information about a canary run.</p>
      * @public
      */
-    RunConfig?: CanaryRunConfigOutput;
+    RunConfig?: CanaryRunConfigOutput | undefined;
     /**
      * <p>The number of days to retain data about successful runs of this canary.</p>
      * @public
      */
-    SuccessRetentionPeriodInDays?: number;
+    SuccessRetentionPeriodInDays?: number | undefined;
     /**
      * <p>The number of days to retain data about failed runs of this canary.</p>
      * @public
      */
-    FailureRetentionPeriodInDays?: number;
+    FailureRetentionPeriodInDays?: number | undefined;
     /**
      * <p>A structure that contains information about the canary's status.</p>
      * @public
      */
-    Status?: CanaryStatus;
+    Status?: CanaryStatus | undefined;
     /**
      * <p>A structure that contains information about when the canary was created, modified, and
      *          most recently run.</p>
      * @public
      */
-    Timeline?: CanaryTimeline;
+    Timeline?: CanaryTimeline | undefined;
     /**
      * <p>The location in Amazon S3 where Synthetics stores artifacts from the runs of this
      *          canary. Artifacts include the log file, screenshots, and HAR files.</p>
      * @public
      */
-    ArtifactS3Location?: string;
+    ArtifactS3Location?: string | undefined;
     /**
      * <p>The ARN of the Lambda function that is used as your canary's engine. For more information
      *          about Lambda ARN format, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html">Resources and Conditions for Lambda Actions</a>.</p>
      * @public
      */
-    EngineArn?: string;
+    EngineArn?: string | undefined;
     /**
      * <p>Specifies the runtime version to use for the canary. For more information about
      *          runtime versions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html">
      *             Canary Runtime Versions</a>.</p>
      * @public
      */
-    RuntimeVersion?: string;
+    RuntimeVersion?: string | undefined;
     /**
      * <p>If this canary is to test an endpoint in a VPC, this structure contains
      *          information about the subnets and security groups of the VPC endpoint.
@@ -476,24 +488,34 @@ export interface Canary {
      *             Running a Canary in a VPC</a>.</p>
      * @public
      */
-    VpcConfig?: VpcConfigOutput;
+    VpcConfig?: VpcConfigOutput | undefined;
     /**
      * <p>If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates
      *       of any parts of the screen to ignore during the visual monitoring comparison.</p>
      * @public
      */
-    VisualReference?: VisualReferenceOutput;
+    VisualReference?: VisualReferenceOutput | undefined;
+    /**
+     * <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 | undefined;
     /**
      * <p>The list of key-value pairs that are associated with the canary.</p>
      * @public
      */
-    Tags?: Record<string, string>;
+    Tags?: Record<string, string> | undefined;
     /**
      * <p>A structure that contains the configuration for canary artifacts, including
      *          the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>
      * @public
      */
-    ArtifactConfig?: ArtifactConfigOutput;
+    ArtifactConfig?: ArtifactConfigOutput | undefined;
 }
 /**
  * @public
@@ -529,19 +551,19 @@ export interface CanaryRunStatus {
      * <p>The current state of the run.</p>
      * @public
      */
-    State?: CanaryRunState;
+    State?: CanaryRunState | undefined;
     /**
      * <p>If run of the canary failed, this field contains the reason for the error.</p>
      * @public
      */
-    StateReason?: string;
+    StateReason?: string | undefined;
     /**
      * <p>If this value is <code>CANARY_FAILURE</code>, an exception occurred in the
      *          canary code. If this value is <code>EXECUTION_FAILURE</code>, an exception occurred in
      *          CloudWatch Synthetics.</p>
      * @public
      */
-    StateReasonCode?: CanaryRunStateReasonCode;
+    StateReasonCode?: CanaryRunStateReasonCode | undefined;
 }
 /**
  * <p>This structure contains the start and end times of a single canary run.</p>
@@ -552,12 +574,12 @@ export interface CanaryRunTimeline {
      * <p>The start time of the run.</p>
      * @public
      */
-    Started?: Date;
+    Started?: Date | undefined;
     /**
      * <p>The end time of the run.</p>
      * @public
      */
-    Completed?: Date;
+    Completed?: Date | undefined;
 }
 /**
  * <p>This structure contains the details about one run of one canary.</p>
@@ -568,28 +590,28 @@ export interface CanaryRun {
      * <p>A unique ID that identifies this canary run.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The name of the canary.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>The status of this run.</p>
      * @public
      */
-    Status?: CanaryRunStatus;
+    Status?: CanaryRunStatus | undefined;
     /**
      * <p>A structure that contains the start and end times of this run.</p>
      * @public
      */
-    Timeline?: CanaryRunTimeline;
+    Timeline?: CanaryRunTimeline | undefined;
     /**
      * <p>The location where the canary stored artifacts from the run. Artifacts include
      *          the log file, screenshots, and HAR files.</p>
      * @public
      */
-    ArtifactS3Location?: string;
+    ArtifactS3Location?: string | undefined;
 }
 /**
  * <p>This structure contains information about the most recent run of a single canary.</p>
@@ -600,12 +622,12 @@ export interface CanaryLastRun {
      * <p>The name of the canary.</p>
      * @public
      */
-    CanaryName?: string;
+    CanaryName?: string | undefined;
     /**
      * <p>The results from this canary's most recent run.</p>
      * @public
      */
-    LastRun?: CanaryRun;
+    LastRun?: CanaryRun | undefined;
 }
 /**
  * <p>Use this structure to input your script code for the canary. This structure contains the
@@ -638,17 +660,17 @@ export interface CanaryCodeInput {
      *          start of the bucket name.</p>
      * @public
      */
-    S3Bucket?: string;
+    S3Bucket?: string | undefined;
     /**
      * <p>The S3 key of your script. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html">Working with Amazon S3 Objects</a>.</p>
      * @public
      */
-    S3Key?: string;
+    S3Key?: string | undefined;
     /**
      * <p>The S3 version ID of your script.</p>
      * @public
      */
-    S3Version?: string;
+    S3Version?: string | undefined;
     /**
      * <p>If you input your canary script directly into the canary instead of referring to an S3
      *          location, the value of this parameter is the base64-encoded contents of the .zip file that
@@ -657,7 +679,7 @@ export interface CanaryCodeInput {
      *       directly with this parameter.</p>
      * @public
      */
-    ZipFile?: Uint8Array;
+    ZipFile?: Uint8Array | undefined;
     /**
      * <p>The entry point to use for the source code when running the canary. For canaries that use the
      *          <code>syn-python-selenium-1.0</code> runtime
@@ -688,12 +710,12 @@ export interface CanaryRunConfigInput {
      *          frequency of the canary is used as this value, up to a maximum of 14 minutes.</p>
      * @public
      */
-    TimeoutInSeconds?: number;
+    TimeoutInSeconds?: number | undefined;
     /**
      * <p>The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.</p>
      * @public
      */
-    MemoryInMB?: number;
+    MemoryInMB?: number | undefined;
     /**
      * <p>Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing
      *          enables
@@ -705,7 +727,7 @@ export interface CanaryRunConfigInput {
      *       or later for their canary runtime.</p>
      * @public
      */
-    ActiveTracing?: boolean;
+    ActiveTracing?: boolean | undefined;
     /**
      * <p>Specifies the keys and values to use for any environment variables
      *       used in the canary script. Use the following format:</p>
@@ -721,7 +743,7 @@ export interface CanaryRunConfigInput {
      *          </important>
      * @public
      */
-    EnvironmentVariables?: Record<string, string>;
+    EnvironmentVariables?: Record<string, string> | undefined;
 }
 /**
  * <p>This structure specifies how often a canary is to make runs and the date and time
@@ -753,7 +775,7 @@ export interface CanaryScheduleInput {
      *          making runs until you stop it. If you omit this field, the default of 0 is used.</p>
      * @public
      */
-    DurationInSeconds?: number;
+    DurationInSeconds?: number | undefined;
 }
 /**
  * @public
@@ -778,12 +800,12 @@ export interface VpcConfigInput {
      * <p>The IDs of the subnets where this canary is to run.</p>
      * @public
      */
-    SubnetIds?: string[];
+    SubnetIds?: string[] | undefined;
     /**
      * <p>The IDs of the security groups for this canary.</p>
      * @public
      */
-    SecurityGroupIds?: string[];
+    SecurityGroupIds?: string[] | undefined;
 }
 /**
  * @public
@@ -873,19 +895,19 @@ export interface CreateCanaryRequest {
      *          </important>
      * @public
      */
-    RunConfig?: CanaryRunConfigInput;
+    RunConfig?: CanaryRunConfigInput | undefined;
     /**
      * <p>The number of days to retain data about successful runs of this canary. If you omit
      *          this field, the default of 31 days is used. The valid range is 1 to 455 days.</p>
      * @public
      */
-    SuccessRetentionPeriodInDays?: number;
+    SuccessRetentionPeriodInDays?: number | undefined;
     /**
      * <p>The number of days to retain data about failed runs of this canary. If you omit
      *          this field, the default of 31 days is used. The valid range is 1 to 455 days.</p>
      * @public
      */
-    FailureRetentionPeriodInDays?: number;
+    FailureRetentionPeriodInDays?: number | undefined;
     /**
      * <p>Specifies the runtime version to use for the canary. For a list of valid
      *          runtime versions and more information about
@@ -901,15 +923,25 @@ export interface CreateCanaryRequest {
      *          Running a Canary in a VPC</a>.</p>
      * @public
      */
-    VpcConfig?: VpcConfigInput;
+    VpcConfig?: VpcConfigInput | undefined;
     /**
      * <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[] | undefined;
+    /**
+     * <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
      */
-    ResourcesToReplicateTags?: ResourceToTag[];
+    ProvisionedResourceCleanup?: ProvisionedResourceCleanupSetting | undefined;
     /**
      * <p>A list of key-value pairs to associate with the canary.
      *          You can associate as many as 50 tags with a canary.</p>
@@ -921,13 +953,13 @@ export interface CreateCanaryRequest {
      *          the canary uses, specify this parameter with the value <code>lambda-function</code>.</p>
      * @public
      */
-    Tags?: Record<string, string>;
+    Tags?: Record<string, string> | undefined;
     /**
      * <p>A structure that contains the configuration for canary artifacts, including
      *          the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>
      * @public
      */
-    ArtifactConfig?: ArtifactConfigInput;
+    ArtifactConfig?: ArtifactConfigInput | undefined;
 }
 /**
  * @public
@@ -937,7 +969,7 @@ export interface CreateCanaryResponse {
      * <p>The full details about the canary you have created.</p>
      * @public
      */
-    Canary?: Canary;
+    Canary?: Canary | undefined;
 }
 /**
  * <p>One of the input resources is larger than is allowed.</p>
@@ -946,7 +978,7 @@ export interface CreateCanaryResponse {
 export declare class RequestEntityTooLargeException extends __BaseException {
     readonly name: "RequestEntityTooLargeException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -971,7 +1003,7 @@ export interface CreateGroupRequest {
      *          certain tag values.</p>
      * @public
      */
-    Tags?: Record<string, string>;
+    Tags?: Record<string, string> | undefined;
 }
 /**
  * <p>This structure contains information about one group.</p>
@@ -982,32 +1014,32 @@ export interface Group {
      * <p>The unique ID of the group.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The name of the group.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>The ARN of the group.</p>
      * @public
      */
-    Arn?: string;
+    Arn?: string | undefined;
     /**
      * <p>The list of key-value pairs that are associated with the canary.</p>
      * @public
      */
-    Tags?: Record<string, string>;
+    Tags?: Record<string, string> | undefined;
     /**
      * <p>The date and time that the group was created.</p>
      * @public
      */
-    CreatedTime?: Date;
+    CreatedTime?: Date | undefined;
     /**
      * <p>The date and time that the group was most recently updated.</p>
      * @public
      */
-    LastModifiedTime?: Date;
+    LastModifiedTime?: Date | undefined;
 }
 /**
  * @public
@@ -1017,7 +1049,7 @@ export interface CreateGroupResponse {
      * <p>A structure that contains information about the group that was just created.</p>
      * @public
      */
-    Group?: Group;
+    Group?: Group | undefined;
 }
 /**
  * @public
@@ -1030,11 +1062,14 @@ 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
      */
-    DeleteLambda?: boolean;
+    DeleteLambda?: boolean | undefined;
 }
 /**
  * @public
@@ -1067,13 +1102,13 @@ export interface DescribeCanariesRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many canaries are returned each time you use
      *       the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 20 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
     /**
      * <p>Use this parameter to return only canaries that match the names that you specify here. You can
      *          specify as many as five canary names.</p>
@@ -1086,7 +1121,7 @@ export interface DescribeCanariesRequest {
      *             Limiting a user to viewing specific canaries</a>.</p>
      * @public
      */
-    Names?: string[];
+    Names?: string[] | undefined;
 }
 /**
  * @public
@@ -1097,14 +1132,14 @@ export interface DescribeCanariesResponse {
      *          one canary.</p>
      * @public
      */
-    Canaries?: Canary[];
+    Canaries?: Canary[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>DescribeCanaries</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1116,13 +1151,13 @@ export interface DescribeCanariesLastRunRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many runs are returned each time you use
      *          the <code>DescribeLastRun</code> operation. If you omit this parameter, the default of 100 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
     /**
      * <p>Use this parameter to return only canaries that match the names that you specify here. You can
      *          specify as many as five canary names.</p>
@@ -1135,7 +1170,7 @@ export interface DescribeCanariesLastRunRequest {
      *             Limiting a user to viewing specific canaries</a>.</p>
      * @public
      */
-    Names?: string[];
+    Names?: string[] | undefined;
 }
 /**
  * @public
@@ -1146,14 +1181,14 @@ export interface DescribeCanariesLastRunResponse {
      *          canary.</p>
      * @public
      */
-    CanariesLastRun?: CanaryLastRun[];
+    CanariesLastRun?: CanaryLastRun[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>DescribeCanariesLastRun</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1165,13 +1200,13 @@ export interface DescribeRuntimeVersionsRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many runs are returned each time you use
      *          the <code>DescribeRuntimeVersions</code> operation. If you omit this parameter, the default of 100 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
 }
 /**
  * <p>This structure contains information about one canary runtime version. For more information about
@@ -1186,22 +1221,22 @@ export interface RuntimeVersion {
      *             Canary Runtime Versions</a>.</p>
      * @public
      */
-    VersionName?: string;
+    VersionName?: string | undefined;
     /**
      * <p>A description of the runtime version, created by Amazon.</p>
      * @public
      */
-    Description?: string;
+    Description?: string | undefined;
     /**
      * <p>The date that the runtime version was released.</p>
      * @public
      */
-    ReleaseDate?: Date;
+    ReleaseDate?: Date | undefined;
     /**
      * <p>If this runtime version is deprecated, this value is the date of deprecation.</p>
      * @public
      */
-    DeprecationDate?: Date;
+    DeprecationDate?: Date | undefined;
 }
 /**
  * @public
@@ -1212,14 +1247,14 @@ export interface DescribeRuntimeVersionsResponse {
      *          version.</p>
      * @public
      */
-    RuntimeVersions?: RuntimeVersion[];
+    RuntimeVersions?: RuntimeVersion[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>DescribeRuntimeVersions</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1260,7 +1295,7 @@ export interface GetCanaryResponse {
      * <p>A structure that contains the full information about the canary.</p>
      * @public
      */
-    Canary?: Canary;
+    Canary?: Canary | undefined;
 }
 /**
  * @public
@@ -1277,13 +1312,13 @@ export interface GetCanaryRunsRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many runs are returned each time you use
      *          the <code>GetCanaryRuns</code> operation. If you omit this parameter, the default of 100 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
 }
 /**
  * @public
@@ -1294,7 +1329,7 @@ export interface GetCanaryRunsResponse {
      *          retrieved canary runs.</p>
      * @public
      */
-    CanaryRuns?: CanaryRun[];
+    CanaryRuns?: CanaryRun[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>GetCanaryRuns</code>
@@ -1302,7 +1337,7 @@ export interface GetCanaryRunsResponse {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1323,7 +1358,7 @@ export interface GetGroupResponse {
      * <p>A structure that contains information about the group.</p>
      * @public
      */
-    Group?: Group;
+    Group?: Group | undefined;
 }
 /**
  * <p>A structure containing some information about a group.</p>
@@ -1334,17 +1369,17 @@ export interface GroupSummary {
      * <p>The unique ID of the group.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The name of the group.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>The ARN of the group.</p>
      * @public
      */
-    Arn?: string;
+    Arn?: string | undefined;
 }
 /**
  * <p>An internal failure occurred. Try the operation again.</p>
@@ -1353,7 +1388,7 @@ export interface GroupSummary {
 export declare class InternalFailureException extends __BaseException {
     readonly name: "InternalFailureException";
     readonly $fault: "server";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -1369,13 +1404,13 @@ export interface ListAssociatedGroupsRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many groups are returned each time you use
      *          the <code>ListAssociatedGroups</code> operation. If you omit this parameter, the default of 20 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
     /**
      * <p>The ARN of the canary that you want to view groups for.</p>
      * @public
@@ -1390,14 +1425,14 @@ export interface ListAssociatedGroupsResponse {
      * <p>An array of structures that contain information about the groups that this canary is associated with.</p>
      * @public
      */
-    Groups?: GroupSummary[];
+    Groups?: GroupSummary[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>ListAssociatedGroups</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1409,13 +1444,13 @@ export interface ListGroupResourcesRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many canary ARNs are returned each time you use
      *          the <code>ListGroupResources</code> operation. If you omit this parameter, the default of 20 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
     /**
      * <p>Specifies the group to return information for. You can specify the group name, the ARN, or the
      *          group ID as the <code>GroupIdentifier</code>.</p>
@@ -1431,14 +1466,14 @@ export interface ListGroupResourcesResponse {
      * <p>An array of ARNs. These ARNs are for the canaries that are associated with the group.</p>
      * @public
      */
-    Resources?: string[];
+    Resources?: string[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>ListGroupResources</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1450,13 +1485,13 @@ export interface ListGroupsRequest {
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>Specify this parameter to limit how many groups are returned each time you use
      *          the <code>ListGroups</code> operation. If you omit this parameter, the default of 20 is used.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
 }
 /**
  * @public
@@ -1466,14 +1501,14 @@ export interface ListGroupsResponse {
      * <p>An array of structures that each contain information about one group.</p>
      * @public
      */
-    Groups?: GroupSummary[];
+    Groups?: GroupSummary[] | undefined;
     /**
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>ListGroups</code> operation to retrieve the next
      *          set of results.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * @public
@@ -1500,7 +1535,7 @@ export interface ListTagsForResourceResponse {
      * <p>The list of tag keys and values associated with the resource that you specified.</p>
      * @public
      */
-    Tags?: Record<string, string>;
+    Tags?: Record<string, string> | undefined;
 }
 /**
  * <p>The specified resource was not found.</p>
@@ -1509,7 +1544,7 @@ export interface ListTagsForResourceResponse {
 export declare class NotFoundException extends __BaseException {
     readonly name: "NotFoundException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -1522,7 +1557,7 @@ export declare class NotFoundException extends __BaseException {
 export declare class TooManyRequestsException extends __BaseException {
     readonly name: "TooManyRequestsException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -1630,7 +1665,7 @@ export interface VisualReferenceInput {
      *       visual monitoring, remove it from this array.</p>
      * @public
      */
-    BaseScreenshots?: BaseScreenshot[];
+    BaseScreenshots?: BaseScreenshot[] | undefined;
     /**
      * <p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are
      *          <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run
@@ -1658,7 +1693,7 @@ export interface UpdateCanaryRequest {
      *       </p>
      * @public
      */
-    Code?: CanaryCodeInput;
+    Code?: CanaryCodeInput | undefined;
     /**
      * <p>The ARN of the IAM role to be used to run the canary. This role must already exist,
      *          and must include <code>lambda.amazonaws.com</code> as a principal in the trust
@@ -1702,7 +1737,7 @@ export interface UpdateCanaryRequest {
      *          </ul>
      * @public
      */
-    ExecutionRoleArn?: string;
+    ExecutionRoleArn?: string | undefined;
     /**
      * <p>Specifies the runtime version to use for the canary.
      *          For a list of valid runtime versions and for more information about
@@ -1710,13 +1745,13 @@ export interface UpdateCanaryRequest {
      *             Canary Runtime Versions</a>.</p>
      * @public
      */
-    RuntimeVersion?: string;
+    RuntimeVersion?: string | undefined;
     /**
      * <p>A structure that contains information about how often the canary is to run, and when
      *          these runs are to stop.</p>
      * @public
      */
-    Schedule?: CanaryScheduleInput;
+    Schedule?: CanaryScheduleInput | undefined;
     /**
      * <p>A structure that contains the timeout value that is used for each individual run of the
      *          canary.</p>
@@ -1726,17 +1761,17 @@ export interface UpdateCanaryRequest {
      *          </important>
      * @public
      */
-    RunConfig?: CanaryRunConfigInput;
+    RunConfig?: CanaryRunConfigInput | undefined;
     /**
      * <p>The number of days to retain data about successful runs of this canary.</p>
      * @public
      */
-    SuccessRetentionPeriodInDays?: number;
+    SuccessRetentionPeriodInDays?: number | undefined;
     /**
      * <p>The number of days to retain data about failed runs of this canary.</p>
      * @public
      */
-    FailureRetentionPeriodInDays?: number;
+    FailureRetentionPeriodInDays?: number | undefined;
     /**
      * <p>If this canary is to test an endpoint in a VPC, this structure contains
      *          information about the subnet and security groups of the VPC endpoint.
@@ -1744,7 +1779,7 @@ export interface UpdateCanaryRequest {
      *             Running a Canary in a VPC</a>.</p>
      * @public
      */
-    VpcConfig?: VpcConfigInput;
+    VpcConfig?: VpcConfigInput | undefined;
     /**
      * <p>Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this
      *       parameter, no changes are made to any baseline screenshots that the canary might be using already.</p>
@@ -1755,21 +1790,30 @@ export interface UpdateCanaryRequest {
      *          </p>
      * @public
      */
-    VisualReference?: VisualReferenceInput;
+    VisualReference?: VisualReferenceInput | undefined;
     /**
      * <p>The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
      *          Artifacts include the log file, screenshots, and HAR files. The name of the
      *          S3 bucket can't include a period (.).</p>
      * @public
      */
-    ArtifactS3Location?: string;
+    ArtifactS3Location?: string | undefined;
     /**
      * <p>A structure that contains the configuration for canary artifacts,
      *          including the encryption-at-rest settings for artifacts that
      *          the canary uploads to Amazon S3.</p>
      * @public
      */
-    ArtifactConfig?: ArtifactConfigInput;
+    ArtifactConfig?: ArtifactConfigInput | undefined;
+    /**
+     * <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 | undefined;
 }
 /**
  * @public