Amazon Elastic Beanstalk #DescribeEnvironments API

openapi: 3.1.0
info:
  title: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk API #DescribeEnvironments 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: '#DescribeEnvironments'
paths:
  /#DescribeEnvironments:
    get:
      operationId: describeEnvironments
      summary: Amazon Elastic Beanstalk Describe Environments
      description: Returns descriptions for existing environments.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeEnvironments
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-12-01'
      - name: ApplicationName
        in: query
        schema:
          type: string
        description: The name of the application associated with the environments.
      - name: EnvironmentIds.member.1
        in: query
        schema:
          type: string
        description: An environment ID to describe.
      - name: EnvironmentNames.member.1
        in: query
        schema:
          type: string
        description: An environment name to describe.
      - name: IncludeDeleted
        in: query
        schema:
          type: boolean
        description: Indicates whether to include deleted environments.
      - name: MaxRecords
        in: query
        schema:
          type: integer
        description: The maximum number of environments to return.
      - name: NextToken
        in: query
        schema:
          type: string
        description: The pagination token for the next set of results.
      responses:
        '200':
          description: Successful response with environment details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/EnvironmentDescriptionsMessage'
              examples:
                describeEnvironments200Example:
                  summary: Default describeEnvironments 200 response
                  x-microcks-default: true
                  value:
                    Environments: []
                    NextToken: example
      tags:
      - '#DescribeEnvironments'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
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.
    EnvironmentDescriptionsMessage:
      type: object
      properties:
        Environments:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
        NextToken:
          type: string
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.