This package has been deprecated

Author message:

The package @aws-sdk/client-codestar-node has been renamed to @aws-sdk/client-codestar. Please install the renamed package.

@aws-sdk/client-codestar-node

Description

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 using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-codestar-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(CodeStarClient) and the commands you need, for example AssociateTeamMemberCommand:

//JavaScript
const {
  CodeStarClient
} = require("@aws-sdk/client-codestar-node/CodeStarClient");
const {
  AssociateTeamMemberCommand
} = require("@aws-sdk/client-codestar-node/commands/AssociateTeamMemberCommand");

//TypeScript
import { CodeStarClient } from "@aws-sdk/client-codestar-node/CodeStarClient";
import { AssociateTeamMemberCommand } from "@aws-sdk/client-codestar-node/commands/AssociateTeamMemberCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const codeStar = new CodeStarClient({region: 'region'});
//clients can be shared by different commands
const params = {
  projectId: /**a string value*/,
  userArn: /**a string value*/,
  projectRole: /**a string value*/,
};
const associateTeamMemberCommand = new AssociateTeamMemberCommand(params);
codeStar.send(associateTeamMemberCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await codeStar.send(associateTeamMemberCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
codeStar.send(associateTeamMemberCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-codestar-node/CodeStar";
const codeStar = new AWS.CodeStar({ region: "region" });
codeStar.associateTeamMember(params, (err, data) => {
  //do something
});

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 codeStar.send(associateTeamMemberCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-codestar-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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