{ "version":"2.0", "metadata":{ "apiVersion":"2017-10-11", "endpointPrefix":"synthetics", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"Synthetics", "serviceFullName":"Synthetics", "serviceId":"synthetics", "signatureVersion":"v4", "signingName":"synthetics", "uid":"synthetics-2017-10-11" }, "operations":{ "AssociateResource":{ "name":"AssociateResource", "http":{ "method":"PATCH", "requestUri":"/group/{groupIdentifier}/associate" }, "input":{"shape":"AssociateResourceRequest"}, "output":{"shape":"AssociateResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

You must run this operation in the Region where the canary exists.

" }, "CreateCanary":{ "name":"CreateCanary", "http":{ "method":"POST", "requestUri":"/canary" }, "input":{"shape":"CreateCanaryRequest"}, "output":{"shape":"CreateCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"RequestEntityTooLargeException"} ], "documentation":"

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.

" }, "CreateGroup":{ "name":"CreateGroup", "http":{ "method":"POST", "requestUri":"/group" }, "input":{"shape":"CreateGroupRequest"}, "output":{"shape":"CreateGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

" }, "DeleteCanary":{ "name":"DeleteCanary", "http":{ "method":"DELETE", "requestUri":"/canary/{name}" }, "input":{"shape":"DeleteCanaryRequest"}, "output":{"shape":"DeleteCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Permanently deletes the specified canary.

If you specify `DeleteLambda` to `true`, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

- The CloudWatch alarms created for this canary. These alarms have a name of `Synthetics-SharpDrop-Alarm-MyCanaryName` .

- Amazon S3 objects and buckets, such as the canary's artifact location.

- IAM roles created for the canary. If they were created in the console, these roles have the name `role/service-role/CloudWatchSyntheticsRole-MyCanaryName` .

- CloudWatch Logs log groups created for the canary. These logs groups have the name `/aws/lambda/cwsyn-MyCanaryName` .

Before you delete a canary, you might want to use `GetCanary` to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

" }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ "method":"DELETE", "requestUri":"/group/{groupIdentifier}" }, "input":{"shape":"DeleteGroupRequest"}, "output":{"shape":"DeleteGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.

Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.

" }, "DescribeCanaries":{ "name":"DescribeCanaries", "http":{ "method":"POST", "requestUri":"/canaries" }, "input":{"shape":"DescribeCanariesRequest"}, "output":{"shape":"DescribeCanariesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation supports resource-level authorization using an IAM policy and the `Names` parameter. If you specify the `Names` parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the `Names` parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

" }, "DescribeCanariesLastRun":{ "name":"DescribeCanariesLastRun", "http":{ "method":"POST", "requestUri":"/canaries/last-run" }, "input":{"shape":"DescribeCanariesLastRunRequest"}, "output":{"shape":"DescribeCanariesLastRunResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Use this operation to see information from the most recent run of each canary that you have created.

This operation supports resource-level authorization using an IAM policy and the `Names` parameter. If you specify the `Names` parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the `Names` parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

" }, "DescribeRuntimeVersions":{ "name":"DescribeRuntimeVersions", "http":{ "method":"POST", "requestUri":"/runtime-versions" }, "input":{"shape":"DescribeRuntimeVersionsRequest"}, "output":{"shape":"DescribeRuntimeVersionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

" }, "DisassociateResource":{ "name":"DisassociateResource", "http":{ "method":"PATCH", "requestUri":"/group/{groupIdentifier}/disassociate" }, "input":{"shape":"DisassociateResourceRequest"}, "output":{"shape":"DisassociateResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Removes a canary from a group. You must run this operation in the Region where the canary exists.

" }, "GetCanary":{ "name":"GetCanary", "http":{ "method":"GET", "requestUri":"/canary/{name}" }, "input":{"shape":"GetCanaryRequest"}, "output":{"shape":"GetCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.

" }, "GetCanaryRuns":{ "name":"GetCanaryRuns", "http":{ "method":"POST", "requestUri":"/canary/{name}/runs" }, "input":{"shape":"GetCanaryRunsRequest"}, "output":{"shape":"GetCanaryRunsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves a list of runs for a specified canary.

" }, "GetGroup":{ "name":"GetGroup", "http":{ "method":"GET", "requestUri":"/group/{groupIdentifier}" }, "input":{"shape":"GetGroupRequest"}, "output":{"shape":"GetGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

" }, "ListAssociatedGroups":{ "name":"ListAssociatedGroups", "http":{ "method":"POST", "requestUri":"/resource/{resourceArn}/groups" }, "input":{"shape":"ListAssociatedGroupsRequest"}, "output":{"shape":"ListAssociatedGroupsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

" }, "ListGroupResources":{ "name":"ListGroupResources", "http":{ "method":"POST", "requestUri":"/group/{groupIdentifier}/resources" }, "input":{"shape":"ListGroupResourcesRequest"}, "output":{"shape":"ListGroupResourcesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

" }, "ListGroups":{ "name":"ListGroups", "http":{ "method":"POST", "requestUri":"/groups" }, "input":{"shape":"ListGroupsRequest"}, "output":{"shape":"ListGroupsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Displays the tags associated with a canary or group.

" }, "StartCanary":{ "name":"StartCanary", "http":{ "method":"POST", "requestUri":"/canary/{name}/start" }, "input":{"shape":"StartCanaryRequest"}, "output":{"shape":"StartCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's `Schedule`. To see a canary's schedule, use GetCanary.

" }, "StopCanary":{ "name":"StopCanary", "http":{ "method":"POST", "requestUri":"/canary/{name}/stop" }, "input":{"shape":"StopCanaryRequest"}, "output":{"shape":"StopCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use `StartCanary` to start it running again with the canary’s current schedule at any point in the future.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Assigns one or more tags (key-value pairs) to the specified canary or group.

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 resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the `TagResource` action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary or group.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Removes one or more tags from the specified resource.

" }, "UpdateCanary":{ "name":"UpdateCanary", "http":{ "method":"PATCH", "requestUri":"/canary/{name}" }, "input":{"shape":"UpdateCanaryRequest"}, "output":{"shape":"UpdateCanaryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"RequestEntityTooLargeException"} ], "documentation":"

