Package software.amazon.awssdk.services.timestreaminfluxdb

Interface TimestreamInfluxDbClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface TimestreamInfluxDbClient
extends AwsClient

Service client for accessing Timestream InfluxDB. This can be created using the static builder() method.

Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static TimestreamInfluxDbClientBuilder	builder()	Create a builder that can be used to configure and create a TimestreamInfluxDbClient.
static TimestreamInfluxDbClient	create()	Create a TimestreamInfluxDbClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDbInstanceResponse	createDbInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)	Creates a new Timestream for InfluxDB DB instance.
default CreateDbInstanceResponse	createDbInstance(CreateDbInstanceRequest createDbInstanceRequest)	Creates a new Timestream for InfluxDB DB instance.
default CreateDbParameterGroupResponse	createDbParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)	Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
default CreateDbParameterGroupResponse	createDbParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)	Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
default DeleteDbInstanceResponse	deleteDbInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)	Deletes a Timestream for InfluxDB DB instance.
default DeleteDbInstanceResponse	deleteDbInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)	Deletes a Timestream for InfluxDB DB instance.
default GetDbInstanceResponse	getDbInstance(Consumer<GetDbInstanceRequest.Builder> getDbInstanceRequest)	Returns a Timestream for InfluxDB DB instance.
default GetDbInstanceResponse	getDbInstance(GetDbInstanceRequest getDbInstanceRequest)	Returns a Timestream for InfluxDB DB instance.
default GetDbParameterGroupResponse	getDbParameterGroup(Consumer<GetDbParameterGroupRequest.Builder> getDbParameterGroupRequest)	Returns a Timestream for InfluxDB DB parameter group.
default GetDbParameterGroupResponse	getDbParameterGroup(GetDbParameterGroupRequest getDbParameterGroupRequest)	Returns a Timestream for InfluxDB DB parameter group.
default ListDbInstancesResponse	listDbInstances(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)	Returns a list of Timestream for InfluxDB DB instances.
default ListDbInstancesResponse	listDbInstances(ListDbInstancesRequest listDbInstancesRequest)	Returns a list of Timestream for InfluxDB DB instances.
default ListDbInstancesIterable	listDbInstancesPaginator(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)	This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.
default ListDbInstancesIterable	listDbInstancesPaginator(ListDbInstancesRequest listDbInstancesRequest)	This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.
default ListDbParameterGroupsResponse	listDbParameterGroups(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)	Returns a list of Timestream for InfluxDB DB parameter groups.
default ListDbParameterGroupsResponse	listDbParameterGroups(ListDbParameterGroupsRequest listDbParameterGroupsRequest)	Returns a list of Timestream for InfluxDB DB parameter groups.
default ListDbParameterGroupsIterable	listDbParameterGroupsPaginator(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)	This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.
default ListDbParameterGroupsIterable	listDbParameterGroupsPaginator(ListDbParameterGroupsRequest listDbParameterGroupsRequest)	This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	A list of tags applied to the resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	A list of tags applied to the resource.
default TimestreamInfluxDbServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags are composed of a Key/Value pairs.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags are composed of a Key/Value pairs.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the tag from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the tag from the specified resource.
default UpdateDbInstanceResponse	updateDbInstance(Consumer<UpdateDbInstanceRequest.Builder> updateDbInstanceRequest)	Updates a Timestream for InfluxDB DB instance.
default UpdateDbInstanceResponse	updateDbInstance(UpdateDbInstanceRequest updateDbInstanceRequest)	Updates a Timestream for InfluxDB DB instance.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createDbInstance

default CreateDbInstanceResponse createDbInstance(CreateDbInstanceRequest createDbInstanceRequest)
                                           throws ServiceQuotaExceededException,
                                                  ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Creates a new Timestream for InfluxDB DB instance.

Parameters:

createDbInstanceRequest -

Returns:

Result of the CreateDbInstance operation returned by the service.

Throws:

ServiceQuotaExceededException - The request exceeds the service quota.

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createDbInstance

default CreateDbInstanceResponse createDbInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
                                           throws ServiceQuotaExceededException,
                                                  ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Creates a new Timestream for InfluxDB DB instance.

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

Parameters:

createDbInstanceRequest - A Consumer that will call methods on CreateDbInstanceRequest.Builder to create a request.

Returns:

Result of the CreateDbInstance operation returned by the service.

Throws:

ServiceQuotaExceededException - The request exceeds the service quota.

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createDbParameterGroup

