GuardDuty / Paginator / ListMembers

ListMembers

class GuardDuty.Paginator.ListMembers

paginator = client.get_paginator('list_members')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DetectorId (string) –

  [REQUIRED]

  The unique ID of the detector that is associated with the member.

  To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

• OnlyAssociated (string) – Specifies whether to only return associated members or to return all members (including members who haven’t been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using Create Members.

• 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',
            'DetectorId': 'string',
            'MasterId': 'string',
            'Email': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string',
            'UpdatedAt': 'string',
            'AdministratorId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Members (list) –

    A list of members.

    Note

    The values for email and invitedAt are available only if the member accounts are added by invitation.

    • (dict) –

      Contains information about the member account.

      • AccountId (string) –

        The ID of the member account.

      • DetectorId (string) –

        The detector ID of the member account.

      • MasterId (string) –

        The administrator account ID.

      • Email (string) –

        The email address of the member account.

      • RelationshipStatus (string) –

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

      • InvitedAt (string) –

        The timestamp when the invitation was sent.

      • UpdatedAt (string) –

        The last-updated timestamp of the member.

      • AdministratorId (string) –

        The administrator account ID.