AWS Elastic Beanstalk Elastic Beanstalk Platform Version API

openapi: 3.2.0
info:
  title: AWS Elastic Beanstalk Platform 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: Platform Version
paths:
  /?Action=CreatePlatformVersion:
    post:
      operationId: CreatePlatformVersion
      summary: Create Platform Version
      description: Create a new version of your custom platform.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreatePlatformVersionResult'
        '400':
          description: ElasticBeanstalkServiceException; TooManyPlatformsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ElasticBeanstalkServiceException'
        '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: CreatePlatformVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/CreatePlatformVersionRequest'
      tags:
      - Platform Version
  /?Action=DeletePlatformVersion:
    post:
      operationId: DeletePlatformVersion
      summary: Delete Platform Version
      description: Deletes the specified version of a custom platform.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeletePlatformVersionResult'
        '400':
          description: ElasticBeanstalkServiceException; OperationInProgressException; PlatformVersionStillReferencedException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ElasticBeanstalkServiceException'
        '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: DeletePlatformVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DeletePlatformVersionRequest'
      tags:
      - Platform Version
  /?Action=DescribePlatformVersion:
    post:
      operationId: DescribePlatformVersion
      summary: Describe Platform Version
      description: Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see Elastic Beanstalk Platforms Glossary. 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/DescribePlatformVersionResult'
        '400':
          description: ElasticBeanstalkServiceException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ElasticBeanstalkServiceException'
        '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: DescribePlatformVersion
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/DescribePlatformVersionRequest'
      tags:
      - Platform Version
  /?Action=ListPlatformVersions:
    post:
      operationId: ListPlatformVersions
      summary: List Platform Versions
      description: Lists the platform versions available for your account in an Amazon Web Services Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. This action only returns information about platform versions that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of ten platform versions. When the user calls the ListPlatformVersions action, the response will only include the one platform version that the user has permission to access instead of all ten platform versions. If the user doesn’t have access to any of the platform versions 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. For definitions of platform version and other platform-related
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListPlatformVersionsResult'
        '400':
          description: ElasticBeanstalkServiceException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ElasticBeanstalkServiceException'
        '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: ListPlatformVersions
                  Version:
                    type: string
                    const: '2010-12-01'
              - $ref: '#/components/schemas/ListPlatformVersionsRequest'
      tags:
      - Platform Version
