Synthetics

Client

class Synthetics.Client

A low-level client representing Synthetics

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries , which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The 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. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide .

Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries .

client = session.create_client('synthetics')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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 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 .

See also: AWS API Documentation

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',
        ]
    },
    Tags={
        'string': '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 full bucket name here. The bucket must already exist. Specify the full bucket name, including 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 .zip file that contains the script. It can be up to 5 MB.

    • Handler (string) -- [REQUIRED]

      The entry point to use for the source code when running the canary. This value must end with the string .handler .

  • 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.

  • 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 that defines how often the canary is to run. 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.

    • 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.

    • 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 AWS 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 .

      • (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) --
  • 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.

    • (string) --
      • (string) --
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'
        },
        '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',
            ]
        },
        'Tags': {
            'string': '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 that defines how often the canary is to run. 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.

          Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

        • 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 AWS 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) --
      • Tags (dict) --

        The list of key-value pairs that are associated with the canary.

        • (string) --
          • (string) --

Exceptions

delete_canary(**kwargs)

Permanently deletes the specified canary.

When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

  • The Lambda functions and layers used by this canary. These have the prefix ``cwsyn-MyCanaryName `` .
  • The CloudWatch alarms created for this canary. These alarms have a name of ``Synthetics-SharpDrop-Alarm-MyCanaryName `` .
  • Amazon S3 objects and buckets, such as the canary's artifact location.
  • IAM roles created for the canary. If they were created in the console, these roles have the name ``role/service-role/CloudWatchSyntheticsRole-MyCanaryName `` .
  • CloudWatch Logs log groups created for the canary. These logs groups have the name ``/aws/lambda/cwsyn-MyCanaryName `` .

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

See also: AWS API Documentation

Request Syntax

