Recovery readiness
", "operations" : { - "CreateCell" : "Creates a new Cell.", - "CreateCrossAccountAuthorization" : "Create a new cross account readiness authorization.", - "CreateReadinessCheck" : "Creates a new Readiness Check.", - "CreateRecoveryGroup" : "Creates a new Recovery Group.", - "CreateResourceSet" : "Creates a new Resource Set.", - "DeleteCell" : "Deletes an existing Cell.", - "DeleteCrossAccountAuthorization" : "Delete cross account readiness authorization", - "DeleteReadinessCheck" : "Deletes an existing Readiness Check.", - "DeleteRecoveryGroup" : "Deletes an existing Recovery Group.", - "DeleteResourceSet" : "Deletes an existing Resource Set.", - "GetArchitectureRecommendations" : "Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.", - "GetCell" : "Returns information about a Cell.", - "GetCellReadinessSummary" : "Returns information about readiness of a Cell.", - "GetReadinessCheck" : "Returns information about a ReadinessCheck.", - "GetReadinessCheckResourceStatus" : "Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.", - "GetReadinessCheckStatus" : "Returns information about the status of a Readiness Check.", - "GetRecoveryGroup" : "Returns information about a Recovery Group.", - "GetRecoveryGroupReadinessSummary" : "Returns information about a Recovery Group.", - "GetResourceSet" : "Returns information about a Resource Set.", - "ListCells" : "Returns a collection of Cells.", - "ListCrossAccountAuthorizations" : "Returns a collection of cross account readiness authorizations.", - "ListReadinessChecks" : "Returns a collection of Readiness Checks.", - "ListRecoveryGroups" : "Returns a collection of Recovery Groups.", - "ListResourceSets" : "Returns a collection of Resource Sets.", - "ListRules" : "Returns a collection of rules that are applied as part of Readiness Checks.", - "ListTagsForResources" : "Returns a list of the tags assigned to the specified resource.", - "TagResource" : "Adds tags to the specified resource. You can specify one or more tags to add.", - "UntagResource" : "Removes tags from the specified resource. You can specify one or more tags to remove.", - "UpdateCell" : "Updates an existing Cell.", - "UpdateReadinessCheck" : "Updates an exisiting Readiness Check.", - "UpdateRecoveryGroup" : "Updates an existing Recovery Group.", - "UpdateResourceSet" : "Updates an existing Resource Set." + "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", + "base" : "Parameters used to create a cell.
", "refs" : { } }, "CellOutput" : { - "base" : "A Cell and its properties", + "base" : "Information about a cell.
", "refs" : { "__listOfCellOutput$member" : null } }, "CellUpdateParameters" : { - "base" : "Parameters used to update a Cell", + "base" : "Parameters used to update a cell.
", "refs" : { } }, "CreateCrossAccountAuthorizationParameters" : { - "base" : "Parameters used to create a cross account authorization", + "base" : "Parameters used to create a cross-account authorization.
", "refs" : { } }, "CreateCrossAccountAuthorizationResult" : { - "base" : "The response for a CreateCrossAccountAuthorization operation.", + "base" : "The result of a successful CreateCrossAccountAuthorization request.
", "refs" : { } }, "CrossAccountAuthorization" : { - "base" : "A cross-account authorization, e.g. arn:aws:iam::123456789012:root", + "base" : "CrossAccountAuthorization
", "refs" : { - "CreateCrossAccountAuthorizationParameters$CrossAccountAuthorization" : "The cross account authorization", - "CreateCrossAccountAuthorizationResult$CrossAccountAuthorization" : "The cross account authorization", + "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", + "base" : "A component for DNS/routing control readiness checks and architecture checks.
", "refs" : { - "Resource$DnsTargetResource" : null + "Resource$DnsTargetResource" : "The DNS target resource.
" } }, "DeleteCrossAccountAuthorizationResult" : { - "base" : "The response for a DeleteCrossAccountAuthorization operation.", + "base" : "A successful DeleteCrossAccountAuthorization request returns no response.
", "refs" : { } }, "GetArchitectureRecommendationsOutput" : { - "base" : "Result from GetArchitectureRecommendations", + "base" : "Result from GetArchitectureRecommendations call.
", "refs" : { } }, "GetCellReadinessSummaryOutput" : { - "base" : "Result of a GetReadinessCellSummary operation", + "base" : "Result of a GetReadinessCellSummary operation
", "refs" : { } }, "GetReadinessCheckResourceStatusOutput" : { - "base" : "Result of a GetReadinessCheckResourceStatus operation", + "base" : "Result of a GetReadinessCheckResourceStatus operation.
", "refs" : { } }, "GetReadinessCheckStatusOutput" : { - "base" : "Result of a GetReadinessCheckStatus operation", + "base" : "Result of a GetReadinessCheckStatus operation.
", "refs" : { } }, "GetRecoveryGroupReadinessSummaryOutput" : { - "base" : "Result of a GetReadinessRecoveryGroupSummary operation", + "base" : "Result of a GetReadinessRecoveryGroupSummary operation.
", "refs" : { } }, "LastAuditTimestamp" : { - "base" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format", + "base" : "The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.
", "refs" : { - "GetArchitectureRecommendationsOutput$LastAuditTimestamp" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format." + "GetArchitectureRecommendationsOutput$LastAuditTimestamp" : "The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.
" } }, "ListCellsResult" : { - "base" : "Response object for listCells", + "base" : "The result of a successful ListCells request.
", "refs" : { } }, "ListCrossAccountAuthorizationsResult" : { - "base" : "The response for a ListCrossAccountAuthorizations operation.", + "base" : "The result of a successful ListCrossAccountAuthorizations request.
", "refs" : { } }, "ListReadinessChecksResult" : { - "base" : "Response object for ListReadinessChecks", + "base" : "The result of a successful ListReadinessChecks request.
", "refs" : { } }, "ListRecoveryGroupsResult" : { - "base" : "Response object for listRecoveryGroups", + "base" : "The result of a successful ListRecoveryGroups request.
", "refs" : { } }, "ListResourceSetsResult" : { - "base" : "Response object for listResourceSets", + "base" : "The result of a successful ListResourceSets request.
", "refs" : { } }, "ListRulesOutput" : { - "base" : "A collection of rules used in a readiness check", + "base" : "Readiness rule information, including the resource type, rule ID, and rule description.
", "refs" : { "__listOfListRulesOutput$member" : null } }, "ListRulesResult" : { - "base" : "Response object for List RulePacks", + "base" : "The result of a successful ListRules request.
", "refs" : { } }, "Message" : { - "base" : "Information relating to readiness check status", + "base" : "Information relating to readiness check status.
", "refs" : { "__listOfMessage$member" : null } }, "NLBResource" : { - "base" : "The NLB resource a DNS Target Resource points to", + "base" : "The Network Load Balancer resource that a DNS target resource points to.
", "refs" : { - "TargetResource$NLBResource" : null + "TargetResource$NLBResource" : "The Network Load Balancer Resource.
" } }, "R53ResourceRecord" : { - "base" : "The Route 53 resource a DNS Target Resource record points to", + "base" : "The Route 53 resource that a DNS target resource record points to.
", "refs" : { - "TargetResource$R53Resource" : null + "TargetResource$R53Resource" : "The Route 53 resource.
" } }, "Readiness" : { - "base" : "The readiness of an entire ReadinessCheck or an individual resource ARN.", + "base" : "The readiness status.
", "refs" : { - "GetCellReadinessSummaryOutput$Readiness" : "The readiness at Cell level.", - "GetReadinessCheckResourceStatusOutput$Readiness" : "The readiness at rule level.", - "GetReadinessCheckStatusOutput$Readiness" : "The readiness at rule level.", - "GetRecoveryGroupReadinessSummaryOutput$Readiness" : "The readiness at RecoveryGroup level.", - "ReadinessCheckSummary$Readiness" : "The readiness of this ReadinessCheck", - "ResourceResult$Readiness" : "The readiness of the resource.", - "RuleResult$Readiness" : "The readiness at rule level." + "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 ReadinessCheck", + "base" : "Parameters used to create or update a readiness check.
", "refs" : { } }, "ReadinessCheckOutput" : { - "base" : "A resource used for checking the readiness of a Resource Set", + "base" : "A readiness check.
", "refs" : { "__listOfReadinessCheckOutput$member" : null } }, "ReadinessCheckSummary" : { - "base" : "Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary", + "base" : "Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.
", "refs" : { "__listOfReadinessCheckSummary$member" : null } }, "ReadinessCheckTimestamp" : { - "base" : "The time the Cell was last checked for readiness, in ISO-8601 format, UTC.", + "base" : "The time (UTC) that the cell was last checked for readiness, in ISO-8601 format.
", "refs" : { - "ResourceResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC.", - "RuleResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC." + "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" : "Parameters used to create or update a ReadinessCheck", + "base" : "Parameter used to create or update a readiness check.
", "refs" : { } }, "Recommendation" : { - "base" : "Guidance for improving Recovery Group resilliancy", + "base" : "Recommendations that are provided to make an application more recovery resilient.
", "refs" : { "__listOfRecommendation$member" : null } }, "RecoveryGroupCreateParameters" : { - "base" : "Parameters used to create an RecoveryGroup", + "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 Recovery Group generally containing multiple Cells", + "base" : "A representation of the application, typically containing multiple cells.
", "refs" : { "__listOfRecoveryGroupOutput$member" : null } }, "RecoveryGroupUpdateParameters" : { - "base" : "Parameters used to update an RecoveryGroup", + "base" : "Parameters used to update a recovery group.
", "refs" : { } }, "Resource" : { - "base" : "The resource element of a ResourceSet", + "base" : "The resource element of a resource set.
", "refs" : { "__listOfResource$member" : null } }, "ResourceResult" : { - "base" : "Result with status for an individual resource.", + "base" : "The result of a successful Resource request, with status for an individual resource.
", "refs" : { "__listOfResourceResult$member" : null } }, "ResourceSetCreateParameters" : { - "base" : "Parameters used to create a ResourceSet", + "base" : "The parameters used to create a resource set.
", "refs" : { } }, "ResourceSetOutput" : { - "base" : "A collection of resources of the same type", + "base" : "A collection of resources of the same type.
", "refs" : { "__listOfResourceSetOutput$member" : null } }, "ResourceSetUpdateParameters" : { - "base" : "Parameters used to create a ResourceSet", + "base" : "Parameters used to create a resource set.
", "refs" : { } }, "RuleResult" : { - "base" : "Result with status for an individual rule..", + "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", + "base" : "A collection of tags associated with a resource.
", "refs" : { "CellCreateParameters$Tags" : null, - "CellOutput$Tags" : null, + "CellOutput$Tags" : "Tags on the resources.
", "ReadinessCheckCreateParameters$Tags" : null, "ReadinessCheckOutput$Tags" : null, "RecoveryGroupCreateParameters$Tags" : null, - "RecoveryGroupOutput$Tags" : null, - "ResourceSetCreateParameters$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" : null + "TagsModel$Tags" : "" } }, "TagsModel" : { - "base" : null, + "base" : "", "refs" : { } }, "TargetResource" : { - "base" : "The target resource the R53 record points to", + "base" : "The target resource that the Route 53 record points to.
", "refs" : { - "DNSTargetResource$TargetResource" : null + "DNSTargetResource$TargetResource" : "The target resource of the DNS target resource.
" } }, "__listOfCellOutput" : { "base" : null, "refs" : { - "ListCellsResult$Cells" : "A list of Cells" + "ListCellsResult$Cells" : "A list of cells.
" } }, "__listOfCrossAccountAuthorization" : { "base" : null, "refs" : { - "ListCrossAccountAuthorizationsResult$CrossAccountAuthorizations" : "A list of CrossAccountAuthorizations" + "ListCrossAccountAuthorizationsResult$CrossAccountAuthorizations" : "A list of cross-account authorizations.
" } }, "__listOfListRulesOutput" : { "base" : null, "refs" : { - "ListRulesResult$Rules" : "A list of rules" + "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" + "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 ReadinessCheck associated with the account" + "ListReadinessChecksResult$ReadinessChecks" : "A list of readiness checks associated with the account.
" } }, "__listOfReadinessCheckSummary" : { "base" : null, "refs" : { - "GetCellReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the Cell", - "GetRecoveryGroupReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the RecoveryGroup" + "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 recommendations for the customer's application" + "GetArchitectureRecommendationsOutput$Recommendations" : "A list of the recommendations for the customer's application.
" } }, "__listOfRecoveryGroupOutput" : { "base" : null, "refs" : { - "ListRecoveryGroupsResult$RecoveryGroups" : "A list of RecoveryGroups" + "ListRecoveryGroupsResult$RecoveryGroups" : "A list of recovery groups.
" } }, "__listOfResource" : { "base" : null, "refs" : { - "ResourceSetCreateParameters$Resources" : "A list of Resource objects", - "ResourceSetOutput$Resources" : "A list of Resource objects", - "ResourceSetUpdateParameters$Resources" : "A list of Resource objects" + "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 resources's readiness" + "GetReadinessCheckStatusOutput$Resources" : "Summary of the readiness of resources.
" } }, "__listOfResourceSetOutput" : { "base" : null, "refs" : { - "ListResourceSetsResult$ResourceSets" : "A list of ResourceSets associated with the account" + "ListResourceSetsResult$ResourceSets" : "A list of resource sets associated with the account.
" } }, "__listOfRuleResult" : { "base" : null, "refs" : { - "GetReadinessCheckResourceStatusOutput$Rules" : "Details of the rules's results" + "GetReadinessCheckResourceStatusOutput$Rules" : "Details of the rule's results.
" } }, "__listOf__string" : { "base" : null, "refs" : { - "CellCreateParameters$Cells" : "A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)", - "CellOutput$Cells" : "A list of Cell arns", - "CellOutput$ParentReadinessScopes" : "A list of Cell ARNs and/or RecoveryGroup ARNs", - "CellUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list", - "RecoveryGroupCreateParameters$Cells" : "A list of Cell arns", - "RecoveryGroupOutput$Cells" : "A list of Cell arns", - "RecoveryGroupUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list", - "Resource$ReadinessScopes" : "A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within." + "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 DNS Name that acts as ingress point to a portion of application", - "DNSTargetResource$HostedZoneArn" : "The Hosted Zone ARN that contains the DNS record with the provided name of target resource.", - "DNSTargetResource$RecordSetId" : "The R53 Set Id to uniquely identify a record given a Name and a Type", - "DNSTargetResource$RecordType" : "The Type of DNS Record of target resource", - "GetArchitectureRecommendationsOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection", - "GetCellReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "GetReadinessCheckResourceStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "GetReadinessCheckStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "GetRecoveryGroupReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListCellsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListCrossAccountAuthorizationsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListReadinessChecksResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListRecoveryGroupsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListResourceSetsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "ListRulesResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.", - "Message$MessageText" : "The text of a readiness check message", - "NLBResource$Arn" : "An NLB resource arn", - "R53ResourceRecord$DomainName" : "The DNS target name", - "R53ResourceRecord$RecordSetId" : "The Resource Record set id", - "ReadinessCheckCreateParameters$ReadinessCheckName" : "The name of the ReadinessCheck to create", - "ReadinessCheckCreateParameters$ResourceSetName" : "The name of the ResourceSet to check", - "ReadinessCheckSummary$ReadinessCheckName" : "The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell", - "ReadinessCheckUpdateParameters$ResourceSetName" : "The name of the ResourceSet to check", - "Recommendation$RecommendationText" : "Guidance text for recommendation", - "RecoveryGroupCreateParameters$RecoveryGroupName" : "The name of the RecoveryGroup to create", - "Resource$ComponentId" : "The component id of the resource, generated by the service when dnsTargetResource is used", - "Resource$ResourceArn" : "The ARN of the AWS resource, can be skipped if dnsTargetResource is used", - "ResourceResult$ComponentId" : "The component id of the resource", - "ResourceResult$ResourceArn" : "The ARN of the resource", - "ResourceSetCreateParameters$ResourceSetName" : "The name of the ResourceSet to create", - "RuleResult$RuleId" : "The identifier of the rule.", + "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 } @@ -396,37 +396,37 @@ "__stringMax256" : { "base" : null, "refs" : { - "CellOutput$CellArn" : "The arn for the Cell", - "ListRulesOutput$RuleDescription" : "A description of the rule", - "ReadinessCheckOutput$ReadinessCheckArn" : "Arn associated with ReadinessCheck", - "RecoveryGroupOutput$RecoveryGroupArn" : "The arn for the RecoveryGroup", - "ResourceSetOutput$ResourceSetArn" : "The arn for the ResourceSet" + "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 the rule applies to.", - "ListRulesOutput$RuleId" : "The Rule's ID." + "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 for a ReadinessCheck", - "ReadinessCheckOutput$ResourceSet" : "Name of the ResourceSet to be checked", - "RecoveryGroupOutput$RecoveryGroupName" : "The name of the RecoveryGroup", - "ResourceSetOutput$ResourceSetName" : "The name of the ResourceSet" + "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" : "AWS Resource type of the resources in the ResourceSet", - "ResourceSetOutput$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet", - "ResourceSetUpdateParameters$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet" + "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
" } } } -} +} \ No newline at end of file diff --git a/service/route53recoveryreadiness/api.go b/service/route53recoveryreadiness/api.go index f2ff453b09f..2080f00ec0d 100644 --- a/service/route53recoveryreadiness/api.go +++ b/service/route53recoveryreadiness/api.go @@ -57,7 +57,7 @@ func (c *Route53RecoveryReadiness) CreateCellRequest(input *CreateCellInput) (re // CreateCell API operation for AWS Route53 Recovery Readiness. // -// Creates a new Cell. +// Creates a cell in an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -143,7 +143,9 @@ func (c *Route53RecoveryReadiness) CreateCrossAccountAuthorizationRequest(input // CreateCrossAccountAuthorization API operation for AWS Route53 Recovery Readiness. // -// Create a new cross account readiness authorization. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -229,7 +231,10 @@ func (c *Route53RecoveryReadiness) CreateReadinessCheckRequest(input *CreateRead // CreateReadinessCheck API operation for AWS Route53 Recovery Readiness. // -// Creates a new Readiness Check. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -315,7 +320,8 @@ func (c *Route53RecoveryReadiness) CreateRecoveryGroupRequest(input *CreateRecov // CreateRecoveryGroup API operation for AWS Route53 Recovery Readiness. // -// Creates a new Recovery Group. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -401,7 +407,9 @@ func (c *Route53RecoveryReadiness) CreateResourceSetRequest(input *CreateResourc // CreateResourceSet API operation for AWS Route53 Recovery Readiness. // -// Creates a new Resource Set. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -488,7 +496,8 @@ func (c *Route53RecoveryReadiness) DeleteCellRequest(input *DeleteCellInput) (re // DeleteCell API operation for AWS Route53 Recovery Readiness. // -// Deletes an existing Cell. +// Delete a cell. When successful, the response code is 204, with no response +// body. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -575,7 +584,7 @@ func (c *Route53RecoveryReadiness) DeleteCrossAccountAuthorizationRequest(input // DeleteCrossAccountAuthorization API operation for AWS Route53 Recovery Readiness. // -// Delete cross account readiness authorization +// Deletes cross account readiness authorization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -660,7 +669,7 @@ func (c *Route53RecoveryReadiness) DeleteReadinessCheckRequest(input *DeleteRead // DeleteReadinessCheck API operation for AWS Route53 Recovery Readiness. // -// Deletes an existing Readiness Check. +// Deletes a readiness check. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -747,7 +756,7 @@ func (c *Route53RecoveryReadiness) DeleteRecoveryGroupRequest(input *DeleteRecov // DeleteRecoveryGroup API operation for AWS Route53 Recovery Readiness. // -// Deletes an existing Recovery Group. +// Deletes a recovery group. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -834,7 +843,7 @@ func (c *Route53RecoveryReadiness) DeleteResourceSetRequest(input *DeleteResourc // DeleteResourceSet API operation for AWS Route53 Recovery Readiness. // -// Deletes an existing Resource Set. +// Deletes a resource set. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -920,8 +929,8 @@ func (c *Route53RecoveryReadiness) GetArchitectureRecommendationsRequest(input * // GetArchitectureRecommendations API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of recommendations to improve resilliance and readiness -// check quality for a Recovery Group. +// Gets recommendations about architecture designs for improving resiliency +// for an application, based on a recovery group. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1007,7 +1016,9 @@ func (c *Route53RecoveryReadiness) GetCellRequest(input *GetCellInput) (req *req // GetCell API operation for AWS Route53 Recovery Readiness. // -// Returns information about a Cell. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1099,7 +1110,8 @@ func (c *Route53RecoveryReadiness) GetCellReadinessSummaryRequest(input *GetCell // GetCellReadinessSummary API operation for AWS Route53 Recovery Readiness. // -// Returns information about readiness of a Cell. +// Gets readiness for a cell. Aggregates the readiness of all the resources +// that are associated with the cell into a single value. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1237,7 +1249,7 @@ func (c *Route53RecoveryReadiness) GetReadinessCheckRequest(input *GetReadinessC // GetReadinessCheck API operation for AWS Route53 Recovery Readiness. // -// Returns information about a ReadinessCheck. +// Gets details about a readiness check. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1329,8 +1341,9 @@ func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatusRequest(input // GetReadinessCheckResourceStatus API operation for AWS Route53 Recovery Readiness. // -// Returns detailed information about the status of an individual resource within -// a Readiness Check's Resource Set. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1474,7 +1487,9 @@ func (c *Route53RecoveryReadiness) GetReadinessCheckStatusRequest(input *GetRead // GetReadinessCheckStatus API operation for AWS Route53 Recovery Readiness. // -// Returns information about the status of a Readiness Check. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1612,7 +1627,8 @@ func (c *Route53RecoveryReadiness) GetRecoveryGroupRequest(input *GetRecoveryGro // GetRecoveryGroup API operation for AWS Route53 Recovery Readiness. // -// Returns information about a Recovery Group. +// Gets details about a recovery group, including a list of the cells that are +// included in it. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1704,7 +1720,9 @@ func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummaryRequest(input // GetRecoveryGroupReadinessSummary API operation for AWS Route53 Recovery Readiness. // -// Returns information about a Recovery Group. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1842,7 +1860,8 @@ func (c *Route53RecoveryReadiness) GetResourceSetRequest(input *GetResourceSetIn // GetResourceSet API operation for AWS Route53 Recovery Readiness. // -// Returns information about a Resource Set. +// Displays the details about a resource set, including a list of the resources +// in the set. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1934,7 +1953,7 @@ func (c *Route53RecoveryReadiness) ListCellsRequest(input *ListCellsInput) (req // ListCells API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of Cells. +// Lists the cells for an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2076,7 +2095,8 @@ func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizationsRequest(input * // ListCrossAccountAuthorizations API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of cross account readiness authorizations. +// Lists the cross-account readiness authorizations that are in place for an +// account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2218,7 +2238,7 @@ func (c *Route53RecoveryReadiness) ListReadinessChecksRequest(input *ListReadine // ListReadinessChecks API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of Readiness Checks. +// Lists the readiness checks for an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2360,7 +2380,7 @@ func (c *Route53RecoveryReadiness) ListRecoveryGroupsRequest(input *ListRecovery // ListRecoveryGroups API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of Recovery Groups. +// Lists the recovery groups in an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2502,7 +2522,7 @@ func (c *Route53RecoveryReadiness) ListResourceSetsRequest(input *ListResourceSe // ListResourceSets API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of Resource Sets. +// Lists the resource sets in an account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2644,7 +2664,8 @@ func (c *Route53RecoveryReadiness) ListRulesRequest(input *ListRulesInput) (req // ListRules API operation for AWS Route53 Recovery Readiness. // -// Returns a collection of rules that are applied as part of Readiness Checks. +// Lists all readiness rules, or lists the readiness rules for a specific resource +// type. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2780,7 +2801,7 @@ func (c *Route53RecoveryReadiness) ListTagsForResourcesRequest(input *ListTagsFo // ListTagsForResources API operation for AWS Route53 Recovery Readiness. // -// Returns a list of the tags assigned to the specified resource. +// Lists the tags for a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2863,8 +2884,7 @@ func (c *Route53RecoveryReadiness) TagResourceRequest(input *TagResourceInput) ( // TagResource API operation for AWS Route53 Recovery Readiness. // -// Adds tags to the specified resource. You can specify one or more tags to -// add. +// Adds a tag to a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2947,8 +2967,7 @@ func (c *Route53RecoveryReadiness) UntagResourceRequest(input *UntagResourceInpu // UntagResource API operation for AWS Route53 Recovery Readiness. // -// Removes tags from the specified resource. You can specify one or more tags -// to remove. +// Removes a tag from a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3030,7 +3049,8 @@ func (c *Route53RecoveryReadiness) UpdateCellRequest(input *UpdateCellInput) (re // UpdateCell API operation for AWS Route53 Recovery Readiness. // -// Updates an existing Cell. +// Updates a cell to replace the list of nested cells with a new list of nested +// cells. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3116,7 +3136,7 @@ func (c *Route53RecoveryReadiness) UpdateReadinessCheckRequest(input *UpdateRead // UpdateReadinessCheck API operation for AWS Route53 Recovery Readiness. // -// Updates an exisiting Readiness Check. +// Updates a readiness check. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3202,7 +3222,7 @@ func (c *Route53RecoveryReadiness) UpdateRecoveryGroupRequest(input *UpdateRecov // UpdateRecoveryGroup API operation for AWS Route53 Recovery Readiness. // -// Updates an existing Recovery Group. +// Updates a recovery group. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3288,7 +3308,7 @@ func (c *Route53RecoveryReadiness) UpdateResourceSetRequest(input *UpdateResourc // UpdateResourceSet API operation for AWS Route53 Recovery Readiness. // -// Updates an existing Resource Set. +// Updates a resource set. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3393,31 +3413,33 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// A Cell and its properties +// Information about a cell. type CellOutput_ struct { _ struct{} `type:"structure"` - // The arn for the Cell + // The Amazon Resource Name (ARN) for the cell. // // CellArn is a required field CellArn *string `locationName:"cellArn" type:"string" required:"true"` - // The name of the Cell + // The name of the cell. // // CellName is a required field CellName *string `locationName:"cellName" type:"string" required:"true"` - // A list of Cell arns + // A list of cell ARNs. // // Cells is a required field Cells []*string `locationName:"cells" type:"list" required:"true"` - // A list of Cell ARNs and/or RecoveryGroup ARNs + // 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. // // ParentReadinessScopes is a required field ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list" required:"true"` - // A collection of tags associated with a resource + // Tags on the resources. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3540,7 +3562,7 @@ type CreateCellInput struct { Cells []*string `locationName:"cells" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3604,7 +3626,7 @@ type CreateCellOutput struct { ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3659,7 +3681,7 @@ func (s *CreateCellOutput) SetTags(v map[string]*string) *CreateCellOutput { type CreateCrossAccountAuthorizationInput struct { _ struct{} `type:"structure"` - // A cross-account authorization, e.g. arn:aws:iam::123456789012:root + // CrossAccountAuthorization // // CrossAccountAuthorization is a required field CrossAccountAuthorization *string `locationName:"crossAccountAuthorization" type:"string" required:"true"` @@ -3705,7 +3727,7 @@ func (s *CreateCrossAccountAuthorizationInput) SetCrossAccountAuthorization(v st type CreateCrossAccountAuthorizationOutput struct { _ struct{} `type:"structure"` - // A cross-account authorization, e.g. arn:aws:iam::123456789012:root + // CrossAccountAuthorization CrossAccountAuthorization *string `locationName:"crossAccountAuthorization" type:"string"` } @@ -3742,7 +3764,7 @@ type CreateReadinessCheckInput struct { // ResourceSetName is a required field ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3807,7 +3829,7 @@ type CreateReadinessCheckOutput struct { ResourceSet *string `locationName:"resourceSet" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3861,7 +3883,7 @@ type CreateRecoveryGroupInput struct { // RecoveryGroupName is a required field RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3923,7 +3945,7 @@ type CreateRecoveryGroupOutput struct { RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3981,7 +4003,7 @@ type CreateResourceSetInput struct { // Resources is a required field Resources []*Resource `locationName:"resources" type:"list" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -4057,7 +4079,7 @@ type CreateResourceSetOutput struct { Resources []*Resource `locationName:"resources" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -4109,24 +4131,26 @@ func (s *CreateResourceSetOutput) SetTags(v map[string]*string) *CreateResourceS return s } -// A component for DNS/Routing Control Readiness Checks +// A component for DNS/routing control readiness checks and architecture checks. type DNSTargetResource struct { _ struct{} `type:"structure"` - // The DNS Name that acts as ingress point to a portion of application + // The domain name that acts as an ingress point to a portion of the customer + // application. DomainName *string `locationName:"domainName" type:"string"` - // The Hosted Zone ARN that contains the DNS record with the provided name of - // target resource. + // The hosted zone Amazon Resource Name (ARN) that contains the DNS record with + // the provided name of the target resource. HostedZoneArn *string `locationName:"hostedZoneArn" type:"string"` - // The R53 Set Id to uniquely identify a record given a Name and a Type + // The Route 53 record set ID that uniquely identifies a DNS record, given a + // name and a type. RecordSetId *string `locationName:"recordSetId" type:"string"` - // The Type of DNS Record of target resource + // The type of DNS record of the target resource. RecordType *string `locationName:"recordType" type:"string"` - // The target resource the R53 record points to + // The target resource of the DNS target resource. TargetResource *TargetResource `locationName:"targetResource" type:"structure"` } @@ -4592,8 +4616,8 @@ func (s *GetArchitectureRecommendationsInput) SetRecoveryGroupName(v string) *Ge type GetArchitectureRecommendationsOutput struct { _ struct{} `type:"structure"` - // The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 - // format + // The time that a recovery group was last assessed for recommendations, in + // UTC ISO-8601 format. LastAuditTimestamp *time.Time `locationName:"lastAuditTimestamp" type:"timestamp" timestampFormat:"iso8601"` NextToken *string `locationName:"nextToken" type:"string"` @@ -4695,7 +4719,7 @@ type GetCellOutput struct { ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -4818,7 +4842,7 @@ type GetCellReadinessSummaryOutput struct { NextToken *string `locationName:"nextToken" type:"string"` - // The readiness of an entire ReadinessCheck or an individual resource ARN. + // The readiness status. Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"` ReadinessChecks []*ReadinessCheckSummary `locationName:"readinessChecks" type:"list"` @@ -4916,7 +4940,7 @@ type GetReadinessCheckOutput struct { ResourceSet *string `locationName:"resourceSet" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5048,7 +5072,7 @@ type GetReadinessCheckResourceStatusOutput struct { NextToken *string `locationName:"nextToken" type:"string"` - // The readiness of an entire ReadinessCheck or an individual resource ARN. + // The readiness status. Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"` Rules []*RuleResult `locationName:"rules" type:"list"` @@ -5163,7 +5187,7 @@ type GetReadinessCheckStatusOutput struct { NextToken *string `locationName:"nextToken" type:"string"` - // The readiness of an entire ReadinessCheck or an individual resource ARN. + // The readiness status. Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"` Resources []*ResourceResult `locationName:"resources" type:"list"` @@ -5267,7 +5291,7 @@ type GetRecoveryGroupOutput struct { RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5384,7 +5408,7 @@ type GetRecoveryGroupReadinessSummaryOutput struct { NextToken *string `locationName:"nextToken" type:"string"` - // The readiness of an entire ReadinessCheck or an individual resource ARN. + // The readiness status. Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"` ReadinessChecks []*ReadinessCheckSummary `locationName:"readinessChecks" type:"list"` @@ -5484,7 +5508,7 @@ type GetResourceSetOutput struct { Resources []*Resource `locationName:"resources" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6141,21 +6165,22 @@ func (s *ListRulesOutput) SetRules(v []*ListRulesOutput_) *ListRulesOutput { return s } -// A collection of rules used in a readiness check +// Readiness rule information, including the resource type, rule ID, and rule +// description. type ListRulesOutput_ struct { _ struct{} `type:"structure"` - // The resource type the rule applies to. + // The resource type that the readiness rule applies to. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" type:"string" required:"true"` - // A description of the rule + // The description of a readiness rule. // // RuleDescription is a required field RuleDescription *string `locationName:"ruleDescription" type:"string" required:"true"` - // The Rule's ID. + // The ID for the readiness rule. // // RuleId is a required field RuleId *string `locationName:"ruleId" type:"string" required:"true"` @@ -6247,7 +6272,7 @@ func (s *ListTagsForResourcesInput) SetResourceArn(v string) *ListTagsForResourc type ListTagsForResourcesOutput struct { _ struct{} `type:"structure"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6275,11 +6300,11 @@ func (s *ListTagsForResourcesOutput) SetTags(v map[string]*string) *ListTagsForR return s } -// Information relating to readiness check status +// Information relating to readiness check status. type Message struct { _ struct{} `type:"structure"` - // The text of a readiness check message + // The text of a readiness check message. MessageText *string `locationName:"messageText" type:"string"` } @@ -6307,11 +6332,11 @@ func (s *Message) SetMessageText(v string) *Message { return s } -// The NLB resource a DNS Target Resource points to +// The Network Load Balancer resource that a DNS target resource points to. type NLBResource struct { _ struct{} `type:"structure"` - // An NLB resource arn + // The Network Load Balancer resource Amazon Resource Name (ARN). Arn *string `locationName:"arn" type:"string"` } @@ -6339,14 +6364,14 @@ func (s *NLBResource) SetArn(v string) *NLBResource { return s } -// The Route 53 resource a DNS Target Resource record points to +// The Route 53 resource that a DNS target resource record points to. type R53ResourceRecord struct { _ struct{} `type:"structure"` - // The DNS target name + // The DNS target domain name. DomainName *string `locationName:"domainName" type:"string"` - // The Resource Record set id + // The Route 53 Resource Record Set ID. RecordSetId *string `locationName:"recordSetId" type:"string"` } @@ -6380,24 +6405,24 @@ func (s *R53ResourceRecord) SetRecordSetId(v string) *R53ResourceRecord { return s } -// A resource used for checking the readiness of a Resource Set +// A readiness check. type ReadinessCheckOutput_ struct { _ struct{} `type:"structure"` - // Arn associated with ReadinessCheck + // The Amazon Resource Name (ARN) associated with a readiness check. // // ReadinessCheckArn is a required field ReadinessCheckArn *string `locationName:"readinessCheckArn" type:"string" required:"true"` - // Name for a ReadinessCheck + // Name of a readiness check. ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"` - // Name of the ResourceSet to be checked + // Name of the resource set to be checked. // // ResourceSet is a required field ResourceSet *string `locationName:"resourceSet" type:"string" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6443,16 +6468,15 @@ func (s *ReadinessCheckOutput_) SetTags(v map[string]*string) *ReadinessCheckOut return s } -// Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary -// and GetCellReadinessSummary +// Summary of all readiness check statuses in a recovery group, paginated in +// GetRecoveryGroupReadinessSummary and GetCellReadinessSummary. type ReadinessCheckSummary struct { _ struct{} `type:"structure"` - // The readiness of this ReadinessCheck + // The readiness status of this readiness check. Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"` - // The name of a ReadinessCheck which is part of the given RecoveryGroup or - // Cell + // The name of a readiness check. ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"` } @@ -6486,11 +6510,12 @@ func (s *ReadinessCheckSummary) SetReadinessCheckName(v string) *ReadinessCheckS return s } -// Guidance for improving Recovery Group resilliancy +// Recommendations that are provided to make an application more recovery resilient. type Recommendation struct { _ struct{} `type:"structure"` - // Guidance text for recommendation + // Text of the recommendations that are provided to make an application more + // recovery resilient. // // RecommendationText is a required field RecommendationText *string `locationName:"recommendationText" type:"string" required:"true"` @@ -6520,26 +6545,26 @@ func (s *Recommendation) SetRecommendationText(v string) *Recommendation { return s } -// A Recovery Group generally containing multiple Cells +// A representation of the application, typically containing multiple cells. type RecoveryGroupOutput_ struct { _ struct{} `type:"structure"` - // A list of Cell arns + // A list of a cell's Amazon Resource Names (ARNs). // // Cells is a required field Cells []*string `locationName:"cells" type:"list" required:"true"` - // The arn for the RecoveryGroup + // The Amazon Resource Name (ARN) for the recovery group. // // RecoveryGroupArn is a required field RecoveryGroupArn *string `locationName:"recoveryGroupArn" type:"string" required:"true"` - // The name of the RecoveryGroup + // The name of the recovery group. // // RecoveryGroupName is a required field RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string" required:"true"` - // A collection of tags associated with a resource + // The tags associated with the recovery group. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6585,22 +6610,22 @@ func (s *RecoveryGroupOutput_) SetTags(v map[string]*string) *RecoveryGroupOutpu return s } -// The resource element of a ResourceSet +// The resource element of a resource set. type Resource struct { _ struct{} `type:"structure"` - // The component id of the resource, generated by the service when dnsTargetResource - // is used + // The component identifier of the resource, generated when DNS target resource + // is used. ComponentId *string `locationName:"componentId" type:"string"` - // A component for DNS/Routing Control Readiness Checks + // The DNS target resource. DnsTargetResource *DNSTargetResource `locationName:"dnsTargetResource" type:"structure"` - // A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained - // within. + // A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that + // this resource is contained within. ReadinessScopes []*string `locationName:"readinessScopes" type:"list"` - // The ARN of the AWS resource, can be skipped if dnsTargetResource is used + // The Amazon Resource Name (ARN) of the Amazon Web Services resource. ResourceArn *string `locationName:"resourceArn" type:"string"` } @@ -6709,25 +6734,26 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Result with status for an individual resource. +// The result of a successful Resource request, with status for an individual +// resource. type ResourceResult struct { _ struct{} `type:"structure"` - // The component id of the resource + // The component id of the resource. ComponentId *string `locationName:"componentId" type:"string"` - // The time the resource was last checked for readiness, in ISO-8601 format, - // UTC. + // The time (UTC) that the resource was last checked for readiness, in ISO-8601 + // format. // // LastCheckedTimestamp is a required field LastCheckedTimestamp *time.Time `locationName:"lastCheckedTimestamp" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // The readiness of the resource. + // The readiness of a resource. // // Readiness is a required field Readiness *string `locationName:"readiness" type:"string" required:"true" enum:"Readiness"` - // The ARN of the resource + // The Amazon Resource Name (ARN) of the resource. ResourceArn *string `locationName:"resourceArn" type:"string"` } @@ -6773,31 +6799,39 @@ func (s *ResourceResult) SetResourceArn(v string) *ResourceResult { return s } -// A collection of resources of the same type +// A collection of resources of the same type. type ResourceSetOutput_ struct { _ struct{} `type:"structure"` - // The arn for the ResourceSet + // The Amazon Resource Name (ARN) for the resource set. // // ResourceSetArn is a required field ResourceSetArn *string `locationName:"resourceSetArn" type:"string" required:"true"` - // The name of the ResourceSet + // The name of the resource set. // // ResourceSetName is a required field ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"` - // AWS Resource Type of the resources in the ResourceSet + // 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 // // ResourceSetType is a required field ResourceSetType *string `locationName:"resourceSetType" type:"string" required:"true"` - // A list of Resource objects + // A list of resource objects. // // Resources is a required field Resources []*Resource `locationName:"resources" type:"list" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6849,7 +6883,7 @@ func (s *ResourceSetOutput_) SetTags(v map[string]*string) *ResourceSetOutput_ { return s } -// Result with status for an individual rule.. +// The result of a successful Rule request, with status for an individual rule. type RuleResult struct { _ struct{} `type:"structure"` @@ -6859,7 +6893,7 @@ type RuleResult struct { // LastCheckedTimestamp is a required field LastCheckedTimestamp *time.Time `locationName:"lastCheckedTimestamp" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Details about the resource's readiness + // Details about the resource's readiness. // // Messages is a required field Messages []*Message `locationName:"messages" type:"list" required:"true"` @@ -6923,7 +6957,7 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` @@ -7000,14 +7034,14 @@ func (s TagResourceOutput) GoString() string { return s.String() } -// The target resource the R53 record points to +// The target resource that the Route 53 record points to. type TargetResource struct { _ struct{} `type:"structure"` - // The NLB resource a DNS Target Resource points to + // The Network Load Balancer Resource. NLBResource *NLBResource `locationName:"nLBResource" type:"structure"` - // The Route 53 resource a DNS Target Resource record points to + // The Route 53 resource. R53Resource *R53ResourceRecord `locationName:"r53Resource" type:"structure"` } @@ -7255,7 +7289,7 @@ type UpdateCellOutput struct { ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7375,7 +7409,7 @@ type UpdateReadinessCheckOutput struct { ResourceSet *string `locationName:"resourceSet" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7489,7 +7523,7 @@ type UpdateRecoveryGroupOutput struct { RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7617,7 +7651,7 @@ type UpdateResourceSetOutput struct { Resources []*Resource `locationName:"resources" type:"list"` - // A collection of tags associated with a resource + // A collection of tags associated with a resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7732,7 +7766,7 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } -// The readiness of an entire ReadinessCheck or an individual resource ARN. +// The readiness status. const ( // ReadinessReady is a Readiness enum value ReadinessReady = "READY" diff --git a/service/route53recoveryreadiness/doc.go b/service/route53recoveryreadiness/doc.go index b04626ff1b7..dc814a61ee5 100644 --- a/service/route53recoveryreadiness/doc.go +++ b/service/route53recoveryreadiness/doc.go @@ -3,7 +3,7 @@ // Package route53recoveryreadiness provides the client and types for making API // requests to AWS Route53 Recovery Readiness. // -// AWS Route53 Recovery Readiness +// Recovery readiness // // See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02 for more information on this service. //