URI HTTP methods Schemas Properties See also

ListRecoveryGroups, CreateRecoveryGroup

URI

/recoverygroups

HTTP methods

GET

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

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

Enable CORS by returning correct headers

Responses
Status code	Response model	Description
`200`	None	200 response - Success.

Schemas

Request bodies


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

Response bodies


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


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

Properties

ListRecoveryGroupsResult

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	False	A list of recovery groups.

RecoveryGroupCreateParameters

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	False

RecoveryGroupOutput

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`	string MaxLength: 256	True	The Amazon Resource Name (ARN) for the recovery group.
`recoveryGroupName`	string Pattern: `\A[a-zA-Z0-9_]+\z` MaxLength: 64	True	The name of the recovery group.
`tags`	Tags	False	The tags associated with the recovery group.