2021/07/27 - AWS Route53 Recovery Readiness - 32 new api methods
Changes Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed.
Returns a collection of cross account readiness authorizations.
See also: AWS API Documentation
Request Syntax
client.list_cross_account_authorizations(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
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.
Returns information about a Recovery Group.
See also: AWS API Documentation
Request Syntax
client.get_recovery_group_readiness_summary(
MaxResults=123,
NextToken='string',
RecoveryGroupName='string'
)
integer
Upper bound on number of records to return.
string
A token used to resume pagination from the end of a previous request.
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
Creates a new Readiness Check.
See also: AWS API Documentation
Request Syntax
client.create_readiness_check(
ReadinessCheckName='string',
ResourceSetName='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED] The name of the ReadinessCheck to create
string
[REQUIRED] The name of the ResourceSet to check
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) --
Updates an existing Resource Set.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
string
[REQUIRED] The ResourceSet to update
string
[REQUIRED] AWS Resource Type of the resources in the ResourceSet
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) --
Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.
See also: AWS API Documentation
Request Syntax
client.get_readiness_check_resource_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string',
ResourceIdentifier='string'
)
integer
Upper bound on number of records to return.
string
A token used to resume pagination from the end of a previous request.
string
[REQUIRED] The ReadinessCheck to get
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.
Creates a new Resource Set.
See also: AWS API Documentation
Request Syntax
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'
}
)
string
[REQUIRED] The name of the ResourceSet to create
string
[REQUIRED] AWS Resource type of the resources in the ResourceSet
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
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) --
Returns information about readiness of a Cell.
See also: AWS API Documentation
Request Syntax
client.get_cell_readiness_summary(
CellName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED] The name of the Cell
integer
Upper bound on number of records to return.
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
Returns information about a Cell.
See also: AWS API Documentation
Request Syntax
client.get_cell(
CellName='string'
)
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) --
Create a new cross account readiness authorization.
See also: AWS API Documentation
Request Syntax
client.create_cross_account_authorization(
CrossAccountAuthorization='string'
)
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
Updates an existing Cell.
See also: AWS API Documentation
Request Syntax
client.update_cell(
CellName='string',
Cells=[
'string',
]
)
string
[REQUIRED] The Cell to update
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) --
Adds tags to the specified resource. You can specify one or more tags to add.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED] The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
dict
[REQUIRED] A collection of tags associated with a resource
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) -- 200 response
Returns a list of the tags assigned to the specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resources(
ResourceArn='string'
)
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) --
Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.
See also: AWS API Documentation
Request Syntax
client.get_architecture_recommendations(
MaxResults=123,
NextToken='string',
RecoveryGroupName='string'
)
integer
Upper bound on number of records to return.
string
A token that can be used to resume pagination from the end of the collection.
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
Returns information about a ReadinessCheck.
See also: AWS API Documentation
Request Syntax
client.get_readiness_check(
ReadinessCheckName='string'
)
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) --
Deletes an existing Recovery Group.
See also: AWS API Documentation
Request Syntax
client.delete_recovery_group(
RecoveryGroupName='string'
)
string
[REQUIRED] The RecoveryGroup to delete
None
Returns a collection of Recovery Groups.
See also: AWS API Documentation
Request Syntax
client.list_recovery_groups(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
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) --
Creates a new Recovery Group.
See also: AWS API Documentation
Request Syntax
client.create_recovery_group(
Cells=[
'string',
],
RecoveryGroupName='string',
Tags={
'string': 'string'
}
)
list
A list of Cell arns
(string) --
string
[REQUIRED] The name of the RecoveryGroup to create
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) --
Returns a collection of rules that are applied as part of Readiness Checks.
See also: AWS API Documentation
Request Syntax
client.list_rules(
MaxResults=123,
NextToken='string',
ResourceType='string'
)
integer
Upper bound on number of records to return.
string
A token used to resume pagination from the end of a previous request.
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.
Updates an exisiting Readiness Check.
See also: AWS API Documentation
Request Syntax
client.update_readiness_check(
ReadinessCheckName='string',
ResourceSetName='string'
)
string
[REQUIRED] The ReadinessCheck to update
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) --
Deletes an existing Readiness Check.
See also: AWS API Documentation
Request Syntax
client.delete_readiness_check(
ReadinessCheckName='string'
)
string
[REQUIRED] The ReadinessCheck to delete
None
Deletes an existing Resource Set.
See also: AWS API Documentation
Request Syntax
client.delete_resource_set(
ResourceSetName='string'
)
string
[REQUIRED] The ResourceSet to delete
None
Returns a collection of Readiness Checks.
See also: AWS API Documentation
Request Syntax
client.list_readiness_checks(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
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) --
Deletes an existing Cell.
See also: AWS API Documentation
Request Syntax
client.delete_cell(
CellName='string'
)
string
[REQUIRED] The Cell to delete
None
Returns a collection of Resource Sets.
See also: AWS API Documentation
Request Syntax
client.list_resource_sets(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
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) --
Returns information about a Resource Set.
See also: AWS API Documentation
Request Syntax
client.get_resource_set(
ResourceSetName='string'
)
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) --
Creates a new Cell.
See also: AWS API Documentation
Request Syntax
client.create_cell(
CellName='string',
Cells=[
'string',
],
Tags={
'string': 'string'
}
)
string
[REQUIRED] The name of the Cell to create
list
A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)
(string) --
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) --
Returns information about the status of a Readiness Check.
See also: AWS API Documentation
Request Syntax
client.get_readiness_check_status(
MaxResults=123,
NextToken='string',
ReadinessCheckName='string'
)
integer
Upper bound on number of records to return.
string
A token used to resume pagination from the end of a previous request.
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
Removes tags from the specified resource. You can specify one or more tags to remove.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED] The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
list
[REQUIRED] A comma-separated list of the tag keys to remove from the resource.
(string) --
None
Updates an existing Recovery Group.
See also: AWS API Documentation
Request Syntax
client.update_recovery_group(
Cells=[
'string',
],
RecoveryGroupName='string'
)
list
[REQUIRED] A list of Cell arns, completely replaces previous list
(string) --
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) --
Returns a collection of Cells.
See also: AWS API Documentation
Request Syntax
client.list_cells(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
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.
Delete cross account readiness authorization
See also: AWS API Documentation
Request Syntax
client.delete_cross_account_authorization(
CrossAccountAuthorization='string'
)
string
[REQUIRED] The cross account authorization
dict
Response Syntax
{}
Response Structure
(dict) -- Result of a DeleteCrossAccountAuthorization call
Returns information about a Recovery Group.
See also: AWS API Documentation
Request Syntax
client.get_recovery_group(
RecoveryGroupName='string'
)
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) --