Package software.amazon.awssdk.services.codestarconnections

Interface CodeStarConnectionsAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CodeStarConnectionsAsyncClient
extends AwsClient
    Service client for accessing AWS CodeStar connections asynchronously. This can be created using the static builder() method. 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.

    • Method Detail

      • createConnection

        default CompletableFuture<CreateConnectionResponse> 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.

        Parameters:
        createConnectionRequest -
        Returns:
        A Java Future containing the result of the CreateConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createConnection

        default CompletableFuture<CreateConnectionResponse> createConnection​(Consumer<CreateConnectionRequest.Builder> 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.


        This is a convenience which creates an instance of the CreateConnectionRequest.Builder avoiding the need to create one manually via CreateConnectionRequest.builder()

        Parameters:
        createConnectionRequest - A Consumer that will call methods on CreateConnectionRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createHost

        default CompletableFuture<CreateHostResponse> 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.

        Parameters:
        createHostRequest -
        Returns:
        A Java Future containing the result of the CreateHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • LimitExceededException Exceeded the maximum limit for connections.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createHost

        default CompletableFuture<CreateHostResponse> createHost​(Consumer<CreateHostRequest.Builder> 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.


        This is a convenience which creates an instance of the CreateHostRequest.Builder avoiding the need to create one manually via CreateHostRequest.builder()

        Parameters:
        createHostRequest - A Consumer that will call methods on CreateHostRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • LimitExceededException Exceeded the maximum limit for connections.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteConnection

        default CompletableFuture<DeleteConnectionResponse> deleteConnection​(DeleteConnectionRequest deleteConnectionRequest)

        The connection to be deleted.

        Parameters:
        deleteConnectionRequest -
        Returns:
        A Java Future containing the result of the DeleteConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteConnection

        default CompletableFuture<DeleteConnectionResponse> deleteConnection​(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)

        The connection to be deleted.


        This is a convenience which creates an instance of the DeleteConnectionRequest.Builder avoiding the need to create one manually via DeleteConnectionRequest.builder()

        Parameters:
        deleteConnectionRequest - A Consumer that will call methods on DeleteConnectionRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteHost

        default CompletableFuture<DeleteHostResponse> 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.

        Parameters:
        deleteHostRequest -
        Returns:
        A Java Future containing the result of the DeleteHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteHost

        default CompletableFuture<DeleteHostResponse> deleteHost​(Consumer<DeleteHostRequest.Builder> 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.


        This is a convenience which creates an instance of the DeleteHostRequest.Builder avoiding the need to create one manually via DeleteHostRequest.builder()

        Parameters:
        deleteHostRequest - A Consumer that will call methods on DeleteHostRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getConnection

        default CompletableFuture<GetConnectionResponse> getConnection​(GetConnectionRequest getConnectionRequest)

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

        Parameters:
        getConnectionRequest -
        Returns:
        A Java Future containing the result of the GetConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getConnection

        default CompletableFuture<GetConnectionResponse> getConnection​(Consumer<GetConnectionRequest.Builder> getConnectionRequest)

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


        This is a convenience which creates an instance of the GetConnectionRequest.Builder avoiding the need to create one manually via GetConnectionRequest.builder()

        Parameters:
        getConnectionRequest - A Consumer that will call methods on GetConnectionRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetConnection operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getHost

        default CompletableFuture<GetHostResponse> getHost​(GetHostRequest getHostRequest)

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

        Parameters:
        getHostRequest -
        Returns:
        A Java Future containing the result of the GetHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getHost

        default CompletableFuture<GetHostResponse> getHost​(Consumer<GetHostRequest.Builder> getHostRequest)

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


        This is a convenience which creates an instance of the GetHostRequest.Builder avoiding the need to create one manually via GetHostRequest.builder()

        Parameters:
        getHostRequest - A Consumer that will call methods on GetHostRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConnections

        default CompletableFuture<ListConnectionsResponse> listConnections​(ListConnectionsRequest listConnectionsRequest)

        Lists the connections associated with your account.

        Parameters:
        listConnectionsRequest -
        Returns:
        A Java Future containing the result of the ListConnections operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConnections

        default CompletableFuture<ListConnectionsResponse> listConnections​(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)

        Lists the connections associated with your account.


        This is a convenience which creates an instance of the ListConnectionsRequest.Builder avoiding the need to create one manually via ListConnectionsRequest.builder()

        Parameters:
        listConnectionsRequest - A Consumer that will call methods on ListConnectionsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListConnections operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConnectionsPaginator

        default ListConnectionsPublisher listConnectionsPaginator​(ListConnectionsRequest listConnectionsRequest)

        Lists the connections associated with your account.


        This is a variant of listConnections(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listConnections(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsRequest) operation.

        Parameters:
        listConnectionsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConnectionsPaginator

        default ListConnectionsPublisher listConnectionsPaginator​(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)

        Lists the connections associated with your account.


        This is a variant of listConnections(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listConnections(software.amazon.awssdk.services.codestarconnections.model.ListConnectionsRequest) operation.

        This is a convenience which creates an instance of the ListConnectionsRequest.Builder avoiding the need to create one manually via ListConnectionsRequest.builder()

        Parameters:
        listConnectionsRequest - A Consumer that will call methods on ListConnectionsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listHosts

        default CompletableFuture<ListHostsResponse> listHosts​(ListHostsRequest listHostsRequest)

        Lists the hosts associated with your account.

        Parameters:
        listHostsRequest -
        Returns:
        A Java Future containing the result of the ListHosts operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listHosts

        default CompletableFuture<ListHostsResponse> listHosts​(Consumer<ListHostsRequest.Builder> listHostsRequest)

        Lists the hosts associated with your account.


        This is a convenience which creates an instance of the ListHostsRequest.Builder avoiding the need to create one manually via ListHostsRequest.builder()

        Parameters:
        listHostsRequest - A Consumer that will call methods on ListHostsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListHosts operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listHostsPaginator

        default ListHostsPublisher listHostsPaginator​(ListHostsRequest listHostsRequest)

        Lists the hosts associated with your account.


        This is a variant of listHosts(software.amazon.awssdk.services.codestarconnections.model.ListHostsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListHostsPublisher publisher = client.listHostsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListHostsPublisher publisher = client.listHostsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHosts(software.amazon.awssdk.services.codestarconnections.model.ListHostsRequest) operation.

        Parameters:
        listHostsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listHostsPaginator

        default ListHostsPublisher listHostsPaginator​(Consumer<ListHostsRequest.Builder> listHostsRequest)

        Lists the hosts associated with your account.


        This is a variant of listHosts(software.amazon.awssdk.services.codestarconnections.model.ListHostsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListHostsPublisher publisher = client.listHostsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.codestarconnections.paginators.ListHostsPublisher publisher = client.listHostsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHosts(software.amazon.awssdk.services.codestarconnections.model.ListHostsRequest) operation.

        This is a convenience which creates an instance of the ListHostsRequest.Builder avoiding the need to create one manually via ListHostsRequest.builder()

        Parameters:
        listHostsRequest - A Consumer that will call methods on ListHostsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

        default CompletableFuture<ListTagsForResourceResponse> listTagsForResource​(ListTagsForResourceRequest listTagsForResourceRequest)

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

        Parameters:
        listTagsForResourceRequest -
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

        default CompletableFuture<ListTagsForResourceResponse> listTagsForResource​(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

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


        This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

        Parameters:
        listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(TagResourceRequest tagResourceRequest)

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

        Parameters:
        tagResourceRequest -
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • LimitExceededException Exceeded the maximum limit for connections.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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


        This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

        Parameters:
        tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • LimitExceededException Exceeded the maximum limit for connections.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(UntagResourceRequest untagResourceRequest)

        Removes tags from an Amazon Web Services resource.

        Parameters:
        untagResourceRequest -
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

        Removes tags from an Amazon Web Services resource.


        This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

        Parameters:
        untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • ResourceNotFoundException Resource not found. Verify the connection resource ARN and try again.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateHost

        default CompletableFuture<UpdateHostResponse> updateHost​(UpdateHostRequest updateHostRequest)

        Updates a specified host with the provided configurations.

        Parameters:
        updateHostRequest -
        Returns:
        A Java Future containing the result of the UpdateHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateHost

        default CompletableFuture<UpdateHostResponse> updateHost​(Consumer<UpdateHostRequest.Builder> updateHostRequest)

        Updates a specified host with the provided configurations.


        This is a convenience which creates an instance of the UpdateHostRequest.Builder avoiding the need to create one manually via UpdateHostRequest.builder()

        Parameters:
        updateHostRequest - A Consumer that will call methods on UpdateHostRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UpdateHost operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CodeStarConnectionsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation