CloudWatchObservabilityAdminService / Paginator / ListTelemetryRules

ListTelemetryRules

class CloudWatchObservabilityAdminService.Paginator.ListTelemetryRules

paginator = client.get_paginator('list_telemetry_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchObservabilityAdminService.Client.list_telemetry_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RuleNamePrefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RuleNamePrefix (string) – A string to filter telemetry rules whose names begin with the specified prefix.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TelemetryRuleSummaries': [
        {
            'RuleName': 'string',
            'RuleArn': 'string',
            'CreatedTimeStamp': 123,
            'LastUpdateTimeStamp': 123,
            'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
            'TelemetryType': 'Logs'|'Metrics'|'Traces'
        },
    ],

}

Response Structure

• (dict) –

  • TelemetryRuleSummaries (list) –

    A list of telemetry rule summaries.

    • (dict) –

      A summary of a telemetry rule’s key properties.

      • RuleName (string) –

        The name of the telemetry rule.

      • RuleArn (string) –

        The Amazon Resource Name (ARN) of the telemetry rule.

      • CreatedTimeStamp (integer) –

        The timestamp when the telemetry rule was created.

      • LastUpdateTimeStamp (integer) –

        The timestamp when the telemetry rule was last modified.

      • ResourceType (string) –

        The type of Amazon Web Services resource the rule applies to.

      • TelemetryType (string) –

        The type of telemetry (Logs, Metrics, or Traces) the rule configures.