aws synthetics start-canary-dry-run

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

14 options Its page in the AWS CLI reference

Options

14 in the AWS CLI reference

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

--artifact-s3-locationThe location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

--browser-configsA structure that specifies the browser type to use for a canary run.

--codeUse this structure to input your script code for the canary.

--execution-role-arnThe ARN of the IAM role to be used to run the canary.

--failure-retention-period-in-daysThe number of days to retain data about failed runs of this canary.

--nameThe name of the canary that you want to dry run.

--provisioned-resource-cleanupSpecifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.

--run-configA structure that contains input information for a canary run.

--runtime-versionSpecifies the runtime version to use for the canary.

--success-retention-period-in-daysThe number of days to retain data about successful runs of this canary.

--visual-referenceAn object that specifies what screenshots to use as a baseline for visual monitoring by this canary.

--visual-referencesA list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.

--vpc-configIf this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint.