codestarconnections/aws.sdk.kotlin.services.codestarconnections/CodeStarConnectionsClient

CodeStarConnectionsClient

interface CodeStarConnectionsClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<CodeStarConnectionsClient.Config, CodeStarConnectionsClient.Config.Builder, CodeStarConnectionsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<CodeStarConnectionsClient.Config, CodeStarConnectionsClient.Config.Builder, CodeStarConnectionsClient, CodeStarConnectionsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: CodeStarConnectionsClient.Config

CodeStarConnectionsClient's configuration

Functions

createConnection

abstract suspend fun createConnection(input: CreateConnectionRequest): CreateConnectionResponse

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

abstract suspend fun createHost(input: CreateHostRequest): CreateHostResponse

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.

createRepositoryLink

abstract suspend fun createRepositoryLink(input: CreateRepositoryLinkRequest): CreateRepositoryLinkResponse

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

abstract suspend fun createSyncConfiguration(input: CreateSyncConfigurationRequest): CreateSyncConfigurationResponse

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

abstract suspend fun deleteConnection(input: DeleteConnectionRequest): DeleteConnectionResponse

The connection to be deleted.

deleteHost

abstract suspend fun deleteHost(input: DeleteHostRequest): DeleteHostResponse

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

deleteRepositoryLink

abstract suspend fun deleteRepositoryLink(input: DeleteRepositoryLinkRequest): DeleteRepositoryLinkResponse

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

deleteSyncConfiguration

abstract suspend fun deleteSyncConfiguration(input: DeleteSyncConfigurationRequest): DeleteSyncConfigurationResponse

Deletes the sync configuration for a specified repository and connection.

getConnection

abstract suspend fun getConnection(input: GetConnectionRequest): GetConnectionResponse

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

getHost

abstract suspend fun getHost(input: GetHostRequest): GetHostResponse

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

getRepositoryLink

abstract suspend fun getRepositoryLink(input: GetRepositoryLinkRequest): GetRepositoryLinkResponse

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

abstract suspend fun getRepositorySyncStatus(input: GetRepositorySyncStatusRequest): GetRepositorySyncStatusResponse

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

abstract suspend fun getResourceSyncStatus(input: GetResourceSyncStatusRequest): GetResourceSyncStatusResponse

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

getSyncBlockerSummary

abstract suspend fun getSyncBlockerSummary(input: GetSyncBlockerSummaryRequest): GetSyncBlockerSummaryResponse

Returns a list of the most recent sync blockers.

getSyncConfiguration

abstract suspend fun getSyncConfiguration(input: GetSyncConfigurationRequest): GetSyncConfigurationResponse

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

abstract suspend fun listConnections(input: ListConnectionsRequest = ListConnectionsRequest { }): ListConnectionsResponse

Lists the connections associated with your account.

listHosts

abstract suspend fun listHosts(input: ListHostsRequest = ListHostsRequest { }): ListHostsResponse

Lists the hosts associated with your account.

listRepositoryLinks

abstract suspend fun listRepositoryLinks(input: ListRepositoryLinksRequest = ListRepositoryLinksRequest { }): ListRepositoryLinksResponse

Lists the repository links created for connections in your account.

listRepositorySyncDefinitions

abstract suspend fun listRepositorySyncDefinitions(input: ListRepositorySyncDefinitionsRequest): ListRepositorySyncDefinitionsResponse

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

listSyncConfigurations

abstract suspend fun listSyncConfigurations(input: ListSyncConfigurationsRequest): ListSyncConfigurationsResponse

Returns a list of sync configurations for a specified repository.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from an Amazon Web Services resource.

updateHost

abstract suspend fun updateHost(input: UpdateHostRequest): UpdateHostResponse

Updates a specified host with the provided configurations.

updateRepositoryLink

abstract suspend fun updateRepositoryLink(input: UpdateRepositoryLinkRequest): UpdateRepositoryLinkResponse

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

abstract suspend fun updateSyncBlocker(input: UpdateSyncBlockerRequest): UpdateSyncBlockerResponse

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

updateSyncConfiguration

abstract suspend fun updateSyncConfiguration(input: UpdateSyncConfigurationRequest): UpdateSyncConfigurationResponse

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

Inherited functions

expect abstract fun close()

createConnection

inline suspend fun CodeStarConnectionsClient.createConnection(crossinline block: CreateConnectionRequest.Builder.() -> Unit): CreateConnectionResponse

createHost

inline suspend fun CodeStarConnectionsClient.createHost(crossinline block: CreateHostRequest.Builder.() -> Unit): CreateHostResponse

createRepositoryLink

inline suspend fun CodeStarConnectionsClient.createRepositoryLink(crossinline block: CreateRepositoryLinkRequest.Builder.() -> Unit): CreateRepositoryLinkResponse

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

inline suspend fun CodeStarConnectionsClient.createSyncConfiguration(crossinline block: CreateSyncConfigurationRequest.Builder.() -> Unit): CreateSyncConfigurationResponse

deleteConnection

inline suspend fun CodeStarConnectionsClient.deleteConnection(crossinline block: DeleteConnectionRequest.Builder.() -> Unit): DeleteConnectionResponse

The connection to be deleted.

deleteHost

inline suspend fun CodeStarConnectionsClient.deleteHost(crossinline block: DeleteHostRequest.Builder.() -> Unit): DeleteHostResponse

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

deleteRepositoryLink

inline suspend fun CodeStarConnectionsClient.deleteRepositoryLink(crossinline block: DeleteRepositoryLinkRequest.Builder.() -> Unit): DeleteRepositoryLinkResponse

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

deleteSyncConfiguration

inline suspend fun CodeStarConnectionsClient.deleteSyncConfiguration(crossinline block: DeleteSyncConfigurationRequest.Builder.() -> Unit): DeleteSyncConfigurationResponse

Deletes the sync configuration for a specified repository and connection.

getConnection

inline suspend fun CodeStarConnectionsClient.getConnection(crossinline block: GetConnectionRequest.Builder.() -> Unit): GetConnectionResponse

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

getHost

inline suspend fun CodeStarConnectionsClient.getHost(crossinline block: GetHostRequest.Builder.() -> Unit): GetHostResponse

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

getRepositoryLink

inline suspend fun CodeStarConnectionsClient.getRepositoryLink(crossinline block: GetRepositoryLinkRequest.Builder.() -> Unit): GetRepositoryLinkResponse

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

inline suspend fun CodeStarConnectionsClient.getRepositorySyncStatus(crossinline block: GetRepositorySyncStatusRequest.Builder.() -> Unit): GetRepositorySyncStatusResponse

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

inline suspend fun CodeStarConnectionsClient.getResourceSyncStatus(crossinline block: GetResourceSyncStatusRequest.Builder.() -> Unit): GetResourceSyncStatusResponse

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

getSyncBlockerSummary

inline suspend fun CodeStarConnectionsClient.getSyncBlockerSummary(crossinline block: GetSyncBlockerSummaryRequest.Builder.() -> Unit): GetSyncBlockerSummaryResponse

Returns a list of the most recent sync blockers.

getSyncConfiguration

inline suspend fun CodeStarConnectionsClient.getSyncConfiguration(crossinline block: GetSyncConfigurationRequest.Builder.() -> Unit): GetSyncConfigurationResponse

listConnections

inline suspend fun CodeStarConnectionsClient.listConnections(crossinline block: ListConnectionsRequest.Builder.() -> Unit): ListConnectionsResponse

Lists the connections associated with your account.

listConnectionsPaginated

fun CodeStarConnectionsClient.listConnectionsPaginated(initialRequest: ListConnectionsRequest = ListConnectionsRequest { }): Flow<ListConnectionsResponse>

fun CodeStarConnectionsClient.listConnectionsPaginated(block: ListConnectionsRequest.Builder.() -> Unit): Flow<ListConnectionsResponse>

Paginate over ListConnectionsResponse results.

listHosts

inline suspend fun CodeStarConnectionsClient.listHosts(crossinline block: ListHostsRequest.Builder.() -> Unit): ListHostsResponse

Lists the hosts associated with your account.

listHostsPaginated

fun CodeStarConnectionsClient.listHostsPaginated(initialRequest: ListHostsRequest = ListHostsRequest { }): Flow<ListHostsResponse>

fun CodeStarConnectionsClient.listHostsPaginated(block: ListHostsRequest.Builder.() -> Unit): Flow<ListHostsResponse>

Paginate over ListHostsResponse results.

listRepositoryLinks

inline suspend fun CodeStarConnectionsClient.listRepositoryLinks(crossinline block: ListRepositoryLinksRequest.Builder.() -> Unit): ListRepositoryLinksResponse

Lists the repository links created for connections in your account.

listRepositoryLinksPaginated

fun CodeStarConnectionsClient.listRepositoryLinksPaginated(initialRequest: ListRepositoryLinksRequest = ListRepositoryLinksRequest { }): Flow<ListRepositoryLinksResponse>

fun CodeStarConnectionsClient.listRepositoryLinksPaginated(block: ListRepositoryLinksRequest.Builder.() -> Unit): Flow<ListRepositoryLinksResponse>

Paginate over ListRepositoryLinksResponse results.

listRepositorySyncDefinitions

inline suspend fun CodeStarConnectionsClient.listRepositorySyncDefinitions(crossinline block: ListRepositorySyncDefinitionsRequest.Builder.() -> Unit): ListRepositorySyncDefinitionsResponse

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

listSyncConfigurations

inline suspend fun CodeStarConnectionsClient.listSyncConfigurations(crossinline block: ListSyncConfigurationsRequest.Builder.() -> Unit): ListSyncConfigurationsResponse

Returns a list of sync configurations for a specified repository.

listSyncConfigurationsPaginated

fun CodeStarConnectionsClient.listSyncConfigurationsPaginated(initialRequest: ListSyncConfigurationsRequest): Flow<ListSyncConfigurationsResponse>

fun CodeStarConnectionsClient.listSyncConfigurationsPaginated(block: ListSyncConfigurationsRequest.Builder.() -> Unit): Flow<ListSyncConfigurationsResponse>

Paginate over ListSyncConfigurationsResponse results.

listTagsForResource

inline suspend fun CodeStarConnectionsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

tagResource

inline suspend fun CodeStarConnectionsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun CodeStarConnectionsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from an Amazon Web Services resource.

updateHost

inline suspend fun CodeStarConnectionsClient.updateHost(crossinline block: UpdateHostRequest.Builder.() -> Unit): UpdateHostResponse

Updates a specified host with the provided configurations.

updateRepositoryLink

inline suspend fun CodeStarConnectionsClient.updateRepositoryLink(crossinline block: UpdateRepositoryLinkRequest.Builder.() -> Unit): UpdateRepositoryLinkResponse

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

inline suspend fun CodeStarConnectionsClient.updateSyncBlocker(crossinline block: UpdateSyncBlockerRequest.Builder.() -> Unit): UpdateSyncBlockerResponse

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

updateSyncConfiguration

inline suspend fun CodeStarConnectionsClient.updateSyncConfiguration(crossinline block: UpdateSyncConfigurationRequest.Builder.() -> Unit): UpdateSyncConfigurationResponse

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

withConfig

fun CodeStarConnectionsClient.withConfig(block: CodeStarConnectionsClient.Config.Builder.() -> Unit): CodeStarConnectionsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.