ArtifactConfigOutput
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
Contents
S3Encryption
A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.
Type: S3EncryptionConfig (p. 66) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BaseScreenshot
BaseScreenshot
A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.
Contents
IgnoreCoordinates
Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Pattern: ^(-?\d{1,5}\.?\d{0,2},){3}(-?\d{1,5}\.?\d{0,2}){1}$
Required: No ScreenshotName
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Canary
Canary
This structure contains all information about one canary in your account.
Contents
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.
Type: ArtifactConfigOutput (p. 44) object Required: No
ArtifactS3Location
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Code
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
Type: CanaryCodeOutput (p. 52) object Required: No
EngineArn
The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Required: No ExecutionRoleArn
The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
Required: No
Contents
FailureRetentionPeriodInDays
The number of days to retain data about failed runs of this canary.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1024.
Required: No Id
The unique ID of this canary.
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 21.
Pattern: ^[0-9a-z_\-]+$
Required: No RunConfig
A structure that contains information about a canary run.
Type: CanaryRunConfigOutput (p. 58) object Required: No
RuntimeVersion
Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Schedule
A structure that contains information about how often the canary is to run, and when these runs are to stop.
Type: CanaryScheduleOutput (p. 62) object Required: No
Status
A structure that contains information about the canary's status.
Type: CanaryStatus (p. 63) object Required: No
See Also
SuccessRetentionPeriodInDays
The number of days to retain data about successful runs of this canary.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1024.
Required: No Tags
The list of key-value pairs that are associated with the canary.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Required: No Timeline
A structure that contains information about when the canary was created, modified, and most recently run.
Type: CanaryTimeline (p. 64) object Required: No
VisualReference
If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
Type: VisualReferenceOutput (p. 68) object Required: No
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.
Type: VpcConfigOutput (p. 70) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
CanaryCodeInput
CanaryCodeInput
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 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.
Contents
Handler
The entry point to use for the source code when running the canary. For canaries that use the python-selenium-1.0 runtime or a nodejs.puppeteer runtime earlier than 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 .
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^([0-9a-zA-Z_-]+\/)*[0-9A-Za-z_\\-]+\.[A-Za-z_][A-Za-z0-9_]*$
Required: Yes S3Bucket
If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No S3Key
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No S3Version
The S3 version ID of your script.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No ZipFile
If you input your canary script directly into the canary instead of referring to an 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.
See Also
For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 10000000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CanaryCodeOutput
CanaryCodeOutput
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
Contents
Handler
The entry point to use for the source code when running the canary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No SourceLocationArn
The ARN of the Lambda layer where Synthetics stores the canary script code.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CanaryLastRun
CanaryLastRun
This structure contains information about the most recent run of a single canary.
Contents
CanaryName
The name of the canary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 21.
Pattern: ^[0-9a-z_\-]+$
Required: No LastRun
The results from this canary's most recent run.
Type: CanaryRun (p. 54) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CanaryRun
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 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 21.
Pattern: ^[0-9a-z_\-]+$
Required: No Status
The status of this run.
Type: CanaryRunStatus (p. 59) object Required: No
Timeline
A structure that contains the start and end times of this run.
Type: CanaryRunTimeline (p. 60) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3