ListMemberships
Returns the memberships that the calling principal can access.
Request Syntax
POST /v1/memberships HTTP/1.1
Content-type: application/json
{
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- maxResults
-
Request element for ListMemberships to limit the number of responses.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
- nextToken
-
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"accountId": "string",
"membershipArn": "string",
"membershipId": "string",
"membershipStatus": "string",
"region": "string"
}
],
"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.
- items
-
Request element for ListMemberships including the accountID, membershipARN, membershipID, membershipStatus, and region for each response.
Type: Array of ListMembershipItem objects
- nextToken
-
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ConflictException
-
HTTP Status Code: 409
- InternalServerException
-
HTTP Status Code: 500
- InvalidTokenException
-
HTTP Status Code: 423
- ResourceNotFoundException
-
HTTP Status Code: 404
- SecurityIncidentResponseNotActiveException
-
HTTP Status Code: 400
- ServiceQuotaExceededException
-
HTTP Status Code: 402
- ThrottlingException
-
HTTP Status Code: 429
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: