codestarconnections/aws.sdk.kotlin.services.codestarconnections

Package-level declarations

Types

Link copied to clipboard
interface CodeStarConnectionsClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun CodeStarConnectionsClient.createConnection(crossinline block: CreateConnectionRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun CodeStarConnectionsClient.createHost(crossinline block: CreateHostRequest.Builder.() -> Unit): 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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun CodeStarConnectionsClient.createSyncConfiguration(crossinline block: CreateSyncConfigurationRequest.Builder.() -> Unit): 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.

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

The connection to be deleted.

Link copied to clipboard
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.

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

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

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

Deletes the sync configuration for a specified repository and connection.

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

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

Returns a list of the most recent sync blockers.

Link copied to clipboard
inline suspend fun CodeStarConnectionsClient.getSyncConfiguration(crossinline block: GetSyncConfigurationRequest.Builder.() -> Unit): 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.

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

Lists the connections associated with your account.

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

Lists the hosts associated with your account.

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

Lists the repository links created for connections in your account.

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

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

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

Returns a list of sync configurations for a specified repository.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

Removes tags from an Amazon Web Services resource.

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

Updates a specified host with the provided configurations.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

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

Link copied to clipboard
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.