Synthetics / Client / describe_canaries

describe_canaries#

Synthetics.Client.describe_canaries(**kwargs)#

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

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

See also: AWS API Documentation

Request Syntax

response = client.describe_canaries(
    NextToken='string',
    MaxResults=123,
    Names=[
        'string',
    ]
)
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 20 is used.

  • Names (list) –

    Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

    If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

    You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

    • (string) –

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'|'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',
                ],
                'Ipv6AllowedForDualStack': True|False
            },
            'VisualReference': {
                'BaseScreenshots': [
                    {
                        'ScreenshotName': 'string',
                        'IgnoreCoordinates': [
                            'string',
                        ]
                    },
                ],
                'BaseCanaryRunId': 'string'
            },
            'ProvisionedResourceCleanup': 'AUTOMATIC'|'OFF',
            'Tags': {
                'string': 'string'
            },
            'ArtifactConfig': {
                'S3Encryption': {
                    'EncryptionMode': 'SSE_S3'|'SSE_KMS',
                    'KmsKeyArn': '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 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) –

          • Ipv6AllowedForDualStack (boolean) –

            Indicates whether this canary allows outbound IPv6 traffic if it is connected to dual-stack subnets.

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

        • ProvisionedResourceCleanup (string) –

          Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.

          If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

        • 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

    • 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