AWS Elastic Beanstalk Elastic Beanstalk Application Version API

openapi: 3.2.0
info:
  title: AWS Elastic Beanstalk Application Version API
  version: '2010-12-01'
  description: Generated from AWS's published Smithy model for AWS Elastic Beanstalk. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticbeanstalk.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Application Version
paths:
  /?Action=CreateApplicationVersion:
    post:
      operationId: CreateApplicationVersion
      summary: Create Application Version
      description: 'Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in CodeCommit, or the output of an CodeBuild build as follows: Specify a commit in an CodeCommit repository with SourceBuildInformation. Specify a build in an CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in Amazon S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. After you create an application version with a specified Amazon S3 bucket and key location, you can''t change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ApplicationVersionDescriptionMessage'
              example:
                ApplicationVersion:
                  ApplicationName: my-app
                  VersionLabel: v1
                  Description: my-app-v1
                  DateCreated: '2015-02-03T23:01:25.412Z'
                  DateUpdated: '2015-02-03T23:01:25.412Z'
                  SourceBundle:
                    S3Bucket: my-bucket
                    S3Key: sample.war
        '400':
          description: CodeBuildNotInServiceRegionException; S3LocationNotInServiceRegionException; TooManyApplicationsException; TooManyApplicationVersionsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CodeBuildNotInServiceRegionException'
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateApplicationVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/CreateApplicationVersionMessage'
            example:
              ApplicationName: my-app
              VersionLabel: v1
              Description: my-app-v1
              SourceBundle:
                S3Bucket: my-bucket
                S3Key: sample.war
              AutoCreateApplication: true
              Process: true
      tags:
      - Application Version
  /?Action=DeleteApplicationVersion:
    post:
      operationId: DeleteApplicationVersion
      summary: Delete Application Version
      description: Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
        '400':
          description: OperationInProgressException; S3LocationNotInServiceRegionException; SourceBundleDeletionException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OperationInProgressException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteApplicationVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DeleteApplicationVersionMessage'
            example:
              ApplicationName: my-app
              VersionLabel: 22a0-stage-150819_182129
              DeleteSourceBundle: true
      tags:
      - Application Version
  /?Action=DescribeApplicationVersions:
    post:
      operationId: DescribeApplicationVersions
      summary: Describe Application Versions
      description: Retrieve a list of application versions. This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned. The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ApplicationVersionDescriptionsMessage'
              example:
                ApplicationVersions:
                - ApplicationName: my-app
                  VersionLabel: v2
                  Description: update cover page
                  DateCreated: '2015-07-23T01:32:26.079Z'
                  DateUpdated: '2015-07-23T01:32:26.079Z'
                  SourceBundle:
                    S3Bucket: elasticbeanstalk-us-west-2-015321684451
                    S3Key: my-app/5026-stage-150723_224258.war
                - ApplicationName: my-app
                  VersionLabel: v1
                  Description: initial version
                  DateCreated: '2015-07-23T22:26:10.816Z'
                  DateUpdated: '2015-07-23T22:26:10.816Z'
                  SourceBundle:
                    S3Bucket: elasticbeanstalk-us-west-2-015321684451
                    S3Key: my-app/5026-stage-150723_222618.war
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeApplicationVersions
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DescribeApplicationVersionsMessage'
            example:
              ApplicationName: my-app
              VersionLabels:
              - v2
      tags:
      - Application Version
  /?Action=UpdateApplicationVersion:
    post:
      operationId: UpdateApplicationVersion
      summary: Update Application Version
      description: Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ApplicationVersionDescriptionMessage'
              example:
                ApplicationVersion:
                  ApplicationName: my-app
                  VersionLabel: 22a0-stage-150819_185942
                  Description: new description
                  DateCreated: '2015-08-19T18:59:17.646Z'
                  DateUpdated: '2015-08-20T22:53:28.871Z'
                  SourceBundle:
                    S3Bucket: elasticbeanstalk-us-west-2-0123456789012
                    S3Key: my-app/22a0-stage-150819_185942.war
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateApplicationVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/UpdateApplicationVersionMessage'
            example:
              ApplicationName: my-app
              VersionLabel: 22a0-stage-150819_185942
              Description: new description
      tags:
      - Application Version
