invite_members

invite_members(**kwargs)

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

See also: AWS API Documentation

Request Syntax

response = client.invite_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ],
    DisableEmailNotification=True|False,
    Message='string'
)

Parameters

• DetectorId (string) --

  [REQUIRED]

  The unique ID of the detector of the GuardDuty account that you want to invite members with.

• AccountIds (list) --

  [REQUIRED]

  A list of account IDs of the accounts that you want to invite to GuardDuty as members.

  • (string) --
• DisableEmailNotification (boolean) -- A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.
• Message (string) -- The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • UnprocessedAccounts (list) --

    A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

    • (dict) --

      Contains information about the accounts that weren't processed.

      • AccountId (string) --

        The Amazon Web Services account ID.

      • Result (string) --

        A reason why the account hasn't been processed.

Exceptions

• GuardDuty.Client.exceptions.BadRequestException
• GuardDuty.Client.exceptions.InternalServerErrorException