CreateCanaryCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SyntheticsClient, CreateCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
// const { SyntheticsClient, CreateCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
const client = new SyntheticsClient(config);
const input = { // CreateCanaryRequest
  Name: "STRING_VALUE", // required
  Code: { // CanaryCodeInput
    S3Bucket: "STRING_VALUE",
    S3Key: "STRING_VALUE",
    S3Version: "STRING_VALUE",
    ZipFile: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
    Handler: "STRING_VALUE", // required
  },
  ArtifactS3Location: "STRING_VALUE", // required
  ExecutionRoleArn: "STRING_VALUE", // required
  Schedule: { // CanaryScheduleInput
    Expression: "STRING_VALUE", // required
    DurationInSeconds: Number("long"),
  },
  RunConfig: { // CanaryRunConfigInput
    TimeoutInSeconds: Number("int"),
    MemoryInMB: Number("int"),
    ActiveTracing: true || false,
    EnvironmentVariables: { // EnvironmentVariablesMap
      "<keys>": "STRING_VALUE",
    },
  },
  SuccessRetentionPeriodInDays: Number("int"),
  FailureRetentionPeriodInDays: Number("int"),
  RuntimeVersion: "STRING_VALUE", // required
  VpcConfig: { // VpcConfigInput
    SubnetIds: [ // SubnetIds
      "STRING_VALUE",
    ],
    SecurityGroupIds: [ // SecurityGroupIds
      "STRING_VALUE",
    ],
    Ipv6AllowedForDualStack: true || false,
  },
  ResourcesToReplicateTags: [ // ResourceList
    "lambda-function",
  ],
  ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  ArtifactConfig: { // ArtifactConfigInput
    S3Encryption: { // S3EncryptionConfig
      EncryptionMode: "SSE_S3" || "SSE_KMS",
      KmsKeyArn: "STRING_VALUE",
    },
  },
};
const command = new CreateCanaryCommand(input);
const response = await client.send(command);
// { // CreateCanaryResponse
//   Canary: { // Canary
//     Id: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Code: { // CanaryCodeOutput
//       SourceLocationArn: "STRING_VALUE",
//       Handler: "STRING_VALUE",
//     },
//     ExecutionRoleArn: "STRING_VALUE",
//     Schedule: { // CanaryScheduleOutput
//       Expression: "STRING_VALUE",
//       DurationInSeconds: Number("long"),
//     },
//     RunConfig: { // CanaryRunConfigOutput
//       TimeoutInSeconds: Number("int"),
//       MemoryInMB: Number("int"),
//       ActiveTracing: true || false,
//     },
//     SuccessRetentionPeriodInDays: Number("int"),
//     FailureRetentionPeriodInDays: Number("int"),
//     Status: { // CanaryStatus
//       State: "CREATING" || "READY" || "STARTING" || "RUNNING" || "UPDATING" || "STOPPING" || "STOPPED" || "ERROR" || "DELETING",
//       StateReason: "STRING_VALUE",
//       StateReasonCode: "INVALID_PERMISSIONS" || "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_PENDING" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "ROLLBACK_COMPLETE" || "ROLLBACK_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "SYNC_DELETE_IN_PROGRESS",
//     },
//     Timeline: { // CanaryTimeline
//       Created: new Date("TIMESTAMP"),
//       LastModified: new Date("TIMESTAMP"),
//       LastStarted: new Date("TIMESTAMP"),
//       LastStopped: new Date("TIMESTAMP"),
//     },
//     ArtifactS3Location: "STRING_VALUE",
//     EngineArn: "STRING_VALUE",
//     RuntimeVersion: "STRING_VALUE",
//     VpcConfig: { // VpcConfigOutput
//       VpcId: "STRING_VALUE",
//       SubnetIds: [ // SubnetIds
//         "STRING_VALUE",
//       ],
//       SecurityGroupIds: [ // SecurityGroupIds
//         "STRING_VALUE",
//       ],
//       Ipv6AllowedForDualStack: true || false,
//     },
//     VisualReference: { // VisualReferenceOutput
//       BaseScreenshots: [ // BaseScreenshots
//         { // BaseScreenshot
//           ScreenshotName: "STRING_VALUE", // required
//           IgnoreCoordinates: [ // BaseScreenshotIgnoreCoordinates
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       BaseCanaryRunId: "STRING_VALUE",
//     },
//     ProvisionedResourceCleanup: "AUTOMATIC" || "OFF",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     ArtifactConfig: { // ArtifactConfigOutput
//       S3Encryption: { // S3EncryptionConfig
//         EncryptionMode: "SSE_S3" || "SSE_KMS",
//         KmsKeyArn: "STRING_VALUE",
//       },
//     },
//   },
// };

CreateCanaryCommand Input

See CreateCanaryCommandInput for more details

Parameter
Type
Description
ArtifactS3Location
Required
string | undefined

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 (.).

Code
Required
CanaryCodeInput | undefined

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.

ExecutionRoleArn
Required
string | undefined

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

Name
Required
string | undefined

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 .

RuntimeVersion
Required
string | undefined

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 .

Schedule
Required
CanaryScheduleInput | undefined

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

ArtifactConfig
ArtifactConfigInput | undefined

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

FailureRetentionPeriodInDays
number | undefined

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.

ProvisionedResourceCleanup
ProvisionedResourceCleanupSetting | undefined

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.

ResourcesToReplicateTags
ResourceToTag[] | undefined

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.

RunConfig
CanaryRunConfigInput | undefined

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

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

SuccessRetentionPeriodInDays
number | undefined

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.

Tags
Record<string, string> | undefined

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.

VpcConfig
VpcConfigInput | undefined

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 .

CreateCanaryCommand Output

See CreateCanaryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Canary
Canary | undefined

The full details about the canary you have created.

Throws

Name
Fault
Details
InternalServerException
server

An unknown internal error occurred.

RequestEntityTooLargeException
client

One of the input resources is larger than is allowed.

ValidationException
client

A parameter could not be validated.

SyntheticsServiceException
Base exception class for all service exceptions from Synthetics service.