@aws-sdk/client-codestar

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-codestar

Description

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

AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

DeleteProject, which deletes a project.
DescribeProject, which lists the attributes of a project.
ListProjects, which lists all projects associated with your AWS account.
ListResources, which lists the resources associated with a project.
ListTagsForProject, which lists the tags associated with a project.
TagProject, which adds tags to a project.
UntagProject, which removes tags from a project.
UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

AssociateTeamMember, which adds an IAM user to the team for a project.
DisassociateTeamMember, which removes an IAM user from the team for a project.
ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.
UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.
DeleteUserProfile, which deletes all user profile information across all projects.
DescribeUserProfile, which describes the profile of a user.
ListUserProfiles, which lists all user profiles.
UpdateUserProfile, which updates the profile for a user.

Installing

To install the this package, simply type add or install @aws-sdk/client-codestar using your favorite package manager:

npm install @aws-sdk/client-codestar
yarn add @aws-sdk/client-codestar
pnpm add @aws-sdk/client-codestar

Getting Started

Import

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

// ES5 example
const { CodeStarClient, ListProjectsCommand } = require("@aws-sdk/client-codestar");

// ES6+ example
import { CodeStarClient, ListProjectsCommand } from "@aws-sdk/client-codestar";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region).
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new CodeStarClient({ region: "REGION" });

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

Async/await

We recommend using 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.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

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

Promises can also be called using .catch() and .finally() as follows:

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

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-codestar";
const client = new AWS.CodeStar({ region: "REGION" });

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

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

// callbacks.
client.listProjects(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;
   * }
   */
}

Getting Help

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

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

CreateProject

This API Documentation is now deprecated