ResilienceHub / Client / list_resiliency_policies

list_resiliency_policies#

ResilienceHub.Client.list_resiliency_policies(**kwargs)#

Lists the resiliency policies for the Resilience Hub applications.

See also: AWS API Documentation

Request Syntax

response = client.list_resiliency_policies(
    maxResults=123,
    nextToken='string',
    policyName='string'
)
Parameters:
  • maxResults (integer) – Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken (string) – Null, or the token from a previous call to get the next set of results.

  • policyName (string) – The name of the policy

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'resiliencyPolicies': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
            'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
            'policy': {
                'string': {
                    'rpoInSecs': 123,
                    'rtoInSecs': 123
                }
            },
            'policyArn': 'string',
            'policyDescription': 'string',
            'policyName': 'string',
            'tags': {
                'string': 'string'
            },
            'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'|'NotApplicable'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Token for the next set of results, or null if there are no more results.

    • resiliencyPolicies (list) –

      The resiliency policies for the Resilience Hub applications.

      • (dict) –

        Defines a resiliency policy.

        • creationTime (datetime) –

          The timestamp for when the resiliency policy was created.

        • dataLocationConstraint (string) –

          Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

        • estimatedCostTier (string) –

          Specifies the estimated cost tier of the resiliency policy.

        • policy (dict) –

          The resiliency policy.

          • (string) –

            • (dict) –

              Defines a failure policy.

              • rpoInSecs (integer) –

                The Recovery Point Objective (RPO), in seconds.

              • rtoInSecs (integer) –

                The Recovery Time Objective (RTO), in seconds.

        • policyArn (string) –

          Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition:resiliencehub: region: account:resiliency-policy/ policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

        • policyDescription (string) –

          The description for the policy.

        • policyName (string) –

          The name of the policy

        • tags (dict) –

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) –

            • (string) –

        • tier (string) –

          The tier for this resiliency policy, ranging from the highest severity ( MissionCritical) to lowest ( NonCritical).

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ResourceNotFoundException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException