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

CreateAnalysisTemplate

Creates a new analysis template.

Request Syntax


POST /memberships/membershipIdentifier/analysistemplates HTTP/1.1
Content-type: application/json

{
   "analysisParameters": [ 
      { 
         "defaultValue": "string",
         "name": "string",
         "type": "string"
      }
   ],
   "description": "string",
   "format": "string",
   "name": "string",
   "source": { ... },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The identifier for a membership resource.

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.

analysisParameters

The parameters of the analysis template.

Type: Array of AnalysisParameter objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

description

The description of the analysis template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

format

The format of the analysis template.

Type: String

Valid Values: SQL

Required: Yes

name

The name of the analysis template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?

Required: Yes

source

The information in the analysis template. Currently supports text, the query text for the analysis template.

Type: AnalysisSource object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

tags

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "analysisTemplate": { 
      "analysisParameters": [ 
         { 
            "defaultValue": "string",
            "name": "string",
            "type": "string"
         }
      ],
      "arn": "string",
      "collaborationArn": "string",
      "collaborationId": "string",
      "createTime": number,
      "description": "string",
      "format": "string",
      "id": "string",
      "membershipArn": "string",
      "membershipId": "string",
      "name": "string",
      "schema": { 
         "referencedTables": [ "string" ]
      },
      "source": { ... },
      "updateTime": number,
      "validations": [ 
         { 
            "reasons": [ 
               { 
                  "message": "string"
               }
            ],
            "status": "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.

analysisTemplate

The analysis template.

Type: AnalysisTemplate 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

ServiceQuotaExceededException

Request denied because service quota has been exceeded.

HTTP Status Code: 402

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