AWS.CodeCatalyst — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

Projects, by calling the following:

Users, by calling the following:

Source repositories, by calling the following:

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

Workflows, by calling the following:

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

Note: 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.

Sending a Request Using CodeCatalyst

var codecatalyst = new AWS.CodeCatalyst();
codecatalyst.createAccessToken(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeCatalyst object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codecatalyst = new AWS.CodeCatalyst({apiVersion: '2022-09-28'});

You can also set the API version globally in AWS.config.apiVersions using the codecatalyst service identifier:

AWS.config.apiVersions = {
  codecatalyst: '2022-09-28',
  // other service API versions
};

var codecatalyst = new AWS.CodeCatalyst();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CodeCatalyst(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createAccessToken(params = {}, callback) ⇒ AWS.Request

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.

createDevEnvironment(params = {}, callback) ⇒ AWS.Request

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.

Note: When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

createProject(params = {}, callback) ⇒ AWS.Request

Creates a project in a specified space.

createSourceRepository(params = {}, callback) ⇒ AWS.Request

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.

createSourceRepositoryBranch(params = {}, callback) ⇒ AWS.Request

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

Note: This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

deleteAccessToken(params = {}, callback) ⇒ AWS.Request

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

deleteDevEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes a Dev Environment.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes a project in a space.

deleteSourceRepository(params = {}, callback) ⇒ AWS.Request

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.

deleteSpace(params = {}, callback) ⇒ AWS.Request

Deletes a space.

Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

getDevEnvironment(params = {}, callback) ⇒ AWS.Request

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

getProject(params = {}, callback) ⇒ AWS.Request

Returns information about a project.

getSourceRepository(params = {}, callback) ⇒ AWS.Request

Returns information about a source repository.

getSourceRepositoryCloneUrls(params = {}, callback) ⇒ AWS.Request

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

getSpace(params = {}, callback) ⇒ AWS.Request

Returns information about an space.

getSubscription(params = {}, callback) ⇒ AWS.Request

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

getUserDetails(params = {}, callback) ⇒ AWS.Request

Returns information about a user.

getWorkflow(params = {}, callback) ⇒ AWS.Request

Returns information about a workflow.

getWorkflowRun(params = {}, callback) ⇒ AWS.Request

Returns information about a specified run of a workflow.

listAccessTokens(params = {}, callback) ⇒ AWS.Request

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.

listDevEnvironments(params = {}, callback) ⇒ AWS.Request

Retrieves a list of Dev Environments in a project.

listDevEnvironmentSessions(params = {}, callback) ⇒ AWS.Request

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

listEventLogs(params = {}, callback) ⇒ AWS.Request

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.

Note: ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

listProjects(params = {}, callback) ⇒ AWS.Request

Retrieves a list of projects.

listSourceRepositories(params = {}, callback) ⇒ AWS.Request

Retrieves a list of source repositories in a project.

listSourceRepositoryBranches(params = {}, callback) ⇒ AWS.Request

Retrieves a list of branches in a specified source repository.

listSpaces(params = {}, callback) ⇒ AWS.Request

Retrieves a list of spaces.

listWorkflowRuns(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflow runs of a specified workflow.

listWorkflows(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflows in a specified project.

startDevEnvironment(params = {}, callback) ⇒ AWS.Request

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

startDevEnvironmentSession(params = {}, callback) ⇒ AWS.Request

Starts a session for a specified Dev Environment.

startWorkflowRun(params = {}, callback) ⇒ AWS.Request

Begins a run of a specified workflow.

stopDevEnvironment(params = {}, callback) ⇒ AWS.Request

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

stopDevEnvironmentSession(params = {}, callback) ⇒ AWS.Request

Stops a session for a specified Dev Environment.

updateDevEnvironment(params = {}, callback) ⇒ AWS.Request

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

updateProject(params = {}, callback) ⇒ AWS.Request

Changes one or more values for a project.

updateSpace(params = {}, callback) ⇒ AWS.Request

Changes one or more values for a space.

verifySession(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given CodeCatalyst resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.