SecurityHub / Client / get_members

get_members#

SecurityHub.Client.get_members(**kwargs)#

Returns the details for the Security Hub member accounts for the specified account IDs.

An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.

The results include both member accounts that are managed using Organizations and accounts that were invited manually.

Request Syntax

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

Parameters:

AccountIds (list) –

[REQUIRED]

The list of account IDs for the Security Hub member accounts to return the details for.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'Email': 'string',
            'MasterId': 'string',
            'AdministratorId': 'string',
            'MemberStatus': 'string',
            'InvitedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'ProcessingResult': 'string'
        },
    ]
}

Response Structure

(dict) –
- Members (list) –
  
  The list of details about the Security Hub member accounts.
  - (dict) –
    
    The details about a member account.
    - AccountId (string) –
      
      The Amazon Web Services account ID of the member account.
    - Email (string) –
      
      The email address of the member account.
    - MasterId (string) –
      
      This is replaced by AdministratorID.
      
      The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
    - AdministratorId (string) –
      
      The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
    - MemberStatus (string) –
      
      The status of the relationship between the member account and its administrator account.
      
      The status can have one of the following values:
      - Created - Indicates that the administrator account added the member account, but has not yet invited the member account.
      - Invited - Indicates that the administrator account invited the member account. The member account has not yet responded to the invitation.
      - Enabled - Indicates that the member account is currently active. For manually invited member accounts, indicates that the member account accepted the invitation.
      - Removed - Indicates that the administrator account disassociated the member account.
      - Resigned - Indicates that the member account disassociated themselves from the administrator account.
      - Deleted - Indicates that the administrator account deleted the member account.
      - AccountSuspended - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a member account.
    - InvitedAt (datetime) –
      
      A timestamp for the date and time when the invitation was sent to the member account.
    - UpdatedAt (datetime) –
      
      The timestamp for the date and time when the member account was updated.
- 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