AWS Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update… API

openapi: 3.2.0
info:
  title: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update… API'
  version: '2010-12-01'
  description: 'Operations tagged Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update… across 2 of this provider''s published API definitions: amazon-elastic-beanstalk-updateenvironment-api-openapi.yml, aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-update-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://elasticbeanstalk.amazonaws.com
  description: AWS Elastic Beanstalk API endpoint
- url: https://elasticbeanstalk.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update…'
paths:
  /#UpdateEnvironment:
    post:
      operationId: updateEnvironment
      summary: Amazon Elastic Beanstalk Update Environment
      description: Updates the environment description, deploys a new application version, updates the configuration settings, or updates the stack to a new version.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - UpdateEnvironment
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-12-01'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                EnvironmentId:
                  type: string
                  description: The ID of the environment to update.
                EnvironmentName:
                  type: string
                  description: The name of the environment to update.
                Description:
                  type: string
                  description: A new description for the environment.
                VersionLabel:
                  type: string
                  description: The application version to deploy to the running environment.
                TemplateName:
                  type: string
                  description: The name of the configuration template to deploy.
                SolutionStackName:
                  type: string
                  description: The name of the solution stack to update to.
                PlatformArn:
                  type: string
                  description: The ARN of the platform to update to.
                OptionSettings:
                  type: array
                  items:
                    type: object
                    properties:
                      ResourceName:
                        type: string
                      Namespace:
                        type: string
                      OptionName:
                        type: string
                      Value:
                        type: string
                  description: Updated configuration option values.
            examples:
              updateEnvironmentRequestExample:
                summary: Default updateEnvironment request
                x-microcks-default: true
                value:
                  EnvironmentId: example-id-12345
                  EnvironmentName: example-name
                  Description: Example description
                  VersionLabel: '2025-01-01'
                  TemplateName: example-name
      responses:
        '200':
          description: Successful response with the updated environment details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                updateEnvironment200Example:
                  summary: Default updateEnvironment 200 response
                  x-microcks-default: true
                  value:
                    EnvironmentId: example-id-12345
                    EnvironmentName: example-name
                    EnvironmentArn: arn:aws:service:us-east-1:123456789012:resource/example
                    ApplicationName: example-name
                    VersionLabel: '2025-01-01'
        '400':
          description: Bad request error.
      tags:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update…'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://elasticbeanstalk.amazonaws.com
      description: AWS Elastic Beanstalk API endpoint
  /?Action=UpdateEnvironment:
    post:
      operationId: UpdateEnvironment
      summary: Update Environment
      description: Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. Attempting to update both the release and configuration is not allowed and Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EnvironmentDescription'
              example:
                ApplicationName: my-app
                EnvironmentName: my-env
                VersionLabel: 7f58-stage-150812_025409
                Status: Updating
                EnvironmentId: e-wtp2rpqsej
                EndpointURL: awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com
                SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
                CNAME: my-env.elasticbeanstalk.com
                Health: Grey
                AbortableOperationInProgress: true
                Tier:
                  Version: ' '
                  Type: Standard
                  Name: WebServer
                DateUpdated: '2015-08-12T18:15:23.804Z'
                DateCreated: '2015-08-07T20:48:49.599Z'
        '403':
          description: InsufficientPrivilegesException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InsufficientPrivilegesException'
        '400':
          description: TooManyBucketsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TooManyBucketsException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateEnvironment
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/UpdateEnvironmentMessage'
            example:
              EnvironmentName: my-env
              OptionSettings:
              - Namespace: aws:elb:healthcheck
                OptionName: Interval
                Value: '15'
              - Namespace: aws:elb:healthcheck
                OptionName: Timeout
                Value: '8'
              - Namespace: aws:elb:healthcheck
                OptionName: HealthyThreshold
                Value: '2'
              - Namespace: aws:elb:healthcheck
                OptionName: UnhealthyThreshold
                Value: '3'
      tags:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Update…'
      security:
      - sigv4: []
    servers:
    - url: https://elasticbeanstalk.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    Environment:
      type: object
      properties:
        EnvironmentId:
          type: string
          description: The ID of this environment.
        EnvironmentName:
          type: string
          description: The name of this environment.
        EnvironmentArn:
          type: string
          description: The ARN of this environment.
        ApplicationName:
          type: string
          description: The name of the application associated with this environment.
        VersionLabel:
          type: string
          description: The application version deployed in this environment.
        SolutionStackName:
          type: string
          description: The name of the solution stack deployed with this environment.
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        Description:
          type: string
          description: Describes this environment.
        EndpointURL:
          type: string
          description: The URL to the LoadBalancer for this environment.
        CNAME:
          type: string
          description: The URL to the CNAME for this environment.
        DateCreated:
          type: string
          format: date-time
          description: The creation date for this environment.
        DateUpdated:
          type: string
          format: date-time
          description: The last modified date for this environment.
        Status:
          type: string
          enum:
          - Aborting
          - Launching
          - Updating
          - LinkingFrom
          - LinkingTo
          - Ready
          - Terminating
          - Terminated
          description: The current operational status of the environment.
        Health:
          type: string
          enum:
          - Green
          - Yellow
          - Red
          - Grey
          description: Describes the health status of the environment.
        HealthStatus:
          type: string
          enum:
          - NoData
          - Unknown
          - Pending
          - Ok
          - Info
          - Warning
          - Degraded
          - Severe
          - Suspended
          description: Returns the health status of the application running in your environment.
        Tier:
          type: object
          properties:
            Name:
              type: string
            Type:
              type: string
            Version:
              type: string
          description: Describes the current tier of this environment.
    EnvironmentLink:
      type: object
      properties:
        LinkName:
          type: string
          description: The name of the link.
        EnvironmentName:
          type: string
          description: The name of the linked environment (the dependency).
    InsufficientPrivilegesException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    TooManyBucketsException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    EnvironmentResourcesDescription:
      type: object
      properties:
        LoadBalancer:
          $ref: '#/components/schemas/LoadBalancerDescription'
    EnvironmentDescription:
      type: object
      properties:
        EnvironmentName:
          type: string
          description: The name of this environment.
        EnvironmentId:
          type: string
          description: The ID of this environment.
        ApplicationName:
          type: string
          description: The name of the application associated with this environment.
        VersionLabel:
          type: string
          description: The application version deployed in this environment.
        SolutionStackName:
          type: string
          description: The name of the SolutionStack deployed with this environment.
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        TemplateName:
          type: string
          description: The name of the configuration template used to originally launch this environment.
        Description:
          type: string
          description: Describes this environment.
        EndpointURL:
          type: string
          description: For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
        CNAME:
          type: string
          description: The URL to the CNAME for this environment.
        DateCreated:
          type: string
          format: date-time
          description: The creation date for this environment.
        DateUpdated:
          type: string
          format: date-time
          description: The last modified date for this environment.
        Status:
          type: string
          enum:
          - Aborting
          - Launching
          - Updating
          - LinkingFrom
          - LinkingTo
          - Ready
          - Terminating
          - Terminated
          description: 'The current operational status of the environment: Aborting: Environment is in the process of aborting a deployment. Launching: Environment is in the process of initial deployment. LinkingFrom: Environment is in the process of being linked to by another environment. See Environment links for details. LinkingTo: Environment is in the process of linking to another environment. See Environment links for details. Updating: Environment is in the process of updating its configuration settings or application version. Ready: Environment is available to have an action performed on it, such as update or'
        AbortableOperationInProgress:
          type: boolean
          description: 'Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.'
        Health:
          type: string
          enum:
          - Green
          - Yellow
          - Red
          - Grey
          description: 'Describes the health status of the environment. Elastic Beanstalk indicates the failure levels for a running environment: Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and fully functional. Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or Rest'
        HealthStatus:
          type: string
          enum:
          - NoData
          - Unknown
          - Pending
          - Ok
          - Info
          - Warning
          - Degraded
          - Severe
          - Suspended
          description: Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
        Resources:
          $ref: '#/components/schemas/EnvironmentResourcesDescription'
        Tier:
          $ref: '#/components/schemas/EnvironmentTier'
        EnvironmentLinks:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentLink'
          description: A list of links to other environments in the same group.
        EnvironmentArn:
          type: string
          description: The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
        OperationsRole:
          type: string
          description: The operations role feature of Elastic Beanstalk is in beta release and is subject to change. The Amazon Resource Name (ARN) of the environment's operations role.
    ConfigurationOptionSetting:
      type: object
      properties:
        ResourceName:
          type: string
          description: A unique resource name for the option setting. Use it for a time–based scaling configuration option.
        Namespace:
          type: string
          description: A unique namespace that identifies the option's associated Amazon Web Services resource.
        OptionName:
          type: string
          description: The name of the configuration option.
        Value:
          type: string
          description: The current value for the configuration option.
    Listener:
      type: object
      properties:
        Protocol:
          type: string
          description: The protocol that is used by the Listener.
        Port:
          type: integer
          description: The port that is used by the Listener.
    UpdateEnvironmentMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: The name of the application with which the environment is associated.
        EnvironmentId:
          type: string
          description: 'The ID of the environment to update. If no environment with this ID exists, Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, Elastic Beanstalk returns MissingRequiredParameter error.'
        EnvironmentName:
          type: string
          description: 'The name of the environment to update. If no environment with this name exists, Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, Elastic Beanstalk returns MissingRequiredParameter error.'
        GroupName:
          type: string
          description: The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
        Description:
          type: string
          description: If this parameter is specified, Elastic Beanstalk updates the description of this environment.
        Tier:
          $ref: '#/components/schemas/EnvironmentTier'
        VersionLabel:
          type: string
          description: If this parameter is specified, Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
        TemplateName:
          type: string
          description: If this parameter is specified, Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, Elastic Beanstalk returns an InvalidParameterValue error.
        SolutionStackName:
          type: string
          description: This specifies the platform version that the environment will run after the environment is updated.
        PlatformArn:
          type: string
          description: The ARN of the platform, if used.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: If specified, Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
        OptionsToRemove:
          type: array
          items:
            $ref: '#/components/schemas/OptionSpecification'
          description: A list of custom user-defined configuration options to remove from the configuration set for this environment.
    EnvironmentTier:
      type: object
      properties:
        Name:
          type: string
          description: 'The name of this environment tier. Valid values: For Standard-mode EC2-based web server – WebServer For Standard-mode EC2-based backend application with Amazon SQS – Worker For Cluster-mode Amazon EKS-based applications – Cluster'
        Type:
          type: string
          description: 'The type of this environment tier. Valid values: For Web server tier – Standard For Worker tier – SQS/HTTP For Cluster tier – EKS'
        Version:
          type: string
          description: The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
    LoadBalancerDescription:
      type: object
      properties:
        LoadBalancerName:
          type: string
          description: The name of the LoadBalancer.
        Domain:
          type: string
          description: The domain name of the LoadBalancer.
        Listeners:
          type: array
          items:
            $ref: '#/components/schemas/Listener'
          description: A list of Listeners used by the LoadBalancer.
    OptionSpecification:
      type: object
      properties:
        ResourceName:
          type: string
          description: A unique resource name for a time-based scaling configuration option.
        Namespace:
          type: string
          description: A unique namespace identifying the option's associated Amazon Web Services resource.
        OptionName:
          type: string
          description: The name of the configuration option.
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.
    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-refined-from:
- amazon-elastic-beanstalk-updateenvironment-api-openapi.yml
- aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-update-api-openapi.yml