Amazon CodeCatalyst Codecatalyst Devenvironments API

openapi: 3.2.0
info:
  title: Amazon CodeCatalyst Devenvironments API
  version: '2022-09-28'
  description: Generated from AWS's published Smithy model for Amazon CodeCatalyst. 5 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://codecatalyst.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Devenvironments
paths:
  /v1/spaces/{spaceName}/devEnvironments:
    post:
      operationId: ListDevEnvironments
      summary: List Dev Environments
      description: Retrieves a list of Dev Environments in a project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevEnvironmentsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDevEnvironmentsRequest'
      tags:
      - Devenvironments
components:
  schemas:
    DevEnvironmentSummary:
      type: object
      properties:
        spaceName:
          type: string
          description: The name of the space.
        projectName:
          type: string
          description: The name of the project in the space.
        id:
          type: string
          description: The system-generated unique ID for the Dev Environment.
        lastUpdatedTime:
          type: string
          format: date-time
          description: The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
        creatorId:
          type: string
          description: The system-generated unique ID of the user who created the Dev Environment.
        status:
          type: string
          description: The status of the Dev Environment.
        statusReason:
          type: string
          description: The reason for the status.
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/DevEnvironmentRepositorySummary'
          description: Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.
        alias:
          type: string
          description: The user-specified alias for the Dev Environment.
        ides:
          type: array
          items:
            $ref: '#/components/schemas/Ide'
          description: Information about the integrated development environment (IDE) configured for a Dev Environment.
        instanceType:
          type: string
          description: The Amazon EC2 instace type used for the Dev Environment.
        inactivityTimeoutMinutes:
          type: integer
          description: The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.
        persistentStorage:
          $ref: '#/components/schemas/PersistentStorage'
        vpcConnectionName:
          type: string
          description: The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
      required:
      - id
      - lastUpdatedTime
      - creatorId
      - status
      - repositories
      - instanceType
      - inactivityTimeoutMinutes
      - persistentStorage
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Filter:
      type: object
      properties:
        key:
          type: string
          description: A key that can be used to sort results.
        values:
          type: array
          items:
            type: string
          description: The values of the key.
        comparisonOperator:
          type: string
          description: The operator used to compare the fields.
      required:
      - key
      - values
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Ide:
      type: object
      properties:
        runtime:
          type: string
          description: A link to the IDE runtime image.
        name:
          type: string
          description: The name of the IDE.
    DevEnvironmentRepositorySummary:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the source repository.
        branchName:
          type: string
          description: The name of the branch in a source repository cloned into the Dev Environment.
      required:
      - repositoryName
    PersistentStorage:
      type: object
      properties:
        sizeInGiB:
          type: integer
          description: The size of the persistent storage in gigabytes (specifically GiB). Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
      required:
      - sizeInGiB
    ListDevEnvironmentsRequest:
      type: object
      properties:
        spaceName:
          type: string
          description: The name of the space.
        projectName:
          type: string
          description: The name of the project in the space.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: Information about filters to apply to narrow the results returned in the list.
        nextToken:
          type: string
          description: A token returned from a call to this API to indicate the next batch of results to return, if any.
        maxResults:
          type: integer
          description: The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
      required:
      - spaceName
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListDevEnvironmentsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DevEnvironmentSummary'
          description: Information about the Dev Environments in a project.
        nextToken:
          type: string
          description: A token returned from a call to this API to indicate the next batch of results to return, if any.
      required:
      - items
  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: codecatalyst
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)