A low-level client representing AWS Route53 Recovery Readiness
Recovery readiness
client = session.create_client('route53-recovery-readiness')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
Creates a cell in an account.
See also: AWS API Documentation
Request Syntax
response = client.create_cell(
CellName='string',
Cells=[
'string',
],
Tags={
'string': 'string'
}
)
CellName (string) –
[REQUIRED]
The name of the cell to create.
Cells (list) –
A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Amazon Web Services Regions.
(string) –
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
dict
Response Syntax
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
CellArn (string) –
The Amazon Resource Name (ARN) for the cell.
CellName (string) –
The name of the cell.
Cells (list) –
A list of cell ARNs.
(string) –
ParentReadinessScopes (list) –
The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
(string) –
Tags (dict) –
Tags on the resources.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.ConflictException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.
See also: AWS API Documentation
Request Syntax
response = client.create_cross_account_authorization(
CrossAccountAuthorization='string'
)
CrossAccountAuthorization (string) –
[REQUIRED]
The cross-account authorization.
dict
Response Syntax
{
'CrossAccountAuthorization': 'string'
}
Response Structure
(dict) –
200 response - Success.
CrossAccountAuthorization (string) –
The cross-account authorization.
Exceptions
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.ConflictException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
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'
}
)
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) –
dict
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
Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
See also: AWS API Documentation
Request Syntax
response = client.create_recovery_group(
Cells=[
'string',
],
RecoveryGroupName='string',
Tags={
'string': 'string'
}
)
Cells (list) –
A list of the cell Amazon Resource Names (ARNs) in the recovery group.
(string) –
RecoveryGroupName (string) –
[REQUIRED]
The name of the recovery group to create.
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
dict
Response Syntax
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
Cells (list) –
A list of a cell’s Amazon Resource Names (ARNs).
(string) –
RecoveryGroupArn (string) –
The Amazon Resource Name (ARN) for the recovery group.
RecoveryGroupName (string) –
The name of the recovery group.
Tags (dict) –
The tags associated with the recovery group.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.ConflictException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
See also: AWS API Documentation
Request Syntax
response = client.create_resource_set(
ResourceSetName='string',
ResourceSetType='string',
Resources=[
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
Tags={
'string': 'string'
}
)
ResourceSetName (string) –
[REQUIRED]
The name of the resource set to create.
ResourceSetType (string) –
[REQUIRED]
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
[REQUIRED]
A list of resource objects in the resource set.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
Tags (dict) –
A tag to associate with the parameters for a resource set.
(string) –
(string) –
dict
Response Syntax
{
'ResourceSetArn': 'string',
'ResourceSetName': 'string',
'ResourceSetType': 'string',
'Resources': [
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response
ResourceSetArn (string) –
The Amazon Resource Name (ARN) for the resource set.
ResourceSetName (string) –
The name of the resource set.
ResourceSetType (string) –
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
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
Delete a cell. When successful, the response code is 204, with no response body.
See also: AWS API Documentation
Request Syntax
response = client.delete_cell(
CellName='string'
)
CellName (string) –
[REQUIRED]
The name of the cell.
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Deletes cross account readiness authorization.
See also: AWS API Documentation
Request Syntax
response = client.delete_cross_account_authorization(
CrossAccountAuthorization='string'
)
CrossAccountAuthorization (string) –
[REQUIRED]
The cross-account authorization.
dict
Response Syntax
{}
Response Structure
(dict) –
200 response - Success.
Exceptions
Deletes a readiness check.
See also: AWS API Documentation
Request Syntax
response = client.delete_readiness_check(
ReadinessCheckName='string'
)
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Deletes a recovery group.
See also: AWS API Documentation
Request Syntax
response = client.delete_recovery_group(
RecoveryGroupName='string'
)
RecoveryGroupName (string) –
[REQUIRED]
The name of a recovery group.
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Deletes a resource set.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_set(
ResourceSetName='string'
)
ResourceSetName (string) –
[REQUIRED]
Name of a resource set.
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
See also: AWS API Documentation
Request Syntax
response = client.get_architecture_recommendations(
MaxResults=123,
NextToken='string',
RecoveryGroupName='string'
)
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.
dict
Response Syntax
{
'LastAuditTimestamp': datetime(2015, 1, 1),
'NextToken': 'string',
'Recommendations': [
{
'RecommendationText': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
LastAuditTimestamp (datetime) –
The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.
NextToken (string) –
The token that identifies which batch of results you want to see.
Recommendations (list) –
A list of the recommendations for the customer’s application.
(dict) –
Recommendations that are provided to make an application more recovery resilient.
RecommendationText (string) –
Text of the recommendations that are provided to make an application more recovery resilient.
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
See also: AWS API Documentation
Request Syntax
response = client.get_cell(
CellName='string'
)
CellName (string) –
[REQUIRED]
The name of the cell.
dict
Response Syntax
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
CellArn (string) –
The Amazon Resource Name (ARN) for the cell.
CellName (string) –
The name of the cell.
Cells (list) –
A list of cell ARNs.
(string) –
ParentReadinessScopes (list) –
The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
(string) –
Tags (dict) –
Tags on the resources.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.
See also: AWS API Documentation
Request Syntax
response = client.get_cell_readiness_summary(
CellName='string',
MaxResults=123,
NextToken='string'
)
CellName (string) –
[REQUIRED]
The name of the cell.
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.
dict
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 at a cell level.
ReadinessChecks (list) –
Summaries for the readiness checks that make up the cell.
(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
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Gets details about a readiness check.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check(
ReadinessCheckName='string'
)
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
dict
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.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check_resource_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string',
ResourceIdentifier='string'
)
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.
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
ResourceIdentifier (string) –
[REQUIRED]
The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource).
dict
Response Syntax
{
'NextToken': 'string',
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'Rules': [
{
'LastCheckedTimestamp': datetime(2015, 1, 1),
'Messages': [
{
'MessageText': 'string'
},
],
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'RuleId': '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 at a rule level.
Rules (list) –
Details of the rule’s results.
(dict) –
The result of a successful Rule request, with status for an individual rule.
LastCheckedTimestamp (datetime) –
The time the resource was last checked for readiness, in ISO-8601 format, UTC.
Messages (list) –
Details about the resource’s readiness.
(dict) –
Information relating to readiness check status.
MessageText (string) –
The text of a readiness check message.
Readiness (string) –
The readiness at rule level.
RuleId (string) –
The identifier of the rule.
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string'
)
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.
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
dict
Response Syntax
{
'Messages': [
{
'MessageText': 'string'
},
],
'NextToken': 'string',
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'Resources': [
{
'ComponentId': 'string',
'LastCheckedTimestamp': datetime(2015, 1, 1),
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
Messages (list) –
Top level messages for readiness check status
(dict) –
Information relating to readiness check status.
MessageText (string) –
The text of a readiness check message.
NextToken (string) –
The token that identifies which batch of results you want to see.
Readiness (string) –
The readiness at rule level.
Resources (list) –
Summary of the readiness of resources.
(dict) –
The result of a successful Resource request, with status for an individual resource.
ComponentId (string) –
The component id of the resource.
LastCheckedTimestamp (datetime) –
The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.
Readiness (string) –
The readiness of a resource.
ResourceArn (string) –
The Amazon Resource Name (ARN) of the resource.
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Gets details about a recovery group, including a list of the cells that are included in it.
See also: AWS API Documentation
Request Syntax
response = client.get_recovery_group(
RecoveryGroupName='string'
)
RecoveryGroupName (string) –
[REQUIRED]
The name of a recovery group.
dict
Response Syntax
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
Cells (list) –
A list of a cell’s Amazon Resource Names (ARNs).
(string) –
RecoveryGroupArn (string) –
The Amazon Resource Name (ARN) for the recovery group.
RecoveryGroupName (string) –
The name of the recovery group.
Tags (dict) –
The tags associated with the recovery group.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
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'
)
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.
dict
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
Displays the details about a resource set, including a list of the resources in the set.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_set(
ResourceSetName='string'
)
ResourceSetName (string) –
[REQUIRED]
Name of a resource set.
dict
Response Syntax
{
'ResourceSetArn': 'string',
'ResourceSetName': 'string',
'ResourceSetType': 'string',
'Resources': [
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
ResourceSetArn (string) –
The Amazon Resource Name (ARN) for the resource set.
ResourceSetName (string) –
The name of the resource set.
ResourceSetType (string) –
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Lists the cells for an account.
See also: AWS API Documentation
Request Syntax
response = client.list_cells(
MaxResults=123,
NextToken='string'
)
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.
dict
Response Syntax
{
'Cells': [
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
200 response - Success.
Cells (list) –
A list of cells.
(dict) –
Information about a cell.
CellArn (string) –
The Amazon Resource Name (ARN) for the cell.
CellName (string) –
The name of the cell.
Cells (list) –
A list of cell ARNs.
(string) –
ParentReadinessScopes (list) –
The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
(string) –
Tags (dict) –
Tags on the resources.
(string) –
(string) –
NextToken (string) –
The token that identifies which batch of results you want to see.
Exceptions
Lists the cross-account readiness authorizations that are in place for an account.
See also: AWS API Documentation
Request Syntax
response = client.list_cross_account_authorizations(
MaxResults=123,
NextToken='string'
)
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.
dict
Response Syntax
{
'CrossAccountAuthorizations': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
200 response - Success.
CrossAccountAuthorizations (list) –
A list of cross-account authorizations.
(string) –
CrossAccountAuthorization
NextToken (string) –
The token that identifies which batch of results you want to see.
Exceptions
Lists the readiness checks for an account.
See also: AWS API Documentation
Request Syntax
response = client.list_readiness_checks(
MaxResults=123,
NextToken='string'
)
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.
dict
Response Syntax
{
'NextToken': 'string',
'ReadinessChecks': [
{
'ReadinessCheckArn': 'string',
'ReadinessCheckName': 'string',
'ResourceSet': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
NextToken (string) –
The token that identifies which batch of results you want to see.
ReadinessChecks (list) –
A list of readiness checks associated with the account.
(dict) –
A readiness check.
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
Lists the recovery groups in an account.
See also: AWS API Documentation
Request Syntax
response = client.list_recovery_groups(
MaxResults=123,
NextToken='string'
)
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.
dict
Response Syntax
{
'NextToken': 'string',
'RecoveryGroups': [
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
NextToken (string) –
The token that identifies which batch of results you want to see.
RecoveryGroups (list) –
A list of recovery groups.
(dict) –
A representation of the application, typically containing multiple cells.
Cells (list) –
A list of a cell’s Amazon Resource Names (ARNs).
(string) –
RecoveryGroupArn (string) –
The Amazon Resource Name (ARN) for the recovery group.
RecoveryGroupName (string) –
The name of the recovery group.
Tags (dict) –
The tags associated with the recovery group.
(string) –
(string) –
Exceptions
Lists the resource sets in an account.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_sets(
MaxResults=123,
NextToken='string'
)
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.
dict
Response Syntax
{
'NextToken': 'string',
'ResourceSets': [
{
'ResourceSetArn': 'string',
'ResourceSetName': 'string',
'ResourceSetType': 'string',
'Resources': [
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
NextToken (string) –
The token that identifies which batch of results you want to see.
ResourceSets (list) –
A list of resource sets associated with the account.
(dict) –
A collection of resources of the same type.
ResourceSetArn (string) –
The Amazon Resource Name (ARN) for the resource set.
ResourceSetName (string) –
The name of the resource set.
ResourceSetType (string) –
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
Exceptions
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'
)
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.
dict
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
Lists the tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resources(
ResourceArn='string'
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) for a resource.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
Tags (dict) –
(string) –
(string) –
Exceptions
Adds a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) for a resource.
Tags (dict) –
[REQUIRED]
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
200 response - Success.
Exceptions
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) for a resource.
TagKeys (list) –
[REQUIRED]
The keys for tags you add to resources.
(string) –
None
Exceptions
Updates a cell to replace the list of nested cells with a new list of nested cells.
See also: AWS API Documentation
Request Syntax
response = client.update_cell(
CellName='string',
Cells=[
'string',
]
)
CellName (string) –
[REQUIRED]
The name of the cell.
Cells (list) –
[REQUIRED]
A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list.
(string) –
dict
Response Syntax
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
CellArn (string) –
The Amazon Resource Name (ARN) for the cell.
CellName (string) –
The name of the cell.
Cells (list) –
A list of cell ARNs.
(string) –
ParentReadinessScopes (list) –
The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
(string) –
Tags (dict) –
Tags on the resources.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Updates a readiness check.
See also: AWS API Documentation
Request Syntax
response = client.update_readiness_check(
ReadinessCheckName='string',
ResourceSetName='string'
)
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
ResourceSetName (string) –
[REQUIRED]
The name of the resource set to be checked.
dict
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.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Updates a recovery group.
See also: AWS API Documentation
Request Syntax
response = client.update_recovery_group(
Cells=[
'string',
],
RecoveryGroupName='string'
)
Cells (list) –
[REQUIRED]
A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list.
(string) –
RecoveryGroupName (string) –
[REQUIRED]
The name of a recovery group.
dict
Response Syntax
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
Cells (list) –
A list of a cell’s Amazon Resource Names (ARNs).
(string) –
RecoveryGroupArn (string) –
The Amazon Resource Name (ARN) for the recovery group.
RecoveryGroupName (string) –
The name of the recovery group.
Tags (dict) –
The tags associated with the recovery group.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Updates a resource set.
See also: AWS API Documentation
Request Syntax
response = client.update_resource_set(
ResourceSetName='string',
ResourceSetType='string',
Resources=[
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
]
)
ResourceSetName (string) –
[REQUIRED]
Name of a resource set.
ResourceSetType (string) –
[REQUIRED]
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
[REQUIRED]
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
dict
Response Syntax
{
'ResourceSetArn': 'string',
'ResourceSetName': 'string',
'ResourceSetType': 'string',
'Resources': [
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
200 response - Success.
ResourceSetArn (string) –
The Amazon Resource Name (ARN) for the resource set.
ResourceSetName (string) –
The name of the resource set.
ResourceSetType (string) –
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Route53RecoveryReadiness.Client.exceptions.ConflictException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
User does not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – User does not have sufficient access to perform this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Updating or deleting a resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Updating or deleting a resource can cause an inconsistent state.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An unexpected error occurred.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – An unexpected error occurred.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The requested resource does not exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The requested resource does not exist.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Request was denied due to request throttling.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The input fails to satisfy the constraints specified by an AWS service.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The input fails to satisfy the constraints specified by an AWS service.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
Route53RecoveryReadiness.Paginator.GetReadinessCheckResourceStatus
Route53RecoveryReadiness.Paginator.GetRecoveryGroupReadinessSummary
Route53RecoveryReadiness.Paginator.ListCrossAccountAuthorizations
paginator = client.get_paginator('get_cell_readiness_summary')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.get_cell_readiness_summary()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CellName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
CellName (string) –
[REQUIRED]
The name of the cell.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ReadinessChecks': [
{
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ReadinessCheckName': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
Readiness (string) –
The readiness at a cell level.
ReadinessChecks (list) –
Summaries for the readiness checks that make up the cell.
(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.
paginator = client.get_paginator('get_readiness_check_resource_status')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.get_readiness_check_resource_status()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReadinessCheckName='string',
ResourceIdentifier='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
ResourceIdentifier (string) –
[REQUIRED]
The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource).
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'Rules': [
{
'LastCheckedTimestamp': datetime(2015, 1, 1),
'Messages': [
{
'MessageText': 'string'
},
],
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'RuleId': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
Readiness (string) –
The readiness at a rule level.
Rules (list) –
Details of the rule’s results.
(dict) –
The result of a successful Rule request, with status for an individual rule.
LastCheckedTimestamp (datetime) –
The time the resource was last checked for readiness, in ISO-8601 format, UTC.
Messages (list) –
Details about the resource’s readiness.
(dict) –
Information relating to readiness check status.
MessageText (string) –
The text of a readiness check message.
Readiness (string) –
The readiness at rule level.
RuleId (string) –
The identifier of the rule.
paginator = client.get_paginator('get_readiness_check_status')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.get_readiness_check_status()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReadinessCheckName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ReadinessCheckName (string) –
[REQUIRED]
Name of a readiness check.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Messages': [
{
'MessageText': 'string'
},
],
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'Resources': [
{
'ComponentId': 'string',
'LastCheckedTimestamp': datetime(2015, 1, 1),
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
Messages (list) –
Top level messages for readiness check status
(dict) –
Information relating to readiness check status.
MessageText (string) –
The text of a readiness check message.
Readiness (string) –
The readiness at rule level.
Resources (list) –
Summary of the readiness of resources.
(dict) –
The result of a successful Resource request, with status for an individual resource.
ComponentId (string) –
The component id of the resource.
LastCheckedTimestamp (datetime) –
The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.
Readiness (string) –
The readiness of a resource.
ResourceArn (string) –
The Amazon Resource Name (ARN) of the resource.
paginator = client.get_paginator('get_recovery_group_readiness_summary')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.get_recovery_group_readiness_summary()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RecoveryGroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
RecoveryGroupName (string) –
[REQUIRED]
The name of a recovery group.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ReadinessChecks': [
{
'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
'ReadinessCheckName': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
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.
paginator = client.get_paginator('list_cells')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_cells()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Cells': [
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
(dict) –
200 response - Success.
Cells (list) –
A list of cells.
(dict) –
Information about a cell.
CellArn (string) –
The Amazon Resource Name (ARN) for the cell.
CellName (string) –
The name of the cell.
Cells (list) –
A list of cell ARNs.
(string) –
ParentReadinessScopes (list) –
The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
(string) –
Tags (dict) –
Tags on the resources.
(string) –
(string) –
paginator = client.get_paginator('list_cross_account_authorizations')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_cross_account_authorizations()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'CrossAccountAuthorizations': [
'string',
],
}
Response Structure
(dict) –
200 response - Success.
CrossAccountAuthorizations (list) –
A list of cross-account authorizations.
(string) –
CrossAccountAuthorization
paginator = client.get_paginator('list_readiness_checks')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_readiness_checks()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'ReadinessChecks': [
{
'ReadinessCheckArn': 'string',
'ReadinessCheckName': 'string',
'ResourceSet': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
ReadinessChecks (list) –
A list of readiness checks associated with the account.
(dict) –
A readiness check.
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) –
paginator = client.get_paginator('list_recovery_groups')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_recovery_groups()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'RecoveryGroups': [
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
RecoveryGroups (list) –
A list of recovery groups.
(dict) –
A representation of the application, typically containing multiple cells.
Cells (list) –
A list of a cell’s Amazon Resource Names (ARNs).
(string) –
RecoveryGroupArn (string) –
The Amazon Resource Name (ARN) for the recovery group.
RecoveryGroupName (string) –
The name of the recovery group.
Tags (dict) –
The tags associated with the recovery group.
(string) –
(string) –
paginator = client.get_paginator('list_resource_sets')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_resource_sets()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'ResourceSets': [
{
'ResourceSetArn': 'string',
'ResourceSetName': 'string',
'ResourceSetType': 'string',
'Resources': [
{
'ComponentId': 'string',
'DnsTargetResource': {
'DomainName': 'string',
'HostedZoneArn': 'string',
'RecordSetId': 'string',
'RecordType': 'string',
'TargetResource': {
'NLBResource': {
'Arn': 'string'
},
'R53Resource': {
'DomainName': 'string',
'RecordSetId': 'string'
}
}
},
'ReadinessScopes': [
'string',
],
'ResourceArn': 'string'
},
],
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) –
200 response - Success.
ResourceSets (list) –
A list of resource sets associated with the account.
(dict) –
A collection of resources of the same type.
ResourceSetArn (string) –
The Amazon Resource Name (ARN) for the resource set.
ResourceSetName (string) –
The name of the resource set.
ResourceSetType (string) –
The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
Resources (list) –
A list of resource objects.
(dict) –
The resource element of a resource set.
ComponentId (string) –
The component identifier of the resource, generated when DNS target resource is used.
DnsTargetResource (dict) –
The DNS target resource.
DomainName (string) –
The domain name that acts as an ingress point to a portion of the customer application.
HostedZoneArn (string) –
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
RecordSetId (string) –
The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
RecordType (string) –
The type of DNS record of the target resource.
TargetResource (dict) –
The target resource of the DNS target resource.
NLBResource (dict) –
The Network Load Balancer Resource.
Arn (string) –
The Network Load Balancer resource Amazon Resource Name (ARN).
R53Resource (dict) –
The Route 53 resource.
DomainName (string) –
The DNS target domain name.
RecordSetId (string) –
The Route 53 Resource Record Set ID.
ReadinessScopes (list) –
A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services resource.
Tags (dict) –
A collection of tags associated with a resource.
(string) –
(string) –
paginator = client.get_paginator('list_rules')
Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_rules()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceType='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ResourceType (string) – The resource type that a readiness rule applies to.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Rules': [
{
'ResourceType': 'string',
'RuleDescription': 'string',
'RuleId': 'string'
},
]
}
Response Structure
(dict) –
200 response - Success.
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.