Updates the configuration of a canary that has already been created.

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.

" } }, "shapes":{ "ArtifactConfigInput":{ "type":"structure", "members":{ "S3Encryption":{ "shape":"S3EncryptionConfig", "documentation":"

A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts

" } }, "documentation":"

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

" }, "ArtifactConfigOutput":{ "type":"structure", "members":{ "S3Encryption":{ "shape":"S3EncryptionConfig", "documentation":"

A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.

" } }, "documentation":"

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

" }, "AssociateResourceRequest":{ "type":"structure", "required":[ "GroupIdentifier", "ResourceArn" ], "members":{ "GroupIdentifier":{ "shape":"GroupIdentifier", "documentation":"

Specifies the group. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

", "location":"uri", "locationName":"groupIdentifier" }, "ResourceArn":{ "shape":"CanaryArn", "documentation":"

The ARN of the canary that you want to associate with the specified group.

" } } }, "AssociateResourceResponse":{ "type":"structure", "members":{ } }, "BadRequestException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The request was not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "BaseScreenshot":{ "type":"structure", "required":["ScreenshotName"], "members":{ "ScreenshotName":{ "shape":"String", "documentation":"

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.

" }, "IgnoreCoordinates":{ "shape":"BaseScreenshotIgnoreCoordinates", "documentation":"

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

" } }, "documentation":"

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

" }, "BaseScreenshotConfigIgnoreCoordinate":{ "type":"string", "pattern":"^(-?\\d{1,5}\\.?\\d{0,2},){3}(-?\\d{1,5}\\.?\\d{0,2}){1}$" }, "BaseScreenshotIgnoreCoordinates":{ "type":"list", "member":{"shape":"BaseScreenshotConfigIgnoreCoordinate"}, "max":20, "min":0 }, "BaseScreenshots":{ "type":"list", "member":{"shape":"BaseScreenshot"} }, "Blob":{ "type":"blob", "max":10000000, "min":1 }, "Canaries":{ "type":"list", "member":{"shape":"Canary"} }, "CanariesLastRun":{ "type":"list", "member":{"shape":"CanaryLastRun"} }, "Canary":{ "type":"structure", "members":{ "Id":{ "shape":"UUID", "documentation":"

The unique ID of this canary.

" }, "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary.

" }, "Code":{"shape":"CanaryCodeOutput"}, "ExecutionRoleArn":{ "shape":"RoleArn", "documentation":"

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.

" }, "Schedule":{ "shape":"CanaryScheduleOutput", "documentation":"

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

" }, "RunConfig":{"shape":"CanaryRunConfigOutput"}, "SuccessRetentionPeriodInDays":{ "shape":"MaxSize1024", "documentation":"

The number of days to retain data about successful runs of this canary.

" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", "documentation":"

The number of days to retain data about failed runs of this canary.

" }, "Status":{ "shape":"CanaryStatus", "documentation":"

A structure that contains information about the canary's status.

" }, "Timeline":{ "shape":"CanaryTimeline", "documentation":"

A structure that contains information about when the canary was created, modified, and most recently run.

" }, "ArtifactS3Location":{ "shape":"String", "documentation":"

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

" }, "EngineArn":{ "shape":"FunctionArn", "documentation":"

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.

" }, "RuntimeVersion":{ "shape":"String", "documentation":"

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

" }, "VpcConfig":{"shape":"VpcConfigOutput"}, "VisualReference":{ "shape":"VisualReferenceOutput", "documentation":"

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.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The list of key-value pairs that are associated with the canary.

" }, "ArtifactConfig":{ "shape":"ArtifactConfigOutput", "documentation":"

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

" } }, "documentation":"

This structure contains all information about one canary in your account.

" }, "CanaryArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,21}" }, "CanaryCodeInput":{ "type":"structure", "required":["Handler"], "members":{ "S3Bucket":{ "shape":"String", "documentation":"

If your canary script is located in S3, specify the bucket name here. Do not include `s3://` as the start of the bucket name.

" }, "S3Key":{ "shape":"String", "documentation":"

The S3 key of your script. For more information, see Working with Amazon S3 Objects.

" }, "S3Version":{ "shape":"String", "documentation":"

The S3 version ID of your script.

" }, "ZipFile":{ "shape":"Blob", "documentation":"

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.

For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.

" }, "Handler":{ "shape":"CodeHandler", "documentation":"

The entry point to use for the source code when running the canary. For canaries that use the `syn-python-selenium-1.0` runtime or a `syn-nodejs.puppeteer` runtime earlier than `syn-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` .

" } }, "documentation":"

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`.

" }, "CanaryCodeOutput":{ "type":"structure", "members":{ "SourceLocationArn":{ "shape":"String", "documentation":"

The ARN of the Lambda layer where Synthetics stores the canary script code.

" }, "Handler":{ "shape":"String", "documentation":"

The entry point to use for the source code when running the canary.

" } }, "documentation":"

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

" }, "CanaryLastRun":{ "type":"structure", "members":{ "CanaryName":{ "shape":"CanaryName", "documentation":"

The name of the canary.

" }, "LastRun":{ "shape":"CanaryRun", "documentation":"

The results from this canary's most recent run.

" } }, "documentation":"

This structure contains information about the most recent run of a single canary.

" }, "CanaryName":{ "type":"string", "max":21, "min":1, "pattern":"^[0-9a-z_\\-]+$" }, "CanaryRun":{ "type":"structure", "members":{ "Id":{ "shape":"UUID", "documentation":"

A unique ID that identifies this canary run.

" }, "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary.

" }, "Status":{ "shape":"CanaryRunStatus", "documentation":"

The status of this run.

" }, "Timeline":{ "shape":"CanaryRunTimeline", "documentation":"

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

" }, "ArtifactS3Location":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

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

" }, "CanaryRunConfigInput":{ "type":"structure", "members":{ "TimeoutInSeconds":{ "shape":"MaxFifteenMinutesInSeconds", "documentation":"

How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.

If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.

" }, "MemoryInMB":{ "shape":"MaxSize3008", "documentation":"

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

" }, "ActiveTracing":{ "shape":"NullableBoolean", "documentation":"

Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.

You can enable active tracing only for canaries that use version `syn-nodejs-2.0` or later for their canary runtime.

" }, "EnvironmentVariables":{ "shape":"EnvironmentVariablesMap", "documentation":"

Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}

Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.

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

" } }, "documentation":"

A structure that contains input information for a canary run.

" }, "CanaryRunConfigOutput":{ "type":"structure", "members":{ "TimeoutInSeconds":{ "shape":"MaxFifteenMinutesInSeconds", "documentation":"

How long the canary is allowed to run before it must stop.

" }, "MemoryInMB":{ "shape":"MaxSize3008", "documentation":"

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

" }, "ActiveTracing":{ "shape":"NullableBoolean", "documentation":"

Displays whether this canary run used active X-Ray tracing.

" } }, "documentation":"

A structure that contains information about a canary run.

" }, "CanaryRunState":{ "type":"string", "enum":[ "RUNNING", "PASSED", "FAILED" ] }, "CanaryRunStateReasonCode":{ "type":"string", "enum":[ "CANARY_FAILURE", "EXECUTION_FAILURE" ] }, "CanaryRunStatus":{ "type":"structure", "members":{ "State":{ "shape":"CanaryRunState", "documentation":"

The current state of the run.

" }, "StateReason":{ "shape":"String", "documentation":"

If run of the canary failed, this field contains the reason for the error.

" }, "StateReasonCode":{ "shape":"CanaryRunStateReasonCode", "documentation":"

If this value is `CANARY_FAILURE`, an exception occurred in the canary code. If this value is `EXECUTION_FAILURE`, an exception occurred in CloudWatch Synthetics.

" } }, "documentation":"

This structure contains the status information about a canary run.

" }, "CanaryRunTimeline":{ "type":"structure", "members":{ "Started":{ "shape":"Timestamp", "documentation":"

The start time of the run.

" }, "Completed":{ "shape":"Timestamp", "documentation":"

The end time of the run.

" } }, "documentation":"

This structure contains the start and end times of a single canary run.

" }, "CanaryRuns":{ "type":"list", "member":{"shape":"CanaryRun"} }, "CanaryScheduleInput":{ "type":"structure", "required":["Expression"], "members":{ "Expression":{ "shape":"String", "documentation":"

A `rate` expression or a `cron` expression that defines how often the canary is to run.

For a rate expression, The syntax is `rate(number unit)`. unit can be `minute`, `minutes`, or `hour`.

For example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)`.

Specifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.

Use `cron(expression)` to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

" }, "DurationInSeconds":{ "shape":"MaxOneYearInSeconds", "documentation":"

How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

" } }, "documentation":"

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

" }, "CanaryScheduleOutput":{ "type":"structure", "members":{ "Expression":{ "shape":"String", "documentation":"

A `rate` expression or a `cron` expression that defines how often the canary is to run.

For a rate expression, The syntax is `rate(number unit)`. unit can be `minute`, `minutes`, or `hour`.

For example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)`.

Specifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.

Use `cron(expression)` to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

" }, "DurationInSeconds":{ "shape":"MaxOneYearInSeconds", "documentation":"

How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the `Expression` value.

" } }, "documentation":"

How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value.

" }, "CanaryState":{ "type":"string", "enum":[ "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING" ] }, "CanaryStateReasonCode":{ "type":"string", "enum":[ "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" ] }, "CanaryStatus":{ "type":"structure", "members":{ "State":{ "shape":"CanaryState", "documentation":"

The current state of the canary.

" }, "StateReason":{ "shape":"String", "documentation":"

If the canary has insufficient permissions to run, this field provides more details.

" }, "StateReasonCode":{ "shape":"CanaryStateReasonCode", "documentation":"

If the canary cannot run or has failed, this field displays the reason.

" } }, "documentation":"

A structure that contains the current state of the canary.

" }, "CanaryTimeline":{ "type":"structure", "members":{ "Created":{ "shape":"Timestamp", "documentation":"

The date and time the canary was created.

" }, "LastModified":{ "shape":"Timestamp", "documentation":"

The date and time the canary was most recently modified.

" }, "LastStarted":{ "shape":"Timestamp", "documentation":"

The date and time that the canary's most recent run started.

" }, "LastStopped":{ "shape":"Timestamp", "documentation":"

The date and time that the canary's most recent run ended.

" } }, "documentation":"

This structure contains information about when the canary was created and modified.

" }, "CodeHandler":{ "type":"string", "max":128, "min":1, "pattern":"^([0-9a-zA-Z_-]+\\/)*[0-9A-Za-z_\\\\-]+\\.[A-Za-z_][A-Za-z0-9_]*$" }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

A conflicting operation is already in progress.

", "error":{"httpStatusCode":409}, "exception":true }, "CreateCanaryRequest":{ "type":"structure", "required":[ "Name", "Code", "ArtifactS3Location", "ExecutionRoleArn", "Schedule", "RuntimeVersion" ], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

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.

" }, "Code":{ "shape":"CanaryCodeInput", "documentation":"

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.

" }, "ArtifactS3Location":{ "shape":"String", "documentation":"

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

" }, "ExecutionRoleArn":{ "shape":"RoleArn", "documentation":"

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`

" }, "Schedule":{ "shape":"CanaryScheduleInput", "documentation":"

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

" }, "RunConfig":{ "shape":"CanaryRunConfigInput", "documentation":"

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":{ "shape":"MaxSize1024", "documentation":"

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.

" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", "documentation":"

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.

" }, "RuntimeVersion":{ "shape":"String", "documentation":"

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.

" }, "VpcConfig":{ "shape":"VpcConfigInput", "documentation":"

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.

" }, "Tags":{ "shape":"TagMap", "documentation":"

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.

" }, "ArtifactConfig":{ "shape":"ArtifactConfigInput", "documentation":"

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

" } } }, "CreateCanaryResponse":{ "type":"structure", "members":{ "Canary":{ "shape":"Canary", "documentation":"

The full details about the canary you have created.

" } } }, "CreateGroupRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"GroupName", "documentation":"

The name for the group. It can include any Unicode characters.

The names for all groups in your account, across all Regions, must be unique.

" }, "Tags":{ "shape":"TagMap", "documentation":"

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

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.

" } } }, "CreateGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"Group", "documentation":"

A structure that contains information about the group that was just created.

" } } }, "DeleteCanaryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

", "location":"uri", "locationName":"name" }, "DeleteLambda":{ "shape":"boolean", "documentation":"

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

Type: Boolean

", "location":"querystring", "locationName":"deleteLambda" } } }, "DeleteCanaryResponse":{ "type":"structure", "members":{ } }, "DeleteGroupRequest":{ "type":"structure", "required":["GroupIdentifier"], "members":{ "GroupIdentifier":{ "shape":"GroupIdentifier", "documentation":"

Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

", "location":"uri", "locationName":"groupIdentifier" } } }, "DeleteGroupResponse":{ "type":"structure", "members":{ } }, "DescribeCanariesLastRunNameFilter":{ "type":"list", "member":{"shape":"CanaryName"}, "max":5, "min":1 }, "DescribeCanariesLastRunRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `DescribeCanariesLastRun` operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxSize100", "documentation":"

Specify this parameter to limit how many runs are returned each time you use the `DescribeLastRun` operation. If you omit this parameter, the default of 100 is used.

" }, "Names":{ "shape":"DescribeCanariesLastRunNameFilter", "documentation":"

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the `Names` parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

" } } }, "DescribeCanariesLastRunResponse":{ "type":"structure", "members":{ "CanariesLastRun":{ "shape":"CanariesLastRun", "documentation":"

An array that contains the information from the most recent run of each canary.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `DescribeCanariesLastRun` operation to retrieve the next set of results.

" } } }, "DescribeCanariesNameFilter":{ "type":"list", "member":{"shape":"CanaryName"}, "max":5, "min":1 }, "DescribeCanariesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxCanaryResults", "documentation":"

Specify this parameter to limit how many canaries are returned each time you use the `DescribeCanaries` operation. If you omit this parameter, the default of 100 is used.

" }, "Names":{ "shape":"DescribeCanariesNameFilter", "documentation":"

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

" } } }, "DescribeCanariesResponse":{ "type":"structure", "members":{ "Canaries":{ "shape":"Canaries", "documentation":"

Returns an array. Each item in the array contains the full information about one canary.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `DescribeCanaries` operation to retrieve the next set of results.

" } } }, "DescribeRuntimeVersionsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `DescribeRuntimeVersions` operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxSize100", "documentation":"

Specify this parameter to limit how many runs are returned each time you use the `DescribeRuntimeVersions` operation. If you omit this parameter, the default of 100 is used.

" } } }, "DescribeRuntimeVersionsResponse":{ "type":"structure", "members":{ "RuntimeVersions":{ "shape":"RuntimeVersionList", "documentation":"

An array of objects that display the details about each Synthetics canary runtime version.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `DescribeRuntimeVersions` operation to retrieve the next set of results.

" } } }, "DisassociateResourceRequest":{ "type":"structure", "required":[ "GroupIdentifier", "ResourceArn" ], "members":{ "GroupIdentifier":{ "shape":"GroupIdentifier", "documentation":"

Specifies the group. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

", "location":"uri", "locationName":"groupIdentifier" }, "ResourceArn":{ "shape":"CanaryArn", "documentation":"

The ARN of the canary that you want to remove from the specified group.

" } } }, "DisassociateResourceResponse":{ "type":"structure", "members":{ } }, "EncryptionMode":{ "type":"string", "enum":[ "SSE_S3", "SSE_KMS" ] }, "EnvironmentVariableName":{ "type":"string", "pattern":"[a-zA-Z]([a-zA-Z0-9_])+" }, "EnvironmentVariableValue":{"type":"string"}, "EnvironmentVariablesMap":{ "type":"map", "key":{"shape":"EnvironmentVariableName"}, "value":{"shape":"EnvironmentVariableValue"} }, "ErrorMessage":{"type":"string"}, "FunctionArn":{ "type":"string", "max":2048, "min":1, "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-_]+))?" }, "GetCanaryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want details for.

