URI HTTP methods Schemas Properties See also

ListCells, CreateCell

URI

/cells

HTTP methods

GET

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

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

Enables CORS by returning correct headers.

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

Schemas

Request bodies


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

Response bodies


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


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

Properties

CellCreateParameters

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	False

CellOutput

Information about a cell.

Property	Type	Required	Description
`cellArn`	string MaxLength: 256	True	The Amazon Resource Name (ARN) for the cell.
`cellName`	string Pattern: `\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	False	Tags on the resources.

ListCellsResult

The result of a successful ListCells request.

Property	Type	Required	Description
`cells`	Array of type CellOutput	False	A list of cells.
`nextToken`	string	False	The token that identifies which batch of results you want to see.