components:
  schemas:
    InsufficientPrivilegesException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
    S3Location:
      type: object
      properties:
        S3Bucket:
          type: string
          description: The Amazon S3 bucket where the data is located.
        S3Key:
          type: string
          description: The Amazon S3 key where the data is located.
    ApplicationVersionDescription:
      type: object
      properties:
        ApplicationVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the application version.
        ApplicationName:
          type: string
          description: The name of the application to which the application version belongs.
        Description:
          type: string
          description: The description of the application version.
        VersionLabel:
          type: string
          description: A unique identifier for the application version.
        SourceBuildInformation:
          $ref: '#/components/schemas/SourceBuildInformation'
        BuildArn:
          type: string
          description: Reference to the artifact from the CodeBuild build.
        SourceBundle:
          $ref: '#/components/schemas/S3Location'
        ImageSource:
          $ref: '#/components/schemas/ImageSource'
        ImageBuildConfiguration:
          $ref: '#/components/schemas/ImageBuildConfiguration'
        Process:
          type: boolean
          description: Indicates whether Elastic Beanstalk pre-processed and validated the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle of the application version.
        DateCreated:
          type: string
          format: date-time
          description: The creation date of the application version.
        DateUpdated:
          type: string
          format: date-time
          description: The last modified date of the application version.
        Status:
          type: string
          enum:
          - Processed
          - Unprocessed
          - Failed
          - Processing
          - Building
          description: The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values. Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment. Processing – Elastic Beanstalk is currently processing the application version. Building – Application version is current
    ImageSource:
      type: object
      properties:
        Uri:
          type: string
          description: The URI of the container image, including the registry, the repository, and the image tag or digest. For example, 111122223333.dkr.ecr.us-east-1.amazonaws.com/my-repository:latest.
    BuildConfiguration:
      type: object
      properties:
        ArtifactName:
          type: string
          description: The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
        CodeBuildServiceRole:
          type: string
          description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that enables CodeBuild to interact with dependent Amazon Web Services service on behalf of the Amazon Web Services account.
        ComputeType:
          type: string
          enum:
          - BUILD_GENERAL1_SMALL
          - BUILD_GENERAL1_MEDIUM
          - BUILD_GENERAL1_LARGE
          description: 'Information about the compute resources the build project will use. BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds'
        Image:
          type: string
          description: The ID of the Docker image to use for this build project.
        TimeoutInMinutes:
          type: integer
          description: How long in minutes, from 5 to 480 (8 hours), for CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
      required:
      - CodeBuildServiceRole
      - Image
    ImageConfiguration:
      type: object
      properties:
        Source:
          $ref: '#/components/schemas/ImageSource'
        Build:
          $ref: '#/components/schemas/ImageBuildConfiguration'
    DescribeApplicationVersionsMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: Specify an application name to show only application versions for that application.
        VersionLabels:
          type: array
          items:
            type: string
          description: Specify a version label to show a specific application version.
        MaxRecords:
          type: integer
          description: For a paginated request. Specify a maximum number of application versions to include in each response. If no MaxRecords is specified, all available application versions are retrieved in a single response.
        NextToken:
          type: string
          description: For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved.
    CreateApplicationVersionMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
        VersionLabel:
          type: string
          description: 'A label identifying this version. Constraint: Must be unique per application. If an application version already exists with this label for the specified application, Elastic Beanstalk returns an InvalidParameterValue error.'
        Description:
          type: string
          description: A description of this application version.
        SourceBuildInformation:
          $ref: '#/components/schemas/SourceBuildInformation'
        SourceBundle:
          $ref: '#/components/schemas/S3Location'
        BuildConfiguration:
          $ref: '#/components/schemas/BuildConfiguration'
        AutoCreateApplication:
          type: boolean
          description: Set to true to create an application with the specified name if it doesn't already exist.
        Process:
          type: boolean
          description: Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. You must turn processing on for application versions that you create using CodeBuild or CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy ser
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Specifies the tags applied to the application version. Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.
        ImageConfiguration:
          $ref: '#/components/schemas/ImageConfiguration'
      required:
      - ApplicationName
      - VersionLabel
    ImageBuildConfiguration:
      type: object
      properties:
        Type:
          type: string
          enum:
          - docker
          - buildpack
          description: 'How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a Build that doesn''t specify it. Valid values: docker – Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile with DockerfileLocation. buildpack – Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder with Buildpack.'
        DockerfileLocation:
          type: string
          description: The path to the Dockerfile within the source bundle, relative to the root of the source bundle. For example, backend/Dockerfile. Elastic Beanstalk uses this member only when Type is docker. If you don't specify it, Elastic Beanstalk uses the Dockerfile at the root of the source bundle.
        Buildpack:
          type: string
          description: The Cloud Native Buildpacks builder image that Elastic Beanstalk uses to build the container image. For example, paketobuildpacks/builder-jammy-base. This member is required when Type is buildpack. Elastic Beanstalk doesn't provide a default builder.
        Architecture:
          type: string
          enum:
          - amd64
          - arm64
          description: 'The processor architecture that Elastic Beanstalk builds the container image for. The architecture must match the architecture of the instances in the environment that you deploy the application version to. Valid values: amd64 – x86-64 instances. This is the default. arm64 – Amazon Web Services Graviton instances.'
        CodeBuildServiceRole:
          type: string
          description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that CodeBuild assumes to run the build in your Amazon Web Services account. Elastic Beanstalk rejects a Build that doesn't specify this role.
        ComputeType:
          type: string
          enum:
          - BUILD_GENERAL1_SMALL
          - BUILD_GENERAL1_MEDIUM
          - BUILD_GENERAL1_LARGE
          description: 'The size of the compute resources that run the build. If you don''t specify it, Elastic Beanstalk uses BUILD_GENERAL1_MEDIUM. Valid values: BUILD_GENERAL1_SMALL – Use up to 3 GB memory and 2 vCPUs for builds. BUILD_GENERAL1_MEDIUM – Use up to 7 GB memory and 4 vCPUs for builds. BUILD_GENERAL1_LARGE – Use up to 15 GB memory and 8 vCPUs for builds.'
        TimeoutInMinutes:
          type: integer
          description: How long, in minutes from 5 to 480 (8 hours), Elastic Beanstalk waits before stopping a build that hasn't completed. The default is 60 minutes.
    DeleteApplicationVersionMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application to which the version belongs.
        VersionLabel:
          type: string
          description: The label of the version to delete.
        DeleteSourceBundle:
          type: boolean
          description: Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
      required:
      - ApplicationName
      - VersionLabel
    OperationInProgressException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    UpdateApplicationVersionMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.
        VersionLabel:
          type: string
          description: The name of the version to update. If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
        Description:
          type: string
          description: A new description for this version.
      required:
      - ApplicationName
      - VersionLabel
    SourceBuildInformation:
      type: object
      properties:
        SourceType:
          type: string
          enum:
          - Git
          - Zip
          description: The type of repository. Git Zip
        SourceRepository:
          type: string
          enum:
          - CodeCommit
          - S3
          description: Location where the repository is stored. CodeCommit S3
        SourceLocation:
          type: string
          description: The location of the source code, as a formatted string, depending on the value of SourceRepository For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a. For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.
      required:
      - SourceType
      - SourceRepository
      - SourceLocation
    ApplicationVersionDescriptionsMessage:
      type: object
      properties:
        ApplicationVersions:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationVersionDescription'
          description: List of ApplicationVersionDescription objects sorted in order of creation.
        NextToken:
          type: string
          description: In a paginated request, the token that you can pass in a subsequent request to get the next response page.
    CodeBuildNotInServiceRegionException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    ApplicationVersionDescriptionMessage:
      type: object
      properties:
        ApplicationVersion:
          $ref: '#/components/schemas/ApplicationVersionDescription'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: elasticbeanstalk
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elastic-beanstalk/service/2010-12-01/elastic-beanstalk-2010-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)