# Resources
<a name="resources"></a>

The Amazon Route 53 Application Recovery Controller REST API includes the following resources.

**Topics**
+ [

# DeleteCrossAccountAuthorization
](crossaccountauthorizations-crossaccountauthorization.md)
+ [

# GetArchitectureRecommendations
](recoverygroups-recoverygroupname-architecturerecommendations.md)
+ [

# GetCell, UpdateCell, DeleteCell
](cells-cellname.md)
+ [

# GetCellReadinessSummary
](cellreadiness-cellname.md)
+ [

# GetReadinessCheck, UpdateReadinessCheck, DeleteReadinessCheck
](readinesschecks-readinesscheckname.md)
+ [

# GetReadinessCheckResourceStatus
](readinesschecks-readinesscheckname-resource-resourceidentifier-status.md)
+ [

# GetReadinessCheckStatus
](readinesschecks-readinesscheckname-status.md)
+ [

# GetRecoveryGroup, UpdateRecoveryGroup, DeleteRecoveryGroup
](recoverygroups-recoverygroupname.md)
+ [

# GetRecoveryGroupReadinessSummary
](recoverygroupreadiness-recoverygroupname.md)
+ [

# GetResourceSet, UpdateResourceSet, DeleteResourceSet
](resourcesets-resourcesetname.md)
+ [

# ListCells, CreateCell
](cells.md)
+ [

# ListCrossAccountAuthorizations, CreateCrossAccountAuthorization
](crossaccountauthorizations.md)
+ [

# ListReadinessChecks, CreateReadinessCheck
](readinesschecks.md)
+ [

# ListRecoveryGroups, CreateRecoveryGroup
](recoverygroups.md)
+ [

# ListResourceSets, CreateResourceSet
](resourcesets.md)
+ [

# ListRules
](rules.md)
+ [

# ListTagsForResources, TagResource, UntagResource
](tags-resource-arn.md)

# DeleteCrossAccountAuthorization
<a name="crossaccountauthorizations-crossaccountauthorization"></a>

## URI
<a name="crossaccountauthorizations-crossaccountauthorization-url"></a>

`/crossaccountauthorizations/crossAccountAuthorization`

## HTTP methods
<a name="crossaccountauthorizations-crossaccountauthorization-http-methods"></a>

### DELETE
<a name="crossaccountauthorizations-crossaccountauthorizationdelete"></a>

**Operation ID:** `DeleteCrossAccountAuthorization`

Deletes cross account readiness authorization.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| crossAccountAuthorization | String | True | The cross-account authorization. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | DeleteCrossAccountAuthorizationResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="crossaccountauthorizations-crossaccountauthorizationoptions"></a>

Enables CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| crossAccountAuthorization | String | True | The cross-account authorization. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="crossaccountauthorizations-crossaccountauthorization-schemas"></a>

### Response bodies
<a name="crossaccountauthorizations-crossaccountauthorization-response-examples"></a>

#### DeleteCrossAccountAuthorizationResult schema
<a name="crossaccountauthorizations-crossaccountauthorization-response-body-deletecrossaccountauthorizationresult-example"></a>

```
{
}
```

## Properties
<a name="crossaccountauthorizations-crossaccountauthorization-properties"></a>

### DeleteCrossAccountAuthorizationResult
<a name="crossaccountauthorizations-crossaccountauthorization-model-deletecrossaccountauthorizationresult"></a>

A successful `DeleteCrossAccountAuthorization` request returns no response.

## See also
<a name="crossaccountauthorizations-crossaccountauthorization-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### DeleteCrossAccountAuthorization
<a name="DeleteCrossAccountAuthorization-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteCrossAccountAuthorization)

# GetArchitectureRecommendations
<a name="recoverygroups-recoverygroupname-architecturerecommendations"></a>

## URI
<a name="recoverygroups-recoverygroupname-architecturerecommendations-url"></a>

`/recoverygroups/recoveryGroupName/architectureRecommendations`

## HTTP methods
<a name="recoverygroups-recoverygroupname-architecturerecommendations-http-methods"></a>

### GET
<a name="recoverygroups-recoverygroupname-architecturerecommendationsget"></a>

**Operation ID:** `GetArchitectureRecommendations`

Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetArchitectureRecommendationsOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="recoverygroups-recoverygroupname-architecturerecommendationsoptions"></a>

Enables CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="recoverygroups-recoverygroupname-architecturerecommendations-schemas"></a>

### Response bodies
<a name="recoverygroups-recoverygroupname-architecturerecommendations-response-examples"></a>

#### GetArchitectureRecommendationsOutput schema
<a name="recoverygroups-recoverygroupname-architecturerecommendations-response-body-getarchitecturerecommendationsoutput-example"></a>

```
{
  "lastAuditTimestamp": "string",
  "nextToken": "string",
  "recommendations": [
    {
      "recommendationText": "string"
    }
  ]
}
```

## Properties
<a name="recoverygroups-recoverygroupname-architecturerecommendations-properties"></a>

### GetArchitectureRecommendationsOutput
<a name="recoverygroups-recoverygroupname-architecturerecommendations-model-getarchitecturerecommendationsoutput"></a>

