Route53RecoveryReadiness / Client / list_rules

list_rules#

Route53RecoveryReadiness.Client.list_rules(**kwargs)#

Lists all readiness rules, or lists the readiness rules for a specific resource type.

See also: AWS API Documentation

Request Syntax

response = client.list_rules(
    MaxResults=123,
    NextToken='string',
    ResourceType='string'
)
Parameters:

  • MaxResults (integer) – The number of objects that you want to return with this call.

  • NextToken (string) – The token that identifies which batch of results you want to see.

  • ResourceType (string) – The resource type that a readiness rule applies to.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Rules': [
        {
            'ResourceType': 'string',
            'RuleDescription': 'string',
            'RuleId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    200 response - Success.

    • NextToken (string) –

      The token that identifies which batch of results you want to see.

    • Rules (list) –

      A list of readiness rules for a specific resource type.

      • (dict) –

        Readiness rule information, including the resource type, rule ID, and rule description.

        • ResourceType (string) –

          The resource type that the readiness rule applies to.

        • RuleDescription (string) –

          The description of a readiness rule.

        • RuleId (string) –

          The ID for the readiness rule.

Exceptions