Skip to content

Start Canary Dry Run

synthetics_start_canary_dry_run R Documentation

Use this operation to start a dry run for a canary that has already been created

Description

Use this operation to start a dry run for a canary that has already been created

Usage

synthetics_start_canary_dry_run(Name, Code, RuntimeVersion, RunConfig,
  VpcConfig, ExecutionRoleArn, SuccessRetentionPeriodInDays,
  FailureRetentionPeriodInDays, VisualReference, ArtifactS3Location,
  ArtifactConfig, ProvisionedResourceCleanup, BrowserConfigs,
  VisualReferences)

Arguments

Name

[required] The name of the canary that you want to dry run. To find canary names, use describe_canaries.
Code

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 Amazon 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 Zipfile.

If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
RuntimeVersion

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

A structure that contains input information for a canary run.
VpcConfig

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 Running a Canary in a VPC.
ExecutionRoleArn

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

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 get_canary_runs, as well as the range of information displayed in the Synthetics console.
FailureRetentionPeriodInDays

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 get_canary_runs, as well as the range of information displayed in the Synthetics console.
VisualReference

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.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
ArtifactS3Location

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

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
ProvisionedResourceCleanup

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 delete_canary operation determines whether the Lambda functions and layers will be deleted.
BrowserConfigs

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

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.

Value

A list with the following syntax:

list(
  DryRunConfig = list(
    DryRunId = "string",
    LastDryRunExecutionStatus = "string"
  )
)

Request syntax

svc$start_canary_dry_run(
  Name = "string",
  Code = list(
    S3Bucket = "string",
    S3Key = "string",
    S3Version = "string",
    ZipFile = raw,
    Handler = "string",
    BlueprintTypes = list(
      "string"
    ),
    Dependencies = list(
      list(
        Type = "LambdaLayer",
        Reference = "string"
      )
    )
  ),
  RuntimeVersion = "string",
  RunConfig = list(
    TimeoutInSeconds = 123,
    MemoryInMB = 123,
    ActiveTracing = TRUE|FALSE,
    EnvironmentVariables = list(
      "string"
    ),
    EphemeralStorage = 123
  ),
  VpcConfig = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    ),
    Ipv6AllowedForDualStack = TRUE|FALSE
  ),
  ExecutionRoleArn = "string",
  SuccessRetentionPeriodInDays = 123,
  FailureRetentionPeriodInDays = 123,
  VisualReference = list(
    BaseScreenshots = list(
      list(
        ScreenshotName = "string",
        IgnoreCoordinates = list(
          "string"
        )
      )
    ),
    BaseCanaryRunId = "string",
    BrowserType = "CHROME"|"FIREFOX"
  ),
  ArtifactS3Location = "string",
  ArtifactConfig = list(
    S3Encryption = list(
      EncryptionMode = "SSE_S3"|"SSE_KMS",
      KmsKeyArn = "string"
    )
  ),
  ProvisionedResourceCleanup = "AUTOMATIC"|"OFF",
  BrowserConfigs = list(
    list(
      BrowserType = "CHROME"|"FIREFOX"
    )
  ),
  VisualReferences = list(
    list(
      BaseScreenshots = list(
        list(
          ScreenshotName = "string",
          IgnoreCoordinates = list(
            "string"
          )
        )
      ),
      BaseCanaryRunId = "string",
      BrowserType = "CHROME"|"FIREFOX"
    )
  )
)