GetCollaboration
Returns metadata about a collaboration.
Request Syntax
GET /collaborations/collaborationIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- collaborationIdentifier
-
The identifier for the collaboration.
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
{
"collaboration": {
"analyticsEngine": "string",
"arn": "string",
"createTime": number,
"creatorAccountId": "string",
"creatorDisplayName": "string",
"dataEncryptionMetadata": {
"allowCleartext": boolean,
"allowDuplicates": boolean,
"allowJoinsOnColumnsWithDifferentNames": boolean,
"preserveNulls": boolean
},
"description": "string",
"id": "string",
"jobLogStatus": "string",
"membershipArn": "string",
"membershipId": "string",
"memberStatus": "string",
"name": "string",
"queryLogStatus": "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.
- collaboration
-
The entire collaboration for this identifier.
Type: Collaboration 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
- 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:
