Table of Contents
Route53RecoveryReadiness.
Client
¶A low-level client representing AWS Route53 Recovery Readiness AWS Route53 Recovery Readiness:
client = session.create_client('route53-recovery-readiness')
These are the available methods:
can_paginate
(operation_name)¶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.
create_cell
(**kwargs)¶Creates a new Cell.
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 arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)
(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) – Result of a CreateCell call
CellArn (string) – The arn for the Cell
CellName (string) – The name of the Cell
Cells (list) – A list of Cell arns
(string) –
ParentReadinessScopes (list) – A list of Cell ARNs and/or RecoveryGroup ARNs
(string) –
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
Create a new cross account readiness authorization.
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) – Result of a CreateCrossAccountAuthorization call
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
create_readiness_check
(**kwargs)¶Creates a new 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 ReadinessCheck to create
ResourceSetName (string) – [REQUIRED] The name of the ResourceSet 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) – Result of a CreateReadinessCheck call
ReadinessCheckArn (string) – Arn associated with ReadinessCheck
ReadinessCheckName (string) – Name for a ReadinessCheck
ResourceSet (string) – Name of the ResourceSet 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
create_recovery_group
(**kwargs)¶Creates a new Recovery Group.
See also: AWS API Documentation
Request Syntax
response = client.create_recovery_group(
Cells=[
'string',
],
RecoveryGroupName='string',
Tags={
'string': 'string'
}
)
Cells (list) –
A list of Cell arns
(string) –
RecoveryGroupName (string) – [REQUIRED] The name of the RecoveryGroup 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) – Result of a CreateRecoveryGroup call
Cells (list) – A list of Cell arns
(string) –
RecoveryGroupArn (string) – The arn for the RecoveryGroup
RecoveryGroupName (string) – The name of the RecoveryGroup
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
create_resource_set
(**kwargs)¶Creates a new Resource Set.
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 ResourceSet to create
ResourceSetType (string) – [REQUIRED] AWS Resource type of the resources in the ResourceSet
Resources (list) –
[REQUIRED] A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
Tags (dict) –
A collection of tags associated with a resource
(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) – Result of a CreateResourceSet call
ResourceSetArn (string) – The arn for the ResourceSet
ResourceSetName (string) – The name of the ResourceSet
ResourceSetType (string) – AWS Resource Type of the resources in the ResourceSet
Resources (list) – A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
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_cell
(**kwargs)¶Deletes an existing Cell.
See also: AWS API Documentation
Request Syntax
response = client.delete_cell(
CellName='string'
)
CellName (string) – [REQUIRED] The Cell to delete
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
Delete 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) – Result of a DeleteCrossAccountAuthorization call
Exceptions
delete_readiness_check
(**kwargs)¶Deletes an existing Readiness Check.
See also: AWS API Documentation
Request Syntax
response = client.delete_readiness_check(
ReadinessCheckName='string'
)
ReadinessCheckName (string) – [REQUIRED] The ReadinessCheck to delete
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
delete_recovery_group
(**kwargs)¶Deletes an existing Recovery Group.
See also: AWS API Documentation
Request Syntax
response = client.delete_recovery_group(
RecoveryGroupName='string'
)
RecoveryGroupName (string) – [REQUIRED] The RecoveryGroup to delete
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
delete_resource_set
(**kwargs)¶Deletes an existing Resource Set.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_set(
ResourceSetName='string'
)
ResourceSetName (string) – [REQUIRED] The ResourceSet to delete
None
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
get_architecture_recommendations
(**kwargs)¶Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.
See also: AWS API Documentation
Request Syntax
response = client.get_architecture_recommendations(
MaxResults=123,
NextToken='string',
RecoveryGroupName='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
RecoveryGroupName (string) – [REQUIRED] Name of RecoveryGroup (top level resource) to be analyzed.
dict
Response Syntax
{
'LastAuditTimestamp': datetime(2015, 1, 1),
'NextToken': 'string',
'Recommendations': [
{
'RecommendationText': 'string'
},
]
}
Response Structure
(dict) – Result of a GetArchitectureRecommendations call
LastAuditTimestamp (datetime) – The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format.
NextToken (string) – A token that can be used to resume pagination from the end of the collection
Recommendations (list) – A list of recommendations for the customer’s application
(dict) – Guidance for improving Recovery Group resilliancy
RecommendationText (string) – Guidance text for recommendation
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
get_cell
(**kwargs)¶Returns information about a Cell.
See also: AWS API Documentation
Request Syntax
response = client.get_cell(
CellName='string'
)
CellName (string) – [REQUIRED] The Cell to get
dict
Response Syntax
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a GetCell call
CellArn (string) – The arn for the Cell
CellName (string) – The name of the Cell
Cells (list) – A list of Cell arns
(string) –
ParentReadinessScopes (list) – A list of Cell ARNs and/or RecoveryGroup ARNs
(string) –
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
get_cell_readiness_summary
(**kwargs)¶Returns information about readiness of a Cell.
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) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
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) – Result of a GetCellReadinessSummary call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Readiness (string) – The readiness at Cell level.
ReadinessChecks (list) – Summaries for the ReadinessChecks making up the Cell
(dict) – Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary
Readiness (string) – The readiness of this ReadinessCheck
ReadinessCheckName (string) – The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
get_paginator
(operation_name)¶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.
get_readiness_check
(**kwargs)¶Returns information about a ReadinessCheck.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check(
ReadinessCheckName='string'
)
ReadinessCheckName (string) – [REQUIRED] The ReadinessCheck to get
dict
Response Syntax
{
'ReadinessCheckArn': 'string',
'ReadinessCheckName': 'string',
'ResourceSet': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a GetReadinessCheck call
ReadinessCheckArn (string) – Arn associated with ReadinessCheck
ReadinessCheckName (string) – Name for a ReadinessCheck
ResourceSet (string) – Name of the ResourceSet 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
get_readiness_check_resource_status
(**kwargs)¶Returns detailed information about the status of an individual resource within a Readiness Check’s Resource Set.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check_resource_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string',
ResourceIdentifier='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
ReadinessCheckName (string) – [REQUIRED] The ReadinessCheck to get
ResourceIdentifier (string) – [REQUIRED] The resource ARN or component Id to get
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) – Result of a GetReadinessCheckResourceStatus call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Readiness (string) – The readiness at rule level.
Rules (list) – Details of the rules’s results
(dict) – Result 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
get_readiness_check_status
(**kwargs)¶Returns information about the status of a Readiness Check.
See also: AWS API Documentation
Request Syntax
response = client.get_readiness_check_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
ReadinessCheckName (string) – [REQUIRED] The ReadinessCheck to get
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) – Result of a GetReadinessCheckStatus call
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) – A token that can be used to resume pagination from the end of the collection.
Readiness (string) – The readiness at rule level.
Resources (list) – Summary of resources’s readiness
(dict) – Result with status for an individual resource.
ComponentId (string) – The component id of the resource
LastCheckedTimestamp (datetime) – The time the resource was last checked for readiness, in ISO-8601 format, UTC.
Readiness (string) – The readiness of the resource.
ResourceArn (string) – The 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
get_recovery_group
(**kwargs)¶Returns information about a Recovery Group.
See also: AWS API Documentation
Request Syntax
response = client.get_recovery_group(
RecoveryGroupName='string'
)
RecoveryGroupName (string) – [REQUIRED] The RecoveryGroup to get
dict
Response Syntax
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a GetRecoveryGroup call
Cells (list) – A list of Cell arns
(string) –
RecoveryGroupArn (string) – The arn for the RecoveryGroup
RecoveryGroupName (string) – The name of the RecoveryGroup
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
get_recovery_group_readiness_summary
(**kwargs)¶Returns information about a Recovery Group.
See also: AWS API Documentation
Request Syntax
response = client.get_recovery_group_readiness_summary(
MaxResults=123,
NextToken='string',
RecoveryGroupName='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
RecoveryGroupName (string) – [REQUIRED] The name of the RecoveryGroup
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) – Result of a GetRecoveryGroupReadinessSummary call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Readiness (string) – The readiness at RecoveryGroup level.
ReadinessChecks (list) – Summaries for the ReadinessChecks making up the RecoveryGroup
(dict) – Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary
Readiness (string) – The readiness of this ReadinessCheck
ReadinessCheckName (string) – The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell
Exceptions
Route53RecoveryReadiness.Client.exceptions.ResourceNotFoundException
Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException
get_resource_set
(**kwargs)¶Returns information about a Resource Set.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_set(
ResourceSetName='string'
)
ResourceSetName (string) – [REQUIRED] The ResourceSet to get
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) – Result of a GetResourceSets call
ResourceSetArn (string) – The arn for the ResourceSet
ResourceSetName (string) – The name of the ResourceSet
ResourceSetType (string) – AWS Resource Type of the resources in the ResourceSet
Resources (list) – A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
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
get_waiter
(waiter_name)¶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
list_cells
(**kwargs)¶Returns a collection of Cells.
See also: AWS API Documentation
Request Syntax
response = client.list_cells(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
dict
Response Syntax
{
'Cells': [
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) – Result of a ListCells call
Cells (list) – A list of Cells
(dict) – A Cell and its properties
CellArn (string) – The arn for the Cell
CellName (string) – The name of the Cell
Cells (list) – A list of Cell arns
(string) –
ParentReadinessScopes (list) – A list of Cell ARNs and/or RecoveryGroup ARNs
(string) –
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Exceptions
Returns a collection of cross account readiness authorizations.
See also: AWS API Documentation
Request Syntax
response = client.list_cross_account_authorizations(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
dict
Response Syntax
{
'CrossAccountAuthorizations': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) – Result of a ListCrossAccountAuthorizations call
CrossAccountAuthorizations (list) – A list of CrossAccountAuthorizations
(string) – A cross-account authorization, e.g. arn:aws:iam::123456789012:root
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Exceptions
list_readiness_checks
(**kwargs)¶Returns a collection of Readiness Checks.
See also: AWS API Documentation
Request Syntax
response = client.list_readiness_checks(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
dict
Response Syntax
{
'NextToken': 'string',
'ReadinessChecks': [
{
'ReadinessCheckArn': 'string',
'ReadinessCheckName': 'string',
'ResourceSet': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) – Result of a ListReadinessChecks call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
ReadinessChecks (list) – A list of ReadinessCheck associated with the account
(dict) – A resource used for checking the readiness of a Resource Set
ReadinessCheckArn (string) – Arn associated with ReadinessCheck
ReadinessCheckName (string) – Name for a ReadinessCheck
ResourceSet (string) – Name of the ResourceSet to be checked
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Exceptions
list_recovery_groups
(**kwargs)¶Returns a collection of Recovery Groups.
See also: AWS API Documentation
Request Syntax
response = client.list_recovery_groups(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
dict
Response Syntax
{
'NextToken': 'string',
'RecoveryGroups': [
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) – Result of a ListRecoveryGroups call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
RecoveryGroups (list) – A list of RecoveryGroups
(dict) – A Recovery Group generally containing multiple Cells
Cells (list) – A list of Cell arns
(string) –
RecoveryGroupArn (string) – The arn for the RecoveryGroup
RecoveryGroupName (string) – The name of the RecoveryGroup
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Exceptions
list_resource_sets
(**kwargs)¶Returns a collection of Resource Sets.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_sets(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
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) – Result of a ListResourceSets call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
ResourceSets (list) – A list of ResourceSets associated with the account
(dict) – A collection of resources of the same type
ResourceSetArn (string) – The arn for the ResourceSet
ResourceSetName (string) – The name of the ResourceSet
ResourceSetType (string) – AWS Resource Type of the resources in the ResourceSet
Resources (list) – A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Exceptions
list_rules
(**kwargs)¶Returns a collection of rules that are applied as part of Readiness Checks.
See also: AWS API Documentation
Request Syntax
response = client.list_rules(
MaxResults=123,
NextToken='string',
ResourceType='string'
)
MaxResults (integer) – Upper bound on number of records to return.
NextToken (string) – A token used to resume pagination from the end of a previous request.
ResourceType (string) – Filter parameter which specifies the rules to return given a resource type.
dict
Response Syntax
{
'NextToken': 'string',
'Rules': [
{
'ResourceType': 'string',
'RuleDescription': 'string',
'RuleId': 'string'
},
]
}
Response Structure
(dict) – Result of a ListRules call
NextToken (string) – A token that can be used to resume pagination from the end of the collection.
Rules (list) – A list of rules
(dict) – A collection of rules used in a readiness check
ResourceType (string) – The resource type the rule applies to.
RuleDescription (string) – A description of the rule
RuleId (string) – The Rule’s ID.
Exceptions
Returns a list of the tags assigned to the specified 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 the resource. You can get this from the response to any request to the resource.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – 200 response
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Exceptions
tag_resource
(**kwargs)¶Adds tags to the specified resource. You can specify one or more tags to add.
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 the resource. You can get this from the response to any request to the resource.
Tags (dict) –
[REQUIRED] A collection of tags associated with a resource
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) – 200 response
Exceptions
untag_resource
(**kwargs)¶Removes tags from the specified resource. You can specify one or more tags to remove.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
TagKeys (list) –
[REQUIRED] A comma-separated list of the tag keys to remove from the resource.
(string) –
None
Exceptions
update_cell
(**kwargs)¶Updates an existing Cell.
See also: AWS API Documentation
Request Syntax
response = client.update_cell(
CellName='string',
Cells=[
'string',
]
)
CellName (string) – [REQUIRED] The Cell to update
Cells (list) –
[REQUIRED] A list of Cell arns, completely replaces previous list
(string) –
dict
Response Syntax
{
'CellArn': 'string',
'CellName': 'string',
'Cells': [
'string',
],
'ParentReadinessScopes': [
'string',
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a UpdateCell call
CellArn (string) – The arn for the Cell
CellName (string) – The name of the Cell
Cells (list) – A list of Cell arns
(string) –
ParentReadinessScopes (list) – A list of Cell ARNs and/or RecoveryGroup ARNs
(string) –
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
update_readiness_check
(**kwargs)¶Updates an exisiting Readiness Check.
See also: AWS API Documentation
Request Syntax
response = client.update_readiness_check(
ReadinessCheckName='string',
ResourceSetName='string'
)
ReadinessCheckName (string) – [REQUIRED] The ReadinessCheck to update
ResourceSetName (string) – [REQUIRED] The name of the ResourceSet to check
dict
Response Syntax
{
'ReadinessCheckArn': 'string',
'ReadinessCheckName': 'string',
'ResourceSet': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a UpdateReadinessChecks call
ReadinessCheckArn (string) – Arn associated with ReadinessCheck
ReadinessCheckName (string) – Name for a ReadinessCheck
ResourceSet (string) – Name of the ResourceSet 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
update_recovery_group
(**kwargs)¶Updates an existing 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 arns, completely replaces previous list
(string) –
RecoveryGroupName (string) – [REQUIRED] The RecoveryGroup to update
dict
Response Syntax
{
'Cells': [
'string',
],
'RecoveryGroupArn': 'string',
'RecoveryGroupName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) – Result of a UpdateRecoveryGroups call
Cells (list) – A list of Cell arns
(string) –
RecoveryGroupArn (string) – The arn for the RecoveryGroup
RecoveryGroupName (string) – The name of the RecoveryGroup
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
update_resource_set
(**kwargs)¶Updates an existing 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] The ResourceSet to update
ResourceSetType (string) – [REQUIRED] AWS Resource Type of the resources in the ResourceSet
Resources (list) –
[REQUIRED] A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
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) – Result of a UpdateResourceSets call
ResourceSetArn (string) – The arn for the ResourceSet
ResourceSetName (string) – The name of the ResourceSet
ResourceSetType (string) – AWS Resource Type of the resources in the ResourceSet
Resources (list) – A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
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
Route53RecoveryReadiness.Client.exceptions.
AccessDeniedException
¶User does not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
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.
Route53RecoveryReadiness.Client.exceptions.
ConflictException
¶Updating or deleting a resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
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.
Route53RecoveryReadiness.Client.exceptions.
InternalServerException
¶An unexpected error occurred.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
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.
Route53RecoveryReadiness.Client.exceptions.
ResourceNotFoundException
¶The requested resource does not exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
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.
Route53RecoveryReadiness.Client.exceptions.
ThrottlingException
¶Request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
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.
Route53RecoveryReadiness.Client.exceptions.
ValidationException
¶The input fails to satisfy the constraints specified by an AWS service.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
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
Route53RecoveryReadiness.Paginator.
GetCellReadinessSummary
¶paginator = client.get_paginator('get_cell_readiness_summary')
paginate
(**kwargs)¶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) – Result of a GetCellReadinessSummary call
Readiness (string) – The readiness at Cell level.
ReadinessChecks (list) – Summaries for the ReadinessChecks making up the Cell
(dict) – Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary
Readiness (string) – The readiness of this ReadinessCheck
ReadinessCheckName (string) – The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell
Route53RecoveryReadiness.Paginator.
GetReadinessCheckResourceStatus
¶paginator = client.get_paginator('get_readiness_check_resource_status')
paginate
(**kwargs)¶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] The ReadinessCheck to get
ResourceIdentifier (string) – [REQUIRED] The resource ARN or component Id to get
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) – Result of a GetReadinessCheckResourceStatus call
Readiness (string) – The readiness at rule level.
Rules (list) – Details of the rules’s results
(dict) – Result 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.
Route53RecoveryReadiness.Paginator.
GetReadinessCheckStatus
¶paginator = client.get_paginator('get_readiness_check_status')
paginate
(**kwargs)¶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] The ReadinessCheck to get
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) – Result of a GetReadinessCheckStatus call
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 resources’s readiness
(dict) – Result with status for an individual resource.
ComponentId (string) – The component id of the resource
LastCheckedTimestamp (datetime) – The time the resource was last checked for readiness, in ISO-8601 format, UTC.
Readiness (string) – The readiness of the resource.
ResourceArn (string) – The ARN of the resource
Route53RecoveryReadiness.Paginator.
GetRecoveryGroupReadinessSummary
¶paginator = client.get_paginator('get_recovery_group_readiness_summary')
paginate
(**kwargs)¶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 the RecoveryGroup
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) – Result of a GetRecoveryGroupReadinessSummary call
Readiness (string) – The readiness at RecoveryGroup level.
ReadinessChecks (list) – Summaries for the ReadinessChecks making up the RecoveryGroup
(dict) – Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary
Readiness (string) – The readiness of this ReadinessCheck
ReadinessCheckName (string) – The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell
Route53RecoveryReadiness.Paginator.
ListCells
¶paginator = client.get_paginator('list_cells')
paginate
(**kwargs)¶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) – Result of a ListCells call
Cells (list) – A list of Cells
(dict) – A Cell and its properties
CellArn (string) – The arn for the Cell
CellName (string) – The name of the Cell
Cells (list) – A list of Cell arns
(string) –
ParentReadinessScopes (list) – A list of Cell ARNs and/or RecoveryGroup ARNs
(string) –
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Route53RecoveryReadiness.Paginator.
ListCrossAccountAuthorizations
¶paginator = client.get_paginator('list_cross_account_authorizations')
paginate
(**kwargs)¶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) – Result of a ListCrossAccountAuthorizations call
CrossAccountAuthorizations (list) – A list of CrossAccountAuthorizations
(string) – A cross-account authorization, e.g. arn:aws:iam::123456789012:root
Route53RecoveryReadiness.Paginator.
ListReadinessChecks
¶paginator = client.get_paginator('list_readiness_checks')
paginate
(**kwargs)¶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) – Result of a ListReadinessChecks call
ReadinessChecks (list) – A list of ReadinessCheck associated with the account
(dict) – A resource used for checking the readiness of a Resource Set
ReadinessCheckArn (string) – Arn associated with ReadinessCheck
ReadinessCheckName (string) – Name for a ReadinessCheck
ResourceSet (string) – Name of the ResourceSet to be checked
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Route53RecoveryReadiness.Paginator.
ListRecoveryGroups
¶paginator = client.get_paginator('list_recovery_groups')
paginate
(**kwargs)¶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) – Result of a ListRecoveryGroups call
RecoveryGroups (list) – A list of RecoveryGroups
(dict) – A Recovery Group generally containing multiple Cells
Cells (list) – A list of Cell arns
(string) –
RecoveryGroupArn (string) – The arn for the RecoveryGroup
RecoveryGroupName (string) – The name of the RecoveryGroup
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Route53RecoveryReadiness.Paginator.
ListResourceSets
¶paginator = client.get_paginator('list_resource_sets')
paginate
(**kwargs)¶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) – Result of a ListResourceSets call
ResourceSets (list) – A list of ResourceSets associated with the account
(dict) – A collection of resources of the same type
ResourceSetArn (string) – The arn for the ResourceSet
ResourceSetName (string) – The name of the ResourceSet
ResourceSetType (string) – AWS Resource Type of the resources in the ResourceSet
Resources (list) – A list of Resource objects
(dict) – The resource element of a ResourceSet
ComponentId (string) – The component id of the resource, generated by the service when dnsTargetResource is used
DnsTargetResource (dict) – A component for DNS/Routing Control Readiness Checks
DomainName (string) – The DNS Name that acts as ingress point to a portion of application
HostedZoneArn (string) – The Hosted Zone ARN that contains the DNS record with the provided name of target resource.
RecordSetId (string) – The R53 Set Id to uniquely identify a record given a Name and a Type
RecordType (string) – The Type of DNS Record of target resource
TargetResource (dict) – The target resource the R53 record points to
NLBResource (dict) – The NLB resource a DNS Target Resource points to
Arn (string) – An NLB resource arn
R53Resource (dict) – The Route 53 resource a DNS Target Resource record points to
DomainName (string) – The DNS target name
RecordSetId (string) – The Resource Record set id
ReadinessScopes (list) – A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within.
(string) –
ResourceArn (string) – The ARN of the AWS resource, can be skipped if dnsTargetResource is used
Tags (dict) – A collection of tags associated with a resource
(string) –
(string) –
Route53RecoveryReadiness.Paginator.
ListRules
¶paginator = client.get_paginator('list_rules')
paginate
(**kwargs)¶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) – Filter parameter which specifies the rules to return given a resource type.
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) – Result of a ListRules call
Rules (list) – A list of rules
(dict) – A collection of rules used in a readiness check
ResourceType (string) – The resource type the rule applies to.
RuleDescription (string) – A description of the rule
RuleId (string) – The Rule’s ID.