GuardDuty / Client / list_members

list_members#

GuardDuty.Client.list_members(**kwargs)#

Lists details about all member accounts for the current GuardDuty administrator account.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    DetectorId='string',
    MaxResults=123,
    NextToken='string',
    OnlyAssociated='string'
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

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

  • MaxResults (integer) – You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

  • NextToken (string) – You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

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

Return type:

dict

Returns:

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'DetectorId': 'string',
            'MasterId': 'string',
            'Email': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string',
            'UpdatedAt': 'string',
            'AdministratorId': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The pagination parameter to be used on the next list operation to retrieve more items.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException