@aws-sdk/client-codecatalyst

Description

AWS SDK for JavaScript CodeCatalyst Client for Node.js, Browser and React Native.

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.

Installing

To install this package, use the CLI of your favorite package manager:

• npm install @aws-sdk/client-codecatalyst
• yarn add @aws-sdk/client-codecatalyst
• pnpm add @aws-sdk/client-codecatalyst

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the CodeCatalystClient and the commands you need, for example ListSpacesCommand:

// ES5 example
const { CodeCatalystClient, ListSpacesCommand } = require("@aws-sdk/client-codecatalyst");

// ES6+ example
import { CodeCatalystClient, ListSpacesCommand } from "@aws-sdk/client-codecatalyst";

Usage

To send a request:

• Instantiate a client with configuration (e.g. credentials, region).
  • See docs/CLIENTS for configuration details.
  • See @aws-sdk/config for additional options.
• Instantiate a command with input parameters.
• Call the send operation on the client, providing the command object as input.

const client = new CodeCatalystClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListSpacesCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

CodeCatalyst extends CodeCatalystClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (CodeCatalystClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { CodeCatalyst } from "@aws-sdk/client-codecatalyst";

const client = new CodeCatalyst({ region: "REGION" });

// async/await.
try {
  const data = await client.listSpaces(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listSpaces(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listSpaces(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

See also docs/ERROR_HANDLING.

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit the Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-codecatalyst package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)