UserNotifications / Paginator / ListMemberAccounts

ListMemberAccounts

class UserNotifications.Paginator.ListMemberAccounts
paginator = client.get_paginator('list_member_accounts')
paginate(**kwargs)

Creates an iterator that will paginate through responses from UserNotifications.Client.list_member_accounts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    notificationConfigurationArn='string',
    memberAccount='string',
    status='ACTIVE'|'PENDING'|'INACTIVE'|'CREATING'|'DELETING',
    organizationalUnitId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • notificationConfigurationArn (string) –

    [REQUIRED]

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

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.