Synthetics / Client / create_canary

create_canary#

Synthetics.Client.create_canary(**kwargs)#

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Request Syntax

response = client.create_canary(
    Name='string',
    Code={
        'S3Bucket': 'string',
        'S3Key': 'string',
        'S3Version': 'string',
        'ZipFile': b'bytes',
        'Handler': 'string'
    },
    ArtifactS3Location='string',
    ExecutionRoleArn='string',
    Schedule={
        'Expression': 'string',
        'DurationInSeconds': 123
    },
    RunConfig={
        'TimeoutInSeconds': 123,
        'MemoryInMB': 123,
        'ActiveTracing': True|False,
        'EnvironmentVariables': {
            'string': 'string'
        }
    },
    SuccessRetentionPeriodInDays=123,
    FailureRetentionPeriodInDays=123,
    RuntimeVersion='string',
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    ResourcesToReplicateTags=[
        'lambda-function',
    ],
    Tags={
        'string': 'string'
    },
    ArtifactConfig={
        'S3Encryption': {
            'EncryptionMode': 'SSE_S3'|'SSE_KMS',
            'KmsKeyArn': 'string'
        }
    }
)

Parameters:

Name (string) –
[REQUIRED]

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
Code (dict) –
[REQUIRED]

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.
- S3Bucket (string) –
  
  If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
- S3Key (string) –
  
  The S3 key of your script. For more information, see Working with Amazon S3 Objects.
- S3Version (string) –
  
  The S3 version ID of your script.
- ZipFile (bytes) –
  
  If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.
  
  For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.
- Handler (string) – [REQUIRED]
  
  The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as ``fileName.functionName ``, or you can specify a folder where canary scripts reside as ``folder/fileName.functionName ``.
ArtifactS3Location (string) –
[REQUIRED]

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can’t include a period (.).
ExecutionRoleArn (string) –
[REQUIRED]

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:PutLogEvents
Schedule (dict) –
[REQUIRED]

A structure that contains information about how often the canary is to run and when these test runs are to stop.
- Expression (string) – [REQUIRED]
  
  A rate expression or a cron expression that defines how often the canary is to run.
  
  For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.
  
  For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
  
  Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
  
  Use cron(expression) to specify a cron expression. You can’t schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
- DurationInSeconds (integer) –
  
  How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
RunConfig (dict) –
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

Warning
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
- TimeoutInSeconds (integer) –
  
  How long the canary is allowed to run before it must stop. You can’t set this time to be longer than the frequency of the runs of this canary.
  
  If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
- MemoryInMB (integer) –
  
  The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
- ActiveTracing (boolean) –
  
  Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.
  
  You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
- EnvironmentVariables (dict) –
  
  Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
  
  { “key1” : “value1”, “key2” : “value2”, …}
  
  Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can’t specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
  
  Warning
  The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
  - (string) –
    - (string) –
SuccessRetentionPeriodInDays (integer) – The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
FailureRetentionPeriodInDays (integer) – The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
RuntimeVersion (string) –
[REQUIRED]

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.
VpcConfig (dict) –
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.
- SubnetIds (list) –
  
  The IDs of the subnets where this canary is to run.
  - (string) –
- SecurityGroupIds (list) –
  
  The IDs of the security groups for this canary.
  - (string) –
ResourcesToReplicateTags (list) –
To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

If you specify this parameter and don’t specify any tags in the Tags parameter, the canary creation fails.
- (string) –
Tags (dict) –
A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
- (string) –
  - (string) –
ArtifactConfig (dict) –
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
- S3Encryption (dict) –
  
  A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts
  - EncryptionMode (string) –
    
    The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.
    
    If you omit this parameter, an Amazon Web Services-managed KMS key is used.
  - KmsKeyArn (string) –
    
    The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode

Return type:

dict

Returns:

Response Syntax

