Macie2 / Client / create_invitations

create_invitations#

Macie2.Client.create_invitations(**kwargs)#

Sends an Amazon Macie membership invitation to one or more accounts.

See also: AWS API Documentation

Request Syntax

response = client.create_invitations(
    accountIds=[
        'string',
    ],
    disableEmailNotification=True|False,
    message='string'
)
Parameters:

  • accountIds (list) –

    [REQUIRED]

    An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

    • (string) –

  • disableEmailNotification (boolean) – Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient’s account when you associated the account with your account. The default value is false.

  • message (string) – Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

Return type:

dict

Returns:

Response Syntax

{
    'unprocessedAccounts': [
        {
            'accountId': 'string',
            'errorCode': 'ClientError'|'InternalError',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    The request succeeded. Processing might not be complete.

    • unprocessedAccounts (list) –

      An array of objects, one for each account whose invitation hasn’t been processed. Each object identifies the account and explains why the invitation hasn’t been processed for the account.

      • (dict) –

        Provides information about an account-related request that hasn’t been processed.

        • accountId (string) –

          The Amazon Web Services account ID for the account that the request applies to.

        • errorCode (string) –

          The source of the issue or delay in processing the request.

        • errorMessage (string) –

          The reason why the request hasn’t been processed.

Exceptions

  • Macie2.Client.exceptions.ValidationException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.ServiceQuotaExceededException

  • Macie2.Client.exceptions.AccessDeniedException

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.ConflictException