Amazon Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk API API

openapi: 3.1.0
info:
  title: Amazon Elastic Beanstalk AWS Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk API API
  description: AWS Elastic Beanstalk is a platform-as-a-service that makes it easy to deploy, manage, and scale web applications and services.
  version: '2010-12-01'
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
    url: https://aws.amazon.com/elasticbeanstalk/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://elasticbeanstalk.amazonaws.com
  description: AWS Elastic Beanstalk API endpoint
tags:
- name: Amazon Elastic Beanstalk AWS Elastic Beanstalk API
paths:
  /:
    post:
      operationId: createApplication
      summary: Amazon Elastic Beanstalk Create Application
      description: Creates an application that has one configuration template named default and no application versions.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateApplication
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-12-01'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - ApplicationName
              properties:
                ApplicationName:
                  type: string
                  description: The name of the application. Must be unique within your account.
                Description:
                  type: string
                  description: Your description of the application.
                ResourceLifecycleConfig:
                  type: object
                  properties:
                    ServiceRole:
                      type: string
                    VersionLifecycleConfig:
                      type: object
                      properties:
                        MaxCountRule:
                          type: object
                          properties:
                            Enabled:
                              type: boolean
                            MaxCount:
                              type: integer
                            DeleteSourceFromS3:
                              type: boolean
                        MaxAgeRule:
                          type: object
                          properties:
                            Enabled:
                              type: boolean
                            MaxAgeInDays:
                              type: integer
                            DeleteSourceFromS3:
                              type: boolean
                  description: Specifies an application resource lifecycle configuration.
                Tags:
                  type: array
                  items:
                    type: object
                    properties:
                      Key:
                        type: string
                      Value:
                        type: string
                  description: Specifies the tags applied to the application.
            examples:
              createApplicationRequestExample:
                summary: Default createApplication request
                x-microcks-default: true
                value:
                  ApplicationName: example-name
                  Description: Example description
                  ResourceLifecycleConfig: {}
                  Tags: []
      responses:
        '200':
          description: Successful response with the created application details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ApplicationDescriptionMessage'
              examples:
                createApplication200Example:
                  summary: Default createApplication 200 response
                  x-microcks-default: true
                  value:
                    Application:
                      ApplicationArn: arn:aws:service:us-east-1:123456789012:resource/example
                      ApplicationName: example-name
                      Description: Example description
                      DateCreated: '2025-01-15T00:00:00Z'
                      DateUpdated: '2025-01-15T00:00:00Z'
        '400':
          description: Bad request error.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Amazon Elastic Beanstalk AWS Elastic Beanstalk API
    get:
      operationId: describeApplications
      summary: Amazon Elastic Beanstalk Describe Applications
      description: Returns the descriptions of existing applications.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeApplications
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-12-01'
      - name: ApplicationNames.member.1
        in: query
        schema:
          type: string
        description: The name of an application to describe.
      responses:
        '200':
          description: Successful response with application details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ApplicationDescriptionsMessage'
              examples:
                describeApplications200Example:
                  summary: Default describeApplications 200 response
                  x-microcks-default: true
                  value:
                    Applications: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Amazon Elastic Beanstalk AWS Elastic Beanstalk API
components:
  schemas:
    ApplicationDescriptionsMessage:
      type: object
      properties:
        Applications:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDescription'
    ApplicationDescription:
      type: object
      properties:
        ApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the application.
        ApplicationName:
          type: string
          description: The name of the application.
        Description:
          type: string
          description: User-defined description of the application.
        DateCreated:
          type: string
          format: date-time
          description: The date when the application was created.
        DateUpdated:
          type: string
          format: date-time
          description: The date when the application was last modified.
        Versions:
          type: array
          items:
            type: string
          description: The names of the versions for this application.
        ConfigurationTemplates:
          type: array
          items:
            type: string
          description: The names of the configuration templates associated with this application.
        ResourceLifecycleConfig:
          type: object
          properties:
            ServiceRole:
              type: string
            VersionLifecycleConfig:
              type: object
          description: The lifecycle settings for the application.
    ApplicationDescriptionMessage:
      type: object
      properties:
        Application:
          $ref: '#/components/schemas/ApplicationDescription'
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.