TimestreamInfluxDB / Client / get_db_parameter_group

get_db_parameter_group#

TimestreamInfluxDB.Client.get_db_parameter_group(**kwargs)#

Returns a Timestream for InfluxDB DB parameter group.

See also: AWS API Documentation

Request Syntax

response = client.get_db_parameter_group(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The id of the DB parameter group.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'description': 'string',
    'parameters': {
        'InfluxDBv2': {
            'fluxLogEnabled': True|False,
            'logLevel': 'debug'|'info'|'error',
            'noTasks': True|False,
            'queryConcurrency': 123,
            'queryQueueSize': 123,
            'tracingType': 'log'|'jaeger',
            'metricsDisabled': True|False
        }
    }
}

Response Structure

  • (dict) –

    • id (string) –

      A service-generated unique identifier.

    • name (string) –

      The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

    • arn (string) –

      The Amazon Resource Name (ARN) of the DB parameter group.

    • description (string) –

      A description of the DB parameter group.

    • parameters (dict) –

      The parameters that comprise the DB parameter group.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: InfluxDBv2. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • InfluxDBv2 (dict) –

        All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

        • fluxLogEnabled (boolean) –

          Include option to show detailed logs for Flux queries.

          Default: false

        • logLevel (string) –

          Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

          Default: info

        • noTasks (boolean) –

          Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

          Default: false

        • queryConcurrency (integer) –

          Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

          Default: 0

        • queryQueueSize (integer) –

          Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

          Default: 0

        • tracingType (string) –

          Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

        • metricsDisabled (boolean) –

          Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

          Default: false

Exceptions