v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
appManagementV2

App upgrade job status

Get the status of an asynchronous app upgrade request for the given job identifier.

get/v2/apps/upgrade/{jobId}/status

Path parameters

jobIdstring required

Identifier of the asynchronous job for upgrading the app.

Response

Status of the app upgrade job.

statusstring required

Whether or not the request is in progress (InProgress), has completed successfully (Success), or has completed with an error (Failed).

instanceIdstring

Instance identifier of the upgraded app. This field is not set yet but is a placeholder for future use.

pathstring

Path of the folder in which the app was upgraded.

folderIdstring

Identifier of the folder in which the app was upgraded.

Example response

{
  "status": "Success",
  "instanceId": "0000000001578BE8",
  "path": "/Library/Installed Apps/AWS CloudTrail",
  "folderId": "0000000001578BE8",
  "error": {
    "code": "auth:password_too_short",
    "message": "Your password was too short.",
    "detail": "Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.",
    "meta": {
      "minLength": 12,
      "actualLength": 5
    }
  }
}