ListMemberships
Lists all memberships resources within the caller's account.
Request Syntax
GET /memberships?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The pagination token that's used to fetch the next set of results.
Length Constraints: Minimum length of 0. Maximum length of 10240.
- status
-
A filter which will return only memberships in the specified status.
Valid Values:
ACTIVE | REMOVED | COLLABORATION_DELETED
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"membershipSummaries": [
{
"arn": "string",
"collaborationArn": "string",
"collaborationCreatorAccountId": "string",
"collaborationCreatorDisplayName": "string",
"collaborationId": "string",
"collaborationName": "string",
"createTime": number,
"id": "string",
"memberAbilities": [ "string" ],
"mlMemberAbilities": {
"customMLMemberAbilities": [ "string" ]
},
"paymentConfiguration": {
"machineLearning": {
"modelInference": {
"isResponsible": boolean
},
"modelTraining": {
"isResponsible": boolean
}
},
"queryCompute": {
"isResponsible": boolean
}
},
"status": "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.
- membershipSummaries
-
The list of memberships returned from the ListMemberships operation.
Type: Array of MembershipSummary objects
- nextToken
-
The pagination token that's used to fetch the next set 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