", "location":"uri", "locationName":"name" } } }, "GetCanaryResponse":{ "type":"structure", "members":{ "Canary":{ "shape":"Canary", "documentation":"

A structure that contains the full information about the canary.

" } } }, "GetCanaryRunsRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want to see runs for.

", "location":"uri", "locationName":"name" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `GetCanaryRuns` operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxSize100", "documentation":"

Specify this parameter to limit how many runs are returned each time you use the `GetCanaryRuns` operation. If you omit this parameter, the default of 100 is used.

" } } }, "GetCanaryRunsResponse":{ "type":"structure", "members":{ "CanaryRuns":{ "shape":"CanaryRuns", "documentation":"

An array of structures. Each structure contains the details of one of the retrieved canary runs.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `GetCanaryRuns` operation to retrieve the next set of results.

" } } }, "GetGroupRequest":{ "type":"structure", "required":["GroupIdentifier"], "members":{ "GroupIdentifier":{ "shape":"GroupIdentifier", "documentation":"

Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

", "location":"uri", "locationName":"groupIdentifier" } } }, "GetGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"Group", "documentation":"

A structure that contains information about the group.

" } } }, "Group":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

The unique ID of the group.

" }, "Name":{ "shape":"GroupName", "documentation":"

The name of the group.

" }, "Arn":{ "shape":"GroupArn", "documentation":"

