CodeStarConnectionsClient

Suggest an Edit
AWS CodeStar Connections

This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the Amazon Web Services CodeStar Connections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect Amazon Web Services resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

  • CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

  • DeleteConnection, which deletes the specified connection.

  • GetConnection, which returns information about the connection, including the connection status.

  • ListConnections, which lists the connections associated with your account.

You can work with hosts by calling:

  • CreateHost, which creates a host that represents the infrastructure where your provider is installed.

  • DeleteHost, which deletes the specified host.

  • GetHost, which returns information about the host, including the setup status.

  • ListHosts, which lists the hosts associated with your account.

You can work with tags in Amazon Web Services CodeStar Connections by calling the following:

  • ListTagsForResource, which gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections.

  • TagResource, which adds or updates tags for a resource in Amazon Web Services CodeStar Connections.

  • UntagResource, which removes tags for a resource in Amazon Web Services CodeStar Connections.

For information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User Guide .

Installation

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

CodeStarConnectionsClient Operations

Command
Summary
CreateConnectionCommand

Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

CreateHostCommand

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

CreateRepositoryLinkCommand

Creates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

CreateSyncConfigurationCommand

Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.

DeleteConnectionCommand

The connection to be deleted.

DeleteHostCommand

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

DeleteRepositoryLinkCommand

Deletes the association between your connection and a specified external Git repository.

DeleteSyncConfigurationCommand

Deletes the sync configuration for a specified repository and connection.

GetConnectionCommand

Returns the connection ARN and details such as status, owner, and provider type.

GetHostCommand

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

GetRepositoryLinkCommand

Returns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.

GetRepositorySyncStatusCommand

Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.

GetResourceSyncStatusCommand

Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.

GetSyncBlockerSummaryCommand

Returns a list of the most recent sync blockers.

GetSyncConfigurationCommand

Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.

ListConnectionsCommand

Lists the connections associated with your account.

ListHostsCommand

Lists the hosts associated with your account.

ListRepositoryLinksCommand

Lists the repository links created for connections in your account.

ListRepositorySyncDefinitionsCommand

Lists the repository sync definitions for repository links in your account.

ListSyncConfigurationsCommand

Returns a list of sync configurations for a specified repository.

ListTagsForResourceCommand

Gets the set of key-value pairs (metadata) that are used to manage the resource.

TagResourceCommand

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

UntagResourceCommand

Removes tags from an Amazon Web Services resource.

UpdateHostCommand

Updates a specified host with the provided configurations.

UpdateRepositoryLinkCommand

Updates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

UpdateSyncBlockerCommand

Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.

UpdateSyncConfigurationCommand

Updates the sync configuration for your connection and a specified external Git repository.

CodeStarConnectionsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: CodeStarConnectionsClientConfig