Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateCanary

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Request Syntax


POST /canary HTTP/1.1
Content-type: application/json

{
   "ArtifactConfig": { 
      "S3Encryption": { 
         "EncryptionMode": "string",
         "KmsKeyArn": "string"
      }
   },
   "ArtifactS3Location": "string",
   "Code": { 
      "Handler": "string",
      "S3Bucket": "string",
      "S3Key": "string",
      "S3Version": "string",
      "ZipFile": blob
   },
   "ExecutionRoleArn": "string",
   "FailureRetentionPeriodInDays": number,
   "Name": "string",
   "ProvisionedResourceCleanup": "string",
   "ResourcesToReplicateTags": [ "string" ],
   "RunConfig": { 
      "ActiveTracing": boolean,
      "EnvironmentVariables": { 
         "string" : "string" 
      },
      "MemoryInMB": number,
      "TimeoutInSeconds": number
   },
   "RuntimeVersion": "string",
   "Schedule": { 
      "DurationInSeconds": number,
      "Expression": "string"
   },
   "SuccessRetentionPeriodInDays": number,
   "Tags": { 
      "string" : "string" 
   },
   "VpcConfig": { 
      "Ipv6AllowedForDualStack": boolean,
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ]
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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: ArtifactConfigInput object

Required: No

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 S3 bucket can't include a period (.).

Type: String

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

Required: Yes

Code

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Type: CanaryCodeInput object

Required: Yes

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:

s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:PutLogEvents

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: Yes

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

Type: Integer

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

Required: No

Name

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Type: String

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

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

Required: Yes

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

Type: String

Valid Values: AUTOMATIC | OFF

Required: No

ResourcesToReplicateTags

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: lambda-function

Required: No

RunConfig

A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

Important

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Type: CanaryRunConfigInput object

Required: No

RuntimeVersion

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

Type: String

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

Required: Yes

Schedule

A structure that contains information about how often the canary is to run and when these test runs are to stop.

Type: CanaryScheduleInput object

Required: Yes

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

Type: Integer

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

Required: No

Tags

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

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

VpcConfig

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Type: VpcConfigInput object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Canary": { 
      "ArtifactConfig": { 
         "S3Encryption": { 
            "EncryptionMode": "string",
            "KmsKeyArn": "string"
         }
      },
      "ArtifactS3Location": "string",
      "Code": { 
         "Handler": "string",
         "SourceLocationArn": "string"
      },
      "EngineArn": "string",
      "ExecutionRoleArn": "string",
      "FailureRetentionPeriodInDays": number,
      "Id": "string",
      "Name": "string",
      "ProvisionedResourceCleanup": "string",
      "RunConfig": { 
         "ActiveTracing": boolean,
         "MemoryInMB": number,
         "TimeoutInSeconds": number
      },
      "RuntimeVersion": "string",
      "Schedule": { 
         "DurationInSeconds": number,
         "Expression": "string"
      },
      "Status": { 
         "State": "string",
         "StateReason": "string",
         "StateReasonCode": "string"
      },
      "SuccessRetentionPeriodInDays": number,
      "Tags": { 
         "string" : "string" 
      },
      "Timeline": { 
         "Created": number,
         "LastModified": number,
         "LastStarted": number,
         "LastStopped": number
      },
      "VisualReference": { 
         "BaseCanaryRunId": "string",
         "BaseScreenshots": [ 
            { 
               "IgnoreCoordinates": [ "string" ],
               "ScreenshotName": "string"
            }
         ]
      },
      "VpcConfig": { 
         "Ipv6AllowedForDualStack": boolean,
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ],
         "VpcId": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Canary

The full details about the canary you have created.

Type: Canary object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An unknown internal error occurred.

HTTP Status Code: 500

RequestEntityTooLargeException

One of the input resources is larger than is allowed.

HTTP Status Code: 413

ValidationException

A parameter could not be validated.

HTTP Status Code: 400