AWS Elastic Beanstalk Amazon Elastic Beanstalk AWS Elastic Beanstalk #Describe… API

openapi: 3.2.0
info:
  title: 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Describe……'
  version: '2010-12-01'
  description: 'Operations tagged Amazon Elastic Beanstalk AWS Elastic Beanstalk #Describe… across 2 of this provider''s published API definitions: amazon-elastic-beanstalk-describeenvironments-api-openapi.yml, aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-describe-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 #Describe…'
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:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Describe…'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://elasticbeanstalk.amazonaws.com
      description: AWS Elastic Beanstalk API endpoint
  /?Action=DescribeEnvironments:
    post:
      operationId: DescribeEnvironments
      summary: Describe Environments
      description: Returns descriptions for existing environments. This action only returns information about environments 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 environments. When the user calls the DescribeEnvironments action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned. The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk environments. 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/EnvironmentDescriptionsMessage_2'
              example:
                Environments:
                - ApplicationName: my-app
                  EnvironmentName: my-env
                  VersionLabel: 7f58-stage-150812_025409
                  Status: Ready
                  EnvironmentId: e-rpqsewtp2j
                  EndpointURL: awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com
                  SolutionStackName: 64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8
                  CNAME: my-env.elasticbeanstalk.com
                  Health: Green
                  AbortableOperationInProgress: false
                  Tier:
                    Version: ' '
                    Type: Standard
                    Name: WebServer
                  DateUpdated: '2015-08-12T18:16:55.019Z'
                  DateCreated: '2015-08-07T20:48:49.599Z'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeEnvironments
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DescribeEnvironmentsMessage'
            example:
              EnvironmentNames:
              - my-env
      tags:
      - 'Amazon Elastic Beanstalk AWS Elastic Beanstalk #Describe…'
      security:
      - sigv4: []
    servers:
    - url: https://elasticbeanstalk.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    EnvironmentDescriptionsMessage:
      type: object
      properties:
        Environments:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
        NextToken:
          type: string
    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).
    EnvironmentDescriptionsMessage_2:
      type: object
      properties:
        Environments:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentDescription'
          description: Returns an EnvironmentDescription list.
        NextToken:
          type: string
          description: In a paginated request, the token that you can pass in a subsequent request to get the next response page.
    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.
    EnvironmentResourcesDescription:
      type: object
      properties:
        LoadBalancer:
          $ref: '#/components/schemas/LoadBalancerDescription'
    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.
    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.
    DescribeEnvironmentsMessage:
      type: object
      properties:
        ApplicationName:
          type: string
          description: If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
        VersionLabel:
          type: string
          description: If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
        EnvironmentIds:
          type: array
          items:
            type: string
          description: If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
        EnvironmentNames:
          type: array
          items:
            type: string
          description: If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
        IncludeDeleted:
          type: boolean
          description: 'Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments.'
        IncludedDeletedBackTo:
          type: string
          format: date-time
          description: If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
        MaxRecords:
          type: integer
          description: For a paginated request. Specify a maximum number of environments to include in each response. If no MaxRecords is specified, all available environments 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.
  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-describeenvironments-api-openapi.yml
- aws-elastic-beanstalk-amazon-elastic-beanstalk-aws-elastic-beanstalk-describe-api-openapi.yml