ListBranchesResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-amplify/json-schema/amazon-amplify-list-branches-result-schema.json",
  "title": "ListBranchesResult",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-amplify-branches-api-openapi.yml#/components/schemas/ListBranchesResult",
  "type": "object",
  "properties": {
    "branches": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Branch"
      },
      "description": "A list of branches for an Amplify app."
    },
    "nextToken": {
      "type": "string",
      "description": "A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries."
    }
  },
  "required": [
    "branches"
  ],
  "$defs": {
    "Backend": {
      "type": "object",
      "properties": {
        "stackArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) for the CloudFormation stack."
        }
      }
    },
    "Branch": {
      "type": "object",
      "properties": {
        "branchArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) for a branch that is part of an Amplify app."
        },
        "branchName": {
          "type": "string",
          "description": "The name for the branch that is part of an Amplify app."
        },
        "description": {
          "type": "string",
          "description": "The description for the branch that is part of an Amplify app."
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The tag for the branch of an Amplify app."
        },
        "stage": {
          "type": "string",
          "enum": [
            "PRODUCTION",
            "BETA",
            "DEVELOPMENT",
            "EXPERIMENTAL",
            "PULL_REQUEST"
          ],
          "description": "The current stage for the branch that is part of an Amplify app."
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the branch. This is used as the default domain prefix."
        },
        "enableNotification": {
          "type": "boolean",
          "description": "Enables notifications for a branch that is part of an Amplify app."
        },
        "createTime": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp of when Amplify created the branch."
        },
        "updateTime": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp for the last updated time for a branch."
        },
        "environmentVariables": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The environment variables specific to a branch of an Amplify app."
        },
        "enableAutoBuild": {
          "type": "boolean",
          "description": "Enables auto-building on push for a branch of an Amplify app."
        },
        "enableSkewProtection": {
          "type": "boolean",
          "description": "Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide."
        },
        "customDomains": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The custom domains for a branch of an Amplify app."
        },
        "framework": {
          "type": "string",
          "description": "The framework for a branch of an Amplify app."
        },
        "activeJobId": {
          "type": "string",
          "description": "The ID of the active job for a branch of an Amplify app."
        },
        "totalNumberOfJobs": {
          "type": "string",
          "description": "The total number of jobs that are part of an Amplify app."
        },
        "enableBasicAuth": {
          "type": "boolean",
          "description": "Enables basic authorization for a branch of an Amplify app."
        },
        "enablePerformanceMode": {
          "type": "boolean",
          "description": "Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out."
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "The thumbnail URL for the branch of an Amplify app."
        },
        "basicAuthCredentials": {
          "type": "string",
          "description": "The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password."
        },
        "buildSpec": {
          "type": "string",
          "description": "The build specification (build spec) content for the branch of an Amplify app."
        },
        "ttl": {
          "type": "string",
          "description": "The content Time to Live (TTL) for the website in seconds."
        },
        "associatedResources": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of custom resources that are linked to this branch."
        },
        "enablePullRequestPreview": {
          "type": "boolean",
          "description": "Enables pull request previews for the branch."
        },
        "pullRequestEnvironmentName": {
          "type": "string",
          "description": "The Amplify environment name for the pull request."
        },
        "destinationBranch": {
          "type": "string",
          "description": "The destination branch if the branch is a pull request branch."
        },
        "sourceBranch": {
          "type": "string",
          "description": "The source branch if the branch is a pull request branch."
        },
        "backendEnvironmentArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code."
        },
        "backend": {
          "$ref": "#/$defs/Backend"
        },
        "computeRoleArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide."
        }
      },
      "required": [
        "branchArn",
        "branchName",
        "description",
        "stage",
        "displayName",
        "enableNotification",
        "createTime",
        "updateTime",
        "environmentVariables",
        "enableAutoBuild",
        "customDomains",
        "framework",
        "activeJobId",
        "totalNumberOfJobs",
        "enableBasicAuth",
        "ttl",
        "enablePullRequestPreview"
      ]
    }
  }
}