Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MacieV2.CreateInvitations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data CreateInvitations Source #

See: newCreateInvitations smart constructor.

Constructors

CreateInvitations'

Fields

disableEmailNotification :: Maybe Bool
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 :: Maybe Text
Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.
accountIds :: [Text]
An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

Instances

Instances details

ToJSON CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods toJSON :: CreateInvitations -> Value # toEncoding :: CreateInvitations -> Encoding # toJSONList :: [CreateInvitations] -> Value # toEncodingList :: [CreateInvitations] -> Encoding #
ToHeaders CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods toHeaders :: CreateInvitations -> [Header] #
ToPath CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods toPath :: CreateInvitations -> ByteString #
ToQuery CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods toQuery :: CreateInvitations -> QueryString #
AWSRequest CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Associated Types type AWSResponse CreateInvitations # Methods request :: (Service -> Service) -> CreateInvitations -> Request CreateInvitations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateInvitations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateInvitations))) #
Generic CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Associated Types type Rep CreateInvitations :: Type -> Type # Methods from :: CreateInvitations -> Rep CreateInvitations x # to :: Rep CreateInvitations x -> CreateInvitations #
Read CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods readsPrec :: Int -> ReadS CreateInvitations # readList :: ReadS [CreateInvitations] # readPrec :: ReadPrec CreateInvitations # readListPrec :: ReadPrec [CreateInvitations] #
Show CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods showsPrec :: Int -> CreateInvitations -> ShowS # show :: CreateInvitations -> String # showList :: [CreateInvitations] -> ShowS #
NFData CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods rnf :: CreateInvitations -> () #
Eq CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods (==) :: CreateInvitations -> CreateInvitations -> Bool # (/=) :: CreateInvitations -> CreateInvitations -> Bool #
Hashable CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods hashWithSalt :: Int -> CreateInvitations -> Int # hash :: CreateInvitations -> Int #
type AWSResponse CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations type AWSResponse CreateInvitations = CreateInvitationsResponse
type Rep CreateInvitations Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations type Rep CreateInvitations = D1 ('MetaData "CreateInvitations" "Amazonka.MacieV2.CreateInvitations" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateInvitations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disableEmailNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newCreateInvitations :: CreateInvitations Source #

Create a value of CreateInvitations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:disableEmailNotification:CreateInvitations', createInvitations_disableEmailNotification - 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.

$sel:message:CreateInvitations', createInvitations_message - Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

$sel:accountIds:CreateInvitations', createInvitations_accountIds - An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

Request Lenses

createInvitations_disableEmailNotification :: Lens' CreateInvitations (Maybe Bool) Source #

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.

createInvitations_message :: Lens' CreateInvitations (Maybe Text) Source #

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

createInvitations_accountIds :: Lens' CreateInvitations [Text] Source #

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

Destructuring the Response

data CreateInvitationsResponse Source #

See: newCreateInvitationsResponse smart constructor.

Constructors

CreateInvitationsResponse'
Fields unprocessedAccounts :: Maybe [UnprocessedAccount] 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Associated Types type Rep CreateInvitationsResponse :: Type -> Type # Methods from :: CreateInvitationsResponse -> Rep CreateInvitationsResponse x # to :: Rep CreateInvitationsResponse x -> CreateInvitationsResponse #
Read CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods readsPrec :: Int -> ReadS CreateInvitationsResponse # readList :: ReadS [CreateInvitationsResponse] # readPrec :: ReadPrec CreateInvitationsResponse # readListPrec :: ReadPrec [CreateInvitationsResponse] #
Show CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods showsPrec :: Int -> CreateInvitationsResponse -> ShowS # show :: CreateInvitationsResponse -> String # showList :: [CreateInvitationsResponse] -> ShowS #
NFData CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods rnf :: CreateInvitationsResponse -> () #
Eq CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations Methods (==) :: CreateInvitationsResponse -> CreateInvitationsResponse -> Bool # (/=) :: CreateInvitationsResponse -> CreateInvitationsResponse -> Bool #
type Rep CreateInvitationsResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateInvitations type Rep CreateInvitationsResponse = D1 ('MetaData "CreateInvitationsResponse" "Amazonka.MacieV2.CreateInvitations" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateInvitationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedAccount])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateInvitationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateInvitationsResponse'`
-> CreateInvitationsResponse

Create a value of CreateInvitationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:unprocessedAccounts:CreateInvitationsResponse', createInvitationsResponse_unprocessedAccounts - 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.

$sel:httpStatus:CreateInvitationsResponse', createInvitationsResponse_httpStatus - The response's http status code.

Response Lenses

createInvitationsResponse_unprocessedAccounts :: Lens' CreateInvitationsResponse (Maybe [UnprocessedAccount]) Source #

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.

createInvitationsResponse_httpStatus :: Lens' CreateInvitationsResponse Int Source #

The response's http status code.