Amazon Web Services, Inc.

Amazon CodeCatalyst

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst
API to work with the following objects.
Spaces, by calling the following:

DeleteSpace , which deletes a space.

GetSpace , which returns information about a space.

GetSubscription , which returns information about the Amazon Web Services account used for billing purposes
and the billing plan for the space.

ListSpaces , which retrieves a list of spaces.

UpdateSpace , which changes one or more values for a space.

Projects, by calling the following:

CreateProject which creates a project in a specified space.

GetProject , which returns information about a project.

ListProjects , which retrieves a list of projects in a space.

Users, by calling the following:

GetUserDetails , which returns information about a user in Amazon CodeCatalyst.

Source repositories, by calling the following:

CreateSourceRepository , which creates an empty Git-based source repository in a specified project.

CreateSourceRepositoryBranch , which creates a branch in a specified repository where you can work on code.

DeleteSourceRepository , which deletes a source repository.

GetSourceRepository , which returns information about a source repository.

GetSourceRepositoryCloneUrls , which returns information about the URLs that can be used with a Git client to clone a source
repository.

ListSourceRepositories , which retrieves a list of source repositories in a project.

ListSourceRepositoryBranches , which retrieves a list of branches in a source repository.

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

CreateDevEnvironment , which creates a Dev Environment,
where you can quickly work on the code stored in the source repositories of your project.

DeleteDevEnvironment , which deletes a Dev Environment.

GetDevEnvironment , which returns information about a Dev Environment.

ListDevEnvironments , which retrieves a list of Dev Environments in a project.

ListDevEnvironmentSessions , which retrieves a list of active Dev Environment sessions in a project.

StartDevEnvironment , which starts a specified Dev Environment and puts it into an active state.

StartDevEnvironmentSession , which starts a session to a specified Dev Environment.

StopDevEnvironment , which stops a specified Dev Environment and puts it into an stopped state.

StopDevEnvironmentSession , which stops a session for a specified Dev Environment.

UpdateDevEnvironment , which changes one or more values for a Dev Environment.

Workflows, by calling the following:

GetWorkflow , which returns information about a workflow.

GetWorkflowRun , which returns information about a specified run of a workflow.

ListWorkflowRuns , which retrieves a list of runs of a specified workflow.

ListWorkflows , which retrieves a list of workflows in a specified project.

StartWorkflowRun , which starts a run of a specified workflow.

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

CreateAccessToken , which creates a personal access token (PAT) for the current user.

DeleteAccessToken , which deletes a specified personal access token (PAT).

ListAccessTokens , which lists all personal access tokens (PATs) associated with a user.

ListEventLogs , which retrieves a list of events that occurred during a specified time period in a space.

VerifySession , which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).
For more information, see Setting up to use the CLI with Amazon CodeCatalyst
and the SSO documentation for your SDK.

Endpoints 38

Access token

  • PUTCreate access token/v1/accessTokensCreates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity…
  • POSTList access tokens/v1/accessTokensLists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.
  • DELETEDelete access token/v1/accessTokens/:idDeletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

Dev environment

  • PUTCreate dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironmentsCreates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source…
  • GETGet dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:idReturns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
  • DELETEDelete dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:idDeletes a Dev Environment.
  • PATCHUpdate dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:idChanges one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.
  • POSTList dev environment sessions/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:devEnvironmentId/sessionsRetrieves a list of active sessions for a Dev Environment in a project.
  • PUTStart dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:id/startStarts a specified Dev Environment and puts it into an active state.
  • PUTStart dev environment session/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:id/sessionStarts a session for a specified Dev Environment.
  • PUTStop dev environment/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:id/stopPauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
  • DELETEStop dev environment session/v1/spaces/:spaceName/projects/:projectName/devEnvironments/:id/session/:sessionIdStops a session for a specified Dev Environment.

