View Source AWS.CodeStarConnections (aws-elixir v1.0.0)
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.
Summary
Functions
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.
Creates a resource that represents the infrastructure where a third-party provider is installed.
Creates a link to a specified external Git repository.
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.
The connection to be deleted.
The host to be deleted.
Deletes the association between your connection and a specified external Git repository.
Deletes the sync configuration for a specified repository and connection.
Returns the connection ARN and details such as status, owner, and provider type.
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
Returns details about a repository link.
Returns details about the sync status for a repository.
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
Returns a list of the most recent sync blockers.
Returns details about a sync configuration, including the sync type and resource name.
Lists the connections associated with your account.
Lists the hosts associated with your account.
Lists the repository links created for connections in your account.
Lists the repository sync definitions for repository links in your account.
Returns a list of sync configurations for a specified repository.
Gets the set of key-value pairs (metadata) that are used to manage the resource.
Adds to or modifies the tags of the given resource.
Removes tags from an Amazon Web Services resource.
Updates a specified host with the provided configurations.
Updates the association between your connection and a specified external Git repository.
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
Updates the sync configuration for your connection and a specified external Git repository.
Functions
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.
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.
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.
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.
The connection to be deleted.
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.
Deletes the association between your connection and a specified external Git repository.
Deletes the sync configuration for a specified repository and connection.
Returns the connection ARN and details such as status, owner, and provider type.
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
Returns details about a repository link.
A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.
Returns details about the sync status for a repository.
A repository sync uses Git sync to push and pull changes from your remote repository.
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
Returns a list of the most recent sync blockers.
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.
Lists the connections associated with your account.
Lists the hosts associated with your account.
Lists the repository links created for connections in your account.
Lists the repository sync definitions for repository links in your account.
Returns a list of sync configurations for a specified repository.
Gets the set of key-value pairs (metadata) that are used to manage the resource.
Adds to or modifies the tags of the given resource.
Tags are metadata that can be used to manage a resource.
Removes tags from an Amazon Web Services resource.
Updates a specified host with the provided configurations.
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.
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
Updates the sync configuration for your connection and a specified external Git repository.