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

DescribeCanariesLastRun

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.

Request Syntax


POST /canaries/last-run HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "Names": [ "string" ],
   "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

Names

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

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

Required: No

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

Length Constraints: Minimum length of 4. Maximum length of 252.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CanariesLastRun": [ 
      { 
         "CanaryName": "string",
         "LastRun": { 
            "ArtifactS3Location": "string",
            "Id": "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

Length Constraints: Minimum length of 4. Maximum length of 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