components:
  schemas:
    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.
    CustomAmi:
      type: object
      properties:
        VirtualizationType:
          type: string
          description: The type of virtualization used to create the custom AMI.
        ImageId:
          type: string
          description: THe ID of the image used to create the custom AMI.
    ListPlatformVersionsRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/PlatformFilter'
          description: Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
        MaxRecords:
          type: integer
          description: The maximum number of platform version values returned in one call.
        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.
    Builder:
      type: object
      properties:
        ARN:
          type: string
          description: The ARN of the builder.
    CreatePlatformVersionRequest:
      type: object
      properties:
        PlatformName:
          type: string
          description: The name of your custom platform.
        PlatformVersion:
          type: string
          description: The number, such as 1.0.2, for the new platform version.
        PlatformDefinitionBundle:
          $ref: '#/components/schemas/S3Location'
        EnvironmentName:
          type: string
          description: The name of the builder environment.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationOptionSetting'
          description: The configuration option settings to apply to the builder environment.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Specifies the tags applied to the new platform version. Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.
      required:
      - PlatformName
      - PlatformVersion
      - PlatformDefinitionBundle
    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.
    PlatformProgrammingLanguage:
      type: object
      properties:
        Name:
          type: string
          description: The name of the programming language.
        Version:
          type: string
          description: The version of the programming language.
    DescribePlatformVersionResult:
      type: object
      properties:
        PlatformDescription:
          $ref: '#/components/schemas/PlatformDescription'
    PlatformDescription:
      type: object
      properties:
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        PlatformOwner:
          type: string
          description: The Amazon Web Services account ID of the person who created the platform version.
        PlatformName:
          type: string
          description: The name of the platform version.
        PlatformVersion:
          type: string
          description: The version of the platform version.
        SolutionStackName:
          type: string
          description: The name of the solution stack used by the platform version.
        PlatformStatus:
          type: string
          enum:
          - Creating
          - Failed
          - Ready
          - Deleting
          - Deleted
          description: The status of the platform version.
        DateCreated:
          type: string
          format: date-time
          description: The date when the platform version was created.
        DateUpdated:
          type: string
          format: date-time
          description: The date when the platform version was last updated.
        PlatformCategory:
          type: string
          description: The category of the platform version.
        Description:
          type: string
          description: The description of the platform version.
        Maintainer:
          type: string
          description: Information about the maintainer of the platform version.
        OperatingSystemName:
          type: string
          description: The operating system used by the platform version.
        OperatingSystemVersion:
          type: string
          description: The version of the operating system used by the platform version.
        ProgrammingLanguages:
          type: array
          items:
            $ref: '#/components/schemas/PlatformProgrammingLanguage'
          description: The programming languages supported by the platform version.
        Frameworks:
          type: array
          items:
            $ref: '#/components/schemas/PlatformFramework'
          description: The frameworks supported by the platform version.
        CustomAmiList:
          type: array
          items:
            $ref: '#/components/schemas/CustomAmi'
          description: The custom AMIs supported by the platform version.
        SupportedTierList:
          type: array
          items:
            type: string
          description: The tiers supported by the platform version.
        SupportedAddonList:
          type: array
          items:
            type: string
          description: The additions supported by the platform version.
        PlatformLifecycleState:
          type: string
          description: 'The state of the platform version in its lifecycle. Possible values: Recommended | null If a null value is returned, the platform version isn''t the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.'
        PlatformBranchName:
          type: string
          description: The platform branch to which the platform version belongs.
        PlatformBranchLifecycleState:
          type: string
          description: 'The state of the platform version''s branch in its lifecycle. Possible values: Beta | Supported | Deprecated | Retired'
    PlatformFramework:
      type: object
      properties:
        Name:
          type: string
          description: The name of the framework.
        Version:
          type: string
          description: The version of the framework.
    DescribePlatformVersionRequest:
      type: object
      properties:
        PlatformArn:
          type: string
          description: The ARN of the platform version.
    ElasticBeanstalkServiceException:
      type: object
      properties:
        message:
          type: string
          description: The exception error message.
    CreatePlatformVersionResult:
      type: object
      properties:
        PlatformSummary:
          $ref: '#/components/schemas/PlatformSummary'
        Builder:
          $ref: '#/components/schemas/Builder'
    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.
    DeletePlatformVersionResult:
      type: object
      properties:
        PlatformSummary:
          $ref: '#/components/schemas/PlatformSummary'
    DeletePlatformVersionRequest:
      type: object
      properties:
        PlatformArn:
          type: string
          description: The ARN of the version of the custom platform.
    PlatformFilter:
      type: object
      properties:
        Type:
          type: string
          description: 'The platform version attribute to which the filter values are applied. Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName'
        Operator:
          type: string
          description: 'The operator to apply to the Type with each of the Values. Valid values: = | != | | | > | >= | contains | begins_with | ends_with'
        Values:
          type: array
          items:
            type: string
          description: 'The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators. The following list shows valid filter values for some filter attributes. PlatformStatus: Creating | Failed | Ready | Deleting | Deleted PlatformLifecycleState: recommended SupportedTier: WebServer/Standard | Worker/SQS/HTTP SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD'
    PlatformSummary:
      type: object
      properties:
        PlatformArn:
          type: string
          description: The ARN of the platform version.
        PlatformOwner:
          type: string
          description: The Amazon Web Services account ID of the person who created the platform version.
        PlatformStatus:
          type: string
          enum:
          - Creating
          - Failed
          - Ready
          - Deleting
          - Deleted
          description: The status of the platform version. You can create an environment from the platform version once it is ready.
        PlatformCategory:
          type: string
          description: The category of platform version.
        OperatingSystemName:
          type: string
          description: The operating system used by the platform version.
        OperatingSystemVersion:
          type: string
          description: The version of the operating system used by the platform version.
        SupportedTierList:
          type: array
          items:
            type: string
          description: The tiers in which the platform version runs.
        SupportedAddonList:
          type: array
          items:
            type: string
          description: The additions associated with the platform version.
        PlatformLifecycleState:
          type: string
          description: 'The state of the platform version in its lifecycle. Possible values: recommended | empty If an empty value is returned, the platform version is supported but isn''t the recommended one for its branch.'
        PlatformVersion:
          type: string
          description: The version string of the platform version.
        PlatformBranchName:
          type: string
          description: The platform branch to which the platform version belongs.
        PlatformBranchLifecycleState:
          type: string
          description: 'The state of the platform version''s branch in its lifecycle. Possible values: beta | supported | deprecated | retired'
    ListPlatformVersionsResult:
      type: object
      properties:
        PlatformSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/PlatformSummary'
          description: Summary information about the platform versions.
        NextToken:
          type: string
          description: In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
  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)