The ARN of the group.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The list of key-value pairs that are associated with the canary.

" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"

The date and time that the group was created.

" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"

The date and time that the group was most recently updated.

" } }, "documentation":"

This structure contains information about one group.

" }, "GroupArn":{ "type":"string", "max":128, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:group:[0-9a-z]+" }, "GroupIdentifier":{ "type":"string", "max":128, "min":1 }, "GroupName":{ "type":"string", "max":64, "min":1 }, "GroupSummary":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

The unique ID of the group.

" }, "Name":{ "shape":"GroupName", "documentation":"

The name of the group.

" }, "Arn":{ "shape":"GroupArn", "documentation":"

The ARN of the group.

" } }, "documentation":"

A structure containing some information about a group.

" }, "GroupSummaryList":{ "type":"list", "member":{"shape":"GroupSummary"} }, "InternalFailureException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

An internal failure occurred. Try the operation again.

", "error":{"httpStatusCode":500}, "exception":true }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

An unknown internal error occurred.

", "error":{"httpStatusCode":500}, "exception":true }, "KmsKeyArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:key/[\\w\\-\\/]+" }, "ListAssociatedGroupsRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxGroupResults", "documentation":"

Specify this parameter to limit how many groups are returned each time you use the `ListAssociatedGroups` operation. If you omit this parameter, the default of 20 is used.

" }, "ResourceArn":{ "shape":"CanaryArn", "documentation":"

The ARN of the canary that you want to view groups for.

", "location":"uri", "locationName":"resourceArn" } } }, "ListAssociatedGroupsResponse":{ "type":"structure", "members":{ "Groups":{ "shape":"GroupSummaryList", "documentation":"

An array of structures that contain information about the groups that this canary is associated with.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `ListAssociatedGroups` operation to retrieve the next set of results.

" } } }, "ListGroupResourcesRequest":{ "type":"structure", "required":["GroupIdentifier"], "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxGroupResults", "documentation":"

Specify this parameter to limit how many canary ARNs are returned each time you use the `ListGroupResources` operation. If you omit this parameter, the default of 20 is used.

" }, "GroupIdentifier":{ "shape":"GroupIdentifier", "documentation":"

Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

", "location":"uri", "locationName":"groupIdentifier" } } }, "ListGroupResourcesResponse":{ "type":"structure", "members":{ "Resources":{ "shape":"StringList", "documentation":"

An array of ARNs. These ARNs are for the canaries that are associated with the group.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `ListGroupResources` operation to retrieve the next set of results.

" } } }, "ListGroupsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

" }, "MaxResults":{ "shape":"MaxGroupResults", "documentation":"

Specify this parameter to limit how many groups are returned each time you use the `ListGroups` operation. If you omit this parameter, the default of 20 is used.

