GetConfiguredTableAnalysisRule
Retrieves a configured table analysis rule.
Request Syntax
GET /configuredTables/configuredTableIdentifier
/analysisRule/analysisRuleType
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- analysisRuleType
-
The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
Valid Values:
AGGREGATION | LIST
Required: Yes
- configuredTableIdentifier
-
The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
Length Constraints: Fixed length of 36.
Pattern:
.*[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}.*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"analysisRule": {
"configuredTableArn": "string",
"configuredTableId": "string",
"createTime": number,
"policy": {
"v1": {
"aggregation": {
"aggregateColumns": [
{
"columnNames": [ "string" ],
"function": "string"
}
],
"dimensionColumns": [ "string" ],
"joinColumns": [ "string" ],
"joinRequired": "string",
"outputConstraints": [
{
"columnName": "string",
"minimum": number,
"type": "string"
}
],
"scalarFunctions": [ "string" ]
},
"list": {
"joinColumns": [ "string" ],
"listColumns": [ "string" ]
}
}
},
"type": "string",
"updateTime": number
}
}
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.
- analysisRule
-
The entire analysis rule output.
Type: ConfiguredTableAnalysisRule object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Caller does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: