CloudWatch / Client / list_managed_insight_rules

list_managed_insight_rules#

CloudWatch.Client.list_managed_insight_rules(**kwargs)#

Returns a list that contains the number of managed Contributor Insights rules in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_managed_insight_rules(
    ResourceARN='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ResourceARN (string) –

    [REQUIRED]

    The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.

  • NextToken (string) – Include this value to get the next set of rules if the value was returned by the previous operation.

  • MaxResults (integer) – The maximum number of results to return in one operation. If you omit this parameter, the default number is used. The default number is 100.

Return type:

dict

Returns:

Response Syntax

{
    'ManagedRules': [
        {
            'TemplateName': 'string',
            'ResourceARN': 'string',
            'RuleState': {
                'RuleName': 'string',
                'State': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ManagedRules (list) –

      The managed rules that are available for the specified Amazon Web Services resource.

      • (dict) –

        Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.

        • TemplateName (string) –

          The template name for the managed rule. Used to enable managed rules using PutManagedInsightRules.

        • ResourceARN (string) –

          If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource.

        • RuleState (dict) –

          Describes the state of a managed rule. If present, it contains information about the Contributor Insights rule that contains information about the related Amazon Web Services resource.

          • RuleName (string) –

            The name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource.

          • State (string) –

            Indicates whether the rule is enabled or disabled.

    • NextToken (string) –

      Include this value to get the next set of rules if the value was returned by the previous operation.

Exceptions

  • CloudWatch.Client.exceptions.InvalidParameterValueException

  • CloudWatch.Client.exceptions.MissingRequiredParameterException

  • CloudWatch.Client.exceptions.InvalidNextToken