CodeCatalystClient

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.

Properties

Link copied to clipboard
abstract override val config: CodeCatalystClient.Config

CodeCatalystClient's configuration

Functions

Link copied to clipboard

Creates 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 for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.

Link copied to clipboard

Creates 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 repositories of your project.

Link copied to clipboard

Creates a project in a specified space.

Link copied to clipboard

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

Link copied to clipboard

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Link copied to clipboard

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

Link copied to clipboard

Deletes a Dev Environment.

Link copied to clipboard

Deletes a project in a space.

Link copied to clipboard

Deletes 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 source repository.

Link copied to clipboard
abstract suspend fun deleteSpace(input: DeleteSpaceRequest): DeleteSpaceResponse

Deletes a space.

Link copied to clipboard

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

Link copied to clipboard
abstract suspend fun getProject(input: GetProjectRequest): GetProjectResponse

Returns information about a project.

Link copied to clipboard

Returns information about a source repository.

Link copied to clipboard

Returns information about the URLs that can be used with a Git client to clone a source repository.

Link copied to clipboard
abstract suspend fun getSpace(input: GetSpaceRequest): GetSpaceResponse

Returns information about an space.

Link copied to clipboard

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

Link copied to clipboard
abstract suspend fun getUserDetails(input: GetUserDetailsRequest = GetUserDetailsRequest { }): GetUserDetailsResponse

Returns information about a user.

Link copied to clipboard
abstract suspend fun getWorkflow(input: GetWorkflowRequest): GetWorkflowResponse

Returns information about a workflow.

Link copied to clipboard

Returns information about a specified run of a workflow.

Link copied to clipboard
abstract suspend fun listAccessTokens(input: ListAccessTokensRequest = ListAccessTokensRequest { }): ListAccessTokensResponse

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

Link copied to clipboard

Retrieves a list of Dev Environments in a project.

Link copied to clipboard

Retrieves a list of active sessions for a Dev Environment in a project.

Link copied to clipboard

Retrieves 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 information, see Monitoring in the Amazon CodeCatalyst User Guide.

Link copied to clipboard

Retrieves a list of projects.

Link copied to clipboard

Retrieves a list of source repositories in a project.

Link copied to clipboard

Retrieves a list of branches in a specified source repository.

Link copied to clipboard
abstract suspend fun listSpaces(input: ListSpacesRequest = ListSpacesRequest { }): ListSpacesResponse

Retrieves a list of spaces.

Link copied to clipboard

Retrieves a list of workflow runs of a specified workflow.

Link copied to clipboard

Retrieves a list of workflows in a specified project.

Link copied to clipboard

Starts a specified Dev Environment and puts it into an active state.

Link copied to clipboard

Starts a session for a specified Dev Environment.

Link copied to clipboard

Begins a run of a specified workflow.

Link copied to clipboard

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

Link copied to clipboard

Stops a session for a specified Dev Environment.

Link copied to clipboard

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Link copied to clipboard

Changes one or more values for a project.

Link copied to clipboard
abstract suspend fun updateSpace(input: UpdateSpaceRequest): UpdateSpaceResponse

Changes one or more values for a space.

Link copied to clipboard
abstract suspend fun verifySession(input: VerifySessionRequest = VerifySessionRequest { }): VerifySessionResponse

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.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates 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 for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.

Link copied to clipboard

Creates 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 repositories of your project.

Link copied to clipboard

Creates a project in a specified space.

Link copied to clipboard

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

Link copied to clipboard

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Link copied to clipboard

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

Link copied to clipboard

Deletes a Dev Environment.

Link copied to clipboard

Deletes a project in a space.

Link copied to clipboard

Deletes 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 source repository.

Link copied to clipboard

Deletes a space.

Link copied to clipboard

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getProject(crossinline block: GetProjectRequest.Builder.() -> Unit): GetProjectResponse

Returns information about a project.

Link copied to clipboard

Returns information about a source repository.

Link copied to clipboard

Returns information about the URLs that can be used with a Git client to clone a source repository.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getSpace(crossinline block: GetSpaceRequest.Builder.() -> Unit): GetSpaceResponse

Returns information about an space.

Link copied to clipboard

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

Link copied to clipboard

Returns information about a user.

Link copied to clipboard

Returns information about a workflow.

Link copied to clipboard

Returns information about a specified run of a workflow.

Link copied to clipboard

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

Link copied to clipboard

Retrieves a list of Dev Environments in a project.

Link copied to clipboard

Retrieves a list of active sessions for a Dev Environment in a project.

Link copied to clipboard

Retrieves 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 information, see Monitoring in the Amazon CodeCatalyst User Guide.

Link copied to clipboard

Retrieves a list of projects.

Link copied to clipboard

Retrieves a list of source repositories in a project.

Link copied to clipboard

Retrieves a list of branches in a specified source repository.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listSpaces(crossinline block: ListSpacesRequest.Builder.() -> Unit): ListSpacesResponse

Retrieves a list of spaces.

Link copied to clipboard
Link copied to clipboard

Retrieves a list of workflow runs of a specified workflow.

Link copied to clipboard

Retrieves a list of workflows in a specified project.

Link copied to clipboard

Starts a specified Dev Environment and puts it into an active state.

Link copied to clipboard

Starts a session for a specified Dev Environment.

Link copied to clipboard

Begins a run of a specified workflow.

Link copied to clipboard

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

Link copied to clipboard

Stops a session for a specified Dev Environment.

Link copied to clipboard

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Link copied to clipboard

Changes one or more values for a project.

Link copied to clipboard

Changes one or more values for a space.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.