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)

Arguments¶

Name

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

Code

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

VpcConfig

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 on the failed runs for this canary. 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 on the failed runs for this canary. 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

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

ProvisionedResourceCleanup

Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is AUTOMATIC, it 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.

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"
  ),
  RuntimeVersion = "string",
  RunConfig = list(
    TimeoutInSeconds = 123,
    MemoryInMB = 123,
    ActiveTracing = TRUE|FALSE,
    EnvironmentVariables = list(
      "string"
    )
  ),
  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"
  ),
  ArtifactS3Location = "string",
  ArtifactConfig = list(
    S3Encryption = list(
      EncryptionMode = "SSE_S3"|"SSE_KMS",
      KmsKeyArn = "string"
    )
  ),
  ProvisionedResourceCleanup = "AUTOMATIC"|"OFF"
)