- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeDimensionCommand
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, DescribeDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DescribeDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DescribeDimensionRequest
name: "STRING_VALUE", // required
};
const command = new DescribeDimensionCommand(input);
const response = await client.send(command);
// { // DescribeDimensionResponse
// name: "STRING_VALUE",
// arn: "STRING_VALUE",
// type: "TOPIC_FILTER",
// stringValues: [ // DimensionStringValues
// "STRING_VALUE",
// ],
// creationDate: new Date("TIMESTAMP"),
// lastModifiedDate: new Date("TIMESTAMP"),
// };
DescribeDimensionCommand Input
See DescribeDimensionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
name Required | string | undefined | The unique identifier for the dimension. |
DescribeDimensionCommand Output
See DescribeDimensionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn | string | undefined | The Amazon Resource Name (ARN) for the dimension. |
creationDate | Date | undefined | The date the dimension was created. |
lastModifiedDate | Date | undefined | The date the dimension was last modified. |
name | string | undefined | The unique identifier for the dimension. |
stringValues | string[] | undefined | The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name. |
type | DimensionType | undefined | The type of the dimension. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalFailureException | server | An unexpected error has occurred. |
InvalidRequestException | client | The request is not valid. |
ResourceNotFoundException | client | The specified resource does not exist. |
ThrottlingException | client | The rate exceeds the limit. |
IoTServiceException | Base exception class for all service exceptions from IoT service. |