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

ListMemberAccounts

Returns a list of member accounts associated with a notification configuration.

Request Syntax


GET /list-member-accounts?maxResults=maxResults&memberAccount=memberAccount&nextToken=nextToken&notificationConfigurationArn=notificationConfigurationArn&organizationalUnitId=organizationalUnitId&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in a single call. Valid values are 1-100.

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

memberAccount

The member account identifier used to filter the results.

Pattern: \d{12}

nextToken

The token for the next page of results. Use the value returned in the previous response.

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w+-/=]+

notificationConfigurationArn

The Amazon Resource Name (ARN) of the notification configuration used to filter the member accounts.

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}

Required: Yes

organizationalUnitId

The organizational unit ID used to filter the member accounts.

Pattern: (Root|r-[0-9a-z]{4,32}|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})

status

The status used to filter the member accounts.

Valid Values: ACTIVE | PENDING | INACTIVE | CREATING | DELETING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "memberAccounts": [ 
      { 
         "accountId": "string",
         "notificationConfigurationArn": "string",
         "organizationalUnitId": "string",
         "status": "string",
         "statusReason": "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.

memberAccounts

The list of member accounts that match the specified criteria.

Type: Array of MemberAccount objects

nextToken

The token to use for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w+-/=]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User 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.

resourceId: The ID of the resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service being throttled.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

fieldList: The list of input fields that are invalid.
reason: The reason why your input is considered invalid.

HTTP Status Code: 400