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.AlexaBusiness.SendInvitation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

Synopsis

Creating a Request

data SendInvitation Source #

See: newSendInvitation smart constructor.

Constructors

SendInvitation'
Fields userArn :: Maybe Text The ARN of the user to whom to send an invitation. Required.

Instances

Instances details

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

newSendInvitation :: SendInvitation Source #

Create a value of SendInvitation 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:

SendInvitation, sendInvitation_userArn - The ARN of the user to whom to send an invitation. Required.

Request Lenses

sendInvitation_userArn :: Lens' SendInvitation (Maybe Text) Source #

The ARN of the user to whom to send an invitation. Required.

Destructuring the Response

data SendInvitationResponse Source #

See: newSendInvitationResponse smart constructor.

Constructors

SendInvitationResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSendInvitationResponse Source #

Arguments

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

Create a value of SendInvitationResponse 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:httpStatus:SendInvitationResponse', sendInvitationResponse_httpStatus - The response's http status code.

Response Lenses

sendInvitationResponse_httpStatus :: Lens' SendInvitationResponse Int Source #

The response's http status code.