Skip to content

TimestreamInfluxDBClient#

Index > TimestreamInfluxDB > TimestreamInfluxDBClient

Auto-generated documentation for TimestreamInfluxDB type annotations stubs module mypy-boto3-timestream-influxdb.

TimestreamInfluxDBClient#

Type annotations and code completion for boto3.client("timestream-influxdb"). boto3 documentation

# TimestreamInfluxDBClient usage example

from boto3.session import Session
from mypy_boto3_timestream_influxdb.client import TimestreamInfluxDBClient

def get_timestream-influxdb_client() -> TimestreamInfluxDBClient:
    return Session().client("timestream-influxdb")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("timestream-influxdb").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("timestream-influxdb")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_timestream_influxdb.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("timestream-influxdb").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("timestream-influxdb").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_db_instance#

Creates a new Timestream for InfluxDB DB instance.

Type annotations and code completion for boto3.client("timestream-influxdb").create_db_instance method. boto3 documentation

# create_db_instance method definition

def create_db_instance(
    self,
    *,
    name: str,
    password: str,
    dbInstanceType: DbInstanceTypeType,  # (1)
    vpcSubnetIds: Sequence[str],
    vpcSecurityGroupIds: Sequence[str],
    allocatedStorage: int,
    username: str = ...,
    organization: str = ...,
    bucket: str = ...,
    publiclyAccessible: bool = ...,
    dbStorageType: DbStorageTypeType = ...,  # (2)
    dbParameterGroupIdentifier: str = ...,
    deploymentType: DeploymentTypeType = ...,  # (3)
    logDeliveryConfiguration: LogDeliveryConfigurationTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
    port: int = ...,
) -> CreateDbInstanceOutputTypeDef:  # (5)
    ...
  1. See DbInstanceTypeType
  2. See DbStorageTypeType
  3. See DeploymentTypeType
  4. See LogDeliveryConfigurationTypeDef
  5. See CreateDbInstanceOutputTypeDef 
# create_db_instance method usage example with argument unpacking

kwargs: CreateDbInstanceInputRequestTypeDef = {  # (1)
    "name": ...,
    "password": ...,
    "dbInstanceType": ...,
    "vpcSubnetIds": ...,
    "vpcSecurityGroupIds": ...,
    "allocatedStorage": ...,
}

parent.create_db_instance(**kwargs)
  1. See CreateDbInstanceInputRequestTypeDef

create_db_parameter_group#

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

Type annotations and code completion for boto3.client("timestream-influxdb").create_db_parameter_group method. boto3 documentation

# create_db_parameter_group method definition

def create_db_parameter_group(
    self,
    *,
    name: str,
    description: str = ...,
    parameters: ParametersTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateDbParameterGroupOutputTypeDef:  # (2)
    ...
  1. See ParametersTypeDef
  2. See CreateDbParameterGroupOutputTypeDef 
# create_db_parameter_group method usage example with argument unpacking

kwargs: CreateDbParameterGroupInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_db_parameter_group(**kwargs)
  1. See CreateDbParameterGroupInputRequestTypeDef

delete_db_instance#

Deletes a Timestream for InfluxDB DB instance.

Type annotations and code completion for boto3.client("timestream-influxdb").delete_db_instance method. boto3 documentation

# delete_db_instance method definition

def delete_db_instance(
    self,
    *,
    identifier: str,
) -> DeleteDbInstanceOutputTypeDef:  # (1)
    ...
  1. See DeleteDbInstanceOutputTypeDef 
# delete_db_instance method usage example with argument unpacking

kwargs: DeleteDbInstanceInputRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_db_instance(**kwargs)
  1. See DeleteDbInstanceInputRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("timestream-influxdb").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_db_instance#

Returns a Timestream for InfluxDB DB instance.

Type annotations and code completion for boto3.client("timestream-influxdb").get_db_instance method. boto3 documentation

# get_db_instance method definition

def get_db_instance(
    self,
    *,
    identifier: str,
) -> GetDbInstanceOutputTypeDef:  # (1)
    ...
  1. See GetDbInstanceOutputTypeDef 
# get_db_instance method usage example with argument unpacking

kwargs: GetDbInstanceInputRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_db_instance(**kwargs)
  1. See GetDbInstanceInputRequestTypeDef

get_db_parameter_group#

Returns a Timestream for InfluxDB DB parameter group.

Type annotations and code completion for boto3.client("timestream-influxdb").get_db_parameter_group method. boto3 documentation

# get_db_parameter_group method definition

def get_db_parameter_group(
    self,
    *,
    identifier: str,
) -> GetDbParameterGroupOutputTypeDef:  # (1)
    ...
  1. See GetDbParameterGroupOutputTypeDef 
# get_db_parameter_group method usage example with argument unpacking

kwargs: GetDbParameterGroupInputRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_db_parameter_group(**kwargs)
  1. See GetDbParameterGroupInputRequestTypeDef

list_db_instances#

Returns a list of Timestream for InfluxDB DB instances.

Type annotations and code completion for boto3.client("timestream-influxdb").list_db_instances method. boto3 documentation

# list_db_instances method definition

def list_db_instances(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDbInstancesOutputTypeDef:  # (1)
    ...
  1. See ListDbInstancesOutputTypeDef 
# list_db_instances method usage example with argument unpacking

kwargs: ListDbInstancesInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_db_instances(**kwargs)
  1. See ListDbInstancesInputRequestTypeDef

list_db_parameter_groups#

Returns a list of Timestream for InfluxDB DB parameter groups.

Type annotations and code completion for boto3.client("timestream-influxdb").list_db_parameter_groups method. boto3 documentation

# list_db_parameter_groups method definition

def list_db_parameter_groups(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDbParameterGroupsOutputTypeDef:  # (1)
    ...
  1. See ListDbParameterGroupsOutputTypeDef 
# list_db_parameter_groups method usage example with argument unpacking

kwargs: ListDbParameterGroupsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_db_parameter_groups(**kwargs)
  1. See ListDbParameterGroupsInputRequestTypeDef

list_tags_for_resource#

A list of tags applied to the resource.

Type annotations and code completion for boto3.client("timestream-influxdb").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

tag_resource#

Tags are composed of a Key/Value pairs.

Type annotations and code completion for boto3.client("timestream-influxdb").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes the tag from the specified resource.

Type annotations and code completion for boto3.client("timestream-influxdb").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_db_instance#

Updates a Timestream for InfluxDB DB instance.

Type annotations and code completion for boto3.client("timestream-influxdb").update_db_instance method. boto3 documentation

# update_db_instance method definition

def update_db_instance(
    self,
    *,
    identifier: str,
    logDeliveryConfiguration: LogDeliveryConfigurationTypeDef = ...,  # (1)
    dbParameterGroupIdentifier: str = ...,
    port: int = ...,
    dbInstanceType: DbInstanceTypeType = ...,  # (2)
    deploymentType: DeploymentTypeType = ...,  # (3)
) -> UpdateDbInstanceOutputTypeDef:  # (4)
    ...
  1. See LogDeliveryConfigurationTypeDef
  2. See DbInstanceTypeType
  3. See DeploymentTypeType
  4. See UpdateDbInstanceOutputTypeDef 
# update_db_instance method usage example with argument unpacking

kwargs: UpdateDbInstanceInputRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_db_instance(**kwargs)
  1. See UpdateDbInstanceInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("timestream-influxdb").get_paginator method with overloads.