Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . synthetics ]

update-canary

Description

Use this operation to change the settings 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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-canary
--name <value>
[--code <value>]
[--execution-role-arn <value>]
[--runtime-version <value>]
[--schedule <value>]
[--run-config <value>]
[--success-retention-period-in-days <value>]
[--failure-retention-period-in-days <value>]
[--vpc-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

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.

--code (structure)

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.

Shorthand Syntax:

S3Bucket=string,S3Key=string,S3Version=string,ZipFile=blob,Handler=string

JSON Syntax:

{
  "S3Bucket": "string",
  "S3Key": "string",
  "S3Version": "string",
  "ZipFile": blob,
  "Handler": "string"
}

--execution-role-arn (string)

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

--runtime-version (string)

Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0 . For more information about runtime versions, see Canary Runtime Versions .

--schedule (structure)

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

Shorthand Syntax:

Expression=string,DurationInSeconds=long

JSON Syntax:

{
  "Expression": "string",
  "DurationInSeconds": long
}

--run-config (structure)

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

Shorthand Syntax:

TimeoutInSeconds=integer,MemoryInMB=integer

JSON Syntax:

{
  "TimeoutInSeconds": integer,
  "MemoryInMB": integer
}

--success-retention-period-in-days (integer)

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

--failure-retention-period-in-days (integer)

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

--vpc-config (structure)

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 .

Shorthand Syntax:

SubnetIds=string,string,SecurityGroupIds=string,string

JSON Syntax:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None