StartCanaryDryRunRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-start-canary-dry-run-request-schema.json",
  "title": "StartCanaryDryRunRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-operations-api-openapi.yml#/components/schemas/StartCanaryDryRunRequest",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "The name of the canary that you want to dry run. To find canary names, use DescribeCanaries."
    },
    "Code": {
      "$ref": "#/$defs/CanaryCodeInput"
    },
    "RuntimeVersion": {
      "type": "string",
      "description": "Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions."
    },
    "RunConfig": {
      "$ref": "#/$defs/CanaryRunConfigInput"
    },
    "VpcConfig": {
      "$ref": "#/$defs/VpcConfigInput"
    },
    "ExecutionRoleArn": {
      "type": "string",
      "description": "The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:"
    },
    "SuccessRetentionPeriodInDays": {
      "type": "integer",
      "description": "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. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console."
    },
    "FailureRetentionPeriodInDays": {
      "type": "integer",
      "description": "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. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console."
    },
    "VisualReference": {
      "$ref": "#/$defs/VisualReferenceInput"
    },
    "ArtifactS3Location": {
      "type": "string",
      "description": "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 Amazon S3 bucket can't include a period (.)."
    },
    "ArtifactConfig": {
      "$ref": "#/$defs/ArtifactConfigInput"
    },
    "ProvisionedResourceCleanup": {
      "type": "string",
      "enum": [
        "AUTOMATIC",
        "OFF"
      ],
      "description": "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 AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted."
    },
    "BrowserConfigs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BrowserConfig"
      },
      "description": "A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers. If not specified, browserConfigs defaults to Chrome."
    },
    "VisualReferences": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/VisualReferenceInput"
      },
      "description": "A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported. Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility."
    }
  },
  "required": [
    "Name"
  ],
  "$defs": {
    "ArtifactConfigInput": {
      "type": "object",
      "properties": {
        "S3Encryption": {
          "$ref": "#/$defs/S3EncryptionConfig"
        }
      }
    },
    "BaseScreenshot": {
      "type": "object",
      "properties": {
        "ScreenshotName": {
          "type": "string",
          "description": "The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring."
        },
        "IgnoreCoordinates": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "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 Editing or deleting a canary"
        }
      },
      "required": [
        "ScreenshotName"
      ]
    },
    "BrowserConfig": {
      "type": "object",
      "properties": {
        "BrowserType": {
          "type": "string",
          "enum": [
            "CHROME",
            "FIREFOX"
          ],
          "description": "The browser type associated with this browser configuration."
        }
      }
    },
    "CanaryCodeInput": {
      "type": "object",
      "properties": {
        "S3Bucket": {
          "type": "string",
          "description": "If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name."
        },
        "S3Key": {
          "type": "string",
          "description": "The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects."
        },
        "S3Version": {
          "type": "string",
          "description": "The Amazon S3 version ID of your script."
        },
        "ZipFile": {
          "type": "string",
          "format": "byte",
          "description": "If you input your canary script directly into the canary instead of referring to an Amazon 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. For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter."
        },
        "Handler": {
          "type": "string",
          "description": "The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName . This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes."
        },
        "BlueprintTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks. Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point. BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime o"
        },
        "Dependencies": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Dependency"
          },
          "description": "A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference."
        }
      }
    },
    "CanaryRunConfigInput": {
      "type": "object",
      "properties": {
        "TimeoutInSeconds": {
          "type": "integer",
          "description": "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. If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes."
        },
        "MemoryInMB": {
          "type": "integer",
          "description": "The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64."
        },
        "ActiveTracing": {
          "type": "boolean",
          "description": "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 not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime."
        },
        "EnvironmentVariables": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Specifies the keys and values to use for any environment variables used in the canary script. Use the following format: { \"key1\" : \"value1\", \"key2\" : \"value2\", ...} Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables. Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment v"
        },
        "EphemeralStorage": {
          "type": "integer",
          "description": "Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB."
        }
      }
    },
    "Dependency": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "LambdaLayer"
          ],
          "description": "The type of dependency. Valid value is LambdaLayer."
        },
        "Reference": {
          "type": "string",
          "description": "The dependency reference. For Lambda layers, this is the ARN of the Lambda layer. For more information about Lambda ARN format, see Lambda."
        }
      },
      "required": [
        "Reference"
      ]
    },
    "S3EncryptionConfig": {
      "type": "object",
      "properties": {
        "EncryptionMode": {
          "type": "string",
          "enum": [
            "SSE_S3",
            "SSE_KMS"
          ],
          "description": "The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key. If you omit this parameter, an Amazon Web Services-managed KMS key is used."
        },
        "KmsKeyArn": {
          "type": "string",
          "description": "The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode"
        }
      }
    },
    "VisualReferenceInput": {
      "type": "object",
      "properties": {
        "BaseScreenshots": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BaseScreenshot"
          },
          "description": "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."
        },
        "BaseCanaryRunId": {
          "type": "string",
          "description": "Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error.."
        },
        "BrowserType": {
          "type": "string",
          "enum": [
            "CHROME",
            "FIREFOX"
          ],
          "description": "The browser type associated with this visual reference."
        }
      },
      "required": [
        "BaseCanaryRunId"
      ]
    },
    "VpcConfigInput": {
      "type": "object",
      "properties": {
        "SubnetIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The IDs of the subnets where this canary is to run."
        },
        "SecurityGroupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The IDs of the security groups for this canary."
        },
        "Ipv6AllowedForDualStack": {
          "type": "boolean",
          "description": "Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is false"
        }
      }
    }
  }
}