BatchGetCollaborationAnalysisTemplate
Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
Request Syntax
POST /collaborations/collaborationIdentifier/batch-analysistemplates HTTP/1.1
Content-type: application/json
{
"analysisTemplateArns": [ "string" ]
}URI Request Parameters
The request uses the following URI parameters.
- collaborationIdentifier
-
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration 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.
- analysisTemplateArns
-
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 0. Maximum length of 200.
Pattern:
arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"collaborationAnalysisTemplates": [
{
"analysisParameters": [
{
"defaultValue": "string",
"name": "string",
"type": "string"
}
],
"arn": "string",
"collaborationArn": "string",
"collaborationId": "string",
"createTime": number,
"creatorAccountId": "string",
"description": "string",
"format": "string",
"id": "string",
"name": "string",
"schema": {
"referencedTables": [ "string" ]
},
"source": { ... },
"sourceMetadata": { ... },
"updateTime": number,
"validations": [
{
"reasons": [
{
"message": "string"
}
],
"status": "string",
"type": "string"
}
]
}
],
"errors": [
{
"arn": "string",
"code": "string",
"message": "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.
- collaborationAnalysisTemplates
-
The retrieved list of analysis templates within a collaboration.
Type: Array of CollaborationAnalysisTemplate objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- errors
-
Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
Type: Array of BatchGetCollaborationAnalysisTemplateError objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
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:
