SecurityHub / Paginator / ListMembers

ListMembers

class SecurityHub.Paginator.ListMembers

paginator = client.get_paginator('list_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityHub.Client.list_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OnlyAssociated=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OnlyAssociated (boolean) –

  Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

  If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

  If OnlyAssociated is set to FALSE, the response includes all existing 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

{
    'Members': [
        {
            'AccountId': 'string',
            'Email': 'string',
            'MasterId': 'string',
            'AdministratorId': 'string',
            'MemberStatus': 'string',
            'InvitedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Members (list) –

    Member details returned by the operation.

    • (dict) –

      The details about a member account.

      • AccountId (string) –

        The Amazon Web Services account ID of the member account.

      • Email (string) –

        The email address of the member account.

      • MasterId (string) –

        This is replaced by AdministratorID.

        The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

      • AdministratorId (string) –

        The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

      • MemberStatus (string) –

        The status of the relationship between the member account and its administrator account.

        The status can have one of the following values:

        • Created - Indicates that the administrator account added the member account, but has not yet invited the member account.

        • Invited - Indicates that the administrator account invited the member account. The member account has not yet responded to the invitation.

        • Enabled - Indicates that the member account is currently active. For manually invited member accounts, indicates that the member account accepted the invitation.

        • Removed - Indicates that the administrator account disassociated the member account.

        • Resigned - Indicates that the member account disassociated themselves from the administrator account.

        • Deleted - Indicates that the administrator account deleted the member account.

        • AccountSuspended - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a member account.

      • InvitedAt (datetime) –

        A timestamp for the date and time when the invitation was sent to the member account.

      • UpdatedAt (datetime) –

        The timestamp for the date and time when the member account was updated.