com.amazonaws.services.timestreaminfluxdb

Class AWSTimestreamInfluxDBClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.timestreaminfluxdb.AWSTimestreamInfluxDBClient

All Implemented Interfaces:

AWSTimestreamInfluxDB

Direct Known Subclasses:

AWSTimestreamInfluxDBAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSTimestreamInfluxDBClient
extends AmazonWebServiceClient
implements AWSTimestreamInfluxDB

Client for accessing Timestream InfluxDB. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.timestreaminfluxdb.AWSTimestreamInfluxDB

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSTimestreamInfluxDBClientBuilder	builder()
CreateDbInstanceResult	createDbInstance(CreateDbInstanceRequest request) Creates a new Timestream for InfluxDB DB instance.
CreateDbParameterGroupResult	createDbParameterGroup(CreateDbParameterGroupRequest request) Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
DeleteDbInstanceResult	deleteDbInstance(DeleteDbInstanceRequest request) Deletes a Timestream for InfluxDB DB instance.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDbInstanceResult	getDbInstance(GetDbInstanceRequest request) Returns a Timestream for InfluxDB DB instance.
GetDbParameterGroupResult	getDbParameterGroup(GetDbParameterGroupRequest request) Returns a Timestream for InfluxDB DB parameter group.
ListDbInstancesResult	listDbInstances(ListDbInstancesRequest request) Returns a list of Timestream for InfluxDB DB instances.
ListDbParameterGroupsResult	listDbParameterGroups(ListDbParameterGroupsRequest request) Returns a list of Timestream for InfluxDB DB parameter groups.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) A list of tags applied to the resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Tags are composed of a Key/Value pairs.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the tag from the specified resource.
UpdateDbInstanceResult	updateDbInstance(UpdateDbInstanceRequest request) Updates a Timestream for InfluxDB DB instance.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSTimestreamInfluxDBClientBuilder builder()

createDbInstance

public CreateDbInstanceResult createDbInstance(CreateDbInstanceRequest request)

Creates a new Timestream for InfluxDB DB instance.

Specified by:

createDbInstance in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

createDbParameterGroup

public CreateDbParameterGroupResult createDbParameterGroup(CreateDbParameterGroupRequest request)

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

Specified by:

createDbParameterGroup in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

deleteDbInstance

public DeleteDbInstanceResult deleteDbInstance(DeleteDbInstanceRequest request)

Deletes a Timestream for InfluxDB DB instance.

Specified by:

deleteDbInstance in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

getDbInstance

public GetDbInstanceResult getDbInstance(GetDbInstanceRequest request)

Returns a Timestream for InfluxDB DB instance.

Specified by:

getDbInstance in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

getDbParameterGroup

public GetDbParameterGroupResult getDbParameterGroup(GetDbParameterGroupRequest request)

Returns a Timestream for InfluxDB DB parameter group.

Specified by:

getDbParameterGroup in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

listDbInstances

public ListDbInstancesResult listDbInstances(ListDbInstancesRequest request)

Returns a list of Timestream for InfluxDB DB instances.

Specified by:

listDbInstances in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

listDbParameterGroups

public ListDbParameterGroupsResult listDbParameterGroups(ListDbParameterGroupsRequest request)

Returns a list of Timestream for InfluxDB DB parameter groups.

Specified by:

listDbParameterGroups in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

A list of tags applied to the resource.

Specified by:

listTagsForResource in interface AWSTimestreamInfluxDB

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AWSTimestreamInfluxDB

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the tag from the specified resource.

Specified by:

untagResource in interface AWSTimestreamInfluxDB

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

updateDbInstance

public UpdateDbInstanceResult updateDbInstance(UpdateDbInstanceRequest request)

Updates a Timestream for InfluxDB DB instance.

Specified by:

updateDbInstance in interface AWSTimestreamInfluxDB

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSTimestreamInfluxDB

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSTimestreamInfluxDB

Overrides:

shutdown in class AmazonWebServiceClient