AWS.CodeConnections — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This Amazon Web Services CodeConnections API Reference provides descriptions and usage examples of the operations and data types for the Amazon Web Services CodeConnections 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:

You can work with hosts by calling:

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

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

Sending a Request Using CodeConnections

var codeconnections = new AWS.CodeConnections();
codeconnections.createConnection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeConnections object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codeconnections = new AWS.CodeConnections({apiVersion: '2023-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the codeconnections service identifier:

AWS.config.apiVersions = {
  codeconnections: '2023-12-01',
  // other service API versions
};

var codeconnections = new AWS.CodeConnections();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeConnections(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createConnection(params = {}, callback) ⇒ AWS.Request

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.

createHost(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

createRepositoryLink(params = {}, callback) ⇒ AWS.Request

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.

createSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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.

deleteConnection(params = {}, callback) ⇒ AWS.Request

The connection to be deleted.

deleteHost(params = {}, callback) ⇒ AWS.Request

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

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

deleteRepositoryLink(params = {}, callback) ⇒ AWS.Request

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

deleteSyncConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the sync configuration for a specified repository and connection.

getConnection(params = {}, callback) ⇒ AWS.Request

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

getHost(params = {}, callback) ⇒ AWS.Request

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

getRepositoryLink(params = {}, callback) ⇒ AWS.Request

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

getRepositorySyncStatus(params = {}, callback) ⇒ AWS.Request

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

getResourceSyncStatus(params = {}, callback) ⇒ AWS.Request

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

getSyncBlockerSummary(params = {}, callback) ⇒ AWS.Request

Returns a list of the most recent sync blockers.

getSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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.

listConnections(params = {}, callback) ⇒ AWS.Request

Lists the connections associated with your account.

listHosts(params = {}, callback) ⇒ AWS.Request

Lists the hosts associated with your account.

listRepositoryLinks(params = {}, callback) ⇒ AWS.Request

Lists the repository links created for connections in your account.

listRepositorySyncDefinitions(params = {}, callback) ⇒ AWS.Request

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

listSyncConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of sync configurations for a specified repository.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from an Amazon Web Services resource.

updateHost(params = {}, callback) ⇒ AWS.Request

Updates a specified host with the provided configurations.

updateRepositoryLink(params = {}, callback) ⇒ AWS.Request

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.

updateSyncBlocker(params = {}, callback) ⇒ AWS.Request

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

updateSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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