{ "version" : "2.0", "service" : "
Recovery readiness
", "operations" : { "CreateCell" : "Creates a cell in an account.
", "CreateCrossAccountAuthorization" : "Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.
", "CreateReadinessCheck" : "Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.
", "CreateRecoveryGroup" : "Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
", "CreateResourceSet" : "Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
", "DeleteCell" : "Delete a cell. When successful, the response code is 204, with no response body.
", "DeleteCrossAccountAuthorization" : "Deletes cross account readiness authorization.
", "DeleteReadinessCheck" : "Deletes a readiness check.
", "DeleteRecoveryGroup" : "Deletes a recovery group.
", "DeleteResourceSet" : "Deletes a resource set.
", "GetArchitectureRecommendations" : "Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
", "GetCell" : "Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
", "GetCellReadinessSummary" : "Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.
", "GetReadinessCheck" : "Gets details about a readiness check.
", "GetReadinessCheckResourceStatus" : "Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.
", "GetReadinessCheckStatus" : "Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.
", "GetRecoveryGroup" : "Gets details about a recovery group, including a list of the cells that are included in it.
", "GetRecoveryGroupReadinessSummary" : "Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.
", "GetResourceSet" : "Displays the details about a resource set, including a list of the resources in the set.
", "ListCells" : "Lists the cells for an account.
", "ListCrossAccountAuthorizations" : "Lists the cross-account readiness authorizations that are in place for an account.
", "ListReadinessChecks" : "Lists the readiness checks for an account.
", "ListRecoveryGroups" : "Lists the recovery groups in an account.
", "ListResourceSets" : "Lists the resource sets in an account.
", "ListRules" : "Lists all readiness rules, or lists the readiness rules for a specific resource type.
", "ListTagsForResources" : "Lists the tags for a resource.
", "TagResource" : "Adds a tag to a resource.
", "UntagResource" : "Removes a tag from a resource.
", "UpdateCell" : "Updates a cell to replace the list of nested cells with a new list of nested cells.
", "UpdateReadinessCheck" : "Updates a readiness check.
", "UpdateRecoveryGroup" : "Updates a recovery group.
", "UpdateResourceSet" : "Updates a resource set.
" }, "shapes" : { "CellCreateParameters" : { "base" : "Parameters used to create a cell.
", "refs" : { } }, "CellOutput" : { "base" : "Information about a cell.
", "refs" : { "__listOfCellOutput$member" : null } }, "CellUpdateParameters" : { "base" : "Parameters used to update a cell.
", "refs" : { } }, "CreateCrossAccountAuthorizationParameters" : { "base" : "Parameters used to create a cross-account authorization.
", "refs" : { } }, "CreateCrossAccountAuthorizationResult" : { "base" : "The result of a successful CreateCrossAccountAuthorization request.
", "refs" : { } }, "CrossAccountAuthorization" : { "base" : "CrossAccountAuthorization
", "refs" : { "CreateCrossAccountAuthorizationParameters$CrossAccountAuthorization" : "The cross-account authorization.
", "CreateCrossAccountAuthorizationResult$CrossAccountAuthorization" : "The cross-account authorization.
", "__listOfCrossAccountAuthorization$member" : null } }, "DNSTargetResource" : { "base" : "A component for DNS/routing control readiness checks and architecture checks.
", "refs" : { "Resource$DnsTargetResource" : "The DNS target resource.
" } }, "DeleteCrossAccountAuthorizationResult" : { "base" : "A successful DeleteCrossAccountAuthorization request returns no response.
", "refs" : { } }, "GetArchitectureRecommendationsOutput" : { "base" : "Result from GetArchitectureRecommendations call.
", "refs" : { } }, "GetCellReadinessSummaryOutput" : { "base" : "Result of a GetReadinessCellSummary operation
", "refs" : { } }, "GetReadinessCheckResourceStatusOutput" : { "base" : "Result of a GetReadinessCheckResourceStatus operation.
", "refs" : { } }, "GetReadinessCheckStatusOutput" : { "base" : "Result of a GetReadinessCheckStatus operation.
", "refs" : { } }, "GetRecoveryGroupReadinessSummaryOutput" : { "base" : "Result of a GetReadinessRecoveryGroupSummary operation.
", "refs" : { } }, "LastAuditTimestamp" : { "base" : "The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.
", "refs" : { "GetArchitectureRecommendationsOutput$LastAuditTimestamp" : "The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.
" } }, "ListCellsResult" : { "base" : "The result of a successful ListCells request.
", "refs" : { } }, "ListCrossAccountAuthorizationsResult" : { "base" : "The result of a successful ListCrossAccountAuthorizations request.
", "refs" : { } }, "ListReadinessChecksResult" : { "base" : "The result of a successful ListReadinessChecks request.
", "refs" : { } }, "ListRecoveryGroupsResult" : { "base" : "The result of a successful ListRecoveryGroups request.
", "refs" : { } }, "ListResourceSetsResult" : { "base" : "The result of a successful ListResourceSets request.
", "refs" : { } }, "ListRulesOutput" : { "base" : "Readiness rule information, including the resource type, rule ID, and rule description.
", "refs" : { "__listOfListRulesOutput$member" : null } }, "ListRulesResult" : { "base" : "The result of a successful ListRules request.
", "refs" : { } }, "Message" : { "base" : "Information relating to readiness check status.
", "refs" : { "__listOfMessage$member" : null } }, "NLBResource" : { "base" : "The Network Load Balancer resource that a DNS target resource points to.
", "refs" : { "TargetResource$NLBResource" : "The Network Load Balancer Resource.
" } }, "R53ResourceRecord" : { "base" : "The Route 53 resource that a DNS target resource record points to.
", "refs" : { "TargetResource$R53Resource" : "The Route 53 resource.
" } }, "Readiness" : { "base" : "The readiness status.
", "refs" : { "GetCellReadinessSummaryOutput$Readiness" : "The readiness at a cell level.
", "GetReadinessCheckResourceStatusOutput$Readiness" : "The readiness at a rule level.
", "GetReadinessCheckStatusOutput$Readiness" : "The readiness at rule level.
", "GetRecoveryGroupReadinessSummaryOutput$Readiness" : "The readiness status at a recovery group level.
", "ReadinessCheckSummary$Readiness" : "The readiness status of this readiness check.
", "ResourceResult$Readiness" : "The readiness of a resource.
", "RuleResult$Readiness" : "The readiness at rule level.
" } }, "ReadinessCheckCreateParameters" : { "base" : "Parameters used to create or update a readiness check.
", "refs" : { } }, "ReadinessCheckOutput" : { "base" : "A readiness check.
", "refs" : { "__listOfReadinessCheckOutput$member" : null } }, "ReadinessCheckSummary" : { "base" : "Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.
", "refs" : { "__listOfReadinessCheckSummary$member" : null } }, "ReadinessCheckTimestamp" : { "base" : "The time (UTC) that the cell was last checked for readiness, in ISO-8601 format.
", "refs" : { "ResourceResult$LastCheckedTimestamp" : "The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.
", "RuleResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC.
" } }, "ReadinessCheckUpdateParameters" : { "base" : "Parameter used to create or update a readiness check.
", "refs" : { } }, "Recommendation" : { "base" : "Recommendations that are provided to make an application more recovery resilient.
", "refs" : { "__listOfRecommendation$member" : null } }, "RecoveryGroupCreateParameters" : { "base" : "Parameters used to create a recovery group. A recovery group corresponds to your application and includes the cells that make up the application.
", "refs" : { } }, "RecoveryGroupOutput" : { "base" : "A representation of the application, typically containing multiple cells.
", "refs" : { "__listOfRecoveryGroupOutput$member" : null } }, "RecoveryGroupUpdateParameters" : { "base" : "Parameters used to update a recovery group.
", "refs" : { } }, "Resource" : { "base" : "The resource element of a resource set.
", "refs" : { "__listOfResource$member" : null } }, "ResourceResult" : { "base" : "The result of a successful Resource request, with status for an individual resource.
", "refs" : { "__listOfResourceResult$member" : null } }, "ResourceSetCreateParameters" : { "base" : "The parameters used to create a resource set.
", "refs" : { } }, "ResourceSetOutput" : { "base" : "A collection of resources of the same type.
", "refs" : { "__listOfResourceSetOutput$member" : null } }, "ResourceSetUpdateParameters" : { "base" : "Parameters used to create a resource set.
", "refs" : { } }, "RuleResult" : { "base" : "The result of a successful Rule request, with status for an individual rule.
", "refs" : { "__listOfRuleResult$member" : null } }, "Tags" : { "base" : "A collection of tags associated with a resource.
", "refs" : { "CellCreateParameters$Tags" : null, "CellOutput$Tags" : "Tags on the resources.
", "ReadinessCheckCreateParameters$Tags" : null, "ReadinessCheckOutput$Tags" : null, "RecoveryGroupCreateParameters$Tags" : null, "RecoveryGroupOutput$Tags" : "The tags associated with the recovery group.
", "ResourceSetCreateParameters$Tags" : "A tag to associate with the parameters for a resource set.
", "ResourceSetOutput$Tags" : null, "TagsModel$Tags" : "" } }, "TagsModel" : { "base" : "", "refs" : { } }, "TargetResource" : { "base" : "The target resource that the Route 53 record points to.
", "refs" : { "DNSTargetResource$TargetResource" : "The target resource of the DNS target resource.
" } }, "__listOfCellOutput" : { "base" : null, "refs" : { "ListCellsResult$Cells" : "A list of cells.
" } }, "__listOfCrossAccountAuthorization" : { "base" : null, "refs" : { "ListCrossAccountAuthorizationsResult$CrossAccountAuthorizations" : "A list of cross-account authorizations.
" } }, "__listOfListRulesOutput" : { "base" : null, "refs" : { "ListRulesResult$Rules" : "A list of readiness rules for a specific resource type.
" } }, "__listOfMessage" : { "base" : null, "refs" : { "GetReadinessCheckStatusOutput$Messages" : "Top level messages for readiness check status
", "RuleResult$Messages" : "Details about the resource's readiness.
" } }, "__listOfReadinessCheckOutput" : { "base" : null, "refs" : { "ListReadinessChecksResult$ReadinessChecks" : "A list of readiness checks associated with the account.
" } }, "__listOfReadinessCheckSummary" : { "base" : null, "refs" : { "GetCellReadinessSummaryOutput$ReadinessChecks" : "Summaries for the readiness checks that make up the cell.
", "GetRecoveryGroupReadinessSummaryOutput$ReadinessChecks" : "Summaries of the readiness checks for the recovery group.
" } }, "__listOfRecommendation" : { "base" : null, "refs" : { "GetArchitectureRecommendationsOutput$Recommendations" : "A list of the recommendations for the customer's application.
" } }, "__listOfRecoveryGroupOutput" : { "base" : null, "refs" : { "ListRecoveryGroupsResult$RecoveryGroups" : "A list of recovery groups.
" } }, "__listOfResource" : { "base" : null, "refs" : { "ResourceSetCreateParameters$Resources" : "A list of resource objects in the resource set.
", "ResourceSetOutput$Resources" : "A list of resource objects.
", "ResourceSetUpdateParameters$Resources" : "A list of resource objects.
" } }, "__listOfResourceResult" : { "base" : null, "refs" : { "GetReadinessCheckStatusOutput$Resources" : "Summary of the readiness of resources.
" } }, "__listOfResourceSetOutput" : { "base" : null, "refs" : { "ListResourceSetsResult$ResourceSets" : "A list of resource sets associated with the account.
" } }, "__listOfRuleResult" : { "base" : null, "refs" : { "GetReadinessCheckResourceStatusOutput$Rules" : "Details of the rule's results.
" } }, "__listOf__string" : { "base" : null, "refs" : { "CellCreateParameters$Cells" : "A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Amazon Web Services Regions.
", "CellOutput$Cells" : "A list of cell ARNs.
", "CellOutput$ParentReadinessScopes" : "The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
", "CellUpdateParameters$Cells" : "A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list.
", "RecoveryGroupCreateParameters$Cells" : "A list of the cell Amazon Resource Names (ARNs) in the recovery group.
", "RecoveryGroupOutput$Cells" : "A list of a cell's Amazon Resource Names (ARNs).
", "RecoveryGroupUpdateParameters$Cells" : "A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list.
", "Resource$ReadinessScopes" : "A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.
" } }, "__string" : { "base" : null, "refs" : { "CellCreateParameters$CellName" : "The name of the cell to create.
", "DNSTargetResource$DomainName" : "The domain name that acts as an ingress point to a portion of the customer application.
", "DNSTargetResource$HostedZoneArn" : "The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
", "DNSTargetResource$RecordSetId" : "The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
", "DNSTargetResource$RecordType" : "The type of DNS record of the target resource.
", "GetArchitectureRecommendationsOutput$NextToken" : "The token that identifies which batch of results you want to see.
", "GetCellReadinessSummaryOutput$NextToken" : "The token that identifies which batch of results you want to see.
", "GetReadinessCheckResourceStatusOutput$NextToken" : "The token that identifies which batch of results you want to see.
", "GetReadinessCheckStatusOutput$NextToken" : "The token that identifies which batch of results you want to see.
", "GetRecoveryGroupReadinessSummaryOutput$NextToken" : "The token that identifies which batch of results you want to see.
", "ListCellsResult$NextToken" : "The token that identifies which batch of results you want to see.
", "ListCrossAccountAuthorizationsResult$NextToken" : "The token that identifies which batch of results you want to see.
", "ListReadinessChecksResult$NextToken" : "The token that identifies which batch of results you want to see.
", "ListRecoveryGroupsResult$NextToken" : "The token that identifies which batch of results you want to see.
", "ListResourceSetsResult$NextToken" : "The token that identifies which batch of results you want to see.
", "ListRulesResult$NextToken" : "The token that identifies which batch of results you want to see.
", "Message$MessageText" : "The text of a readiness check message.
", "NLBResource$Arn" : "The Network Load Balancer resource Amazon Resource Name (ARN).
", "R53ResourceRecord$DomainName" : "The DNS target domain name.
", "R53ResourceRecord$RecordSetId" : "The Route 53 Resource Record Set ID.
", "ReadinessCheckCreateParameters$ReadinessCheckName" : "The name of the readiness check to create.
", "ReadinessCheckCreateParameters$ResourceSetName" : "The name of the resource set to check.
", "ReadinessCheckSummary$ReadinessCheckName" : "The name of a readiness check.
", "ReadinessCheckUpdateParameters$ResourceSetName" : "The name of the resource set to be checked.
", "Recommendation$RecommendationText" : "Text of the recommendations that are provided to make an application more recovery resilient.
", "RecoveryGroupCreateParameters$RecoveryGroupName" : "The name of the recovery group to create.
", "Resource$ComponentId" : "The component identifier of the resource, generated when DNS target resource is used.
", "Resource$ResourceArn" : "The Amazon Resource Name (ARN) of the Amazon Web Services resource.
", "ResourceResult$ComponentId" : "The component id of the resource.
", "ResourceResult$ResourceArn" : "The Amazon Resource Name (ARN) of the resource.
", "ResourceSetCreateParameters$ResourceSetName" : "The name of the resource set to create.
", "RuleResult$RuleId" : "The identifier of the rule.
", "Tags$member" : null, "__listOf__string$member" : null } }, "__stringMax256" : { "base" : null, "refs" : { "CellOutput$CellArn" : "The Amazon Resource Name (ARN) for the cell.
", "ListRulesOutput$RuleDescription" : "The description of a readiness rule.
", "ReadinessCheckOutput$ReadinessCheckArn" : "The Amazon Resource Name (ARN) associated with a readiness check.
", "RecoveryGroupOutput$RecoveryGroupArn" : "The Amazon Resource Name (ARN) for the recovery group.
", "ResourceSetOutput$ResourceSetArn" : "The Amazon Resource Name (ARN) for the resource set.
" } }, "__stringMax64" : { "base" : null, "refs" : { "ListRulesOutput$ResourceType" : "The resource type that the readiness rule applies to.
", "ListRulesOutput$RuleId" : "The ID for the readiness rule.
" } }, "__stringMax64PatternAAZAZ09Z" : { "base" : null, "refs" : { "CellOutput$CellName" : "The name of the cell.
", "ReadinessCheckOutput$ReadinessCheckName" : "Name of a readiness check.
", "ReadinessCheckOutput$ResourceSet" : "Name of the resource set to be checked.
", "RecoveryGroupOutput$RecoveryGroupName" : "The name of the recovery group.
", "ResourceSetOutput$ResourceSetName" : "The name of the resource set.
" } }, "__stringPatternAWSAZaZ09AZaZ09" : { "base" : null, "refs" : { "ResourceSetCreateParameters$ResourceSetType" : "The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
", "ResourceSetOutput$ResourceSetType" : "The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
", "ResourceSetUpdateParameters$ResourceSetType" : "The resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
" } } } }