Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

The request accepts the following data in JSON format.

identifier

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

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

A description of the DB parameter group.

Type: String

id

A service-generated unique identifier.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-zA-Z0-9]+

name

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

The parameters that comprise the DB parameter group.

Type: Parameters 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 Errors.

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