" } } }, "ListGroupsResponse":{ "type":"structure", "members":{ "Groups":{ "shape":"GroupSummaryList", "documentation":"

An array of structures that each contain information about one group.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token that indicates that there is more data available. You can use this token in a subsequent `ListGroups` operation to retrieve the next set of results.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN of the canary or group that you want to view tags for.

The ARN format of a canary is `arn:aws:synthetics:Region:account-id:canary:canary-name` .

The ARN format of a group is `arn:aws:synthetics:Region:account-id:group:group-name`

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"

The list of tag keys and values associated with the resource that you specified.

" } } }, "MaxCanaryResults":{ "type":"integer", "max":20, "min":1 }, "MaxFifteenMinutesInSeconds":{ "type":"integer", "max":840, "min":3 }, "MaxGroupResults":{ "type":"integer", "max":20, "min":1 }, "MaxOneYearInSeconds":{ "type":"long", "max":31622400, "min":0 }, "MaxSize100":{ "type":"integer", "max":100, "min":1 }, "MaxSize1024":{ "type":"integer", "max":1024, "min":1 }, "MaxSize3008":{ "type":"integer", "max":3008, "min":960 }, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource was not found.

", "error":{"httpStatusCode":404}, "exception":true }, "NullableBoolean":{"type":"boolean"}, "PaginationToken":{ "type":"string", "max":512, "min":1, "pattern":"^.+$" }, "RequestEntityTooLargeException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

One of the input resources is larger than is allowed.

", "error":{"httpStatusCode":413}, "exception":true }, "ResourceArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:(canary|group):[0-9a-z_\\-]+" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

One of the specified resources was not found.

", "error":{"httpStatusCode":404}, "exception":true }, "RoleArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "RuntimeVersion":{ "type":"structure", "members":{ "VersionName":{ "shape":"String", "documentation":"

The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions.

" }, "Description":{ "shape":"String", "documentation":"

A description of the runtime version, created by Amazon.

" }, "ReleaseDate":{ "shape":"Timestamp", "documentation":"

The date that the runtime version was released.

" }, "DeprecationDate":{ "shape":"Timestamp", "documentation":"

If this runtime version is deprecated, this value is the date of deprecation.

" } }, "documentation":"

This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions.

" }, "RuntimeVersionList":{ "type":"list", "member":{"shape":"RuntimeVersion"} }, "S3EncryptionConfig":{ "type":"structure", "members":{ "EncryptionMode":{ "shape":"EncryptionMode", "documentation":"

The encryption method to use for artifacts created by this canary. Specify `SSE_S3` to use server-side encryption (SSE) with an Amazon S3-managed key. Specify `SSE-KMS` to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

" }, "KmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"

The ARN of the customer-managed KMS key to use, if you specify `SSE-KMS` for `EncryptionMode`

" } }, "documentation":"

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

For more information, see Encrypting canary artifacts

" }, "SecurityGroupId":{"type":"string"}, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":5, "min":0 }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The request exceeded a service quota value.

", "error":{"httpStatusCode":402}, "exception":true }, "StartCanaryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want to run. To find canary names, use DescribeCanaries.

", "location":"uri", "locationName":"name" } } }, "StartCanaryResponse":{ "type":"structure", "members":{ } }, "StopCanaryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.

", "location":"uri", "locationName":"name" } } }, "StopCanaryResponse":{ "type":"structure", "members":{ } }, "String":{ "type":"string", "max":1024, "min":1 }, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SubnetId":{"type":"string"}, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"}, "max":16, "min":0 }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN of the canary or group that you're adding tags to.

The ARN format of a canary is `arn:aws:synthetics:Region:account-id:canary:canary-name` .

The ARN format of a group is `arn:aws:synthetics:Region:account-id:group:group-name`

", "location":"uri", "locationName":"resourceArn" }, "Tags":{ "shape":"TagMap", "documentation":"

The list of key-value pairs to associate with the resource.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256 }, "Timestamp":{"type":"timestamp"}, "Token":{ "type":"string", "max":252, "min":4 }, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

There were too many simultaneous requests. Try the operation again.

", "error":{"httpStatusCode":429}, "exception":true }, "UUID":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN of the canary or group that you're removing tags from.

The ARN format of a canary is `arn:aws:synthetics:Region:account-id:canary:canary-name` .

The ARN format of a group is `arn:aws:synthetics:Region:account-id:group:group-name`

", "location":"uri", "locationName":"resourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The list of tag keys to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateCanaryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CanaryName", "documentation":"

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

You cannot change the name of a canary that has already been created.

", "location":"uri", "locationName":"name" }, "Code":{ "shape":"CanaryCodeInput", "documentation":"

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":{ "shape":"RoleArn", "documentation":"

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:CreateLogStream`

" }, "RuntimeVersion":{ "shape":"String", "documentation":"

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

" }, "Schedule":{ "shape":"CanaryScheduleInput", "documentation":"

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

" }, "RunConfig":{ "shape":"CanaryRunConfigInput", "documentation":"

A structure that contains the timeout value that is used for each individual run of the canary.

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

" }, "SuccessRetentionPeriodInDays":{ "shape":"MaxSize1024", "documentation":"

The number of days to retain data about successful runs of this canary.

" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", "documentation":"

The number of days to retain data about failed runs of this canary.

" }, "VpcConfig":{ "shape":"VpcConfigInput", "documentation":"

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.

" }, "VisualReference":{ "shape":"VisualReferenceInput", "documentation":"

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

" }, "ArtifactS3Location":{ "shape":"String", "documentation":"

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

" }, "ArtifactConfig":{ "shape":"ArtifactConfigInput", "documentation":"

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

" } } }, "UpdateCanaryResponse":{ "type":"structure", "members":{ } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

A parameter could not be validated.

", "error":{"httpStatusCode":400}, "exception":true }, "VisualReferenceInput":{ "type":"structure", "required":["BaseCanaryRunId"], "members":{ "BaseScreenshots":{ "shape":"BaseScreenshots", "documentation":"

An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

" }, "BaseCanaryRunId":{ "shape":"String", "documentation":"

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are `nextrun` to use the screenshots from the next run after this update is made, `lastrun` to use the screenshots from the most recent run before this update was made, or the value of `Id` in the CanaryRun from any past run of this canary.

" } }, "documentation":"

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

" }, "VisualReferenceOutput":{ "type":"structure", "members":{ "BaseScreenshots":{ "shape":"BaseScreenshots", "documentation":"

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

" }, "BaseCanaryRunId":{ "shape":"String", "documentation":"

The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

" } }, "documentation":"

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates of any parts of those screenshots that are ignored during visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

" }, "VpcConfigInput":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"SubnetIds", "documentation":"

The IDs of the subnets where this canary is to run.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

The IDs of the security groups for this canary.

" } }, "documentation":"

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.

" }, "VpcConfigOutput":{ "type":"structure", "members":{ "VpcId":{ "shape":"VpcId", "documentation":"

The IDs of the VPC where this canary is to run.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

The IDs of the subnets where this canary is to run.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

The IDs of the security groups for this canary.

" } }, "documentation":"

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.

" }, "VpcId":{"type":"string"}, "boolean":{"type":"boolean"} }, "documentation":"Amazon CloudWatch Synthetics

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The 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. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.

Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.

" }