Amazon CodeCatalyst Session API

The Session API from Amazon CodeCatalyst — 1 operation(s) for session.

Documentation GitHub OpenAPI

Operations 4

GET /session Verify Session #

POST /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{devEnvironmentId}/sessions List Dev Environment Sessions #

PUT /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session Start Dev Environment Session #

DELETE /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId} Stop Dev Environment Session #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-codecatalyst:amazon-codecatalyst-session-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon CodeCatalyst Session API
  version: '2022-09-28'
  description: Generated from AWS's published Smithy model for Amazon CodeCatalyst. 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://codecatalyst.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /session:
    get:
      operationId: VerifySession
      summary: Verify Session
      description: Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this
        returns the ID of the user in Amazon CodeCatalyst.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifySessionResponse'
        '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:
              type: string
      tags:
      - Session
  /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{devEnvironmentId}/sessions:
    post:
      operationId: ListDevEnvironmentSessions
      summary: List Dev Environment Sessions
      description: Retrieves a list of active sessions for a Dev Environment in a project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevEnvironmentSessionsResponse'
        '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/ListDevEnvironmentSessionsRequest'
      tags:
      - Session
  /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session:
    put:
      operationId: StartDevEnvironmentSession
      summary: Start Dev Environment Session
      description: Starts a session for a specified Dev Environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDevEnvironmentSessionResponse'
        '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/StartDevEnvironmentSessionRequest'
      tags:
      - Session
  /v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId}:
    delete:
      operationId: StopDevEnvironmentSession
      summary: Stop Dev Environment Session
      description: Stops a session for a specified Dev Environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopDevEnvironmentSessionResponse'
        '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/StopDevEnvironmentSessionRequest'
      tags:
      - Session
components:
  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
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DevEnvironmentAccessDetails:
      type: object
      properties:
        streamUrl:
          type: string
          description: The URL used to send commands to and from the Dev Environment.
        tokenValue:
          type: string
          description: An encrypted token value that contains session and caller information used to authenticate the connection.
      required:
      - streamUrl
      - tokenValue
    DevEnvironmentSessionConfiguration:
      type: object
      properties:
        sessionType:
          type: string
          description: The type of the session.
        executeCommandSessionConfiguration:
          $ref: '#/components/schemas/ExecuteCommandSessionConfiguration'
      required:
      - sessionType
    DevEnvironmentSessionSummary:
      type: object
      properties:
        spaceName:
          type: string
          description: The name of the space.
        projectName:
          type: string
          description: The name of the project in the space.
        devEnvironmentId:
          type: string
          description: The system-generated unique ID of the Dev Environment.
        startedTime:
          type: string
          format: date-time
          description: The date and time the session started, in coordinated universal time (UTC) timestamp format as specified
            in RFC 3339
        id:
          type: string
          description: The system-generated unique ID of the Dev Environment session.
      required:
      - spaceName
      - projectName
      - devEnvironmentId
      - startedTime
      - id
    ExecuteCommandSessionConfiguration:
      type: object
      properties:
        command:
          type: string
          description: The command used at the beginning of the SSH session to a Dev Environment.
        arguments:
          type: array
          items:
            type: string
          description: An array of arguments containing arguments and members.
      required:
      - command
    ListDevEnvironmentSessionsRequest:
      type: object
      properties:
        spaceName:
          type: string
          description: The name of the space.
        projectName:
          type: string
          description: The name of the project in the space.
        devEnvironmentId:
          type: string
          description: The system-generated unique ID of the Dev Environment.
        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
      - projectName
      - devEnvironmentId
    ListDevEnvironmentSessionsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DevEnvironmentSessionSummary'
          description: Information about each session retrieved 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.
      required:
      - items
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    StartDevEnvironmentSessionRequest:
      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 of the Dev Environment.
        sessionConfiguration:
          $ref: '#/components/schemas/DevEnvironmentSessionConfiguration'
      required:
      - spaceName
      - projectName
      - id
      - sessionConfiguration
    StartDevEnvironmentSessionResponse:
      type: object
      properties:
        accessDetails:
          $ref: '#/components/schemas/DevEnvironmentAccessDetails'
        sessionId:
          type: string
          description: The system-generated unique ID of the Dev Environment session.
        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 of the Dev Environment.
      required:
      - accessDetails
      - spaceName
      - projectName
      - id
    StopDevEnvironmentSessionRequest:
      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 of the Dev Environment. To obtain this ID, use ListDevEnvironments.
        sessionId:
          type: string
          description: The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.
      required:
      - spaceName
      - projectName
      - id
      - sessionId
    StopDevEnvironmentSessionResponse:
      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 of the Dev Environment.
        sessionId:
          type: string
          description: The system-generated unique ID of the Dev Environment session.
      required:
      - spaceName
      - projectName
      - id
      - sessionId
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    VerifySessionResponse:
      type: object
      properties:
        identity:
          type: string
          description: The system-generated unique ID of the user in Amazon CodeCatalyst.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)

Amazon CodeCatalyst Session API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources