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

GetCanary

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.

Request Syntax


GET /canary/name?dryRunId=DryRunId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DryRunId

The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

name

The name of the canary that you want details for.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Canary": { 
      "ArtifactConfig": { 
         "S3Encryption": { 
            "EncryptionMode": "string",
            "KmsKeyArn": "string"
         }
      },
      "ArtifactS3Location": "string",
      "Code": { 
         "Handler": "string",
         "SourceLocationArn": "string"
      },
      "DryRunConfig": { 
         "DryRunId": "string",
         "LastDryRunExecutionStatus": "string"
      },
      "EngineArn": "string",
      "ExecutionRoleArn": "string",
      "FailureRetentionPeriodInDays": number,
      "Id": "string",
      "Name": "string",
      "ProvisionedResourceCleanup": "string",
      "RunConfig": { 
         "ActiveTracing": boolean,
         "EphemeralStorage": number,
         "MemoryInMB": number,
         "TimeoutInSeconds": number
      },
      "RuntimeVersion": "string",
      "Schedule": { 
         "DurationInSeconds": number,
         "Expression": "string",
         "RetryConfig": { 
            "MaxRetries": number
         }
      },
      "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

A structure that contains the full information about the canary.

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

ValidationException

A parameter could not be validated.

HTTP Status Code: 400