AWS Recovery Status

API to get AWS recovery status

Path Parameters

• accountId int64 required

  Cloud Rewind account ID.

• projectId string required

  Cloud Rewind project ID.

• assemblyId int64 required

  AWS cloud assembly ID.

Query Parameters

• id string required

  AWS Recovery ID

Responses

• 200
• 401
• 403
• 404
• 409
• 412
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• status string

  Possible values: [pending, in-progress, aborted, partially-completed, completed, failed]

  Status of the recovery process.
  

  Value	Description
  pending	The recovery process is in draft or pending state.
  in-progress	The recovery or deployment is currently in progress.
  aborted	The recovery process was aborted.
  partially-completed	The recovery completed partially; some resources may not be fully recovered.
  completed	The recovery process completed successfully.
  failed	The recovery process has failed.

• message string

  Message contains the recovery failure reasons if the recovery operation fails

{
  "status": "pending",
  "message": "string"
}

Unauthorized

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Forbidden

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Not Found

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Conflict

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Precondition Failed

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Internal Server Error

*/*

• Schema
• Example (from schema)

---

Schema

• errors object[]

  code string

  message string

  type string
• fieldErrors object

  property name* string
• message string
• requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Loading...