@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeStarconnections
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodeStarconnections
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateConnectionResult |
createConnection(CreateConnectionRequest createConnectionRequest)
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.
|
CreateHostResult |
createHost(CreateHostRequest createHostRequest)
Creates a resource that represents the infrastructure where a third-party provider is installed.
|
CreateRepositoryLinkResult |
createRepositoryLink(CreateRepositoryLinkRequest createRepositoryLinkRequest)
Creates a link to a specified external Git repository.
|
CreateSyncConfigurationResult |
createSyncConfiguration(CreateSyncConfigurationRequest createSyncConfigurationRequest)
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a
specified Amazon Web Services resource.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
The connection to be deleted.
|
DeleteHostResult |
deleteHost(DeleteHostRequest deleteHostRequest)
The host to be deleted.
|
DeleteRepositoryLinkResult |
deleteRepositoryLink(DeleteRepositoryLinkRequest deleteRepositoryLinkRequest)
Deletes the association between your connection and a specified external Git repository.
|
DeleteSyncConfigurationResult |
deleteSyncConfiguration(DeleteSyncConfigurationRequest deleteSyncConfigurationRequest)
Deletes the sync configuration for a specified repository and connection.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConnectionResult |
getConnection(GetConnectionRequest getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
|
GetHostResult |
getHost(GetHostRequest getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC
configuration.
|
GetRepositoryLinkResult |
getRepositoryLink(GetRepositoryLinkRequest getRepositoryLinkRequest)
Returns details about a repository link.
|
GetRepositorySyncStatusResult |
getRepositorySyncStatus(GetRepositorySyncStatusRequest getRepositorySyncStatusRequest)
Returns details about the sync status for a repository.
|
GetResourceSyncStatusResult |
getResourceSyncStatus(GetResourceSyncStatusRequest getResourceSyncStatusRequest)
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
|
GetSyncBlockerSummaryResult |
getSyncBlockerSummary(GetSyncBlockerSummaryRequest getSyncBlockerSummaryRequest)
Returns a list of the most recent sync blockers.
|
GetSyncConfigurationResult |
getSyncConfiguration(GetSyncConfigurationRequest getSyncConfigurationRequest)
Returns details about a sync configuration, including the sync type and resource name.
|
ListConnectionsResult |
listConnections(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
|
ListHostsResult |
listHosts(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
|
ListRepositoryLinksResult |
listRepositoryLinks(ListRepositoryLinksRequest listRepositoryLinksRequest)
Lists the repository links created for connections in your account.
|
ListRepositorySyncDefinitionsResult |
listRepositorySyncDefinitions(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest)
Lists the repository sync definitions for repository links in your account.
|
ListSyncConfigurationsResult |
listSyncConfigurations(ListSyncConfigurationsRequest listSyncConfigurationsRequest)
Returns a list of sync configurations for a specified repository.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
UpdateHostResult |
updateHost(UpdateHostRequest updateHostRequest)
Updates a specified host with the provided configurations.
|
UpdateRepositoryLinkResult |
updateRepositoryLink(UpdateRepositoryLinkRequest updateRepositoryLinkRequest)
Updates the association between your connection and a specified external Git repository.
|
UpdateSyncBlockerResult |
updateSyncBlocker(UpdateSyncBlockerRequest updateSyncBlockerRequest)
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
|
UpdateSyncConfigurationResult |
updateSyncConfiguration(UpdateSyncConfigurationRequest updateSyncConfigurationRequest)
Updates the sync configuration for your connection and a specified external Git repository.
|
static final String ENDPOINT_PREFIX
CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest)
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.
createConnectionRequest
- LimitExceededException
- Exceeded the maximum limit for connections.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ResourceUnavailableException
- Resource not found. Verify the ARN for the host resource and try again.CreateHostResult createHost(CreateHostRequest createHostRequest)
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.
createHostRequest
- LimitExceededException
- Exceeded the maximum limit for connections.CreateRepositoryLinkResult createRepositoryLink(CreateRepositoryLinkRequest createRepositoryLinkRequest)
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.
createRepositoryLinkRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.LimitExceededException
- Exceeded the maximum limit for connections.ResourceAlreadyExistsException
- Unable to create resource. Resource already exists.ThrottlingException
- The request was denied due to request throttling.CreateSyncConfigurationResult createSyncConfiguration(CreateSyncConfigurationRequest createSyncConfigurationRequest)
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.
createSyncConfigurationRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.LimitExceededException
- Exceeded the maximum limit for connections.ResourceAlreadyExistsException
- Unable to create resource. Resource already exists.ThrottlingException
- The request was denied due to request throttling.DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
The connection to be deleted.
deleteConnectionRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.DeleteHostResult deleteHost(DeleteHostRequest deleteHostRequest)
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.
deleteHostRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ResourceUnavailableException
- Resource not found. Verify the ARN for the host resource and try again.DeleteRepositoryLinkResult deleteRepositoryLink(DeleteRepositoryLinkRequest deleteRepositoryLinkRequest)
Deletes the association between your connection and a specified external Git repository.
deleteRepositoryLinkRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.SyncConfigurationStillExistsException
- Unable to continue. The sync blocker still exists.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.UnsupportedProviderTypeException
- The specified provider type is not supported for connections.DeleteSyncConfigurationResult deleteSyncConfiguration(DeleteSyncConfigurationRequest deleteSyncConfigurationRequest)
Deletes the sync configuration for a specified repository and connection.
deleteSyncConfigurationRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.LimitExceededException
- Exceeded the maximum limit for connections.ThrottlingException
- The request was denied due to request throttling.GetConnectionResult getConnection(GetConnectionRequest getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
getConnectionRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ResourceUnavailableException
- Resource not found. Verify the ARN for the host resource and try again.GetHostResult getHost(GetHostRequest getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
getHostRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ResourceUnavailableException
- Resource not found. Verify the ARN for the host resource and try again.GetRepositoryLinkResult getRepositoryLink(GetRepositoryLinkRequest getRepositoryLinkRequest)
Returns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.
getRepositoryLinkRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.GetRepositorySyncStatusResult getRepositorySyncStatus(GetRepositorySyncStatusRequest getRepositorySyncStatusRequest)
Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.
getRepositorySyncStatusRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.GetResourceSyncStatusResult getResourceSyncStatus(GetResourceSyncStatusRequest getResourceSyncStatusRequest)
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
getResourceSyncStatusRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.GetSyncBlockerSummaryResult getSyncBlockerSummary(GetSyncBlockerSummaryRequest getSyncBlockerSummaryRequest)
Returns a list of the most recent sync blockers.
getSyncBlockerSummaryRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.GetSyncConfigurationResult getSyncConfiguration(GetSyncConfigurationRequest getSyncConfigurationRequest)
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.
getSyncConfigurationRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.ListConnectionsResult listConnections(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
listConnectionsRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ListHostsResult listHosts(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
listHostsRequest
- ListRepositoryLinksResult listRepositoryLinks(ListRepositoryLinksRequest listRepositoryLinksRequest)
Lists the repository links created for connections in your account.
listRepositoryLinksRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.ListRepositorySyncDefinitionsResult listRepositorySyncDefinitions(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest)
Lists the repository sync definitions for repository links in your account.
listRepositorySyncDefinitionsRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.ListSyncConfigurationsResult listSyncConfigurations(ListSyncConfigurationsRequest listSyncConfigurationsRequest)
Returns a list of sync configurations for a specified repository.
listSyncConfigurationsRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.LimitExceededException
- Exceeded the maximum limit for connections.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.UpdateHostResult updateHost(UpdateHostRequest updateHostRequest)
Updates a specified host with the provided configurations.
updateHostRequest
- ConflictException
- Two conflicting operations have been made on the same resource.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ResourceUnavailableException
- Resource not found. Verify the ARN for the host resource and try again.UnsupportedOperationException
- The operation is not supported. Check the connection status and try again.UpdateRepositoryLinkResult updateRepositoryLink(UpdateRepositoryLinkRequest updateRepositoryLinkRequest)
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.
updateRepositoryLinkRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConditionalCheckFailedException
- The conditional check failed. Try again later.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.UpdateOutOfSyncException
- The update is out of sync. Try syncing again.UpdateSyncBlockerResult updateSyncBlocker(UpdateSyncBlockerRequest updateSyncBlockerRequest)
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
updateSyncBlockerRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.RetryLatestCommitFailedException
- Retrying the latest commit failed. Try again later.SyncBlockerDoesNotExistException
- Unable to continue. The sync blocker does not exist.ThrottlingException
- The request was denied due to request throttling.UpdateSyncConfigurationResult updateSyncConfiguration(UpdateSyncConfigurationRequest updateSyncConfigurationRequest)
Updates the sync configuration for your connection and a specified external Git repository.
updateSyncConfigurationRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.ConcurrentModificationException
- Exception thrown as a result of concurrent modification to an application. For example, two individuals
attempting to edit the same application at the same time.InternalServerException
- Received an internal server exception. Try again later.InvalidInputException
- The input is not valid. Verify that the action is typed correctly.ResourceNotFoundException
- Resource not found. Verify the connection resource ARN and try again.ThrottlingException
- The request was denied due to request throttling.UpdateOutOfSyncException
- The update is out of sync. Try syncing again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.