CanaryRun - Amazon CloudWatch Synthetics

CanaryRun

This structure contains the details about one run of one canary.

Contents

ArtifactS3Location

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

DryRunConfig

Returns the dry run configurations for a canary.

Type: CanaryDryRunConfigOutput object

Required: No

Id

A unique ID that identifies this canary run.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

Name

The name of the canary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[0-9a-z_\-]+$

Required: No

RetryAttempt

The count in number of the retry attempt.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2.

Required: No

ScheduledRunId

The ID of the scheduled canary run.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

Status

The status of this run.

Type: CanaryRunStatus object

Required: No

Timeline

A structure that contains the start and end times of this run.

Type: CanaryRunTimeline object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: