GetCellReadinessSummary
URI
/cellreadiness/
cellName
HTTP methods
GET
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.
Name | Type | Required | Description |
---|---|---|---|
cellName | String | True | The name of the cell. |
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. |
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
Enable CORS by returning correct headers.
Name | Type | Required | Description |
---|---|---|---|
cellName | String | True | The name of the cell. |
Status code | Response model | Description |
---|---|---|
200 | None | 200 response - Success. |
Schemas
Response bodies
{ "nextToken": "string", "readiness": enum, "readinessChecks": [ { "readinessCheckName": "string", "readiness": enum } ] }
Properties
GetCellReadinessSummaryOutput
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 | True | The readiness at a cell level. | |
readinessChecks | Array of type ReadinessCheckSummary | True | Summaries for the readiness checks that make up the cell. |
Readiness
The readiness status.
READY
NOT_READY
UNKNOWN
NOT_AUTHORIZED
ReadinessCheckSummary
Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary
and GetCellReadinessSummary
.
Property | Type | Required | Description |
---|---|---|---|
readiness | False | The readiness status of this readiness check. | |
readinessCheckName | string | False | The name of a readiness check. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: