StartDeploymentRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-amplify/json-schema/amazon-amplify-start-deployment-request-schema.json",
  "title": "StartDeploymentRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-amplify-operations-api-openapi.yml#/components/schemas/StartDeploymentRequest",
  "type": "object",
  "properties": {
    "appId": {
      "type": "string",
      "description": "The unique ID for an Amplify app."
    },
    "branchName": {
      "type": "string",
      "description": "The name of the branch to use for the deployment job."
    },
    "jobId": {
      "type": "string",
      "description": "The job ID for this deployment that is generated by the CreateDeployment request."
    },
    "sourceUrl": {
      "type": "string",
      "description": "The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix."
    },
    "sourceUrlType": {
      "type": "string",
      "enum": [
        "ZIP",
        "BUCKET_PREFIX"
      ],
      "description": "The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP."
    }
  },
  "required": [
    "appId",
    "branchName"
  ]
}