UserNotifications / Client / list_member_accounts

list_member_accounts

UserNotifications.Client.list_member_accounts(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_member_accounts(
    notificationConfigurationArn='string',
    maxResults=123,
    nextToken='string',
    memberAccount='string',
    status='ACTIVE'|'PENDING'|'INACTIVE'|'CREATING'|'DELETING',
    organizationalUnitId='string'
)
Parameters:

  • notificationConfigurationArn (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return in a single call. Valid values are 1-100.

  • nextToken (string) – The token for the next page of results. Use the value returned in the previous response.

  • memberAccount (string) – The member account identifier used to filter the results.

  • status (string) – The status used to filter the member accounts.

  • organizationalUnitId (string) – The organizational unit ID used to filter the member accounts.

Return type:

dict

Returns:

Response Syntax

{
    'memberAccounts': [
        {
            'notificationConfigurationArn': 'string',
            'accountId': 'string',
            'status': 'ACTIVE'|'PENDING'|'INACTIVE'|'CREATING'|'DELETING',
            'statusReason': 'string',
            'organizationalUnitId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • memberAccounts (list) –

      The list of member accounts that match the specified criteria.

      • (dict) –

        Contains information about a member account.

        • notificationConfigurationArn (string) –

          The Amazon Resource Name (ARN) of the notification configuration associated with the member account.

        • accountId (string) –

          The AWS account ID of the member account.

        • status (string) –

          The current status of the member account.

        • statusReason (string) –

          The reason for the current status of the member account.

        • organizationalUnitId (string) –

          The unique identifier of the organizational unit containing the member account.

    • nextToken (string) –

      The token to use for the next page of results.

Exceptions

  • UserNotifications.Client.exceptions.AccessDeniedException

  • UserNotifications.Client.exceptions.ValidationException

  • UserNotifications.Client.exceptions.InternalServerException

  • UserNotifications.Client.exceptions.ThrottlingException

  • UserNotifications.Client.exceptions.ResourceNotFoundException