{
    'Canary': {
        'Id': 'string',
        'Name': 'string',
        'Code': {
            'SourceLocationArn': 'string',
            'Handler': 'string'
        },
        'ExecutionRoleArn': 'string',
        'Schedule': {
            'Expression': 'string',
            'DurationInSeconds': 123
        },
        'RunConfig': {
            'TimeoutInSeconds': 123,
            'MemoryInMB': 123,
            'ActiveTracing': True|False
        },
        'SuccessRetentionPeriodInDays': 123,
        'FailureRetentionPeriodInDays': 123,
        'Status': {
            'State': 'CREATING'|'READY'|'STARTING'|'RUNNING'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR'|'DELETING',
            'StateReason': 'string',
            'StateReasonCode': 'INVALID_PERMISSIONS'|'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_PENDING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'SYNC_DELETE_IN_PROGRESS'
        },
        'Timeline': {
            'Created': datetime(2015, 1, 1),
            'LastModified': datetime(2015, 1, 1),
            'LastStarted': datetime(2015, 1, 1),
            'LastStopped': datetime(2015, 1, 1)
        },
        'ArtifactS3Location': 'string',
        'EngineArn': 'string',
        'RuntimeVersion': 'string',
        'VpcConfig': {
            'VpcId': 'string',
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'VisualReference': {
            'BaseScreenshots': [
                {
                    'ScreenshotName': 'string',
                    'IgnoreCoordinates': [
                        'string',
                    ]
                },
            ],
            'BaseCanaryRunId': 'string'
        },
        'Tags': {
            'string': 'string'
        },
        'ArtifactConfig': {
            'S3Encryption': {
                'EncryptionMode': 'SSE_S3'|'SSE_KMS',
                'KmsKeyArn': 'string'
            }
        }
    }
}

Response Structure

(dict) –
- Canary (dict) –
  
  The full details about the canary you have created.
  - Id (string) –
    
    The unique ID of this canary.
  - Name (string) –
    
    The name of the canary.
  - Code (dict) –
    
    This structure contains information about the canary’s Lambda handler and where its code is stored by CloudWatch Synthetics.
    - SourceLocationArn (string) –
      
      The ARN of the Lambda layer where Synthetics stores the canary script code.
    - Handler (string) –
      
      The entry point to use for the source code when running the canary.
  - ExecutionRoleArn (string) –
    
    The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
  - Schedule (dict) –
    
    A structure that contains information about how often the canary is to run, and when these runs are to stop.
    - Expression (string) –
      
      A rate expression or a cron expression that defines how often the canary is to run.
      
      For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.
      
      For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
      
      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
      
      Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    - DurationInSeconds (integer) –
      
      How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
  - RunConfig (dict) –
    
    A structure that contains information about a canary run.
    - TimeoutInSeconds (integer) –
      
      How long the canary is allowed to run before it must stop.
    - MemoryInMB (integer) –
      
      The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
    - ActiveTracing (boolean) –
      
      Displays whether this canary run used active X-Ray tracing.
  - SuccessRetentionPeriodInDays (integer) –
    
    The number of days to retain data about successful runs of this canary.
  - FailureRetentionPeriodInDays (integer) –
    
    The number of days to retain data about failed runs of this canary.
  - Status (dict) –
    
    A structure that contains information about the canary’s status.
    - State (string) –
      
      The current state of the canary.
    - StateReason (string) –
      
      If the canary has insufficient permissions to run, this field provides more details.
    - StateReasonCode (string) –
      
      If the canary cannot run or has failed, this field displays the reason.
  - Timeline (dict) –
    
    A structure that contains information about when the canary was created, modified, and most recently run.
    - Created (datetime) –
      
      The date and time the canary was created.
    - LastModified (datetime) –
      
      The date and time the canary was most recently modified.
    - LastStarted (datetime) –
      
      The date and time that the canary’s most recent run started.
    - LastStopped (datetime) –
      
      The date and time that the canary’s most recent run ended.
  - ArtifactS3Location (string) –
    
    The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
  - EngineArn (string) –
    
    The ARN of the Lambda function that is used as your canary’s engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
  - RuntimeVersion (string) –
    
    Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
  - VpcConfig (dict) –
    
    If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
    - VpcId (string) –
      
      The IDs of the VPC where this canary is to run.
    - SubnetIds (list) –
      
      The IDs of the subnets where this canary is to run.
      - (string) –
    - SecurityGroupIds (list) –
      
      The IDs of the security groups for this canary.
      - (string) –
  - VisualReference (dict) –
    
    If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
    - BaseScreenshots (list) –
      
      An array of screenshots that are used as the baseline for comparisons during visual monitoring.
      - (dict) –
        
        A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.
        
        ScreenshotName (string) –
        
        The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.
        
        IgnoreCoordinates (list) –
        
        Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary
        
        (string) –
    - BaseCanaryRunId (string) –
      
      The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
  - Tags (dict) –
    
    The list of key-value pairs that are associated with the canary.
    - (string) –
      - (string) –
  - ArtifactConfig (dict) –
    
    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
    - S3Encryption (dict) –
      
      A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3.
      - EncryptionMode (string) –
        
        The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.
        
        If you omit this parameter, an Amazon Web Services-managed KMS key is used.
      - KmsKeyArn (string) –
        
        The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode

Exceptions

Synthetics.Client.exceptions.InternalServerException
Synthetics.Client.exceptions.ValidationException
Synthetics.Client.exceptions.RequestEntityTooLargeException