SecurityHub / Client / invite_members

invite_members#

SecurityHub.Client.invite_members(**kwargs)#

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.

This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.

See also: AWS API Documentation

Request Syntax

response = client.invite_members(
    AccountIds=[
        'string',
    ]
)

Parameters:

AccountIds (list) –

[REQUIRED]

The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

(string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- UnprocessedAccounts (list) –
  
  The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
  - (dict) –
    
    Details about the account that was not processed.
    - AccountId (string) –
      
      An Amazon Web Services account ID of the account that was not processed.
    - ProcessingResult (string) –
      
      The reason that the account was not processed.

Exceptions

SecurityHub.Client.exceptions.InternalException
SecurityHub.Client.exceptions.InvalidInputException
SecurityHub.Client.exceptions.InvalidAccessException
SecurityHub.Client.exceptions.LimitExceededException
SecurityHub.Client.exceptions.ResourceNotFoundException