Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Turn off a canary release

Focus mode
Turn off a canary release - Amazon API Gateway

To turn off a canary release deployment is to set the canarySettings to null to remove it from the stage.

You can disable a canary release deployment using the API Gateway console, the AWS CLI, or an AWS SDK.

Turn off a canary release using the API Gateway console

To use the API Gateway console to turn off a canary release deployment, use the following steps:

To turn off a canary release deployment
  1. Sign in to the API Gateway console and choose an existing API in the main navigation pane.

  2. In the main navigation pane, choose Stages, and then choose an existing stage.

  3. Choose the Canary tab.

  4. Choose Delete.

  5. Confirm you want to delete the canary by choosing Delete.

As a result, the canarySettings property becomes null and is removed from the deployment stage. You can verify this using the AWS CLI. For example, see Turn off a canary release using the AWS CLI.

Turn off a canary release using the AWS CLI

The following update-stage command turns off the canary release deployment:

aws apigateway update-stage \ --rest-api-id abcd1234 \ --stage-name canary \ --patch-operations '[{"op":"remove", "path":"/canarySettings"}]'

The output looks like the following:

{ "stageName": "prod", "accessLogSettings": { ... }, "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "deploymentId": "nfcn0x", "lastUpdatedDate": 1511309280, "createdDate": 1511152939, "methodSettings": { ... } }

As shown in the output, the canarySettings property is no longer present in the stage of a canary-disabled deployment.

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.