Result from `GetArchitectureRecommendations` call.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| lastAuditTimestamp | string | True | The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format. | 
| nextToken | string | False | The token that identifies which batch of results you want to see. | 
| recommendations | Array of type [Recommendation](#recoverygroups-recoverygroupname-architecturerecommendations-model-recommendation) | True | A list of the recommendations for the customer's application. | 

### Recommendation
<a name="recoverygroups-recoverygroupname-architecturerecommendations-model-recommendation"></a>

Recommendations that are provided to make an application more recovery resilient.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| recommendationText | string | True | Text of the recommendations that are provided to make an application more recovery resilient. | 

## See also
<a name="recoverygroups-recoverygroupname-architecturerecommendations-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetArchitectureRecommendations
<a name="GetArchitectureRecommendations-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetArchitectureRecommendations)

# GetCell, UpdateCell, DeleteCell
<a name="cells-cellname"></a>

## URI
<a name="cells-cellname-url"></a>

`/cells/cellName`

## HTTP methods
<a name="cells-cellname-http-methods"></a>

### GET
<a name="cells-cellnameget"></a>

**Operation ID:** `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.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | CellOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### PUT
<a name="cells-cellnameput"></a>

**Operation ID:** `UpdateCell`

Updates a cell to replace the list of nested cells with a new list of nested cells.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | CellOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### DELETE
<a name="cells-cellnamedelete"></a>

**Operation ID:** `DeleteCell`

Delete a cell. When successful, the response code is 204, with no response body.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="cells-cellnameoptions"></a>

Enable CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="cells-cellname-schemas"></a>

### Request bodies
<a name="cells-cellname-request-examples"></a>

#### PUT schema
<a name="cells-cellname-request-body-put-example"></a>

```
{
  "cells": [
    "string"
  ]
}
```

### Response bodies
<a name="cells-cellname-response-examples"></a>

#### CellOutput schema
<a name="cells-cellname-response-body-celloutput-example"></a>

```
{
  "cells": [
    "string"
  ],
  "parentReadinessScopes": [
    "string"
  ],
  "cellName": "string",
  "cellArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="cells-cellname-properties"></a>

### CellOutput
<a name="cells-cellname-model-celloutput"></a>

Information about a cell.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cellArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the cell. | 
| cellName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the cell. | 
| cells | Array of type string | True | A list of cell ARNs. | 
| parentReadinessScopes | Array of type string | True | 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. | 
| tags | [Tags](#cells-cellname-model-tags) | False | Tags on the resources. | 

### CellUpdateParameters
<a name="cells-cellname-model-cellupdateparameters"></a>

Parameters used to update a cell.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type string | True | A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list. | 

### Tags
<a name="cells-cellname-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="cells-cellname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetCell
<a name="GetCell-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetCell)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetCell)

### UpdateCell
<a name="UpdateCell-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UpdateCell)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UpdateCell)

### DeleteCell
<a name="DeleteCell-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteCell)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteCell)

# GetCellReadinessSummary
<a name="cellreadiness-cellname"></a>

## URI
<a name="cellreadiness-cellname-url"></a>

`/cellreadiness/cellName`

## HTTP methods
<a name="cellreadiness-cellname-http-methods"></a>

### GET
<a name="cellreadiness-cellnameget"></a>

**Operation ID:** `GetCellReadinessSummary`

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetCellReadinessSummaryOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="cellreadiness-cellnameoptions"></a>

Enable CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | String | True | The name of the cell. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="cellreadiness-cellname-schemas"></a>

### Response bodies
<a name="cellreadiness-cellname-response-examples"></a>

#### GetCellReadinessSummaryOutput schema
<a name="cellreadiness-cellname-response-body-getcellreadinesssummaryoutput-example"></a>

```
{
  "nextToken": "string",
  "readiness": enum,
  "readinessChecks": [
    {
      "readinessCheckName": "string",
      "readiness": enum
    }
  ]
}
```

## Properties
<a name="cellreadiness-cellname-properties"></a>

### GetCellReadinessSummaryOutput
<a name="cellreadiness-cellname-model-getcellreadinesssummaryoutput"></a>

Result of a `GetReadinessCellSummary` operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | True | The token that identifies which batch of results you want to see. | 
| readiness | [Readiness](#cellreadiness-cellname-model-readiness) | True | The readiness at a cell level. | 
| readinessChecks | Array of type [ReadinessCheckSummary](#cellreadiness-cellname-model-readinesschecksummary) | True | Summaries for the readiness checks that make up the cell. | 

### Readiness
<a name="cellreadiness-cellname-model-readiness"></a>

The readiness status.
+ `READY`
+ `NOT_READY`
+ `UNKNOWN`
+ `NOT_AUTHORIZED`

### ReadinessCheckSummary
<a name="cellreadiness-cellname-model-readinesschecksummary"></a>

Summary of all readiness check statuses in a recovery group, paginated in `GetRecoveryGroupReadinessSummary` and `GetCellReadinessSummary`.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| readiness | [Readiness](#cellreadiness-cellname-model-readiness) | False | The readiness status of this readiness check. | 
| readinessCheckName | string | False | The name of a readiness check. | 

## See also
<a name="cellreadiness-cellname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetCellReadinessSummary
<a name="GetCellReadinessSummary-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetCellReadinessSummary)

# GetReadinessCheck, UpdateReadinessCheck, DeleteReadinessCheck
<a name="readinesschecks-readinesscheckname"></a>

## URI
<a name="readinesschecks-readinesscheckname-url"></a>

`/readinesschecks/readinessCheckName`

## HTTP methods
<a name="readinesschecks-readinesscheckname-http-methods"></a>

### GET
<a name="readinesschecks-readinesschecknameget"></a>

**Operation ID:** `GetReadinessCheck`

Gets details about a readiness check.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ReadinessCheckOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### PUT
<a name="readinesschecks-readinesschecknameput"></a>

**Operation ID:** `UpdateReadinessCheck`

Updates a readiness check.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ReadinessCheckOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### DELETE
<a name="readinesschecks-readinesschecknamedelete"></a>

**Operation ID:** `DeleteReadinessCheck`

Deletes a readiness check.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="readinesschecks-readinesschecknameoptions"></a>

Enables CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="readinesschecks-readinesscheckname-schemas"></a>

### Request bodies
<a name="readinesschecks-readinesscheckname-request-examples"></a>

#### PUT schema
<a name="readinesschecks-readinesscheckname-request-body-put-example"></a>

```
{
  "resourceSetName": "string"
}
```

### Response bodies
<a name="readinesschecks-readinesscheckname-response-examples"></a>

#### ReadinessCheckOutput schema
<a name="readinesschecks-readinesscheckname-response-body-readinesscheckoutput-example"></a>

```
{
  "resourceSet": "string",
  "readinessCheckName": "string",
  "readinessCheckArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="readinesschecks-readinesscheckname-properties"></a>

### ReadinessCheckOutput
<a name="readinesschecks-readinesscheckname-model-readinesscheckoutput"></a>

A readiness check.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) associated with a readiness check. | 
| readinessCheckName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | False | Name of a readiness check. | 
| resourceSet | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | Name of the resource set to be checked. | 
| tags | [Tags](#readinesschecks-readinesscheckname-model-tags) | False |  | 

### ReadinessCheckUpdateParameters
<a name="readinesschecks-readinesscheckname-model-readinesscheckupdateparameters"></a>

Parameter used to create or update a readiness check.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceSetName | string | True | The name of the resource set to be checked. | 

### Tags
<a name="readinesschecks-readinesscheckname-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="readinesschecks-readinesscheckname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetReadinessCheck
<a name="GetReadinessCheck-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetReadinessCheck)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetReadinessCheck)

### UpdateReadinessCheck
<a name="UpdateReadinessCheck-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UpdateReadinessCheck)

### DeleteReadinessCheck
<a name="DeleteReadinessCheck-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteReadinessCheck)

# GetReadinessCheckResourceStatus
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status"></a>

## URI
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-url"></a>

`/readinesschecks/readinessCheckName/resource/resourceIdentifier/status`

## HTTP methods
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-http-methods"></a>

### GET
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-statusget"></a>

**Operation ID:** `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`.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 
| resourceIdentifier | String | True | The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource). | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetReadinessCheckResourceStatusOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-statusoptions"></a>


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 
| resourceIdentifier | String | True | The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource). | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-schemas"></a>

### Response bodies
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-response-examples"></a>

#### GetReadinessCheckResourceStatusOutput schema
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-response-body-getreadinesscheckresourcestatusoutput-example"></a>

```
{
  "nextToken": "string",
  "readiness": enum,
  "rules": [
    {
      "readiness": enum,
      "messages": [
        {
          "messageText": "string"
        }
      ],
      "lastCheckedTimestamp": "string",
      "ruleId": "string"
    }
  ]
}
```

## Properties
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-properties"></a>

### GetReadinessCheckResourceStatusOutput
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-getreadinesscheckresourcestatusoutput"></a>

Result of a `GetReadinessCheckResourceStatus` operation.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | True | The token that identifies which batch of results you want to see. | 
| readiness | [Readiness](#readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-readiness) | True | The readiness at a rule level. | 
| rules | Array of type [RuleResult](#readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-ruleresult) | True | Details of the rule's results. | 

### Message
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-message"></a>

Information relating to readiness check status.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| messageText | string | False | The text of a readiness check message. | 

### Readiness
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-readiness"></a>

The readiness status.
+ `READY`
+ `NOT_READY`
+ `UNKNOWN`
+ `NOT_AUTHORIZED`

### RuleResult
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-ruleresult"></a>

The result of a successful `Rule` request, with status for an individual rule.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| lastCheckedTimestamp | string | True | The time the resource was last checked for readiness, in ISO-8601 format, UTC. | 
| messages | Array of type [Message](#readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-message) | True | Details about the resource's readiness. | 
| readiness | [Readiness](#readinesschecks-readinesscheckname-resource-resourceidentifier-status-model-readiness) | True | The readiness at rule level. | 
| ruleId | string | True | The identifier of the rule. | 

## See also
<a name="readinesschecks-readinesscheckname-resource-resourceidentifier-status-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetReadinessCheckResourceStatus
<a name="GetReadinessCheckResourceStatus-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetReadinessCheckResourceStatus)

# GetReadinessCheckStatus
<a name="readinesschecks-readinesscheckname-status"></a>

## URI
<a name="readinesschecks-readinesscheckname-status-url"></a>

`/readinesschecks/readinessCheckName/status`

## HTTP methods
<a name="readinesschecks-readinesscheckname-status-http-methods"></a>

### GET
<a name="readinesschecks-readinesscheckname-statusget"></a>

**Operation ID:** `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`.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetReadinessCheckStatusOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="readinesschecks-readinesscheckname-statusoptions"></a>

Enables CORS by returning correct headers.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | String | True | Name of a readiness check. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="readinesschecks-readinesscheckname-status-schemas"></a>

### Response bodies
<a name="readinesschecks-readinesscheckname-status-response-examples"></a>

#### GetReadinessCheckStatusOutput schema
<a name="readinesschecks-readinesscheckname-status-response-body-getreadinesscheckstatusoutput-example"></a>

```
{
  "nextToken": "string",
  "readiness": enum,
  "messages": [
    {
      "messageText": "string"
    }
  ],
  "resources": [
    {
      "componentId": "string",
      "readiness": enum,
      "resourceArn": "string",
      "lastCheckedTimestamp": "string"
    }
  ]
}
```

## Properties
<a name="readinesschecks-readinesscheckname-status-properties"></a>

### GetReadinessCheckStatusOutput
<a name="readinesschecks-readinesscheckname-status-model-getreadinesscheckstatusoutput"></a>

Result of a `GetReadinessCheckStatus` operation.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| messages | Array of type [Message](#readinesschecks-readinesscheckname-status-model-message) | True | Top level messages for readiness check status | 
| nextToken | string | True | The token that identifies which batch of results you want to see. | 
| readiness | [Readiness](#readinesschecks-readinesscheckname-status-model-readiness) | True | The readiness at rule level. | 
| resources | Array of type [ResourceResult](#readinesschecks-readinesscheckname-status-model-resourceresult) | True | Summary of the readiness of resources. | 

### Message
<a name="readinesschecks-readinesscheckname-status-model-message"></a>

Information relating to readiness check status.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| messageText | string | False | The text of a readiness check message. | 

### Readiness
<a name="readinesschecks-readinesscheckname-status-model-readiness"></a>

The readiness status.
+ `READY`
+ `NOT_READY`
+ `UNKNOWN`
+ `NOT_AUTHORIZED`

### ResourceResult
<a name="readinesschecks-readinesscheckname-status-model-resourceresult"></a>

The result of a successful `Resource` request, with status for an individual resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| componentId | string | False | The component id of the resource. | 
| lastCheckedTimestamp | string | True | The time (UTC) that the resource was last checked for readiness, in ISO-8601 format. | 
| readiness | [Readiness](#readinesschecks-readinesscheckname-status-model-readiness) | True | The readiness of a resource. | 
| resourceArn | string | False | The Amazon Resource Name (ARN) of the resource. | 

## See also
<a name="readinesschecks-readinesscheckname-status-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetReadinessCheckStatus
<a name="GetReadinessCheckStatus-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetReadinessCheckStatus)

# GetRecoveryGroup, UpdateRecoveryGroup, DeleteRecoveryGroup
<a name="recoverygroups-recoverygroupname"></a>

## URI
<a name="recoverygroups-recoverygroupname-url"></a>

`/recoverygroups/recoveryGroupName`

## HTTP methods
<a name="recoverygroups-recoverygroupname-http-methods"></a>

### GET
<a name="recoverygroups-recoverygroupnameget"></a>

**Operation ID:** `GetRecoveryGroup`

Gets details about a recovery group, including a list of the cells that are included in it.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | RecoveryGroupOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### PUT
<a name="recoverygroups-recoverygroupnameput"></a>

**Operation ID:** `UpdateRecoveryGroup`

Updates a recovery group.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | RecoveryGroupOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### DELETE
<a name="recoverygroups-recoverygroupnamedelete"></a>

**Operation ID:** `DeleteRecoveryGroup`

Deletes a recovery group.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="recoverygroups-recoverygroupnameoptions"></a>

Enable CORS by returning correct headers 


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="recoverygroups-recoverygroupname-schemas"></a>

### Request bodies
<a name="recoverygroups-recoverygroupname-request-examples"></a>

#### PUT schema
<a name="recoverygroups-recoverygroupname-request-body-put-example"></a>

```
{
  "cells": [
    "string"
  ]
}
```

### Response bodies
<a name="recoverygroups-recoverygroupname-response-examples"></a>

#### RecoveryGroupOutput schema
<a name="recoverygroups-recoverygroupname-response-body-recoverygroupoutput-example"></a>

```
{
  "cells": [
    "string"
  ],
  "recoveryGroupName": "string",
  "recoveryGroupArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="recoverygroups-recoverygroupname-properties"></a>

### RecoveryGroupOutput
<a name="recoverygroups-recoverygroupname-model-recoverygroupoutput"></a>

A representation of the application, typically containing multiple cells.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type string | True | A list of a cell's Amazon Resource Names (ARNs). | 
| recoveryGroupArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the recovery group. | 
| recoveryGroupName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the recovery group. | 
| tags | [Tags](#recoverygroups-recoverygroupname-model-tags) | False | The tags associated with the recovery group. | 

### RecoveryGroupUpdateParameters
<a name="recoverygroups-recoverygroupname-model-recoverygroupupdateparameters"></a>

Parameters used to update a recovery group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type string | True | A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list. | 

### Tags
<a name="recoverygroups-recoverygroupname-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="recoverygroups-recoverygroupname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetRecoveryGroup
<a name="GetRecoveryGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetRecoveryGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetRecoveryGroup)

### UpdateRecoveryGroup
<a name="UpdateRecoveryGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UpdateRecoveryGroup)

### DeleteRecoveryGroup
<a name="DeleteRecoveryGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteRecoveryGroup)

# GetRecoveryGroupReadinessSummary
<a name="recoverygroupreadiness-recoverygroupname"></a>

## URI
<a name="recoverygroupreadiness-recoverygroupname-url"></a>

`/recoverygroupreadiness/recoveryGroupName`

## HTTP methods
<a name="recoverygroupreadiness-recoverygroupname-http-methods"></a>

### GET
<a name="recoverygroupreadiness-recoverygroupnameget"></a>

**Operation ID:** `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.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetRecoveryGroupReadinessSummaryOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="recoverygroupreadiness-recoverygroupnameoptions"></a>

Enable CORS by returning correct headers 


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| recoveryGroupName | String | True | The name of a recovery group. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="recoverygroupreadiness-recoverygroupname-schemas"></a>

### Response bodies
<a name="recoverygroupreadiness-recoverygroupname-response-examples"></a>

#### GetRecoveryGroupReadinessSummaryOutput schema
<a name="recoverygroupreadiness-recoverygroupname-response-body-getrecoverygroupreadinesssummaryoutput-example"></a>

```
{
  "nextToken": "string",
  "readiness": enum,
  "readinessChecks": [
    {
      "readinessCheckName": "string",
      "readiness": enum
    }
  ]
}
```

## Properties
<a name="recoverygroupreadiness-recoverygroupname-properties"></a>

### GetRecoveryGroupReadinessSummaryOutput
<a name="recoverygroupreadiness-recoverygroupname-model-getrecoverygroupreadinesssummaryoutput"></a>

Result of a `GetReadinessRecoveryGroupSummary` operation.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | True | The token that identifies which batch of results you want to see. | 
| readiness | [Readiness](#recoverygroupreadiness-recoverygroupname-model-readiness) | True | The readiness status at a recovery group level. | 
| readinessChecks | Array of type [ReadinessCheckSummary](#recoverygroupreadiness-recoverygroupname-model-readinesschecksummary) | True | Summaries of the readiness checks for the recovery group. | 

### Readiness
<a name="recoverygroupreadiness-recoverygroupname-model-readiness"></a>

The readiness status.
+ `READY`
+ `NOT_READY`
+ `UNKNOWN`
+ `NOT_AUTHORIZED`

### ReadinessCheckSummary
<a name="recoverygroupreadiness-recoverygroupname-model-readinesschecksummary"></a>

Summary of all readiness check statuses in a recovery group, paginated in `GetRecoveryGroupReadinessSummary` and `GetCellReadinessSummary`.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| readiness | [Readiness](#recoverygroupreadiness-recoverygroupname-model-readiness) | False | The readiness status of this readiness check. | 
| readinessCheckName | string | False | The name of a readiness check. | 

## See also
<a name="recoverygroupreadiness-recoverygroupname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetRecoveryGroupReadinessSummary
<a name="GetRecoveryGroupReadinessSummary-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetRecoveryGroupReadinessSummary)

# GetResourceSet, UpdateResourceSet, DeleteResourceSet
<a name="resourcesets-resourcesetname"></a>

## URI
<a name="resourcesets-resourcesetname-url"></a>

`/resourcesets/resourceSetName`

## HTTP methods
<a name="resourcesets-resourcesetname-http-methods"></a>

### GET
<a name="resourcesets-resourcesetnameget"></a>

**Operation ID:** `GetResourceSet`

Displays the details about a resource set, including a list of the resources in the set.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceSetName | String | True | Name of a resource set. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ResourceSetOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### PUT
<a name="resourcesets-resourcesetnameput"></a>

**Operation ID:** `UpdateResourceSet`

Updates a resource set.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceSetName | String | True | Name of a resource set. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ResourceSetOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### DELETE
<a name="resourcesets-resourcesetnamedelete"></a>

**Operation ID:** `DeleteResourceSet`

Deletes a resource set.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceSetName | String | True | Name of a resource set. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="resourcesets-resourcesetnameoptions"></a>

Enable CORS by returning correct headers 


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceSetName | String | True | Name of a resource set. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="resourcesets-resourcesetname-schemas"></a>

### Request bodies
<a name="resourcesets-resourcesetname-request-examples"></a>

#### PUT schema
<a name="resourcesets-resourcesetname-request-body-put-example"></a>

```
{
  "resourceSetType": "string",
  "resources": [
    {
      "readinessScopes": [
        "string"
      ],
      "componentId": "string",
      "resourceArn": "string",
      "dnsTargetResource": {
        "recordType": "string",
        "domainName": "string",
        "hostedZoneArn": "string",
        "targetResource": {
          "r53Resource": {
            "domainName": "string",
            "recordSetId": "string"
          },
          "nLBResource": {
            "arn": "string"
          }
        },
        "recordSetId": "string"
      }
    }
  ]
}
```

### Response bodies
<a name="resourcesets-resourcesetname-response-examples"></a>

#### ResourceSetOutput schema
<a name="resourcesets-resourcesetname-response-body-resourcesetoutput-example"></a>

```
{
  "resourceSetType": "string",
  "resourceSetName": "string",
  "resources": [
    {
      "readinessScopes": [
        "string"
      ],
      "componentId": "string",
      "resourceArn": "string",
      "dnsTargetResource": {
        "recordType": "string",
        "domainName": "string",
        "hostedZoneArn": "string",
        "targetResource": {
          "r53Resource": {
            "domainName": "string",
            "recordSetId": "string"
          },
          "nLBResource": {
            "arn": "string"
          }
        },
        "recordSetId": "string"
      }
    }
  ],
  "resourceSetArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="resourcesets-resourcesetname-properties"></a>

### DNSTargetResource
<a name="resourcesets-resourcesetname-model-dnstargetresource"></a>

A component for DNS/routing control readiness checks and architecture checks.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| domainName | string | False | The domain name that acts as an ingress point to a portion of the customer application. | 
| hostedZoneArn | string | False | The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource. | 
| recordSetId | string | False | The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type. | 
| recordType | string | False | The type of DNS record of the target resource. | 
| targetResource | [TargetResource](#resourcesets-resourcesetname-model-targetresource) | False | The target resource of the DNS target resource. | 

### NLBResource
<a name="resourcesets-resourcesetname-model-nlbresource"></a>

The Network Load Balancer resource that a DNS target resource points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Network Load Balancer resource Amazon Resource Name (ARN). | 

### R53ResourceRecord
<a name="resourcesets-resourcesetname-model-r53resourcerecord"></a>

The Route 53 resource that a DNS target resource record points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| domainName | string | False | The DNS target domain name. | 
| recordSetId | string | False | The Route 53 Resource Record Set ID. | 

### Resource
<a name="resourcesets-resourcesetname-model-resource"></a>

The resource element of a resource set.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| componentId | string | False | The component identifier of the resource, generated when DNS target resource is used. | 
| dnsTargetResource | [DNSTargetResource](#resourcesets-resourcesetname-model-dnstargetresource) | False | The DNS target resource. | 
| readinessScopes | Array of type string | False | The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to. | 
| resourceArn | string | False | The Amazon Resource Name (ARN) of the AWS resource. | 

### ResourceSetOutput
<a name="resourcesets-resourcesetname-model-resourcesetoutput"></a>

A collection of resources of the same type.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resources | Array of type [Resource](#resourcesets-resourcesetname-model-resource) | True | A list of resource objects. | 
| resourceSetArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the resource set. | 
| resourceSetName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the resource set. | 
| resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | True | The resource type of the resources in the resource set. One of the following values: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 | 
| tags | [Tags](#resourcesets-resourcesetname-model-tags) | False |  | 

### ResourceSetUpdateParameters
<a name="resourcesets-resourcesetname-model-resourcesetupdateparameters"></a>

Parameters used to create a resource set.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resources | Array of type [Resource](#resourcesets-resourcesetname-model-resource) | True | A list of resource objects. | 
| resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | True | The resource type of the resources in the resource set. One of the following values: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 | 

### Tags
<a name="resourcesets-resourcesetname-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TargetResource
<a name="resourcesets-resourcesetname-model-targetresource"></a>

The target resource that the Route 53 record points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nLBResource | [NLBResource](#resourcesets-resourcesetname-model-nlbresource) | False | The Network Load Balancer resource. | 
| r53Resource | [R53ResourceRecord](#resourcesets-resourcesetname-model-r53resourcerecord) | False | The Route 53 resource. | 

## See also
<a name="resourcesets-resourcesetname-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### GetResourceSet
<a name="GetResourceSet-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetResourceSet)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetResourceSet)

### UpdateResourceSet
<a name="UpdateResourceSet-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UpdateResourceSet)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UpdateResourceSet)

### DeleteResourceSet
<a name="DeleteResourceSet-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteResourceSet)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteResourceSet)

# ListCells, CreateCell
<a name="cells"></a>

## URI
<a name="cells-url"></a>

`/cells`

## HTTP methods
<a name="cells-http-methods"></a>

### GET
<a name="cellsget"></a>

**Operation ID:** `ListCells`

Lists the cells for an account.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListCellsResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="cellspost"></a>

**Operation ID:** `CreateCell`

Creates a cell in an account.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | CellOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 409 | None | 409 response - Conflict exception. You might be using a predefined variable. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="cellsoptions"></a>

Enables CORS by returning correct headers.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="cells-schemas"></a>

### Request bodies
<a name="cells-request-examples"></a>

#### POST schema
<a name="cells-request-body-post-example"></a>

```
{
  "cells": [
    "string"
  ],
  "cellName": "string",
  "tags": {
  }
}
```

### Response bodies
<a name="cells-response-examples"></a>

#### ListCellsResult schema
<a name="cells-response-body-listcellsresult-example"></a>

```
{
  "cells": [
    {
      "cells": [
        "string"
      ],
      "parentReadinessScopes": [
        "string"
      ],
      "cellName": "string",
      "cellArn": "string",
      "tags": {
      }
    }
  ],
  "nextToken": "string"
}
```

#### CellOutput schema
<a name="cells-response-body-celloutput-example"></a>

```
{
  "cells": [
    "string"
  ],
  "parentReadinessScopes": [
    "string"
  ],
  "cellName": "string",
  "cellArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="cells-properties"></a>

### CellCreateParameters
<a name="cells-model-cellcreateparameters"></a>

Parameters used to create a cell.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cellName | string | True | The name of the cell to create. | 
| cells | Array of type string | False | A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific AWS Regions. | 
| tags | [Tags](#cells-model-tags) | False |  | 

### CellOutput
<a name="cells-model-celloutput"></a>

Information about a cell.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cellArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the cell. | 
| cellName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the cell. | 
| cells | Array of type string | True | A list of cell ARNs. | 
| parentReadinessScopes | Array of type string | True | 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. | 
| tags | [Tags](#cells-model-tags) | False | Tags on the resources. | 

### ListCellsResult
<a name="cells-model-listcellsresult"></a>

The result of a successful `ListCells` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type [CellOutput](#cells-model-celloutput) | False | A list of cells. | 
| nextToken | string | False | The token that identifies which batch of results you want to see. | 

### Tags
<a name="cells-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="cells-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListCells
<a name="ListCells-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListCells)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListCells)

### CreateCell
<a name="CreateCell-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/CreateCell)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/CreateCell)

# ListCrossAccountAuthorizations, CreateCrossAccountAuthorization
<a name="crossaccountauthorizations"></a>

## URI
<a name="crossaccountauthorizations-url"></a>

`/crossaccountauthorizations`

## HTTP methods
<a name="crossaccountauthorizations-http-methods"></a>

### GET
<a name="crossaccountauthorizationsget"></a>

**Operation ID:** `ListCrossAccountAuthorizations`

Lists the cross-account readiness authorizations that are in place for an account.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListCrossAccountAuthorizationsResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="crossaccountauthorizationspost"></a>

**Operation ID:** `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.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | CreateCrossAccountAuthorizationResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 409 | None | 409 response - Conflict exception. You might be using a predefined variable. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="crossaccountauthorizationsoptions"></a>

Enables CORS by returning correct headers.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="crossaccountauthorizations-schemas"></a>

### Request bodies
<a name="crossaccountauthorizations-request-examples"></a>

#### POST schema
<a name="crossaccountauthorizations-request-body-post-example"></a>

```
{
  "crossAccountAuthorization": "string"
}
```

### Response bodies
<a name="crossaccountauthorizations-response-examples"></a>

#### ListCrossAccountAuthorizationsResult schema
<a name="crossaccountauthorizations-response-body-listcrossaccountauthorizationsresult-example"></a>

```
{
  "nextToken": "string",
  "crossAccountAuthorizations": [
    "string"
  ]
}
```

#### CreateCrossAccountAuthorizationResult schema
<a name="crossaccountauthorizations-response-body-createcrossaccountauthorizationresult-example"></a>

```
{
  "crossAccountAuthorization": "string"
}
```

## Properties
<a name="crossaccountauthorizations-properties"></a>

### CreateCrossAccountAuthorizationParameters
<a name="crossaccountauthorizations-model-createcrossaccountauthorizationparameters"></a>

Parameters used to create a cross-account authorization.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| crossAccountAuthorization | string | True | The cross-account authorization. | 

### CreateCrossAccountAuthorizationResult
<a name="crossaccountauthorizations-model-createcrossaccountauthorizationresult"></a>

The result of a successful `CreateCrossAccountAuthorization` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| crossAccountAuthorization | string | False | The cross-account authorization. | 

### ListCrossAccountAuthorizationsResult
<a name="crossaccountauthorizations-model-listcrossaccountauthorizationsresult"></a>

The result of a successful `ListCrossAccountAuthorizations` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| crossAccountAuthorizations | Array of type string | True | A list of cross-account authorizations. | 
| nextToken | string | False | The token that identifies which batch of results you want to see. | 

## See also
<a name="crossaccountauthorizations-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListCrossAccountAuthorizations
<a name="ListCrossAccountAuthorizations-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListCrossAccountAuthorizations)

### CreateCrossAccountAuthorization
<a name="CreateCrossAccountAuthorization-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/CreateCrossAccountAuthorization)

# ListReadinessChecks, CreateReadinessCheck
<a name="readinesschecks"></a>

## URI
<a name="readinesschecks-url"></a>

`/readinesschecks`

## HTTP methods
<a name="readinesschecks-http-methods"></a>

### GET
<a name="readinesschecksget"></a>

**Operation ID:** `ListReadinessChecks`

Lists the readiness checks for an account.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListReadinessChecksResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="readinesscheckspost"></a>

**Operation ID:** `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.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ReadinessCheckOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 409 | None | 409 response - Conflict exception. You might be using a predefined variable. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="readinesschecksoptions"></a>

Enables CORS by returning correct headers.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="readinesschecks-schemas"></a>

### Request bodies
<a name="readinesschecks-request-examples"></a>

#### POST schema
<a name="readinesschecks-request-body-post-example"></a>

```
{
  "readinessCheckName": "string",
  "resourceSetName": "string",
  "tags": {
  }
}
```

### Response bodies
<a name="readinesschecks-response-examples"></a>

#### ListReadinessChecksResult schema
<a name="readinesschecks-response-body-listreadinesschecksresult-example"></a>

```
{
  "nextToken": "string",
  "readinessChecks": [
    {
      "resourceSet": "string",
      "readinessCheckName": "string",
      "readinessCheckArn": "string",
      "tags": {
      }
    }
  ]
}
```

#### ReadinessCheckOutput schema
<a name="readinesschecks-response-body-readinesscheckoutput-example"></a>

```
{
  "resourceSet": "string",
  "readinessCheckName": "string",
  "readinessCheckArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="readinesschecks-properties"></a>

### ListReadinessChecksResult
<a name="readinesschecks-model-listreadinesschecksresult"></a>

The result of a successful `ListReadinessChecks` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | The token that identifies which batch of results you want to see. | 
| readinessChecks | Array of type [ReadinessCheckOutput](#readinesschecks-model-readinesscheckoutput) | False | A list of readiness checks associated with the account. | 

### ReadinessCheckCreateParameters
<a name="readinesschecks-model-readinesscheckcreateparameters"></a>

Parameters used to create or update a readiness check.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckName | string | True | The name of the readiness check to create. | 
| resourceSetName | string | True | The name of the resource set to check. | 
| tags | [Tags](#readinesschecks-model-tags) | False |  | 

### ReadinessCheckOutput
<a name="readinesschecks-model-readinesscheckoutput"></a>

A readiness check.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| readinessCheckArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) associated with a readiness check. | 
| readinessCheckName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | False | Name of a readiness check. | 
| resourceSet | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | Name of the resource set to be checked. | 
| tags | [Tags](#readinesschecks-model-tags) | False |  | 

### Tags
<a name="readinesschecks-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="readinesschecks-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListReadinessChecks
<a name="ListReadinessChecks-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListReadinessChecks)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListReadinessChecks)

### CreateReadinessCheck
<a name="CreateReadinessCheck-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/CreateReadinessCheck)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/CreateReadinessCheck)

# ListRecoveryGroups, CreateRecoveryGroup
<a name="recoverygroups"></a>

## URI
<a name="recoverygroups-url"></a>

`/recoverygroups`

## HTTP methods
<a name="recoverygroups-http-methods"></a>

### GET
<a name="recoverygroupsget"></a>

**Operation ID:** `ListRecoveryGroups`

Lists the recovery groups in an account.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListRecoveryGroupsResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="recoverygroupspost"></a>

**Operation ID:** `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.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | RecoveryGroupOutput | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 409 | None | 409 response - Conflict exception. You might be using a predefined variable. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="recoverygroupsoptions"></a>

Enable CORS by returning correct headers 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="recoverygroups-schemas"></a>

### Request bodies
<a name="recoverygroups-request-examples"></a>

#### POST schema
<a name="recoverygroups-request-body-post-example"></a>

```
{
  "cells": [
    "string"
  ],
  "recoveryGroupName": "string",
  "tags": {
  }
}
```

### Response bodies
<a name="recoverygroups-response-examples"></a>

#### ListRecoveryGroupsResult schema
<a name="recoverygroups-response-body-listrecoverygroupsresult-example"></a>

```
{
  "nextToken": "string",
  "recoveryGroups": [
    {
      "cells": [
        "string"
      ],
      "recoveryGroupName": "string",
      "recoveryGroupArn": "string",
      "tags": {
      }
    }
  ]
}
```

#### RecoveryGroupOutput schema
<a name="recoverygroups-response-body-recoverygroupoutput-example"></a>

```
{
  "cells": [
    "string"
  ],
  "recoveryGroupName": "string",
  "recoveryGroupArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="recoverygroups-properties"></a>

### ListRecoveryGroupsResult
<a name="recoverygroups-model-listrecoverygroupsresult"></a>

The result of a successful `ListRecoveryGroups` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | The token that identifies which batch of results you want to see. | 
| recoveryGroups | Array of type [RecoveryGroupOutput](#recoverygroups-model-recoverygroupoutput) | False | A list of recovery groups. | 

### RecoveryGroupCreateParameters
<a name="recoverygroups-model-recoverygroupcreateparameters"></a>

Parameters used to create a recovery group. A recovery group corresponds to your application and includes the cells that make up the application.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type string | False | A list of the cell Amazon Resource Names (ARNs) in the recovery group. | 
| recoveryGroupName | string | True | The name of the recovery group to create.  | 
| tags | [Tags](#recoverygroups-model-tags) | False |  | 

### RecoveryGroupOutput
<a name="recoverygroups-model-recoverygroupoutput"></a>

A representation of the application, typically containing multiple cells.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cells | Array of type string | True | A list of a cell's Amazon Resource Names (ARNs). | 
| recoveryGroupArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the recovery group. | 
| recoveryGroupName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the recovery group. | 
| tags | [Tags](#recoverygroups-model-tags) | False | The tags associated with the recovery group. | 

### Tags
<a name="recoverygroups-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="recoverygroups-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListRecoveryGroups
<a name="ListRecoveryGroups-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListRecoveryGroups)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListRecoveryGroups)

### CreateRecoveryGroup
<a name="CreateRecoveryGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/CreateRecoveryGroup)

# ListResourceSets, CreateResourceSet
<a name="resourcesets"></a>

## URI
<a name="resourcesets-url"></a>

`/resourcesets`

## HTTP methods
<a name="resourcesets-http-methods"></a>

### GET
<a name="resourcesetsget"></a>

**Operation ID:** `ListResourceSets`

Lists the resource sets in an account.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListResourceSetsResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="resourcesetspost"></a>

**Operation ID:** `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.


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ResourceSetOutput | 200 response | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 409 | None | 409 response - Conflict exception. You might be using a predefined variable. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="resourcesetsoptions"></a>

Enable CORS by returning correct headers 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="resourcesets-schemas"></a>

### Request bodies
<a name="resourcesets-request-examples"></a>

#### POST schema
<a name="resourcesets-request-body-post-example"></a>

```
{
  "resourceSetType": "string",
  "resourceSetName": "string",
  "resources": [
    {
      "readinessScopes": [
        "string"
      ],
      "componentId": "string",
      "resourceArn": "string",
      "dnsTargetResource": {
        "recordType": "string",
        "domainName": "string",
        "hostedZoneArn": "string",
        "targetResource": {
          "r53Resource": {
            "domainName": "string",
            "recordSetId": "string"
          },
          "nLBResource": {
            "arn": "string"
          }
        },
        "recordSetId": "string"
      }
    }
  ],
  "tags": {
  }
}
```

### Response bodies
<a name="resourcesets-response-examples"></a>

#### ListResourceSetsResult schema
<a name="resourcesets-response-body-listresourcesetsresult-example"></a>

```
{
  "nextToken": "string",
  "resourceSets": [
    {
      "resourceSetType": "string",
      "resourceSetName": "string",
      "resources": [
        {
          "readinessScopes": [
            "string"
          ],
          "componentId": "string",
          "resourceArn": "string",
          "dnsTargetResource": {
            "recordType": "string",
            "domainName": "string",
            "hostedZoneArn": "string",
            "targetResource": {
              "r53Resource": {
                "domainName": "string",
                "recordSetId": "string"
              },
              "nLBResource": {
                "arn": "string"
              }
            },
            "recordSetId": "string"
          }
        }
      ],
      "resourceSetArn": "string",
      "tags": {
      }
    }
  ]
}
```

#### ResourceSetOutput schema
<a name="resourcesets-response-body-resourcesetoutput-example"></a>

```
{
  "resourceSetType": "string",
  "resourceSetName": "string",
  "resources": [
    {
      "readinessScopes": [
        "string"
      ],
      "componentId": "string",
      "resourceArn": "string",
      "dnsTargetResource": {
        "recordType": "string",
        "domainName": "string",
        "hostedZoneArn": "string",
        "targetResource": {
          "r53Resource": {
            "domainName": "string",
            "recordSetId": "string"
          },
          "nLBResource": {
            "arn": "string"
          }
        },
        "recordSetId": "string"
      }
    }
  ],
  "resourceSetArn": "string",
  "tags": {
  }
}
```

## Properties
<a name="resourcesets-properties"></a>

### DNSTargetResource
<a name="resourcesets-model-dnstargetresource"></a>

A component for DNS/routing control readiness checks and architecture checks.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| domainName | string | False | The domain name that acts as an ingress point to a portion of the customer application. | 
| hostedZoneArn | string | False | The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource. | 
| recordSetId | string | False | The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type. | 
| recordType | string | False | The type of DNS record of the target resource. | 
| targetResource | [TargetResource](#resourcesets-model-targetresource) | False | The target resource of the DNS target resource. | 

### ListResourceSetsResult
<a name="resourcesets-model-listresourcesetsresult"></a>

The result of a successful `ListResourceSets` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | The token that identifies which batch of results you want to see. | 
| resourceSets | Array of type [ResourceSetOutput](#resourcesets-model-resourcesetoutput) | False | A list of resource sets associated with the account. | 

### NLBResource
<a name="resourcesets-model-nlbresource"></a>

The Network Load Balancer resource that a DNS target resource points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Network Load Balancer resource Amazon Resource Name (ARN). | 

### R53ResourceRecord
<a name="resourcesets-model-r53resourcerecord"></a>

The Route 53 resource that a DNS target resource record points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| domainName | string | False | The DNS target domain name. | 
| recordSetId | string | False | The Route 53 Resource Record Set ID. | 

### Resource
<a name="resourcesets-model-resource"></a>

The resource element of a resource set.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| componentId | string | False | The component identifier of the resource, generated when DNS target resource is used. | 
| dnsTargetResource | [DNSTargetResource](#resourcesets-model-dnstargetresource) | False | The DNS target resource. | 
| readinessScopes | Array of type string | False | The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to. | 
| resourceArn | string | False | The Amazon Resource Name (ARN) of the AWS resource. | 

### ResourceSetCreateParameters
<a name="resourcesets-model-resourcesetcreateparameters"></a>

The parameters used to create a resource set.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resources | Array of type [Resource](#resourcesets-model-resource) | True | A list of resource objects in the resource set. | 
| resourceSetName | string | True | The name of the resource set to create. | 
| resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | True | The resource type of the resources in the resource set. One of the following values: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 | 
| tags | [Tags](#resourcesets-model-tags) | False | A tag to associate with the parameters for a resource set. | 

### ResourceSetOutput
<a name="resourcesets-model-resourcesetoutput"></a>

A collection of resources of the same type.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resources | Array of type [Resource](#resourcesets-model-resource) | True | A list of resource objects. | 
| resourceSetArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the resource set. | 
| resourceSetName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the resource set. | 
| resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | True | The resource type of the resources in the resource set. One of the following values: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 | 
| tags | [Tags](#resourcesets-model-tags) | False |  | 

### Tags
<a name="resourcesets-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TargetResource
<a name="resourcesets-model-targetresource"></a>

The target resource that the Route 53 record points to.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nLBResource | [NLBResource](#resourcesets-model-nlbresource) | False | The Network Load Balancer resource. | 
| r53Resource | [R53ResourceRecord](#resourcesets-model-r53resourcerecord) | False | The Route 53 resource. | 

## See also
<a name="resourcesets-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListResourceSets
<a name="ListResourceSets-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListResourceSets)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListResourceSets)

### CreateResourceSet
<a name="CreateResourceSet-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/CreateResourceSet)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/CreateResourceSet)

# ListRules
<a name="rules"></a>

## URI
<a name="rules-url"></a>

`/rules`

## HTTP methods
<a name="rules-http-methods"></a>

### GET
<a name="rulesget"></a>

**Operation ID:** `ListRules`

Lists all readiness rules, or lists the readiness rules for a specific resource type.


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceType | String | False | The resource type that a readiness rule applies to. | 
| nextToken | String | False | The token that identifies which batch of results you want to see. | 
| maxResults | String | False | The number of objects that you want to return with this call. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListRulesResult | 200 response - Success. | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 403 | None | 403 response - Access denied exception. You do not have sufficient access to perform this action. | 
| 429 | None | 429 response - Limit exceeded exception or too many requests exception.  | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### OPTIONS
<a name="rulesoptions"></a>

Enable CORS by returning correct headers 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 

## Schemas
<a name="rules-schemas"></a>

### Response bodies
<a name="rules-response-examples"></a>

#### ListRulesResult schema
<a name="rules-response-body-listrulesresult-example"></a>

```
{
  "nextToken": "string",
  "rules": [
    {
      "ruleId": "string",
      "ruleDescription": "string",
      "resourceType": "string"
    }
  ]
}
```

## Properties
<a name="rules-properties"></a>

### ListRulesOutput
<a name="rules-model-listrulesoutput"></a>

Readiness rule information, including the resource type, rule ID, and rule description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceType | stringMaxLength: 64 | True | The resource type that the readiness rule applies to. | 
| ruleDescription | stringMaxLength: 256 | True | The description of a readiness rule. | 
| ruleId | stringMaxLength: 64 | True | The ID for the readiness rule. | 

### ListRulesResult
<a name="rules-model-listrulesresult"></a>

The result of a successful `ListRules` request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | The token that identifies which batch of results you want to see. | 
| rules | Array of type [ListRulesOutput](#rules-model-listrulesoutput) | False | A list of readiness rules for a specific resource type. | 

## See also
<a name="rules-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListRules
<a name="ListRules-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListRules)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListRules)

# ListTagsForResources, TagResource, UntagResource
<a name="tags-resource-arn"></a>

## URI
<a name="tags-resource-arn-url"></a>

`/tags/resource-arn`

## HTTP methods
<a name="tags-resource-arn-http-methods"></a>

### GET
<a name="tags-resource-arnget"></a>

**Operation ID:** `ListTagsForResources`

Lists the tags for a resource.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True | The Amazon Resource Name (ARN) for a resource. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | tagsModel | 200 response - Success. | 
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### POST
<a name="tags-resource-arnpost"></a>

**Operation ID:** `TagResource`

Adds a tag to a resource.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True | The Amazon Resource Name (ARN) for a resource. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response - Success. | 
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

### DELETE
<a name="tags-resource-arndelete"></a>

**Operation ID:** `UntagResource`

Removes a tag from a resource.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True | The Amazon Resource Name (ARN) for a resource. | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| tagKeys | String | True | The keys for tags you add to resources. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response - Successful deletion | 
| 400 | None | 400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly. | 
| 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | 
| 500 | None | 500 response - Internal service error or temporary service error. Retry the request. | 

## Schemas
<a name="tags-resource-arn-schemas"></a>

### Request bodies
<a name="tags-resource-arn-request-examples"></a>

#### POST schema
<a name="tags-resource-arn-request-body-post-example"></a>

```
{
  "tags": {
  }
}
```

### Response bodies
<a name="tags-resource-arn-response-examples"></a>

#### tagsModel schema
<a name="tags-resource-arn-response-body-tagsmodel-example"></a>

```
{
  "tags": {
  }
}
```

## Properties
<a name="tags-resource-arn-properties"></a>

### Tags
<a name="tags-resource-arn-model-tags"></a>

A collection of tags associated with a resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### tagsModel
<a name="tags-resource-arn-model-tagsmodel"></a>




| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tags | [Tags](#tags-resource-arn-model-tags) | True |  | 

## See also
<a name="tags-resource-arn-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListTagsForResources
<a name="ListTagsForResources-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/ListTagsForResources)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/ListTagsForResources)

### TagResource
<a name="TagResource-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/TagResource)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/TagResource)

### UntagResource
<a name="UntagResource-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UntagResource)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UntagResource)