create_readiness_check

create_readiness_check(**kwargs)

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

See also: AWS API Documentation

Request Syntax

response = client.create_readiness_check(
    ReadinessCheckName='string',
    ResourceSetName='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ReadinessCheckName (string) --

    [REQUIRED]

    The name of the readiness check to create.

  • ResourceSetName (string) --

    [REQUIRED]

    The name of the resource set to check.

  • Tags (dict) --

    A collection of tags associated with a resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'ReadinessCheckArn': 'string',
    'ReadinessCheckName': 'string',
    'ResourceSet': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    200 response - Success.

    • ReadinessCheckArn (string) --

      The Amazon Resource Name (ARN) associated with a readiness check.

    • ReadinessCheckName (string) --

      Name of a readiness check.

    • ResourceSet (string) --

      Name of the resource set to be checked.

    • Tags (dict) --

      A collection of tags associated with a resource.

      • (string) --
        • (string) --

Exceptions

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