SecurityHub / Client / create_members

create_members#

SecurityHub.Client.create_members(**kwargs)#

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new organization accounts.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

  • For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

See also: AWS API Documentation

Request Syntax

response = client.create_members(
    AccountDetails=[
        {
            'AccountId': 'string',
            'Email': 'string'
        },
    ]
)
Parameters:

AccountDetails (list) –

[REQUIRED]

The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

  • (dict) –

    The details of an Amazon Web Services account.

    • AccountId (string) – [REQUIRED]

      The ID of an Amazon Web Services account.

    • Email (string) –

      The email of an Amazon Web Services account.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • UnprocessedAccounts (list) –

      The list of Amazon Web Services accounts that were not 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.LimitExceededException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.ResourceConflictException