default CreateDbParameterGroupResponse createDbParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)
                                                       throws ServiceQuotaExceededException,
                                                              ValidationException,
                                                              AccessDeniedException,
                                                              InternalServerException,
                                                              ConflictException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TimestreamInfluxDbException

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

Parameters:

createDbParameterGroupRequest -

Returns:

Result of the CreateDbParameterGroup operation returned by the service.

Throws:

ServiceQuotaExceededException - The request exceeds the service quota.

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createDbParameterGroup

default CreateDbParameterGroupResponse createDbParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)
                                                       throws ServiceQuotaExceededException,
                                                              ValidationException,
                                                              AccessDeniedException,
                                                              InternalServerException,
                                                              ConflictException,
                                                              ResourceNotFoundException,
                                                              ThrottlingException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TimestreamInfluxDbException

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

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

Parameters:

createDbParameterGroupRequest - A Consumer that will call methods on CreateDbParameterGroupRequest.Builder to create a request.

Returns:

Result of the CreateDbParameterGroup operation returned by the service.

Throws:

ServiceQuotaExceededException - The request exceeds the service quota.

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteDbInstance

default DeleteDbInstanceResponse deleteDbInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
                                           throws ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Deletes a Timestream for InfluxDB DB instance.

Parameters:

deleteDbInstanceRequest -

Returns:

Result of the DeleteDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteDbInstance

default DeleteDbInstanceResponse deleteDbInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
                                           throws ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Deletes a Timestream for InfluxDB DB instance.

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

Parameters:

deleteDbInstanceRequest - A Consumer that will call methods on DeleteDbInstanceRequest.Builder to create a request.

Returns:

Result of the DeleteDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getDbInstance

default GetDbInstanceResponse getDbInstance(GetDbInstanceRequest getDbInstanceRequest)
                                     throws ValidationException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TimestreamInfluxDbException

Returns a Timestream for InfluxDB DB instance.

Parameters:

getDbInstanceRequest -

Returns:

Result of the GetDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getDbInstance

default GetDbInstanceResponse getDbInstance(Consumer<GetDbInstanceRequest.Builder> getDbInstanceRequest)
                                     throws ValidationException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TimestreamInfluxDbException

Returns a Timestream for InfluxDB DB instance.

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

Parameters:

getDbInstanceRequest - A Consumer that will call methods on GetDbInstanceRequest.Builder to create a request.

Returns:

Result of the GetDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getDbParameterGroup

default GetDbParameterGroupResponse getDbParameterGroup(GetDbParameterGroupRequest getDbParameterGroupRequest)
                                                 throws ValidationException,
                                                        AccessDeniedException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TimestreamInfluxDbException

Returns a Timestream for InfluxDB DB parameter group.

Parameters:

getDbParameterGroupRequest -

Returns:

Result of the GetDbParameterGroup operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getDbParameterGroup

default GetDbParameterGroupResponse getDbParameterGroup(Consumer<GetDbParameterGroupRequest.Builder> getDbParameterGroupRequest)
                                                 throws ValidationException,
                                                        AccessDeniedException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TimestreamInfluxDbException

Returns a Timestream for InfluxDB DB parameter group.

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

Parameters:

getDbParameterGroupRequest - A Consumer that will call methods on GetDbParameterGroupRequest.Builder to create a request.

Returns:

Result of the GetDbParameterGroup operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbInstances

default ListDbInstancesResponse listDbInstances(ListDbInstancesRequest listDbInstancesRequest)
                                         throws ValidationException,
                                                AccessDeniedException,
                                                InternalServerException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                TimestreamInfluxDbException

Returns a list of Timestream for InfluxDB DB instances.

Parameters:

listDbInstancesRequest -

Returns:

Result of the ListDbInstances operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbInstances

default ListDbInstancesResponse listDbInstances(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)
                                         throws ValidationException,
                                                AccessDeniedException,
                                                InternalServerException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                TimestreamInfluxDbException

Returns a list of Timestream for InfluxDB DB instances.

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

Parameters:

listDbInstancesRequest - A Consumer that will call methods on ListDbInstancesRequest.Builder to create a request.

Returns:

Result of the ListDbInstances operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbInstancesPaginator

default ListDbInstancesIterable listDbInstancesPaginator(ListDbInstancesRequest listDbInstancesRequest)
                                                  throws ValidationException,
                                                         AccessDeniedException,
                                                         InternalServerException,
                                                         ResourceNotFoundException,
                                                         ThrottlingException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         TimestreamInfluxDbException

This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) 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.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client.listDbInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client
             .listDbInstancesPaginator(request);
     for (software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client.listDbInstancesPaginator(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 listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.

Parameters:

listDbInstancesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbInstancesPaginator

default ListDbInstancesIterable listDbInstancesPaginator(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)
                                                  throws ValidationException,
                                                         AccessDeniedException,
                                                         InternalServerException,
                                                         ResourceNotFoundException,
                                                         ThrottlingException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         TimestreamInfluxDbException

This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) 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.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client.listDbInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client
             .listDbInstancesPaginator(request);
     for (software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesIterable responses = client.listDbInstancesPaginator(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 listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.

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

Parameters:

listDbInstancesRequest - A Consumer that will call methods on ListDbInstancesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbParameterGroups

default ListDbParameterGroupsResponse listDbParameterGroups(ListDbParameterGroupsRequest listDbParameterGroupsRequest)
                                                     throws ValidationException,
                                                            AccessDeniedException,
                                                            InternalServerException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TimestreamInfluxDbException

Returns a list of Timestream for InfluxDB DB parameter groups.

Parameters:

listDbParameterGroupsRequest -

Returns:

Result of the ListDbParameterGroups operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbParameterGroups

default ListDbParameterGroupsResponse listDbParameterGroups(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)
                                                     throws ValidationException,
                                                            AccessDeniedException,
                                                            InternalServerException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TimestreamInfluxDbException

Returns a list of Timestream for InfluxDB DB parameter groups.

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

Parameters:

listDbParameterGroupsRequest - A Consumer that will call methods on ListDbParameterGroupsRequest.Builder to create a request.

Returns:

Result of the ListDbParameterGroups operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbParameterGroupsPaginator

default ListDbParameterGroupsIterable listDbParameterGroupsPaginator(ListDbParameterGroupsRequest listDbParameterGroupsRequest)
                                                              throws ValidationException,
                                                                     AccessDeniedException,
                                                                     InternalServerException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     TimestreamInfluxDbException

This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) 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.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client.listDbParameterGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client
             .listDbParameterGroupsPaginator(request);
     for (software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client.listDbParameterGroupsPaginator(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 listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.

Parameters:

listDbParameterGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listDbParameterGroupsPaginator

default ListDbParameterGroupsIterable listDbParameterGroupsPaginator(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)
                                                              throws ValidationException,
                                                                     AccessDeniedException,
                                                                     InternalServerException,
                                                                     ResourceNotFoundException,
                                                                     ThrottlingException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     TimestreamInfluxDbException

This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) 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.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client.listDbParameterGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client
             .listDbParameterGroupsPaginator(request);
     for (software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsIterable responses = client.listDbParameterGroupsPaginator(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 listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.

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

Parameters:

listDbParameterGroupsRequest - A Consumer that will call methods on ListDbParameterGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TimestreamInfluxDbException

A list of tags applied to the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TimestreamInfluxDbException

A list of tags applied to 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:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        TimestreamInfluxDbException

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        TimestreamInfluxDbException

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

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:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TimestreamInfluxDbException

Removes the tag from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TimestreamInfluxDbException

Removes the tag from the specified 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:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource was not found or does not exist.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateDbInstance

default UpdateDbInstanceResponse updateDbInstance(UpdateDbInstanceRequest updateDbInstanceRequest)
                                           throws ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Updates a Timestream for InfluxDB DB instance.

Parameters:

updateDbInstanceRequest -

Returns:

Result of the UpdateDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateDbInstance

default UpdateDbInstanceResponse updateDbInstance(Consumer<UpdateDbInstanceRequest.Builder> updateDbInstanceRequest)
                                           throws ValidationException,
                                                  AccessDeniedException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TimestreamInfluxDbException

Updates a Timestream for InfluxDB DB instance.

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

Parameters:

updateDbInstanceRequest - A Consumer that will call methods on UpdateDbInstanceRequest.Builder to create a request.

Returns:

Result of the UpdateDbInstance operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by Timestream for InfluxDB.

AccessDeniedException - You do not have sufficient access to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The request conflicts with an existing resource in Timestream for InfluxDB.

ResourceNotFoundException - The requested resource was not found or does not exist.

ThrottlingException - The request was denied due to request throttling.

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.

TimestreamInfluxDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static TimestreamInfluxDbClient create()

Create a TimestreamInfluxDbClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TimestreamInfluxDbClientBuilder builder()

Create a builder that can be used to configure and create a TimestreamInfluxDbClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default TimestreamInfluxDbServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient