@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CodeStarConnectionsClient extends AwsClient
builder()
method.
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 |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static CodeStarConnectionsClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodeStarConnectionsClient. |
static CodeStarConnectionsClient |
create()
Create a
CodeStarConnectionsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default 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.
|
default 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.
|
default CreateHostResponse |
createHost(Consumer<CreateHostRequest.Builder> createHostRequest)
Creates a resource that represents the infrastructure where a third-party provider is installed.
|
default CreateHostResponse |
createHost(CreateHostRequest createHostRequest)
Creates a resource that represents the infrastructure where a third-party provider is installed.
|
default DeleteConnectionResponse |
deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)
The connection to be deleted.
|
default DeleteConnectionResponse |
deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
The connection to be deleted.
|
default DeleteHostResponse |
deleteHost(Consumer<DeleteHostRequest.Builder> deleteHostRequest)
The host to be deleted.
|
default DeleteHostResponse |
deleteHost(DeleteHostRequest deleteHostRequest)
The host to be deleted.
|
default GetConnectionResponse |
getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
|
default GetConnectionResponse |
getConnection(GetConnectionRequest getConnectionRequest)
Returns the connection ARN and details such as status, owner, and provider type.
|
default GetHostResponse |
getHost(Consumer<GetHostRequest.Builder> getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC
configuration.
|
default GetHostResponse |
getHost(GetHostRequest getHostRequest)
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC
configuration.
|
default ListConnectionsResponse |
listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)
Lists the connections associated with your account.
|
default ListConnectionsResponse |
listConnections(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
|
default ListConnectionsIterable |
listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)
Lists the connections associated with your account.
|
default ListConnectionsIterable |
listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest)
Lists the connections associated with your account.
|
default ListHostsResponse |
listHosts(Consumer<ListHostsRequest.Builder> listHostsRequest)
Lists the hosts associated with your account.
|
default ListHostsResponse |
listHosts(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
|
default ListHostsIterable |
listHostsPaginator(Consumer<ListHostsRequest.Builder> listHostsRequest)
Lists the hosts associated with your account.
|
default ListHostsIterable |
listHostsPaginator(ListHostsRequest listHostsRequest)
Lists the hosts associated with your account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default CodeStarConnectionsServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UpdateHostResponse |
updateHost(Consumer<UpdateHostRequest.Builder> updateHostRequest)
Updates a specified host with the provided configurations.
|
default UpdateHostResponse |
updateHost(UpdateHostRequest updateHostRequest)
Updates a specified host with the provided configurations.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateConnectionResponse createConnection(CreateConnectionRequest createConnectionRequest) throws LimitExceededException, ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault CreateConnectionResponse createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest) throws LimitExceededException, ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
createConnectionRequest - A Consumer that will call methods on
CreateConnectionRequest.Builder to
create a request.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.AwsServiceExceptiondefault CreateHostResponse createHost(CreateHostRequest createHostRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault CreateHostResponse createHost(Consumer<CreateHostRequest.Builder> createHostRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
createHostRequest - A Consumer that will call methods on
CreateHostRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
The connection to be deleted.
deleteConnectionRequest - 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.AwsServiceExceptiondefault DeleteConnectionResponse deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
deleteConnectionRequest - A Consumer that will call methods on
DeleteConnectionRequest.Builder to
create a request.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.AwsServiceExceptiondefault DeleteHostResponse deleteHost(DeleteHostRequest deleteHostRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault DeleteHostResponse deleteHost(Consumer<DeleteHostRequest.Builder> deleteHostRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
deleteHostRequest - A Consumer that will call methods on
DeleteHostRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetConnectionResponse getConnection(GetConnectionRequest getConnectionRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault GetConnectionResponse getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
getConnectionRequest - A Consumer that will call methods on
GetConnectionRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetHostResponse getHost(GetHostRequest getHostRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault GetHostResponse getHost(Consumer<GetHostRequest.Builder> getHostRequest) throws ResourceNotFoundException, ResourceUnavailableException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
getHostRequest - A Consumer that will call methods on
GetHostRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListConnectionsResponse listConnections(ListConnectionsRequest listConnectionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
Lists the connections associated with your account.
listConnectionsRequest - 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.AwsServiceExceptiondefault ListConnectionsResponse listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
listConnectionsRequest - A Consumer that will call methods on
ListConnectionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListConnectionsIterable listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client
.listConnectionsPaginator(request);
for (software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listConnectionsRequest - 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.AwsServiceExceptiondefault ListConnectionsIterable listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client
.listConnectionsPaginator(request);
for (software.amazon.awssdk.services.codestarconnections.model.ListConnectionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codestarconnections.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listConnectionsRequest - A Consumer that will call methods on
ListConnectionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListHostsResponse listHosts(ListHostsRequest listHostsRequest) throws AwsServiceException, SdkClientException, CodeStarConnectionsException
Lists the hosts associated with your account.
listHostsRequest - 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.AwsServiceExceptiondefault ListHostsResponse listHosts(Consumer<ListHostsRequest.Builder> listHostsRequest) throws AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
listHostsRequest - A Consumer that will call methods on
ListHostsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListHostsIterable listHostsPaginator(ListHostsRequest listHostsRequest) throws AwsServiceException, SdkClientException, CodeStarConnectionsException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client.listHostsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client
.listHostsPaginator(request);
for (software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client.listHostsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listHostsRequest - 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.AwsServiceExceptiondefault ListHostsIterable listHostsPaginator(Consumer<ListHostsRequest.Builder> listHostsRequest) throws AwsServiceException, SdkClientException, CodeStarConnectionsException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client.listHostsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client
.listHostsPaginator(request);
for (software.amazon.awssdk.services.codestarconnections.model.ListHostsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codestarconnections.paginators.ListHostsIterable responses = client.listHostsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listHostsRequest - A Consumer that will call methods on
ListHostsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to
create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
Removes tags from an Amazon Web Services resource.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault UpdateHostResponse updateHost(UpdateHostRequest updateHostRequest) throws ConflictException, ResourceNotFoundException, ResourceUnavailableException, UnsupportedOperationException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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.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.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateHostResponse updateHost(Consumer<UpdateHostRequest.Builder> updateHostRequest) throws ConflictException, ResourceNotFoundException, ResourceUnavailableException, UnsupportedOperationException, AwsServiceException, SdkClientException, CodeStarConnectionsException
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()
updateHostRequest - A Consumer that will call methods on
UpdateHostRequest.Builder to create a
request.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.UnsupportedOperationExceptionAwsServiceExceptionstatic CodeStarConnectionsClient create()
CodeStarConnectionsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CodeStarConnectionsClientBuilder builder()
CodeStarConnectionsClient.static ServiceMetadata serviceMetadata()
default CodeStarConnectionsServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.