ResilienceHub / Client / describe_resiliency_policy

describe_resiliency_policy

ResilienceHub.Client.describe_resiliency_policy(**kwargs)

Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.

See also: AWS API Documentation

Request Syntax

response = client.describe_resiliency_policy(
    policyArn='string'
)

Parameters:

policyArn (string) –

[REQUIRED]

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 Amazon Web Services General Reference guide.

Return type:

dict

Returns:

Response Syntax

{
    'policy': {
        '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) –

  • policy (dict) –

    Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.

    • creationTime (datetime) –

      Date and time 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) –

            Recovery Point Objective (RPO) in seconds.

          • rtoInSecs (integer) –

            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 Amazon Web Services 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