SecurityHub / Client / delete_invitations

delete_invitations#

SecurityHub.Client.delete_invitations(**kwargs)#

Note

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.

Deletes invitations to become a Security Hub member account.

A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts.

This operation is only used to delete invitations that are sent to prospective member accounts that aren’t part of an Amazon Web Services organization. Organization accounts don’t receive invitations.

Request Syntax

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

Parameters:

AccountIds (list) –

[REQUIRED]

The list of member account IDs that received the invitations you want to delete.

(string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- UnprocessedAccounts (list) –
  
  The list of Amazon Web Services accounts for which the invitations were not deleted. 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.ResourceNotFoundException
SecurityHub.Client.exceptions.InvalidAccessException