DescribeDimension
Provides details about a dimension that is defined in your AWS accounts.
Requires permission to access the DescribeDimension action.
Request Syntax
GET /dimensions/name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The unique identifier for the dimension.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDate": number,
"lastModifiedDate": number,
"name": "string",
"stringValues": [ "string" ],
"type": "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.
- arn
-
The Amazon Resource Name (ARN) for the dimension.
Type: String
- creationDate
-
The date the dimension was created.
Type: Timestamp
- lastModifiedDate
-
The date the dimension was last modified.
Type: Timestamp
- name
-
The unique identifier for the dimension.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+ - stringValues
-
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: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
- type
-
The type of the dimension.
Type: String
Valid Values:
TOPIC_FILTER
Errors
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
- message
-
The message for the exception.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
