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

ListCollaborations

Lists collaborations the caller owns, is active in, or has been invited to.

Request Syntax


GET /collaborations?maxResults=maxResults&memberStatus=memberStatus&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

Valid Range: Minimum value of 1. Maximum value of 100.

memberStatus

The caller's status in a collaboration.

Valid Values: INVITED | ACTIVE

nextToken

The token value retrieved from a previous call to access the next page of results.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "collaborationList": [ 
      { 
         "arn": "string",
         "createTime": number,
         "creatorAccountId": "string",
         "creatorDisplayName": "string",
         "id": "string",
         "membershipArn": "string",
         "membershipId": "string",
         "memberStatus": "string",
         "name": "string",
         "updateTime": number
      }
   ],
   "nextToken": "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.

collaborationList

The list of collaborations.

Type: Array of CollaborationSummary objects

nextToken

The token value retrieved from a previous call to access the next page of results.

Type: String

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

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