Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Chime.InviteUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Synopsis

data InviteUsers = InviteUsers' {
- userType :: Maybe UserType
- accountId :: Text
- userEmailList :: [Sensitive Text]
}
newInviteUsers :: Text -> InviteUsers
inviteUsers_userType :: Lens' InviteUsers (Maybe UserType)
inviteUsers_accountId :: Lens' InviteUsers Text
inviteUsers_userEmailList :: Lens' InviteUsers [Text]
data InviteUsersResponse = InviteUsersResponse' {
- invites :: Maybe [Invite]
- httpStatus :: Int
}
newInviteUsersResponse :: Int -> InviteUsersResponse
inviteUsersResponse_invites :: Lens' InviteUsersResponse (Maybe [Invite])
inviteUsersResponse_httpStatus :: Lens' InviteUsersResponse Int

Creating a Request

data InviteUsers Source #

See: newInviteUsers smart constructor.

Constructors

InviteUsers'
Fields userType :: Maybe UserType The user type. accountId :: Text The Amazon Chime account ID. userEmailList :: [Sensitive Text] The user email addresses to which to send the email invitation.

Instances

Instances details

Eq InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods (==) :: InviteUsers -> InviteUsers -> Bool # (/=) :: InviteUsers -> InviteUsers -> Bool #
Show InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods showsPrec :: Int -> InviteUsers -> ShowS # show :: InviteUsers -> String # showList :: [InviteUsers] -> ShowS #
Generic InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Associated Types type Rep InviteUsers :: Type -> Type # Methods from :: InviteUsers -> Rep InviteUsers x # to :: Rep InviteUsers x -> InviteUsers #
NFData InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods rnf :: InviteUsers -> () #
Hashable InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods hashWithSalt :: Int -> InviteUsers -> Int # hash :: InviteUsers -> Int #
ToJSON InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods toJSON :: InviteUsers -> Value # toEncoding :: InviteUsers -> Encoding # toJSONList :: [InviteUsers] -> Value # toEncodingList :: [InviteUsers] -> Encoding #
AWSRequest InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Associated Types type AWSResponse InviteUsers # Methods request :: InviteUsers -> Request InviteUsers # response :: MonadResource m => Logger -> Service -> Proxy InviteUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InviteUsers))) #
ToHeaders InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods toHeaders :: InviteUsers -> [Header] #
ToPath InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods toPath :: InviteUsers -> ByteString #
ToQuery InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods toQuery :: InviteUsers -> QueryString #
type Rep InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers type Rep InviteUsers = D1 ('MetaData "InviteUsers" "Amazonka.Chime.InviteUsers" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "InviteUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userEmailList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Sensitive Text]))))
type AWSResponse InviteUsers Source #
Instance details Defined in Amazonka.Chime.InviteUsers type AWSResponse InviteUsers = InviteUsersResponse

newInviteUsers Source #

Arguments

:: Text	`$sel:accountId:InviteUsers'`
-> InviteUsers

Create a value of InviteUsers 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:userType:InviteUsers', inviteUsers_userType - The user type.

$sel:accountId:InviteUsers', inviteUsers_accountId - The Amazon Chime account ID.

$sel:userEmailList:InviteUsers', inviteUsers_userEmailList - The user email addresses to which to send the email invitation.

Request Lenses

inviteUsers_userType :: Lens' InviteUsers (Maybe UserType) Source #

The user type.

inviteUsers_accountId :: Lens' InviteUsers Text Source #

The Amazon Chime account ID.

inviteUsers_userEmailList :: Lens' InviteUsers [Text] Source #

The user email addresses to which to send the email invitation.

Destructuring the Response

data InviteUsersResponse Source #

See: newInviteUsersResponse smart constructor.

Constructors

InviteUsersResponse'
Fields invites :: Maybe [Invite] The email invitation details. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq InviteUsersResponse Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods (==) :: InviteUsersResponse -> InviteUsersResponse -> Bool # (/=) :: InviteUsersResponse -> InviteUsersResponse -> Bool #
Show InviteUsersResponse Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods showsPrec :: Int -> InviteUsersResponse -> ShowS # show :: InviteUsersResponse -> String # showList :: [InviteUsersResponse] -> ShowS #
Generic InviteUsersResponse Source #
Instance details Defined in Amazonka.Chime.InviteUsers Associated Types type Rep InviteUsersResponse :: Type -> Type # Methods from :: InviteUsersResponse -> Rep InviteUsersResponse x # to :: Rep InviteUsersResponse x -> InviteUsersResponse #
NFData InviteUsersResponse Source #
Instance details Defined in Amazonka.Chime.InviteUsers Methods rnf :: InviteUsersResponse -> () #
type Rep InviteUsersResponse Source #
Instance details Defined in Amazonka.Chime.InviteUsers type Rep InviteUsersResponse = D1 ('MetaData "InviteUsersResponse" "Amazonka.Chime.InviteUsers" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "InviteUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Invite])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newInviteUsersResponse Source #

Arguments

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

Create a value of InviteUsersResponse 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:invites:InviteUsersResponse', inviteUsersResponse_invites - The email invitation details.

$sel:httpStatus:InviteUsersResponse', inviteUsersResponse_httpStatus - The response's http status code.

Response Lenses

inviteUsersResponse_invites :: Lens' InviteUsersResponse (Maybe [Invite]) Source #

The email invitation details.

inviteUsersResponse_httpStatus :: Lens' InviteUsersResponse Int Source #

The response's http status code.