@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeStarconnectionsAsync extends AWSCodeStarconnections
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodeStarconnectionsAsync instead.
The CodeStar Connections feature is in preview release and is subject to change.
This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.
Connections are configurations that you use to connect AWS 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 Cloud 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 AWS CodeStar Connections by calling the following:
ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.
TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.
UntagResource, which removes tags for a resource in AWS CodeStar Connections.
For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<CreateConnectionResult> |
createConnectionAsync(CreateConnectionRequest createConnectionRequest)
Creates a connection that can then be given to other AWS services like CodePipeline so that it can access
third-party code repositories.
|
Future<CreateConnectionResult> |
createConnectionAsync(CreateConnectionRequest createConnectionRequest,
AsyncHandler<CreateConnectionRequest,CreateConnectionResult> asyncHandler)
Creates a connection that can then be given to other AWS services like CodePipeline so that it can access
third-party code repositories.
|
Future<CreateHostResult> |
createHostAsync(CreateHostRequest createHostRequest)
Creates a resource that represents the infrastructure where a third-party provider is installed.
|
Future<CreateHostResult> |
createHostAsync(CreateHostRequest createHostRequest,
AsyncHandler<CreateHostRequest,CreateHostResult> asyncHandler)
Creates a resource that represents the infrastructure where a third-party provider is installed.
|
Future<DeleteConnectionResult> |
deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest)
The connection to be deleted.
|
Future<DeleteConnectionResult> |
deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest,
AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler)
The connection to be deleted.
|
Future<DeleteHostResult> |
deleteHostAsync(DeleteHostRequest deleteHostRequest)
The host to be deleted.
|
Future<DeleteHostResult> |
deleteHostAsync(DeleteHostRequest deleteHostRequest,
AsyncHandler<DeleteHostRequest,DeleteHostResult> asyncHandler)
The host to be deleted.
|
Future<GetConnectionResult> |
getConnectionAsync(GetConnectionRequest getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
|
Future<GetConnectionResult> |
getConnectionAsync(GetConnectionRequest getConnectionRequest,
AsyncHandler<GetConnectionRequest,GetConnectionResult> asyncHandler)
Returns the connection ARN and details such as status, owner, and provider type.
|
Future<GetHostResult> |
getHostAsync(GetHostRequest getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC
configuration.
|
Future<GetHostResult> |
getHostAsync(GetHostRequest getHostRequest,
AsyncHandler<GetHostRequest,GetHostResult> asyncHandler)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC
configuration.
|
Future<ListConnectionsResult> |
listConnectionsAsync(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
|
Future<ListConnectionsResult> |
listConnectionsAsync(ListConnectionsRequest listConnectionsRequest,
AsyncHandler<ListConnectionsRequest,ListConnectionsResult> asyncHandler)
Lists the connections associated with your account.
|
Future<ListHostsResult> |
listHostsAsync(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
|
Future<ListHostsResult> |
listHostsAsync(ListHostsRequest listHostsRequest,
AsyncHandler<ListHostsRequest,ListHostsResult> asyncHandler)
Lists the hosts associated with your account.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds to or modifies the tags of the given resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an AWS resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an AWS resource.
|
createConnection, createHost, deleteConnection, deleteHost, getCachedResponseMetadata, getConnection, getHost, listConnections, listHosts, listTagsForResource, shutdown, tagResource, untagResourceFuture<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest createConnectionRequest)
Creates a connection that can then be given to other AWS 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 - Future<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest createConnectionRequest, AsyncHandler<CreateConnectionRequest,CreateConnectionResult> asyncHandler)
Creates a connection that can then be given to other AWS 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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateHostResult> createHostAsync(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 - Future<CreateHostResult> createHostAsync(CreateHostRequest createHostRequest, AsyncHandler<CreateHostRequest,CreateHostResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest)
The connection to be deleted.
deleteConnectionRequest - Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler)
The connection to be deleted.
deleteConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteHostResult> deleteHostAsync(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 - Future<DeleteHostResult> deleteHostAsync(DeleteHostRequest deleteHostRequest, AsyncHandler<DeleteHostRequest,DeleteHostResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetConnectionResult> getConnectionAsync(GetConnectionRequest getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
getConnectionRequest - Future<GetConnectionResult> getConnectionAsync(GetConnectionRequest getConnectionRequest, AsyncHandler<GetConnectionRequest,GetConnectionResult> asyncHandler)
Returns the connection ARN and details such as status, owner, and provider type.
getConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetHostResult> getHostAsync(GetHostRequest getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
getHostRequest - Future<GetHostResult> getHostAsync(GetHostRequest getHostRequest, AsyncHandler<GetHostRequest,GetHostResult> asyncHandler)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
getHostRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
listConnectionsRequest - Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest listConnectionsRequest, AsyncHandler<ListConnectionsRequest,ListConnectionsResult> asyncHandler)
Lists the connections associated with your account.
listConnectionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListHostsResult> listHostsAsync(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
listHostsRequest - Future<ListHostsResult> listHostsAsync(ListHostsRequest listHostsRequest, AsyncHandler<ListHostsRequest,ListHostsResult> asyncHandler)
Lists the hosts associated with your account.
listHostsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an AWS resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an AWS resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.