# Actions The following actions are supported: + [CreateDbCluster](API_CreateDbCluster.md) + [CreateDbInstance](API_CreateDbInstance.md) + [CreateDbParameterGroup](API_CreateDbParameterGroup.md) + [DeleteDbCluster](API_DeleteDbCluster.md) + [DeleteDbInstance](API_DeleteDbInstance.md) + [GetDbCluster](API_GetDbCluster.md) + [GetDbInstance](API_GetDbInstance.md) + [GetDbParameterGroup](API_GetDbParameterGroup.md) + [ListDbClusters](API_ListDbClusters.md) + [ListDbInstances](API_ListDbInstances.md) + [ListDbInstancesForCluster](API_ListDbInstancesForCluster.md) + [ListDbParameterGroups](API_ListDbParameterGroups.md) + [ListTagsForResource](API_ListTagsForResource.md) + [RebootDbCluster](API_RebootDbCluster.md) + [RebootDbInstance](API_RebootDbInstance.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDbCluster](API_UpdateDbCluster.md) + [UpdateDbInstance](API_UpdateDbInstance.md) # CreateDbCluster Creates a new Timestream for InfluxDB cluster. ## Request Syntax ``` { "allocatedStorage": number, "bucket": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "failoverMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "organization": "string", "password": "string", "port": number, "publiclyAccessible": boolean, "tags": { "string" : "string" }, "username": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [allocatedStorage](#API_CreateDbCluster_RequestSyntax) ** The amount of storage to allocate for your DB storage type in GiB (gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No ** [bucket](#API_CreateDbCluster_RequestSyntax) ** The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization. Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: `[^_"][^"]*` Required: No ** [dbInstanceType](#API_CreateDbCluster_RequestSyntax) ** The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` Required: Yes ** [dbParameterGroupIdentifier](#API_CreateDbCluster_RequestSyntax) ** The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [dbStorageType](#API_CreateDbCluster_RequestSyntax) ** The Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements: + Influx I/O Included 3000 IOPS + Influx I/O Included 12000 IOPS + Influx I/O Included 16000 IOPS Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` Required: No ** [deploymentType](#API_CreateDbCluster_RequestSyntax) ** Specifies the type of cluster to create. Type: String Valid Values: `MULTI_NODE_READ_REPLICAS` Required: No ** [failoverMode](#API_CreateDbCluster_RequestSyntax) ** Specifies the behavior of failure recovery when the primary node of the cluster fails. Type: String Valid Values: `AUTOMATIC | NO_FAILOVER` Required: No ** [logDeliveryConfiguration](#API_CreateDbCluster_RequestSyntax) ** Configuration for sending InfluxDB engine logs to a specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object Required: No ** [name](#API_CreateDbCluster_RequestSyntax) ** The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` Required: Yes ** [networkType](#API_CreateDbCluster_RequestSyntax) ** Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` Required: No ** [organization](#API_CreateDbCluster_RequestSyntax) ** The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [password](#API_CreateDbCluster_RequestSyntax) ** The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in AWS Secrets Manager in your account. Type: String Length Constraints: Minimum length of 8. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [port](#API_CreateDbCluster_RequestSyntax) ** The port number on which InfluxDB accepts connections. Valid Values: 1024-65535 Default: 8086 for InfluxDB v2, 8181 for InfluxDB v3 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No ** [publiclyAccessible](#API_CreateDbCluster_RequestSyntax) ** Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC. Type: Boolean Required: No ** [tags](#API_CreateDbCluster_RequestSyntax) ** A list of key-value pairs to associate with the DB instance. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [username](#API_CreateDbCluster_RequestSyntax) ** The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in AWS Secrets Manager in your account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [vpcSecurityGroupIds](#API_CreateDbCluster_RequestSyntax) ** A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` Required: Yes ** [vpcSubnetIds](#API_CreateDbCluster_RequestSyntax) ** A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` Required: Yes ## Response Syntax ``` { "dbClusterId": "string", "dbClusterStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dbClusterId](#API_CreateDbCluster_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbClusterStatus](#API_CreateDbCluster_ResponseSyntax) ** The status of the DB cluster. Type: String Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ServiceQuotaExceededException ** The request exceeds the service quota. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/CreateDbCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/CreateDbCluster) # CreateDbInstance Creates a new Timestream for InfluxDB DB instance. ## Request Syntax ``` { "allocatedStorage": number, "bucket": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "organization": "string", "password": "string", "port": number, "publiclyAccessible": boolean, "tags": { "string" : "string" }, "username": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [allocatedStorage](#API_CreateDbInstance_RequestSyntax) ** The amount of storage to allocate for your DB storage type in GiB (gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: Yes ** [bucket](#API_CreateDbInstance_RequestSyntax) ** The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization. Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: `[^_"][^"]*` Required: No ** [dbInstanceType](#API_CreateDbInstance_RequestSyntax) ** The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` Required: Yes ** [dbParameterGroupIdentifier](#API_CreateDbInstance_RequestSyntax) ** The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [dbStorageType](#API_CreateDbInstance_RequestSyntax) ** The Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: + Influx IO Included 3000 IOPS + Influx IO Included 12000 IOPS + Influx IO Included 16000 IOPS Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` Required: No ** [deploymentType](#API_CreateDbInstance_RequestSyntax) ** Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` Required: No ** [logDeliveryConfiguration](#API_CreateDbInstance_RequestSyntax) ** Configuration for sending InfluxDB engine logs to a specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object Required: No ** [name](#API_CreateDbInstance_RequestSyntax) ** The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` Required: Yes ** [networkType](#API_CreateDbInstance_RequestSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` Required: No ** [organization](#API_CreateDbInstance_RequestSyntax) ** The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [password](#API_CreateDbInstance_RequestSyntax) ** The password of the initial admin user created in InfluxDB v2. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS Secrets Manager in your account. Type: String Length Constraints: Minimum length of 8. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [port](#API_CreateDbInstance_RequestSyntax) ** The port number on which InfluxDB accepts connections. Valid Values: 1024-65535 Default: 8086 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No ** [publiclyAccessible](#API_CreateDbInstance_RequestSyntax) ** Configures the DB instance with a public IP to facilitate access. Type: Boolean Required: No ** [tags](#API_CreateDbInstance_RequestSyntax) ** A list of key-value pairs to associate with the DB instance. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [username](#API_CreateDbInstance_RequestSyntax) ** The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [vpcSecurityGroupIds](#API_CreateDbInstance_RequestSyntax) ** A list of VPC security group IDs to associate with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` Required: Yes ** [vpcSubnetIds](#API_CreateDbInstance_RequestSyntax) ** A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` Required: Yes ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "instanceModes": [ "string" ], "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_CreateDbInstance_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_CreateDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [availabilityZone](#API_CreateDbInstance_ResponseSyntax) ** The Availability Zone in which the DB instance resides. Type: String ** [dbClusterId](#API_CreateDbInstance_ResponseSyntax) ** Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbInstanceType](#API_CreateDbInstance_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_CreateDbInstance_ResponseSyntax) ** The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_CreateDbInstance_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_CreateDbInstance_ResponseSyntax) ** Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` ** [endpoint](#API_CreateDbInstance_ResponseSyntax) ** The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String ** [id](#API_CreateDbInstance_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_CreateDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [instanceMode](#API_CreateDbInstance_ResponseSyntax) ** Specifies the DbInstance's role in the cluster. Type: String Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [instanceModes](#API_CreateDbInstance_ResponseSyntax) ** Specifies the DbInstance's roles in the cluster. Type: Array of strings Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [logDeliveryConfiguration](#API_CreateDbInstance_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_CreateDbInstance_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_CreateDbInstance_ResponseSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_CreateDbInstance_ResponseSyntax) ** The port number on which InfluxDB accepts connections. The default value is 8086. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_CreateDbInstance_ResponseSyntax) ** Indicates if the DB instance has a public IP to facilitate access. Type: Boolean ** [secondaryAvailabilityZone](#API_CreateDbInstance_ResponseSyntax) ** The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String ** [status](#API_CreateDbInstance_ResponseSyntax) ** The status of the DB instance. Type: String Valid Values: `CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE | MAINTENANCE | REBOOTING | REBOOT_FAILED` ** [vpcSecurityGroupIds](#API_CreateDbInstance_ResponseSyntax) ** A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_CreateDbInstance_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ServiceQuotaExceededException ** The request exceeds the service quota. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/CreateDbInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/CreateDbInstance) # CreateDbParameterGroup Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances. ## Request Syntax ``` { "description": "string", "name": "string", "parameters": { ... }, "tags": { "string" : "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [description](#API_CreateDbParameterGroup_RequestSyntax) ** A description of the DB parameter group. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ** [name](#API_CreateDbParameterGroup_RequestSyntax) ** The name of the DB parameter group. The name must be unique per customer and per region. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` Required: Yes ** [parameters](#API_CreateDbParameterGroup_RequestSyntax) ** A list of the parameters that comprise the DB parameter group. Type: [Parameters](API_Parameters.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [tags](#API_CreateDbParameterGroup_RequestSyntax) ** A list of key-value pairs to associate with the DB parameter group. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` { "arn": "string", "description": "string", "id": "string", "name": "string", "parameters": { ... } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [arn](#API_CreateDbParameterGroup_ResponseSyntax) ** The Amazon Resource Name (ARM) of the DB parameter group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [description](#API_CreateDbParameterGroup_ResponseSyntax) ** The description of the DB parameter group. Type: String ** [id](#API_CreateDbParameterGroup_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [name](#API_CreateDbParameterGroup_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [parameters](#API_CreateDbParameterGroup_ResponseSyntax) ** A list of the parameters that comprise the DB parameter group. Type: [Parameters](API_Parameters.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ServiceQuotaExceededException ** The request exceeds the service quota. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/CreateDbParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/CreateDbParameterGroup) # DeleteDbCluster Deletes a Timestream for InfluxDB cluster. ## Request Syntax ``` { "dbClusterId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [dbClusterId](#API_DeleteDbCluster_RequestSyntax) ** Service-generated unique identifier of the DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "dbClusterStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dbClusterStatus](#API_DeleteDbCluster_ResponseSyntax) ** The status of the DB cluster. Type: String Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/DeleteDbCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/DeleteDbCluster) # DeleteDbInstance Deletes a Timestream for InfluxDB DB instance. ## Request Syntax ``` { "identifier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [identifier](#API_DeleteDbInstance_RequestSyntax) ** The id of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "instanceModes": [ "string" ], "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_DeleteDbInstance_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_DeleteDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [availabilityZone](#API_DeleteDbInstance_ResponseSyntax) ** The Availability Zone in which the DB instance resides. Type: String ** [dbClusterId](#API_DeleteDbInstance_ResponseSyntax) ** Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbInstanceType](#API_DeleteDbInstance_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_DeleteDbInstance_ResponseSyntax) ** The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_DeleteDbInstance_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_DeleteDbInstance_ResponseSyntax) ** Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` ** [endpoint](#API_DeleteDbInstance_ResponseSyntax) ** The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String ** [id](#API_DeleteDbInstance_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_DeleteDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [instanceMode](#API_DeleteDbInstance_ResponseSyntax) ** Specifies the DbInstance's role in the cluster. Type: String Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [instanceModes](#API_DeleteDbInstance_ResponseSyntax) ** Specifies the DbInstance's roles in the cluster. Type: Array of strings Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [logDeliveryConfiguration](#API_DeleteDbInstance_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_DeleteDbInstance_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_DeleteDbInstance_ResponseSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_DeleteDbInstance_ResponseSyntax) ** The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_DeleteDbInstance_ResponseSyntax) ** Indicates if the DB instance has a public IP to facilitate access. Type: Boolean ** [secondaryAvailabilityZone](#API_DeleteDbInstance_ResponseSyntax) ** The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String ** [status](#API_DeleteDbInstance_ResponseSyntax) ** The status of the DB instance. Type: String Valid Values: `CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE | MAINTENANCE | REBOOTING | REBOOT_FAILED` ** [vpcSecurityGroupIds](#API_DeleteDbInstance_ResponseSyntax) ** A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_DeleteDbInstance_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/DeleteDbInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/DeleteDbInstance) # GetDbCluster Retrieves information about a Timestream for InfluxDB cluster. ## Request Syntax ``` { "dbClusterId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [dbClusterId](#API_GetDbCluster_RequestSyntax) ** Service-generated unique identifier of the DB cluster to retrieve. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "engineType": "string", "failoverMode": "string", "id": "string", "influxAuthParametersSecretArn": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "readerEndpoint": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_GetDbCluster_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_GetDbCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [dbInstanceType](#API_GetDbCluster_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_GetDbCluster_ResponseSyntax) ** The ID of the DB parameter group assigned to your DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_GetDbCluster_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_GetDbCluster_ResponseSyntax) ** Deployment type of the DB cluster. Type: String Valid Values: `MULTI_NODE_READ_REPLICAS` ** [endpoint](#API_GetDbCluster_ResponseSyntax) ** The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations. Type: String ** [engineType](#API_GetDbCluster_ResponseSyntax) ** The engine type of your DB cluster. Type: String Valid Values: `INFLUXDB_V2 | INFLUXDB_V3_CORE | INFLUXDB_V3_ENTERPRISE` ** [failoverMode](#API_GetDbCluster_ResponseSyntax) ** The configured failover mode for the DB cluster. Type: String Valid Values: `AUTOMATIC | NO_FAILOVER` ** [id](#API_GetDbCluster_ResponseSyntax) ** Service-generated unique identifier of the DB cluster to retrieve. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_GetDbCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [logDeliveryConfiguration](#API_GetDbCluster_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_GetDbCluster_ResponseSyntax) ** Customer-supplied name of the Timestream for InfluxDB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_GetDbCluster_ResponseSyntax) ** Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_GetDbCluster_ResponseSyntax) ** The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_GetDbCluster_ResponseSyntax) ** Indicates if the DB cluster has a public IP to facilitate access from outside the VPC. Type: Boolean ** [readerEndpoint](#API_GetDbCluster_ResponseSyntax) ** The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. Type: String ** [status](#API_GetDbCluster_ResponseSyntax) ** The status of the DB cluster. Type: String Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` ** [vpcSecurityGroupIds](#API_GetDbCluster_ResponseSyntax) ** A list of VPC security group IDs associated with the DB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_GetDbCluster_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/GetDbCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/GetDbCluster) # GetDbInstance Returns a Timestream for InfluxDB DB instance. ## Request Syntax ``` { "identifier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [identifier](#API_GetDbInstance_RequestSyntax) ** The id of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "instanceModes": [ "string" ], "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_GetDbInstance_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_GetDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [availabilityZone](#API_GetDbInstance_ResponseSyntax) ** The Availability Zone in which the DB instance resides. Type: String ** [dbClusterId](#API_GetDbInstance_ResponseSyntax) ** Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbInstanceType](#API_GetDbInstance_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_GetDbInstance_ResponseSyntax) ** The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_GetDbInstance_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_GetDbInstance_ResponseSyntax) ** Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` ** [endpoint](#API_GetDbInstance_ResponseSyntax) ** The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String ** [id](#API_GetDbInstance_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_GetDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [instanceMode](#API_GetDbInstance_ResponseSyntax) ** Specifies the DbInstance's role in the cluster. Type: String Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [instanceModes](#API_GetDbInstance_ResponseSyntax) ** Specifies the DbInstance's roles in the cluster. Type: Array of strings Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [logDeliveryConfiguration](#API_GetDbInstance_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_GetDbInstance_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_GetDbInstance_ResponseSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_GetDbInstance_ResponseSyntax) ** The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_GetDbInstance_ResponseSyntax) ** Indicates if the DB instance has a public IP to facilitate access. Type: Boolean ** [secondaryAvailabilityZone](#API_GetDbInstance_ResponseSyntax) ** The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String ** [status](#API_GetDbInstance_ResponseSyntax) ** The status of the DB instance. Type: String Valid Values: `CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE | MAINTENANCE | REBOOTING | REBOOT_FAILED` ** [vpcSecurityGroupIds](#API_GetDbInstance_ResponseSyntax) ** A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_GetDbInstance_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/GetDbInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/GetDbInstance) # GetDbParameterGroup Returns a Timestream for InfluxDB DB parameter group. ## Request Syntax ``` { "identifier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [identifier](#API_GetDbParameterGroup_RequestSyntax) ** The id of the DB parameter group. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "arn": "string", "description": "string", "id": "string", "name": "string", "parameters": { ... } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [arn](#API_GetDbParameterGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB parameter group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [description](#API_GetDbParameterGroup_ResponseSyntax) ** A description of the DB parameter group. Type: String ** [id](#API_GetDbParameterGroup_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [name](#API_GetDbParameterGroup_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [parameters](#API_GetDbParameterGroup_ResponseSyntax) ** The parameters that comprise the DB parameter group. Type: [Parameters](API_Parameters.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/GetDbParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/GetDbParameterGroup) # ListDbClusters Returns a list of Timestream for InfluxDB DB clusters. ## Request Syntax ``` { "maxResults": number, "nextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_ListDbClusters_RequestSyntax) ** The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [nextToken](#API_ListDbClusters_RequestSyntax) ** The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ## Response Syntax ``` { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "engineType": "string", "id": "string", "name": "string", "networkType": "string", "port": number, "readerEndpoint": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [items](#API_ListDbClusters_ResponseSyntax) ** A list of Timestream for InfluxDB cluster summaries. Type: Array of [DbClusterSummary](API_DbClusterSummary.md) objects ** [nextToken](#API_ListDbClusters_ResponseSyntax) ** Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/ListDbClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/ListDbClusters) # ListDbInstances Returns a list of Timestream for InfluxDB DB instances. ## Request Syntax ``` { "maxResults": number, "nextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_ListDbInstances_RequestSyntax) ** The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [nextToken](#API_ListDbInstances_RequestSyntax) ** The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ## Response Syntax ``` { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "name": "string", "networkType": "string", "port": number, "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [items](#API_ListDbInstances_ResponseSyntax) ** A list of Timestream for InfluxDB DB instance summaries. Type: Array of [DbInstanceSummary](API_DbInstanceSummary.md) objects ** [nextToken](#API_ListDbInstances_ResponseSyntax) ** Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/ListDbInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/ListDbInstances) # ListDbInstancesForCluster Returns a list of Timestream for InfluxDB clusters. ## Request Syntax ``` { "dbClusterId": "string", "maxResults": number, "nextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [dbClusterId](#API_ListDbInstancesForCluster_RequestSyntax) ** Service-generated unique identifier of the DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [maxResults](#API_ListDbInstancesForCluster_RequestSyntax) ** The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [nextToken](#API_ListDbInstancesForCluster_RequestSyntax) ** The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ## Response Syntax ``` { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "instanceMode": "string", "instanceModes": [ "string" ], "name": "string", "networkType": "string", "port": number, "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [items](#API_ListDbInstancesForCluster_ResponseSyntax) ** A list of Timestream for InfluxDB instance summaries belonging to the cluster. Type: Array of [DbInstanceForClusterSummary](API_DbInstanceForClusterSummary.md) objects ** [nextToken](#API_ListDbInstancesForCluster_ResponseSyntax) ** Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/ListDbInstancesForCluster) # ListDbParameterGroups Returns a list of Timestream for InfluxDB DB parameter groups. ## Request Syntax ``` { "maxResults": number, "nextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_ListDbParameterGroups_RequestSyntax) ** The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [nextToken](#API_ListDbParameterGroups_RequestSyntax) ** The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ## Response Syntax ``` { "items": [ { "arn": "string", "description": "string", "id": "string", "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [items](#API_ListDbParameterGroups_ResponseSyntax) ** A list of Timestream for InfluxDB DB parameter group summaries. Type: Array of [DbParameterGroupSummary](API_DbParameterGroupSummary.md) objects ** [nextToken](#API_ListDbParameterGroups_ResponseSyntax) ** Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/ListDbParameterGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/ListDbParameterGroups) # ListTagsForResource A list of tags applied to the resource. ## Request Syntax ``` { "resourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` Required: Yes ## Response Syntax ``` { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** A list of tags used to categorize and track resources. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/ListTagsForResource) # RebootDbCluster Reboots a Timestream for InfluxDB cluster. ## Request Syntax ``` { "dbClusterId": "string", "instanceIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [dbClusterId](#API_RebootDbCluster_RequestSyntax) ** Service-generated unique identifier of the DB cluster to reboot. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [instanceIds](#API_RebootDbCluster_RequestSyntax) ** A list of service-generated unique DB Instance Ids belonging to the DB Cluster to reboot. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ## Response Syntax ``` { "dbClusterStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dbClusterStatus](#API_RebootDbCluster_ResponseSyntax) ** The status of the DB Cluster. Type: String Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/RebootDbCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/RebootDbCluster) # RebootDbInstance Reboots a Timestream for InfluxDB instance. ## Request Syntax ``` { "identifier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [identifier](#API_RebootDbInstance_RequestSyntax) ** The id of the DB instance to reboot. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "instanceModes": [ "string" ], "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_RebootDbInstance_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_RebootDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [availabilityZone](#API_RebootDbInstance_ResponseSyntax) ** The Availability Zone in which the DB instance resides. Type: String ** [dbClusterId](#API_RebootDbInstance_ResponseSyntax) ** Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbInstanceType](#API_RebootDbInstance_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_RebootDbInstance_ResponseSyntax) ** The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_RebootDbInstance_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_RebootDbInstance_ResponseSyntax) ** Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` ** [endpoint](#API_RebootDbInstance_ResponseSyntax) ** The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String ** [id](#API_RebootDbInstance_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_RebootDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [instanceMode](#API_RebootDbInstance_ResponseSyntax) ** Specifies the DbInstance's role in the cluster. Type: String Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [instanceModes](#API_RebootDbInstance_ResponseSyntax) ** Specifies the DbInstance's roles in the cluster. Type: Array of strings Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [logDeliveryConfiguration](#API_RebootDbInstance_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_RebootDbInstance_ResponseSyntax) ** The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_RebootDbInstance_ResponseSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_RebootDbInstance_ResponseSyntax) ** The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_RebootDbInstance_ResponseSyntax) ** Indicates if the DB instance has a public IP to facilitate access. Type: Boolean ** [secondaryAvailabilityZone](#API_RebootDbInstance_ResponseSyntax) ** The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String ** [status](#API_RebootDbInstance_ResponseSyntax) ** The status of the DB instance. Type: String Valid Values: `CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE | MAINTENANCE | REBOOTING | REBOOT_FAILED` ** [vpcSecurityGroupIds](#API_RebootDbInstance_ResponseSyntax) ** A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_RebootDbInstance_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/RebootDbInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/RebootDbInstance) # TagResource Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources. ## Request Syntax ``` { "resourceArn": "string", "tags": { "string" : "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` Required: Yes ** [tags](#API_TagResource_RequestSyntax) ** A list of tags used to categorize and track resources. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ServiceQuotaExceededException ** The request exceeds the service quota. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/TagResource) # UntagResource Removes the tag from the specified resource. ## Request Syntax ``` { "resourceArn": "string", "tagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** The keys used to identify the tags. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/UntagResource) # UpdateDbCluster Updates a Timestream for InfluxDB cluster. ## Request Syntax ``` { "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "failoverMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "port": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [dbClusterId](#API_UpdateDbCluster_RequestSyntax) ** Service-generated unique identifier of the DB cluster to update. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [dbInstanceType](#API_UpdateDbCluster_RequestSyntax) ** Update the DB cluster to use the specified DB instance Type. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` Required: No ** [dbParameterGroupIdentifier](#API_UpdateDbCluster_RequestSyntax) ** Update the DB cluster to use the specified DB parameter group. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [failoverMode](#API_UpdateDbCluster_RequestSyntax) ** Update the DB cluster's failover behavior. Type: String Valid Values: `AUTOMATIC | NO_FAILOVER` Required: No ** [logDeliveryConfiguration](#API_UpdateDbCluster_RequestSyntax) ** The log delivery configuration to apply to the DB cluster. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object Required: No ** [port](#API_UpdateDbCluster_RequestSyntax) ** Update the DB cluster to use the specified port. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No ## Response Syntax ``` { "dbClusterStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dbClusterStatus](#API_UpdateDbCluster_ResponseSyntax) ** The status of the DB cluster. Type: String Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/UpdateDbCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/UpdateDbCluster) # UpdateDbInstance Updates a Timestream for InfluxDB DB instance. ## Request Syntax ``` { "allocatedStorage": number, "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "identifier": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "port": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [allocatedStorage](#API_UpdateDbInstance_RequestSyntax) ** The amount of storage to allocate for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No ** [dbInstanceType](#API_UpdateDbInstance_RequestSyntax) ** The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` Required: No ** [dbParameterGroupIdentifier](#API_UpdateDbInstance_RequestSyntax) ** The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: No ** [dbStorageType](#API_UpdateDbInstance_RequestSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` Required: No ** [deploymentType](#API_UpdateDbInstance_RequestSyntax) ** Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` Required: No ** [identifier](#API_UpdateDbInstance_RequestSyntax) ** The id of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [logDeliveryConfiguration](#API_UpdateDbInstance_RequestSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object Required: No ** [port](#API_UpdateDbInstance_RequestSyntax) ** The port number on which InfluxDB accepts connections. If you change the Port value, your database restarts immediately. Valid Values: 1024-65535 Default: 8086 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No ## Response Syntax ``` { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "instanceModes": [ "string" ], "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [allocatedStorage](#API_UpdateDbInstance_ResponseSyntax) ** The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. ** [arn](#API_UpdateDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}` ** [availabilityZone](#API_UpdateDbInstance_ResponseSyntax) ** The Availability Zone in which the DB instance resides. Type: String ** [dbClusterId](#API_UpdateDbInstance_ResponseSyntax) ** Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbInstanceType](#API_UpdateDbInstance_ResponseSyntax) ** The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid Values: `db.influx.medium | db.influx.large | db.influx.xlarge | db.influx.2xlarge | db.influx.4xlarge | db.influx.8xlarge | db.influx.12xlarge | db.influx.16xlarge | db.influx.24xlarge` ** [dbParameterGroupIdentifier](#API_UpdateDbInstance_ResponseSyntax) ** The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [dbStorageType](#API_UpdateDbInstance_ResponseSyntax) ** The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3` ** [deploymentType](#API_UpdateDbInstance_ResponseSyntax) ** Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: `SINGLE_AZ | WITH_MULTIAZ_STANDBY` ** [endpoint](#API_UpdateDbInstance_ResponseSyntax) ** The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String ** [id](#API_UpdateDbInstance_ResponseSyntax) ** A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: `[a-zA-Z0-9]+` ** [influxAuthParametersSecretArn](#API_UpdateDbInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. Type: String ** [instanceMode](#API_UpdateDbInstance_ResponseSyntax) ** Specifies the DbInstance's role in the cluster. Type: String Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [instanceModes](#API_UpdateDbInstance_ResponseSyntax) ** Specifies the DbInstance's roles in the cluster. Type: Array of strings Valid Values: `PRIMARY | STANDBY | REPLICA | INGEST | QUERY | COMPACT | PROCESS` ** [logDeliveryConfiguration](#API_UpdateDbInstance_ResponseSyntax) ** Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object ** [name](#API_UpdateDbInstance_ResponseSyntax) ** This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: `[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*` ** [networkType](#API_UpdateDbInstance_ResponseSyntax) ** Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. Type: String Valid Values: `IPV4 | DUAL` ** [port](#API_UpdateDbInstance_ResponseSyntax) ** The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. ** [publiclyAccessible](#API_UpdateDbInstance_ResponseSyntax) ** Indicates if the DB instance has a public IP to facilitate access. Type: Boolean ** [secondaryAvailabilityZone](#API_UpdateDbInstance_ResponseSyntax) ** The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String ** [status](#API_UpdateDbInstance_ResponseSyntax) ** The status of the DB instance. Type: String Valid Values: `CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE | MAINTENANCE | REBOOTING | REBOOT_FAILED` ** [vpcSecurityGroupIds](#API_UpdateDbInstance_ResponseSyntax) ** A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `sg-[a-z0-9]+` ** [vpcSubnetIds](#API_UpdateDbInstance_ResponseSyntax) ** A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `subnet-[a-z0-9]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 400 ** ConflictException ** The request conflicts with an existing resource in Timestream for InfluxDB. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** The requested resource was not found or does not exist. ** resourceId ** The identifier for the Timestream for InfluxDB resource associated with the request. ** resourceType ** The type of Timestream for InfluxDB resource associated with the request. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. ** retryAfterSeconds ** The number of seconds the caller should wait before retrying. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints specified by Timestream for InfluxDB. ** reason ** The reason that validation failed. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/UpdateDbInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/UpdateDbInstance)