response = client.delete_canary(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries .

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

describe_canaries(**kwargs)

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries , the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.

See also: AWS API Documentation

Request Syntax

response = client.describe_canaries(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
  • MaxResults (integer) -- Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.
Return type

dict

Returns

Response Syntax

{
    'Canaries': [
        {
            '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'
            },
            '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',
                ]
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Canaries (list) --

      Returns an array. Each item in the array contains the full information about one canary.

      • (dict) --

        This structure contains all information about one canary in your account.

        • 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 that defines how often the canary is to run. 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.

            Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

          • 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 AWS 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) --
        • Tags (dict) --

          The list of key-value pairs that are associated with the canary.

          • (string) --
            • (string) --
    • NextToken (string) --

      A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.

Exceptions

describe_canaries_last_run(**kwargs)

Use this operation to see information from the most recent run of each canary that you have created.

See also: AWS API Documentation

Request Syntax

response = client.describe_canaries_last_run(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
  • MaxResults (integer) -- 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.
Return type

dict

Returns

Response Syntax

{
    'CanariesLastRun': [
        {
            'CanaryName': 'string',
            'LastRun': {
                'Id': 'string',
                'Name': 'string',
                'Status': {
                    'State': 'RUNNING'|'PASSED'|'FAILED',
                    'StateReason': 'string',
                    'StateReasonCode': 'CANARY_FAILURE'|'EXECUTION_FAILURE'
                },
                'Timeline': {
                    'Started': datetime(2015, 1, 1),
                    'Completed': datetime(2015, 1, 1)
                },
                'ArtifactS3Location': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CanariesLastRun (list) --

      An array that contains the information from the most recent run of each canary.

      • (dict) --

        This structure contains information about the most recent run of a single canary.

        • CanaryName (string) --

          The name of the canary.

        • LastRun (dict) --

          The results from this canary's most recent run.

          • Id (string) --

            A unique ID that identifies this canary run.

          • Name (string) --

            The name of the canary.

          • Status (dict) --

            The status of this run.

            • State (string) --

              The current state of the run.

            • StateReason (string) --

              If run of the canary failed, this field contains the reason for the error.

            • StateReasonCode (string) --

              If this value is CANARY_FAILURE , an exception occurred in the canary code. If this value is EXECUTION_FAILURE , an exception occurred in CloudWatch Synthetics.

          • Timeline (dict) --

            A structure that contains the start and end times of this run.

            • Started (datetime) --

              The start time of the run.

            • Completed (datetime) --

              The end time of the run.

          • ArtifactS3Location (string) --

            The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

    • NextToken (string) --

      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.

Exceptions

describe_runtime_versions(**kwargs)

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions .

See also: AWS API Documentation

Request Syntax

response = client.describe_runtime_versions(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
  • MaxResults (integer) -- Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.
Return type

dict

Returns

Response Syntax

{
    'RuntimeVersions': [
        {
            'VersionName': 'string',
            'Description': 'string',
            'ReleaseDate': datetime(2015, 1, 1),
            'DeprecationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RuntimeVersions (list) --

      An array of objects that display the details about each Synthetics canary runtime version.

      • (dict) --

        This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions .

        • VersionName (string) --

          The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions .

        • Description (string) --

          A description of the runtime version, created by Amazon.

        • ReleaseDate (datetime) --

          The date that the runtime version was released.

        • DeprecationDate (datetime) --

          If this runtime version is deprecated, this value is the date of deprecation.

    • NextToken (string) --

      A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_canary(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_canary(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the canary that you want details for.

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'
        },
        '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',
            ]
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • Canary (dict) --

      A strucure that contains the full information about the canary.

      • 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 that defines how often the canary is to run. 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.

          Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

        • 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 AWS 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) --
      • Tags (dict) --

        The list of key-value pairs that are associated with the canary.

        • (string) --
          • (string) --

Exceptions

get_canary_runs(**kwargs)

Retrieves a list of runs for a specified canary.

See also: AWS API Documentation

Request Syntax

response = client.get_canary_runs(
    Name='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the canary that you want to see runs for.

  • NextToken (string) -- A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
  • MaxResults (integer) -- Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
Return type

dict

Returns

Response Syntax

{
    'CanaryRuns': [
        {
            'Id': 'string',
            'Name': 'string',
            'Status': {
                'State': 'RUNNING'|'PASSED'|'FAILED',
                'StateReason': 'string',
                'StateReasonCode': 'CANARY_FAILURE'|'EXECUTION_FAILURE'
            },
            'Timeline': {
                'Started': datetime(2015, 1, 1),
                'Completed': datetime(2015, 1, 1)
            },
            'ArtifactS3Location': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CanaryRuns (list) --

      An array of structures. Each structure contains the details of one of the retrieved canary runs.

      • (dict) --

        This structure contains the details about one run of one canary.

        • Id (string) --

          A unique ID that identifies this canary run.

        • Name (string) --

          The name of the canary.

        • Status (dict) --

          The status of this run.

          • State (string) --

            The current state of the run.

          • StateReason (string) --

            If run of the canary failed, this field contains the reason for the error.

          • StateReasonCode (string) --

            If this value is CANARY_FAILURE , an exception occurred in the canary code. If this value is EXECUTION_FAILURE , an exception occurred in CloudWatch Synthetics.

        • Timeline (dict) --

          A structure that contains the start and end times of this run.

          • Started (datetime) --

            The start time of the run.

          • Completed (datetime) --

            The end time of the run.

        • ArtifactS3Location (string) --

          The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

    • NextToken (string) --

      A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_tags_for_resource(**kwargs)

Displays the tags associated with a canary.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The ARN of the canary that you want to view tags for.

The ARN format of a canary is ``arn:aws:synthetics:Region :account-id :canary:canary-name `` .

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The list of tag keys and values associated with the canary that you specified.

      • (string) --
        • (string) --

Exceptions

start_canary(**kwargs)

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule . To see a canary's schedule, use GetCanary .

See also: AWS API Documentation

Request Syntax

response = client.start_canary(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the canary that you want to run. To find canary names, use DescribeCanaries .

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

stop_canary(**kwargs)

Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

See also: AWS API Documentation

Request Syntax

response = client.stop_canary(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the canary that you want to stop. To find the names of your canaries, use DescribeCanaries .

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Assigns one or more tags (key-value pairs) to the specified 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 resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the canary that you're adding tags to.

    The ARN format of a canary is ``arn:aws:synthetics:Region :account-id :canary:canary-name `` .

  • Tags (dict) --

    [REQUIRED]

    The list of key-value pairs to associate with the canary.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tags from the specified canary.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the canary that you're removing tags from.

    The ARN format of a canary is ``arn:aws:synthetics:Region :account-id :canary:canary-name `` .

  • TagKeys (list) --

    [REQUIRED]

    The list of tag keys to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_canary(**kwargs)

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

Request Syntax

response = client.update_canary(
    Name='string',
    Code={
        'S3Bucket': 'string',
        'S3Key': 'string',
        'S3Version': 'string',
        'ZipFile': b'bytes',
        'Handler': 'string'
    },
    ExecutionRoleArn='string',
    RuntimeVersion='string',
    Schedule={
        'Expression': 'string',
        'DurationInSeconds': 123
    },
    RunConfig={
        'TimeoutInSeconds': 123,
        'MemoryInMB': 123,
        'ActiveTracing': True|False,
        'EnvironmentVariables': {
            'string': 'string'
        }
    },
    SuccessRetentionPeriodInDays=123,
    FailureRetentionPeriodInDays=123,
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    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 (dict) --

    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 full bucket name here. The bucket must already exist. Specify the full bucket name, including 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 .zip file that contains the script. It can be up to 5 MB.

    • Handler (string) -- [REQUIRED]

      The entry point to use for the source code when running the canary. This value must end with the string .handler .

  • ExecutionRoleArn (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
  • RuntimeVersion (string) -- Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions .
  • Schedule (dict) --

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

    • Expression (string) -- [REQUIRED]

      A rate expression that defines how often the canary is to run. 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.

    • 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 timeout value that is used for each individual run of the canary.

    • 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 AWS 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 .

      • (string) --
        • (string) --
  • 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.
  • 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) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Synthetics.Client.exceptions.ConflictException

A conflicting operation is already in progress.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A conflicting operation is already in progress.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Synthetics.Client.exceptions.InternalServerException

An unknown internal error occurred.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An unknown internal error occurred.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Synthetics.Client.exceptions.ResourceNotFoundException

One of the specified resources was not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One of the specified resources was not found.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Synthetics.Client.exceptions.ValidationException

A parameter could not be validated.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A parameter could not be validated.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: