Jump to Content

Class GetDimensionKeyDetailsCommandProtected

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

Example

Use a bare-bones client and the command you need to make an API call.

import { PIClient, GetDimensionKeyDetailsCommand } from "@aws-sdk/client-pi"; // ES Modules import
// const { PIClient, GetDimensionKeyDetailsCommand } = require("@aws-sdk/client-pi"); // CommonJS import
const client = new PIClient(config);
const input = { // GetDimensionKeyDetailsRequest
ServiceType: "RDS" || "DOCDB", // required
Identifier: "STRING_VALUE", // required
Group: "STRING_VALUE", // required
GroupIdentifier: "STRING_VALUE", // required
RequestedDimensions: [ // RequestedDimensionList
"STRING_VALUE",
],
};
const command = new GetDimensionKeyDetailsCommand(input);
const response = await client.send(command);

Param

GetDimensionKeyDetailsCommandInput

Returns

GetDimensionKeyDetailsCommandOutput

See

Throws

InternalServiceError (server fault)

The request failed due to an unknown error.

Throws

InvalidArgumentException (client fault)

One of the arguments provided is invalid for this request.

Throws

NotAuthorizedException (client fault)

The user is not authorized to perform this request.

Hierarchy

Constructors

Properties

Methods