Project

  • PUTCreate project/v1/spaces/:spaceName/projectsCreates a project in a specified space.
  • POSTList projects/v1/spaces/:spaceName/projectsRetrieves a list of projects.
  • GETGet project/v1/spaces/:spaceName/projects/:nameReturns information about a project.
  • DELETEDelete project/v1/spaces/:spaceName/projects/:nameDeletes a project in a space.
  • PATCHUpdate project/v1/spaces/:spaceName/projects/:nameChanges one or more values for a project.

Source repository

  • GETGet source repository/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:nameReturns information about a source repository.
  • PUTCreate source repository/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:nameCreates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main .
  • DELETEDelete source repository/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:nameDeletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst…
  • GETGet source repository clone urls/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:sourceRepositoryName/cloneUrlsReturns information about the URLs that can be used with a Git client to clone a source repository.
  • POSTList source repositories/v1/spaces/:spaceName/projects/:projectName/sourceRepositoriesRetrieves a list of source repositories in a project.

Source repository branch

  • PUTCreate source repository branch/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:sourceRepositoryName/branches/:nameCreates a branch in a specified source repository in Amazon CodeCatalyst. This API only creates a branch in a source repository hosted in Amazon CodeCatalyst.…
  • POSTList source repository branches/v1/spaces/:spaceName/projects/:projectName/sourceRepositories/:sourceRepositoryName/branchesRetrieves a list of branches in a specified source repository.

Space

  • GETGet space/v1/spaces/:nameReturns information about an space.
  • DELETEDelete space/v1/spaces/:nameDeletes a space. Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of…
  • PATCHUpdate space/v1/spaces/:nameChanges one or more values for a space.
  • POSTList dev environments/v1/spaces/:spaceName/devEnvironmentsRetrieves a list of Dev Environments in a project.
  • POSTList spaces/v1/spacesRetrieves a list of spaces.

Subscription

  • GETGet subscription/v1/spaces/:spaceName/subscriptionReturns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

Workflow

  • GETGet workflow/v1/spaces/:spaceName/projects/:projectName/workflows/:idReturns information about a workflow.
  • POSTList workflows/v1/spaces/:spaceName/projects/:projectName/workflows?nextToken=string&maxResults=0Retrieves a list of workflows in a specified project.

Workflow run

  • GETGet workflow run/v1/spaces/:spaceName/projects/:projectName/workflowRuns/:idReturns information about a specified run of a workflow.
  • PUTStart workflow run/v1/spaces/:spaceName/projects/:projectName/workflowRuns?workflowId=stringBegins a run of a specified workflow.
  • POSTList workflow runs/v1/spaces/:spaceName/projects/:projectName/workflowRuns?workflowId=string&nextToken=string&maxResults=0Retrieves a list of workflow runs of a specified workflow.

Event log

  • POSTList event logs/v1/spaces/:spaceName/eventLogsRetrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more…
  • GETGet user details/userDetails?id=string&userName=stringReturns information about a user.
  • GETVerify session/sessionVerifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

API details

Base URL
https://codecatalyst.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
38 operations on 27 pathsGET 10POST 10PUT 9DELETE 6PATCH 3
Main resources
Dev environment 9Project 5Source repository 5Space 5Access token 3Workflow run 3Source repository branch 2Workflow 2Event log 1Subscription 1
Description format
AWS Smithy model, API version 2022-09-28

How to test the Amazon CodeCatalyst in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CodeCatalyst collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create access token” (PUT /v1/accessTokens), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CodeCatalyst?

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the… It is listed under Developer tools and has 38 endpoints.

Who publishes the Amazon CodeCatalyst?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon CodeCatalyst?

Requests go to https://codecatalyst.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CodeCatalyst?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CodeCatalyst have?

38 operations on 27 paths (10 GET, 10 POST, 9 PUT, 6 DELETE, 3 PATCH). The largest groups are Dev environment, Project, Source repository, Space.

Is forking the Amazon CodeCatalyst free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.