DescribeCanariesLastRun - Amazon CloudWatch Synthetics

DescribeCanariesLastRun

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

Request Syntax

POST /canaries/last-run HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

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.

Type: Integer

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

Required: No

NextToken

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.

Type: String

Pattern: ^[a-zA-Z0-9=/+_.-]{4,252}$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CanariesLastRun": [ { "CanaryName": "string", "LastRun": { "ArtifactS3Location": "string", "Name": "string", "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "Timeline": { "Completed": number, "Started": number } } } ], "NextToken": "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.

CanariesLastRun

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

Type: Array of CanaryLastRun objects

NextToken

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.

Type: String

Pattern: ^[a-zA-Z0-9=/+_.-]{4,252}$

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

ValidationException

A parameter could not be validated.

HTTP Status Code: 400

See Also

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