This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of\nthe operations and data types for the Amazon Web Services CodeStar Connections API. You can use the\nconnections API to work with connections and installations.
\n\nConnections are configurations that you use to connect Amazon Web Services\nresources to external code repositories. Each connection is a resource that can be given to\nservices such as CodePipeline to connect to a third-party repository such as Bitbucket. For\nexample, you can add the connection in CodePipeline so that it triggers your pipeline when a\ncode change is made to your third-party code repository. Each connection is named and\nassociated with a unique ARN that is used to reference the connection.
\nWhen you create a connection, the console initiates a third-party connection handshake.\nInstallations are the apps that are used to conduct this handshake. For\nexample, the installation for the Bitbucket provider type is the Bitbucket app. When you\ncreate a connection, you can choose an existing installation or create one.
\nWhen you want to create a connection to an installed provider type such as GitHub\nEnterprise Server, you create a host for your connections.
\nYou can work with connections by calling:
\n\nCreateConnection, which creates a uniquely named connection that can be\nreferenced by services such as CodePipeline.
\n\nDeleteConnection, which deletes the specified connection.
\n\nGetConnection, which returns information about the connection, including\nthe connection status.
\n\nListConnections, which lists the connections associated with your\naccount.
\nYou can work with hosts by calling:
\n\nCreateHost, which creates a host that represents the infrastructure where your provider is installed.
\n\nDeleteHost, which deletes the specified host.
\n\nGetHost, which returns information about the host, including\nthe setup status.
\n\nListHosts, which lists the hosts associated with your\naccount.
\nYou can work with tags in Amazon Web Services CodeStar Connections by calling the following:
\n\nListTagsForResource, which gets information about Amazon Web Services tags for a\nspecified Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections.
\n\nTagResource, which adds or updates tags for a resource in Amazon Web Services CodeStar\nConnections.
\n\nUntagResource, which removes tags for a resource in Amazon Web Services CodeStar\nConnections.
\nFor information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User\nGuide.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-codestar-connections`\n- `yarn add @aws-sdk/client-codestar-connections`\n- `pnpm add @aws-sdk/client-codestar-connections`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `CodeStarConnectionsClient` and\nthe commands you need, for example `ListHostsCommand`:\n\n```js\n// ES5 example\nconst { CodeStarConnectionsClient, ListHostsCommand } = require(\"@aws-sdk/client-codestar-connections\");\n```\n\n```ts\n// ES6+ example\nimport { CodeStarConnectionsClient, ListHostsCommand } from \"@aws-sdk/client-codestar-connections\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new CodeStarConnectionsClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListHostsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`CodeStarConnections` extends `CodeStarConnectionsClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeStarConnectionsClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { CodeStarConnections } from \"@aws-sdk/client-codestar-connections\";\n\nconst client = new CodeStarConnections({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listHosts(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listHosts(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listHosts(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-codestar-connections` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n