get_recovery_group_readiness_summary

Route53RecoveryReadiness.Client.get_recovery_group_readiness_summary(**kwargs)

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

See also: AWS API Documentation

Request Syntax

response = client.get_recovery_group_readiness_summary(
    MaxResults=123,
    NextToken='string',
    RecoveryGroupName='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.
  • RecoveryGroupName (string) --

    [REQUIRED]

    The name of a recovery group.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
    'ReadinessChecks': [
        {
            'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
            'ReadinessCheckName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    200 response - Success.

    • NextToken (string) --

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

    • Readiness (string) --

      The readiness status at a recovery group level.

    • ReadinessChecks (list) --

      Summaries of the readiness checks for the recovery group.

      • (dict) --

        Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.

        • Readiness (string) --

          The readiness status of this readiness check.

        • ReadinessCheckName (string) --

          The name of a readiness check.

Exceptions

  • Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
  • Route53RecoveryReadiness.Client.exceptions.ThrottlingException
  • Route53RecoveryReadiness.Client.exceptions.ValidationException
  • Route53RecoveryReadiness.Client.exceptions.InternalServerException
  • Route53RecoveryReadiness.Client.exceptions.AccessDeniedException