com.amazonaws.services.timestreaminfluxdb.AWSTimestreamInfluxDB Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-timestreaminfluxdb Show documentation
Show all versions of aws-java-sdk-timestreaminfluxdb Show documentation
The AWS Java SDK for Timestream InfluxDB module holds the client classes that are used for communicating with Timestream InfluxDB Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.timestreaminfluxdb;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.timestreaminfluxdb.model.*;
/**
* Interface for accessing Timestream InfluxDB.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.timestreaminfluxdb.AbstractAWSTimestreamInfluxDB} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSTimestreamInfluxDB {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "timestream-influxdb";
/**
*
* Creates a new Timestream for InfluxDB DB instance.
*
*
* @param createDbInstanceRequest
* @return Result of the CreateDbInstance operation returned by the service.
* @throws ServiceQuotaExceededException
* The request exceeds the service quota.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request conflicts with an existing resource in Timestream for InfluxDB.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.CreateDbInstance
* @see AWS API Documentation
*/
CreateDbInstanceResult createDbInstance(CreateDbInstanceRequest createDbInstanceRequest);
/**
*
* Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
*
*
* @param createDbParameterGroupRequest
* @return Result of the CreateDbParameterGroup operation returned by the service.
* @throws ServiceQuotaExceededException
* The request exceeds the service quota.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request conflicts with an existing resource in Timestream for InfluxDB.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.CreateDbParameterGroup
* @see AWS API Documentation
*/
CreateDbParameterGroupResult createDbParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest);
/**
*
* Deletes a Timestream for InfluxDB DB instance.
*
*
* @param deleteDbInstanceRequest
* @return Result of the DeleteDbInstance operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request conflicts with an existing resource in Timestream for InfluxDB.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.DeleteDbInstance
* @see AWS API Documentation
*/
DeleteDbInstanceResult deleteDbInstance(DeleteDbInstanceRequest deleteDbInstanceRequest);
/**
*
* Returns a Timestream for InfluxDB DB instance.
*
*
* @param getDbInstanceRequest
* @return Result of the GetDbInstance operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.GetDbInstance
* @see AWS API Documentation
*/
GetDbInstanceResult getDbInstance(GetDbInstanceRequest getDbInstanceRequest);
/**
*
* Returns a Timestream for InfluxDB DB parameter group.
*
*
* @param getDbParameterGroupRequest
* @return Result of the GetDbParameterGroup operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.GetDbParameterGroup
* @see AWS API Documentation
*/
GetDbParameterGroupResult getDbParameterGroup(GetDbParameterGroupRequest getDbParameterGroupRequest);
/**
*
* Returns a list of Timestream for InfluxDB DB instances.
*
*
* @param listDbInstancesRequest
* @return Result of the ListDbInstances operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.ListDbInstances
* @see AWS API Documentation
*/
ListDbInstancesResult listDbInstances(ListDbInstancesRequest listDbInstancesRequest);
/**
*
* Returns a list of Timestream for InfluxDB DB parameter groups.
*
*
* @param listDbParameterGroupsRequest
* @return Result of the ListDbParameterGroups operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.ListDbParameterGroups
* @see AWS API Documentation
*/
ListDbParameterGroupsResult listDbParameterGroups(ListDbParameterGroupsRequest listDbParameterGroupsRequest);
/**
*
* A list of tags applied to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @sample AWSTimestreamInfluxDB.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB
* resources.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @sample AWSTimestreamInfluxDB.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the tag from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @sample AWSTimestreamInfluxDB.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a Timestream for InfluxDB DB instance.
*
*
* @param updateDbInstanceRequest
* @return Result of the UpdateDbInstance operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by Timestream for InfluxDB.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request conflicts with an existing resource in Timestream for InfluxDB.
* @throws ResourceNotFoundException
* The requested resource was not found or does not exist.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSTimestreamInfluxDB.UpdateDbInstance
* @see AWS API Documentation
*/
UpdateDbInstanceResult updateDbInstance(UpdateDbInstanceRequest updateDbInstanceRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}