@aws-sdk/client-synthetics 3.529.1 → 3.535.0

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

@@ -13,58 +13,58 @@ export declare const EncryptionMode: {
  */
 export type EncryptionMode = (typeof EncryptionMode)[keyof typeof EncryptionMode];
 /**
- * @public
  * <p>A structure that contains the configuration of encryption-at-rest settings for canary artifacts that the canary
  *          uploads to Amazon S3. </p>
  *          <p>For more information, see
  *          <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html">Encrypting canary artifacts</a>
  *          </p>
+ * @public
  */
 export interface S3EncryptionConfig {
     /**
-     * @public
      * <p> The encryption method to use for artifacts created by this canary. Specify <code>SSE_S3</code> to use
      *          server-side encryption (SSE) with an Amazon S3-managed
      *          key. Specify <code>SSE-KMS</code> to use server-side encryption with a customer-managed KMS key.</p>
      *          <p>If you omit this parameter, an
      *             Amazon Web Services-managed KMS key is used.
      *         </p>
+     * @public
      */
     EncryptionMode?: EncryptionMode;
     /**
-     * @public
      * <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;
 }
 /**
- * @public
  * <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
  */
 export interface ArtifactConfigInput {
     /**
-     * @public
      * <p>A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads
      *          to Amazon S3.
      *          Artifact encryption functionality is available only for canaries that use Synthetics runtime version
      *          syn-nodejs-puppeteer-3.3 or later. For more information, see
      *          <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html">Encrypting canary artifacts</a>
      *          </p>
+     * @public
      */
     S3Encryption?: S3EncryptionConfig;
 }
 /**
- * @public
  * <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
  */
 export interface ArtifactConfigOutput {
     /**
-     * @public
      * <p>A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3. </p>
+     * @public
      */
     S3Encryption?: S3EncryptionConfig;
 }
@@ -73,14 +73,14 @@ export interface ArtifactConfigOutput {
  */
 export interface AssociateResourceRequest {
     /**
-     * @public
      * <p>Specifies the group. You can specify the group name, the ARN, or the
      *          group ID as the <code>GroupIdentifier</code>.</p>
+     * @public
      */
     GroupIdentifier: string | undefined;
     /**
-     * @public
      * <p>The ARN of the canary that you want to associate with the specified group.</p>
+     * @public
      */
     ResourceArn: string | undefined;
 }
@@ -90,8 +90,8 @@ export interface AssociateResourceRequest {
 export interface AssociateResourceResponse {
 }
 /**
- * @public
  * <p>A conflicting operation is already in progress.</p>
+ * @public
  */
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
@@ -103,8 +103,8 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
- * @public
  * <p>An unknown internal error occurred.</p>
+ * @public
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -116,8 +116,8 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * @public
  * <p>One of the specified resources was not found.</p>
+ * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
@@ -129,8 +129,8 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
- * @public
  * <p>The request exceeded a service quota value.</p>
+ * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
@@ -142,8 +142,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
- * @public
  * <p>A parameter could not be validated.</p>
+ * @public
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
@@ -155,8 +155,8 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
- * @public
  * <p>The request was not valid.</p>
+ * @public
  */
 export declare class BadRequestException extends __BaseException {
     readonly name: "BadRequestException";
@@ -168,74 +168,73 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
- * @public
  * <p>A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.</p>
+ * @public
  */
 export interface BaseScreenshot {
     /**
-     * @public
      * <p>The name of the screenshot. This is generated the first time the canary is run after the <code>UpdateCanary</code> operation that
      *       specified for this canary to perform visual monitoring.</p>
+     * @public
      */
     ScreenshotName: string | undefined;
     /**
-     * @public
      * <p>Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
      *          coordinates to use here, use the
      *          CloudWatch console to draw the boundaries on the screen. For more information, see
      *          <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html">
      *             Editing or deleting a canary</a>
      *          </p>
+     * @public
      */
     IgnoreCoordinates?: string[];
 }
 /**
- * @public
  * <p>This structure contains information about the canary's Lambda handler and
  *       where its code is stored by CloudWatch Synthetics.</p>
+ * @public
  */
 export interface CanaryCodeOutput {
     /**
-     * @public
      * <p>The ARN of the Lambda layer where Synthetics stores the canary script code.</p>
+     * @public
      */
     SourceLocationArn?: string;
     /**
-     * @public
      * <p>The entry point to use for the source code when running the canary.</p>
+     * @public
      */
     Handler?: string;
 }
 /**
- * @public
  * <p>A structure that contains information about a canary run.</p>
+ * @public
  */
 export interface CanaryRunConfigOutput {
     /**
-     * @public
      * <p>How long the canary is allowed to run before it must stop.</p>
+     * @public
      */
     TimeoutInSeconds?: number;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>Displays whether this canary run used active X-Ray tracing. </p>
+     * @public
      */
     ActiveTracing?: boolean;
 }
 /**
- * @public
  * <p>How long, in seconds, for the canary to continue making regular runs according to the schedule in the
  *          <code>Expression</code> value.</p>
+ * @public
  */
 export interface CanaryScheduleOutput {
     /**
-     * @public
      * <p>A <code>rate</code> expression or a <code>cron</code> expression that defines how often the canary is to run.</p>
      *          <p>For a rate expression, The syntax is
      *          <code>rate(<i>number unit</i>)</code>. <i>unit</i>
@@ -250,13 +249,14 @@ export interface CanaryScheduleOutput {
      *          expression. For information about the syntax for cron expressions, see
      *          <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html">
      *             Scheduling canary runs using cron</a>.</p>
+     * @public
      */
     Expression?: string;
     /**
-     * @public
      * <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;
 }
@@ -302,196 +302,196 @@ export declare const CanaryStateReasonCode: {
  */
 export type CanaryStateReasonCode = (typeof CanaryStateReasonCode)[keyof typeof CanaryStateReasonCode];
 /**
- * @public
  * <p>A structure that contains the current state of the canary.</p>
+ * @public
  */
 export interface CanaryStatus {
     /**
-     * @public
      * <p>The current state of the canary.</p>
+     * @public
      */
     State?: CanaryState;
     /**
-     * @public
      * <p>If the canary has insufficient permissions to run, this field provides more details.</p>
+     * @public
      */
     StateReason?: string;
     /**
-     * @public
      * <p>If the canary cannot run or has failed, this field displays the reason.</p>
+     * @public
      */
     StateReasonCode?: CanaryStateReasonCode;
 }
 /**
- * @public
  * <p>This structure contains information about when the canary was created and modified.</p>
+ * @public
  */
 export interface CanaryTimeline {
     /**
-     * @public
      * <p>The date and time the canary was created.</p>
+     * @public
      */
     Created?: Date;
     /**
-     * @public
      * <p>The date and time the canary was most recently modified.</p>
+     * @public
      */
     LastModified?: Date;
     /**
-     * @public
      * <p>The date and time that the canary's most recent run started.</p>
+     * @public
      */
     LastStarted?: Date;
     /**
-     * @public
      * <p>The date and time that the canary's most recent run ended.</p>
+     * @public
      */
     LastStopped?: Date;
 }
 /**
- * @public
  * <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
  *          of any parts of those screenshots that are ignored during visual monitoring comparison.</p>
  *          <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b> runtime or later.</p>
+ * @public
  */
 export interface VisualReferenceOutput {
     /**
-     * @public
      * <p>An array of screenshots that are used as the baseline for comparisons during visual monitoring.</p>
+     * @public
      */
     BaseScreenshots?: BaseScreenshot[];
     /**
-     * @public
      * <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;
 }
 /**
- * @public
  * <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.
  *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
  *             Running a Canary in a VPC</a>.</p>
+ * @public
  */
 export interface VpcConfigOutput {
     /**
-     * @public
      * <p>The IDs of the VPC where this canary is to run.</p>
+     * @public
      */
     VpcId?: string;
     /**
-     * @public
      * <p>The IDs of the subnets where this canary is to run.</p>
+     * @public
      */
     SubnetIds?: string[];
     /**
-     * @public
      * <p>The IDs of the security groups for this canary.</p>
+     * @public
      */
     SecurityGroupIds?: string[];
 }
 /**
- * @public
  * <p>This structure contains all information about one canary in your account.</p>
+ * @public
  */
 export interface Canary {
     /**
-     * @public
      * <p>The unique ID of this canary.</p>
+     * @public
      */
     Id?: string;
     /**
-     * @public
      * <p>The name of the canary.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>This structure contains information about the canary's Lambda handler and
      *       where its code is stored by CloudWatch Synthetics.</p>
+     * @public
      */
     Code?: CanaryCodeOutput;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>A structure that contains information about a canary run.</p>
+     * @public
      */
     RunConfig?: CanaryRunConfigOutput;
     /**
-     * @public
      * <p>The number of days to retain data about successful runs of this canary.</p>
+     * @public
      */
     SuccessRetentionPeriodInDays?: number;
     /**
-     * @public
      * <p>The number of days to retain data about failed runs of this canary.</p>
+     * @public
      */
     FailureRetentionPeriodInDays?: number;
     /**
-     * @public
      * <p>A structure that contains information about the canary's status.</p>
+     * @public
      */
     Status?: CanaryStatus;
     /**
-     * @public
      * <p>A structure that contains information about when the canary was created, modified, and
      *          most recently run.</p>
+     * @public
      */
     Timeline?: CanaryTimeline;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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.
      *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
      *             Running a Canary in a VPC</a>.</p>
+     * @public
      */
     VpcConfig?: VpcConfigOutput;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>The list of key-value pairs that are associated with the canary.</p>
+     * @public
      */
     Tags?: Record<string, string>;
     /**
-     * @public
      * <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;
 }
@@ -521,128 +521,127 @@ export declare const CanaryRunStateReasonCode: {
  */
 export type CanaryRunStateReasonCode = (typeof CanaryRunStateReasonCode)[keyof typeof CanaryRunStateReasonCode];
 /**
- * @public
  * <p>This structure contains the status information about a canary run.</p>
+ * @public
  */
 export interface CanaryRunStatus {
     /**
-     * @public
      * <p>The current state of the run.</p>
+     * @public
      */
     State?: CanaryRunState;
     /**
-     * @public
      * <p>If run of the canary failed, this field contains the reason for the error.</p>
+     * @public
      */
     StateReason?: string;
     /**
-     * @public
      * <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;
 }
 /**
- * @public
  * <p>This structure contains the start and end times of a single canary run.</p>
+ * @public
  */
 export interface CanaryRunTimeline {
     /**
-     * @public
      * <p>The start time of the run.</p>
+     * @public
      */
     Started?: Date;
     /**
-     * @public
      * <p>The end time of the run.</p>
+     * @public
      */
     Completed?: Date;
 }
 /**
- * @public
  * <p>This structure contains the details about one run of one canary.</p>
+ * @public
  */
 export interface CanaryRun {
     /**
-     * @public
      * <p>A unique ID that identifies this canary run.</p>
+     * @public
      */
     Id?: string;
     /**
-     * @public
      * <p>The name of the canary.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The status of this run.</p>
+     * @public
      */
     Status?: CanaryRunStatus;
     /**
-     * @public
      * <p>A structure that contains the start and end times of this run.</p>
+     * @public
      */
     Timeline?: CanaryRunTimeline;
     /**
-     * @public
      * <p>The location where the canary stored artifacts from the run. Artifacts include
      *          the log file, screenshots, and HAR files.</p>
+     * @public
      */
     ArtifactS3Location?: string;
 }
 /**
- * @public
  * <p>This structure contains information about the most recent run of a single canary.</p>
+ * @public
  */
 export interface CanaryLastRun {
     /**
-     * @public
      * <p>The name of the canary.</p>
+     * @public
      */
     CanaryName?: string;
     /**
-     * @public
      * <p>The results from this canary's most recent run.</p>
+     * @public
      */
     LastRun?: CanaryRun;
 }
 /**
- * @public
  * <p>Use this structure to input your script code for the canary. This structure contains the
  *          Lambda handler with the location where the canary should start running the script. If the
  *          script is stored in an S3 bucket, the bucket name, key, and version are also included. If
  *          the script was passed into the canary directly, the script code is contained in the value
  *          of <code>Zipfile</code>. </p>
+ * @public
  */
 export interface CanaryCodeInput {
     /**
-     * @public
      * <p>If your canary script is located in S3, specify the bucket name here. Do not include <code>s3://</code> as the
      *          start of the bucket name.</p>
+     * @public
      */
     S3Bucket?: string;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>The S3 version ID of your script.</p>
+     * @public
      */
     S3Version?: string;
     /**
-     * @public
      * <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
      *          contains the script. It must be smaller than 225 Kb.</p>
      *          <p>For large canary scripts, we recommend that you use an S3 location instead of inputting it
      *       directly with this parameter.</p>
+     * @public
      */
     ZipFile?: Uint8Array;
     /**
-     * @public
      * <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
      *          or a <code>syn-nodejs.puppeteer</code> runtime earlier than <code>syn-nodejs.puppeteer-3.4</code>,
@@ -656,29 +655,29 @@ export interface CanaryCodeInput {
      * <code>
      *                <i>folder</i>/<i>fileName</i>.<i>functionName</i>
      *             </code>.</p>
+     * @public
      */
     Handler: string | undefined;
 }
 /**
- * @public
  * <p>A structure that contains input information for a canary run.</p>
+ * @public
  */
 export interface CanaryRunConfigInput {
     /**
-     * @public
      * <p>How long the canary is allowed to run before it must stop. You can't set this time to be longer
      *          than the frequency of the runs of this canary.</p>
      *          <p>If you omit this field, the
      *          frequency of the canary is used as this value, up to a maximum of 14 minutes.</p>
+     * @public
      */
     TimeoutInSeconds?: number;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing
      *          enables
      *          this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does
@@ -687,10 +686,10 @@ export interface CanaryRunConfigInput {
      *          Canaries and X-Ray tracing</a>.</p>
      *          <p>You can enable active tracing only for canaries that use version <code>syn-nodejs-2.0</code>
      *       or later for their canary runtime.</p>
+     * @public
      */
     ActiveTracing?: boolean;
     /**
-     * @public
      * <p>Specifies the keys and values to use for any environment variables
      *       used in the canary script. Use the following format:</p>
      *          <p>\{ "key1" : "value1", "key2" : "value2", ...\}</p>
@@ -703,17 +702,17 @@ export interface CanaryRunConfigInput {
      *             <p>The environment variables keys and values are not encrypted. Do not store sensitive information
      *          in this field.</p>
      *          </important>
+     * @public
      */
     EnvironmentVariables?: Record<string, string>;
 }
 /**
- * @public
  * <p>This structure specifies how often a canary is to make runs and the date and time
  *          when it should stop making runs.</p>
+ * @public
  */
 export interface CanaryScheduleInput {
     /**
-     * @public
      * <p>A <code>rate</code> expression or a <code>cron</code> expression that defines how often the canary is to run.</p>
      *          <p>For a rate expression, The syntax is
      *                <code>rate(<i>number unit</i>)</code>. <i>unit</i>
@@ -728,32 +727,33 @@ export interface CanaryScheduleInput {
      *          expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see
      *          <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html">
      *             Scheduling canary runs using cron</a>.</p>
+     * @public
      */
     Expression: string | undefined;
     /**
-     * @public
      * <p>How long, in seconds, for the canary to continue making regular runs according to
      *          the schedule in the <code>Expression</code> value. If you specify 0, the canary continues
      *          making runs until you stop it. If you omit this field, the default of 0 is used.</p>
+     * @public
      */
     DurationInSeconds?: number;
 }
 /**
- * @public
  * <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.
  *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
  *             Running a Canary in a VPC</a>.</p>
+ * @public
  */
 export interface VpcConfigInput {
     /**
-     * @public
      * <p>The IDs of the subnets where this canary is to run.</p>
+     * @public
      */
     SubnetIds?: string[];
     /**
-     * @public
      * <p>The IDs of the security groups for this canary.</p>
+     * @public
      */
     SecurityGroupIds?: string[];
 }
@@ -762,32 +762,31 @@ export interface VpcConfigInput {
  */
 export interface CreateCanaryRequest {
     /**
-     * @public
      * <p>The name for this canary. Be sure to give it a descriptive name
      *          that distinguishes it from other canaries in your account.</p>
      *          <p>Do not include secrets or proprietary information in your canary names. The canary name
      *          makes up part of the canary ARN, and the ARN is included in outbound calls over the
      *          internet. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html">Security
      *             Considerations for Synthetics Canaries</a>.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A structure that includes the entry point from which the canary should start
      *          running your script. If the script is stored in
      *          an S3 bucket, the bucket name, key, and version are also included.
      *       </p>
+     * @public
      */
     Code: CanaryCodeInput | undefined;
     /**
-     * @public
      * <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 | undefined;
     /**
-     * @public
      * <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
      *          policy. The role must also have the following permissions:</p>
@@ -828,66 +827,67 @@ export interface CreateCanaryRequest {
      *                </p>
      *             </li>
      *          </ul>
+     * @public
      */
     ExecutionRoleArn: string | undefined;
     /**
-     * @public
      * <p>A structure that contains information about how often the canary is to run and when
      *          these test runs are to stop.</p>
+     * @public
      */
     Schedule: CanaryScheduleInput | undefined;
     /**
-     * @public
      * <p>A structure that contains the configuration for individual canary runs,
      *          such as timeout value and environment variables.</p>
      *          <important>
      *             <p>The environment variables keys and values are not encrypted. Do not store sensitive information
      *       in this field.</p>
      *          </important>
+     * @public
      */
     RunConfig?: CanaryRunConfigInput;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>Specifies the runtime version to use for the canary. For a list of valid
      *          runtime versions and 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 | undefined;
     /**
-     * @public
      * <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.
      *       For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
      *          Running a Canary in a VPC</a>.</p>
+     * @public
      */
     VpcConfig?: VpcConfigInput;
     /**
-     * @public
      * <p>A list of key-value pairs to associate with the canary.
      *          You can associate as many as 50 tags with a canary.</p>
      *          <p>Tags can help you organize and categorize your
      *          resources. You can also use them to scope user permissions, by
      *          granting a user permission to access or change only the resources that have
      *          certain tag values.</p>
+     * @public
      */
     Tags?: Record<string, string>;
     /**
-     * @public
      * <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;
 }
@@ -896,14 +896,14 @@ export interface CreateCanaryRequest {
  */
 export interface CreateCanaryResponse {
     /**
-     * @public
      * <p>The full details about the canary you have created.</p>
+     * @public
      */
     Canary?: Canary;
 }
 /**
- * @public
  * <p>One of the input resources is larger than is allowed.</p>
+ * @public
  */
 export declare class RequestEntityTooLargeException extends __BaseException {
     readonly name: "RequestEntityTooLargeException";
@@ -919,55 +919,55 @@ export declare class RequestEntityTooLargeException extends __BaseException {
  */
 export interface CreateGroupRequest {
     /**
-     * @public
      * <p>The name for the group. It can include any Unicode characters.</p>
      *          <p>The names for all groups in your account, across all Regions, must be unique.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A list of key-value pairs to associate with the group.
      *          You can associate as many as 50 tags with a group.</p>
      *          <p>Tags can help you organize and categorize your
      *          resources. You can also use them to scope user permissions, by
      *          granting a user permission to access or change only the resources that have
      *          certain tag values.</p>
+     * @public
      */
     Tags?: Record<string, string>;
 }
 /**
- * @public
  * <p>This structure contains information about one group.</p>
+ * @public
  */
 export interface Group {
     /**
-     * @public
      * <p>The unique ID of the group.</p>
+     * @public
      */
     Id?: string;
     /**
-     * @public
      * <p>The name of the group.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The ARN of the group.</p>
+     * @public
      */
     Arn?: string;
     /**
-     * @public
      * <p>The list of key-value pairs that are associated with the canary.</p>
+     * @public
      */
     Tags?: Record<string, string>;
     /**
-     * @public
      * <p>The date and time that the group was created.</p>
+     * @public
      */
     CreatedTime?: Date;
     /**
-     * @public
      * <p>The date and time that the group was most recently updated.</p>
+     * @public
      */
     LastModifiedTime?: Date;
 }
@@ -976,8 +976,8 @@ export interface Group {
  */
 export interface CreateGroupResponse {
     /**
-     * @public
      * <p>A structure that contains information about the group that was just created.</p>
+     * @public
      */
     Group?: Group;
 }
@@ -986,15 +986,15 @@ export interface CreateGroupResponse {
  */
 export interface DeleteCanaryRequest {
     /**
-     * @public
      * <p>The name of the canary that you want to delete. To find the names of your canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>Specifies whether to also delete the Lambda functions and layers used by this canary. The default
      *       is false.</p>
      *          <p>Type: Boolean</p>
+     * @public
      */
     DeleteLambda?: boolean;
 }
@@ -1008,9 +1008,9 @@ export interface DeleteCanaryResponse {
  */
 export interface DeleteGroupRequest {
     /**
-     * @public
      * <p>Specifies which group to delete. You can specify the group name, the ARN, or the
      *       group ID as the <code>GroupIdentifier</code>.</p>
+     * @public
      */
     GroupIdentifier: string | undefined;
 }
@@ -1024,20 +1024,19 @@ export interface DeleteGroupResponse {
  */
 export interface DescribeCanariesRequest {
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <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 100 is used.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <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>
      *          <p>If you specify this parameter, the operation is successful only if you have authorization to view
@@ -1047,6 +1046,7 @@ export interface DescribeCanariesRequest {
      *          IAM policy that restricts which canaries that you are allowed to view. For more information,
      *          see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
      *             Limiting a user to viewing specific canaries</a>.</p>
+     * @public
      */
     Names?: string[];
 }
@@ -1055,16 +1055,16 @@ export interface DescribeCanariesRequest {
  */
 export interface DescribeCanariesResponse {
     /**
-     * @public
      * <p>Returns an array. Each item in the array contains the full information about
      *          one canary.</p>
+     * @public
      */
     Canaries?: Canary[];
     /**
-     * @public
      * <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;
 }
@@ -1073,20 +1073,19 @@ export interface DescribeCanariesResponse {
  */
 export interface DescribeCanariesLastRunRequest {
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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>
      *          <p>If you specify this parameter, the operation is successful only if you have authorization to view
@@ -1096,6 +1095,7 @@ export interface DescribeCanariesLastRunRequest {
      *          IAM policy that restricts which canaries that you are allowed to view. For more information,
      *          see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
      *             Limiting a user to viewing specific canaries</a>.</p>
+     * @public
      */
     Names?: string[];
 }
@@ -1104,16 +1104,16 @@ export interface DescribeCanariesLastRunRequest {
  */
 export interface DescribeCanariesLastRunResponse {
     /**
-     * @public
      * <p>An array that contains the information from the most recent run of each
      *          canary.</p>
+     * @public
      */
     CanariesLastRun?: CanaryLastRun[];
     /**
-     * @public
      * <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;
 }
@@ -1122,46 +1122,46 @@ export interface DescribeCanariesLastRunResponse {
  */
 export interface DescribeRuntimeVersionsRequest {
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
 }
 /**
- * @public
  * <p>This structure contains information about one canary runtime version. 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
  */
 export interface RuntimeVersion {
     /**
-     * @public
      * <p>The name of the runtime version. For a list of valid runtime versions,
      *          see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html">
      *             Canary Runtime Versions</a>.</p>
+     * @public
      */
     VersionName?: string;
     /**
-     * @public
      * <p>A description of the runtime version, created by Amazon.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The date that the runtime version was released.</p>
+     * @public
      */
     ReleaseDate?: Date;
     /**
-     * @public
      * <p>If this runtime version is deprecated, this value is the date of deprecation.</p>
+     * @public
      */
     DeprecationDate?: Date;
 }
@@ -1170,16 +1170,16 @@ export interface RuntimeVersion {
  */
 export interface DescribeRuntimeVersionsResponse {
     /**
-     * @public
      * <p>An array of objects that display the details about each Synthetics canary runtime
      *          version.</p>
+     * @public
      */
     RuntimeVersions?: RuntimeVersion[];
     /**
-     * @public
      * <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;
 }
@@ -1188,14 +1188,14 @@ export interface DescribeRuntimeVersionsResponse {
  */
 export interface DisassociateResourceRequest {
     /**
-     * @public
      * <p>Specifies the group. You can specify the group name, the ARN, or the
      *          group ID as the <code>GroupIdentifier</code>.</p>
+     * @public
      */
     GroupIdentifier: string | undefined;
     /**
-     * @public
      * <p>The ARN of the canary that you want to remove from the specified group.</p>
+     * @public
      */
     ResourceArn: string | undefined;
 }
@@ -1209,8 +1209,8 @@ export interface DisassociateResourceResponse {
  */
 export interface GetCanaryRequest {
     /**
-     * @public
      * <p>The name of the canary that you want details for.</p>
+     * @public
      */
     Name: string | undefined;
 }
@@ -1219,8 +1219,8 @@ export interface GetCanaryRequest {
  */
 export interface GetCanaryResponse {
     /**
-     * @public
      * <p>A structure that contains the full information about the canary.</p>
+     * @public
      */
     Canary?: Canary;
 }
@@ -1229,21 +1229,21 @@ export interface GetCanaryResponse {
  */
 export interface GetCanaryRunsRequest {
     /**
-     * @public
      * <p>The name of the canary that you want to see runs for.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <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;
 }
@@ -1252,17 +1252,17 @@ export interface GetCanaryRunsRequest {
  */
 export interface GetCanaryRunsResponse {
     /**
-     * @public
      * <p>An array of structures. Each structure contains the details of one of the
      *          retrieved canary runs.</p>
+     * @public
      */
     CanaryRuns?: CanaryRun[];
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent <code>GetCanaryRuns</code>
      *          operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -1271,9 +1271,9 @@ export interface GetCanaryRunsResponse {
  */
 export interface GetGroupRequest {
     /**
-     * @public
      * <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>
+     * @public
      */
     GroupIdentifier: string | undefined;
 }
@@ -1282,35 +1282,35 @@ export interface GetGroupRequest {
  */
 export interface GetGroupResponse {
     /**
-     * @public
      * <p>A structure that contains information about the group.</p>
+     * @public
      */
     Group?: Group;
 }
 /**
- * @public
  * <p>A structure containing some information about a group.</p>
+ * @public
  */
 export interface GroupSummary {
     /**
-     * @public
      * <p>The unique ID of the group.</p>
+     * @public
      */
     Id?: string;
     /**
-     * @public
      * <p>The name of the group.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The ARN of the group.</p>
+     * @public
      */
     Arn?: string;
 }
 /**
- * @public
  * <p>An internal failure occurred. Try the operation again.</p>
+ * @public
  */
 export declare class InternalFailureException extends __BaseException {
     readonly name: "InternalFailureException";
@@ -1326,21 +1326,21 @@ export declare class InternalFailureException extends __BaseException {
  */
 export interface ListAssociatedGroupsRequest {
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>The ARN of the canary that you want to view groups for.</p>
+     * @public
      */
     ResourceArn: string | undefined;
 }
@@ -1349,15 +1349,15 @@ export interface ListAssociatedGroupsRequest {
  */
 export interface ListAssociatedGroupsResponse {
     /**
-     * @public
      * <p>An array of structures that contain information about the groups that this canary is associated with.</p>
+     * @public
      */
     Groups?: GroupSummary[];
     /**
-     * @public
      * <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;
 }
@@ -1366,22 +1366,22 @@ export interface ListAssociatedGroupsResponse {
  */
 export interface ListGroupResourcesRequest {
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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>
+     * @public
      */
     GroupIdentifier: string | undefined;
 }
@@ -1390,15 +1390,15 @@ export interface ListGroupResourcesRequest {
  */
 export interface ListGroupResourcesResponse {
     /**
-     * @public
      * <p>An array of ARNs. These ARNs are for the canaries that are associated with the group.</p>
+     * @public
      */
     Resources?: string[];
     /**
-     * @public
      * <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;
 }
@@ -1407,16 +1407,16 @@ export interface ListGroupResourcesResponse {
  */
 export interface ListGroupsRequest {
     /**
-     * @public
      * <p>A token that indicates that there is more data
      *          available. You can use this token in a subsequent operation to retrieve the next
      *          set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <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;
 }
@@ -1425,15 +1425,15 @@ export interface ListGroupsRequest {
  */
 export interface ListGroupsResponse {
     /**
-     * @public
      * <p>An array of structures that each contain information about one group.</p>
+     * @public
      */
     Groups?: GroupSummary[];
     /**
-     * @public
      * <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;
 }
@@ -1442,7 +1442,6 @@ export interface ListGroupsResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * @public
      * <p>The ARN of the canary or group that you want to view tags for.</p>
      *          <p>The ARN format of a canary is
      *                <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
@@ -1451,6 +1450,7 @@ export interface ListTagsForResourceRequest {
      *          <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
      *             </code>
      *          </p>
+     * @public
      */
     ResourceArn: string | undefined;
 }
@@ -1459,14 +1459,14 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
-     * @public
      * <p>The list of tag keys and values associated with the resource that you specified.</p>
+     * @public
      */
     Tags?: Record<string, string>;
 }
 /**
- * @public
  * <p>The specified resource was not found.</p>
+ * @public
  */
 export declare class NotFoundException extends __BaseException {
     readonly name: "NotFoundException";
@@ -1478,8 +1478,8 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
- * @public
  * <p>There were too many simultaneous requests. Try the operation again.</p>
+ * @public
  */
 export declare class TooManyRequestsException extends __BaseException {
     readonly name: "TooManyRequestsException";
@@ -1495,9 +1495,9 @@ export declare class TooManyRequestsException extends __BaseException {
  */
 export interface StartCanaryRequest {
     /**
-     * @public
      * <p>The name of the canary that you want to run. To find
      *          canary names, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
+     * @public
      */
     Name: string | undefined;
 }
@@ -1511,9 +1511,9 @@ export interface StartCanaryResponse {
  */
 export interface StopCanaryRequest {
     /**
-     * @public
      * <p>The name of the canary that you want to stop. To find the names of your
      *          canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">ListCanaries</a>.</p>
+     * @public
      */
     Name: string | undefined;
 }
@@ -1527,7 +1527,6 @@ export interface StopCanaryResponse {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>The ARN of the canary or group that you're adding tags to.</p>
      *          <p>The ARN format of a canary is
      * <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
@@ -1536,11 +1535,12 @@ export interface TagResourceRequest {
      *  <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
      *             </code>
      *          </p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The list of key-value pairs to associate with the resource.</p>
+     * @public
      */
     Tags: Record<string, string> | undefined;
 }
@@ -1554,7 +1554,6 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The ARN of the canary or group that you're removing tags from.</p>
      *          <p>The ARN format of a canary is
      *                <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:canary:<i>canary-name</i>
@@ -1563,11 +1562,12 @@ export interface UntagResourceRequest {
      *          <code>arn:aws:synthetics:<i>Region</i>:<i>account-id</i>:group:<i>group-name</i>
      *             </code>
      *          </p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The list of tag keys to remove from the resource.</p>
+     * @public
      */
     TagKeys: string[] | undefined;
 }
@@ -1577,7 +1577,6 @@ export interface UntagResourceRequest {
 export interface UntagResourceResponse {
 }
 /**
- * @public
  * <p>An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can
  *          optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.</p>
  *          <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b>
@@ -1585,20 +1584,21 @@ export interface UntagResourceResponse {
  *             Visual monitoring</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html">
  *                Visual monitoring blueprint</a>
  *          </p>
+ * @public
  */
 export interface VisualReferenceInput {
     /**
-     * @public
      * <p>An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for
      *       visual monitoring, remove it from this array.</p>
+     * @public
      */
     BaseScreenshots?: BaseScreenshot[];
     /**
-     * @public
      * <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
      *          before this update was made, or the value of <code>Id</code> in the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html">
      *             CanaryRun</a> from any past run of this canary.</p>
+     * @public
      */
     BaseCanaryRunId: string | undefined;
 }
@@ -1607,22 +1607,21 @@ export interface VisualReferenceInput {
  */
 export interface UpdateCanaryRequest {
     /**
-     * @public
      * <p>The name of the canary that you want to update. To find the names of your
      *          canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
      *          <p>You cannot change the name of a canary that has already been created.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A structure that includes the entry point from which the canary should start
      *          running your script. If the script is stored in
      *          an S3 bucket, the bucket name, key, and version are also included.
      *       </p>
+     * @public
      */
     Code?: CanaryCodeInput;
     /**
-     * @public
      * <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
      *          policy. The role must also have the following permissions:</p>
@@ -1663,52 +1662,52 @@ export interface UpdateCanaryRequest {
      *                </p>
      *             </li>
      *          </ul>
+     * @public
      */
     ExecutionRoleArn?: string;
     /**
-     * @public
      * <p>Specifies the runtime version to use for the canary.
      *          For a list of valid runtime versions and 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;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <p>A structure that contains the timeout value that is used for each individual run of the
      *          canary.</p>
      *          <important>
      *             <p>The environment variables keys and values are not encrypted. Do not store sensitive information
      *          in this field.</p>
      *          </important>
+     * @public
      */
     RunConfig?: CanaryRunConfigInput;
     /**
-     * @public
      * <p>The number of days to retain data about successful runs of this canary.</p>
+     * @public
      */
     SuccessRetentionPeriodInDays?: number;
     /**
-     * @public
      * <p>The number of days to retain data about failed runs of this canary.</p>
+     * @public
      */
     FailureRetentionPeriodInDays?: number;
     /**
-     * @public
      * <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.
      *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
      *             Running a Canary in a VPC</a>.</p>
+     * @public
      */
     VpcConfig?: VpcConfigInput;
     /**
-     * @public
      * <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>
      *          <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b>
@@ -1716,20 +1715,21 @@ export interface UpdateCanaryRequest {
      *             Visual monitoring</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html">
      *                Visual monitoring blueprint</a>
      *          </p>
+     * @public
      */
     VisualReference?: VisualReferenceInput;
     /**
-     * @public
      * <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;
     /**
-     * @public
      * <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;
 }