aws-elixir

View Source AWS.CodeConnections (aws-elixir v1.0.4)

AWS CodeConnections

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:

*

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 CodeConnections by calling the following:

*

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

*

TagResource, which adds or updates tags for a resource in Amazon Web Services CodeConnections.

*

UntagResource, which removes tags for a resource in Amazon Web Services CodeConnections.

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

Link to this section Summary

Functions

create_connection(client, input, options \\ [])

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.

create_host(client, input, options \\ [])

Creates a resource that represents the infrastructure where a third-party provider is installed.

create_repository_link(client, input, options \\ [])

Creates a link to a specified external Git repository.

create_sync_configuration(client, input, options \\ [])

Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.

delete_connection(client, input, options \\ [])

The connection to be deleted.

delete_host(client, input, options \\ [])

The host to be deleted.

delete_repository_link(client, input, options \\ [])

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

delete_sync_configuration(client, input, options \\ [])

Deletes the sync configuration for a specified repository and connection.

get_connection(client, input, options \\ [])

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

get_host(client, input, options \\ [])

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

get_repository_link(client, input, options \\ [])

Returns details about a repository link.

get_repository_sync_status(client, input, options \\ [])

Returns details about the sync status for a repository.

get_resource_sync_status(client, input, options \\ [])

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

get_sync_blocker_summary(client, input, options \\ [])

Returns a list of the most recent sync blockers.

get_sync_configuration(client, input, options \\ [])

Returns details about a sync configuration, including the sync type and resource name.

list_connections(client, input, options \\ [])

Lists the connections associated with your account.

list_hosts(client, input, options \\ [])

Lists the hosts associated with your account.

list_repository_links(client, input, options \\ [])

Lists the repository links created for connections in your account.

list_repository_sync_definitions(client, input, options \\ [])

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

list_sync_configurations(client, input, options \\ [])

Returns a list of sync configurations for a specified repository.

list_tags_for_resource(client, input, options \\ [])

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

metadata()
tag_resource(client, input, options \\ [])

Adds to or modifies the tags of the given resource.

untag_resource(client, input, options \\ [])

Removes tags from an Amazon Web Services resource.

update_host(client, input, options \\ [])

Updates a specified host with the provided configurations.

update_repository_link(client, input, options \\ [])

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

update_sync_blocker(client, input, options \\ [])

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

update_sync_configuration(client, input, options \\ [])

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

Link to this section Functions

Link to this function

create_connection(client, input, options \\ [])

View Source

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.

Link to this function

create_host(client, input, options \\ [])

View Source

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.

Link to this function

create_repository_link(client, input, options \\ [])

View Source

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.

Link to this function

create_sync_configuration(client, input, options \\ [])

View Source

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.

Link to this function

delete_connection(client, input, options \\ [])

View Source

The connection to be deleted.

Link to this function

delete_host(client, input, options \\ [])

View Source

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.

Link to this function

delete_repository_link(client, input, options \\ [])

View Source

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

Link to this function

delete_sync_configuration(client, input, options \\ [])

View Source

Deletes the sync configuration for a specified repository and connection.

Link to this function

get_connection(client, input, options \\ [])

View Source

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

Link to this function

get_host(client, input, options \\ [])

View Source

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

Link to this function

get_repository_link(client, input, options \\ [])

View Source

Returns details about a repository link.

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

Link to this function

get_repository_sync_status(client, input, options \\ [])

View Source

Returns details about the sync status for a repository.

A repository sync uses Git sync to push and pull changes from your remote repository.

Link to this function

get_resource_sync_status(client, input, options \\ [])

View Source

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

Link to this function

get_sync_blocker_summary(client, input, options \\ [])

View Source

Returns a list of the most recent sync blockers.

Link to this function

get_sync_configuration(client, input, options \\ [])

View Source

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.

Link to this function

list_connections(client, input, options \\ [])

View Source

Lists the connections associated with your account.

Link to this function

list_hosts(client, input, options \\ [])

View Source

Lists the hosts associated with your account.

Link to this function

list_repository_links(client, input, options \\ [])

View Source

Lists the repository links created for connections in your account.

Link to this function

list_repository_sync_definitions(client, input, options \\ [])

View Source

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

Link to this function

list_sync_configurations(client, input, options \\ [])

View Source

Returns a list of sync configurations for a specified repository.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds to or modifies the tags of the given resource.

Tags are metadata that can be used to manage a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from an Amazon Web Services resource.

Link to this function

update_host(client, input, options \\ [])

View Source

Updates a specified host with the provided configurations.

Link to this function

update_repository_link(client, input, options \\ [])

View Source

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.

Link to this function

update_sync_blocker(client, input, options \\ [])

View Source

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

Link to this function

update_sync_configuration(client, input, options \\ [])

View Source

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