Welcome

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.

Dev Environments and the AWS Toolkits, by calling the following:

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

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

• CreateProject which creates a project in a specified space.

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

• DeleteDevEnvironment, which deletes a Dev Environment.

• GetDevEnvironment, which returns information about a Dev Environment.

• GetProject, which returns information about a project.

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

• GetSpace, which returns information about a space.

• GetSubscription, which returns information about the AWS account used for billing purposes and the billing plan for the space.

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

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

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

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

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

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

• ListSpaces, which retrieves a list of spaces.

• 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.

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

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

• 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.

Note

If you are using the Amazon CodeCatalyst APIs with an SDK or the AWS 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 AWS CLI with Amazon CodeCatalyst and the SSO documentation for your SDK.

This document was last published on June 9, 2023.