Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConfiguredTableAnalysisRule

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

Request Syntax


POST /configuredTables/configuredTableIdentifier/analysisRule HTTP/1.1
Content-type: application/json

{
   "analysisRulePolicy": { 
      "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" ]
         }
      }
   },
   "analysisRuleType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

configuredTableIdentifier

The identifier for the configured table to create the analysis rule for. 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 accepts the following data in JSON format.

analysisRulePolicy

The entire created configured table analysis rule object.

Type: ConfiguredTableAnalysisRulePolicy object

Required: Yes

analysisRuleType

The type of analysis rule. Valid values are AGGREGATION and LIST.

Type: String

Valid Values: AGGREGATION | LIST

Required: Yes

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 created analysis rule.

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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