Amazonka.Chime.InviteUsers

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.

Creating a Request

data InviteUsers

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

ToJSON InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

toJSON :: InviteUsers -> Value

toEncoding :: InviteUsers -> Encoding

toJSONList :: [InviteUsers] -> Value

toEncodingList :: [InviteUsers] -> Encoding

ToHeaders InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

toHeaders :: InviteUsers -> [Header]

ToPath InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

toPath :: InviteUsers -> ByteString

ToQuery InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

toQuery :: InviteUsers -> QueryString

AWSRequest InviteUsers

Defined in Amazonka.Chime.InviteUsers

Associated Types

type AWSResponse InviteUsers

Methods

request :: (Service -> Service) -> InviteUsers -> Request InviteUsers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InviteUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InviteUsers)))

Generic InviteUsers

Defined in Amazonka.Chime.InviteUsers

Associated Types

type Rep InviteUsers :: Type -> Type

Methods

from :: InviteUsers -> Rep InviteUsers x

to :: Rep InviteUsers x -> InviteUsers

Show InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

showsPrec :: Int -> InviteUsers -> ShowS

show :: InviteUsers -> String

showList :: [InviteUsers] -> ShowS

NFData InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

rnf :: InviteUsers -> ()

Eq InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

(==) :: InviteUsers -> InviteUsers -> Bool

(/=) :: InviteUsers -> InviteUsers -> Bool

Hashable InviteUsers

Defined in Amazonka.Chime.InviteUsers

Methods

hashWithSalt :: Int -> InviteUsers -> Int

hash :: InviteUsers -> Int

type AWSResponse InviteUsers

Defined in Amazonka.Chime.InviteUsers

type AWSResponse InviteUsers = InviteUsersResponse

type Rep InviteUsers

Defined in Amazonka.Chime.InviteUsers

type Rep InviteUsers = D1 ('MetaData "InviteUsers" "Amazonka.Chime.InviteUsers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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]))))

newInviteUsers

Arguments

:: Text

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:

InviteUsers, inviteUsers_userType - The user type.

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)

The user type.

inviteUsers_accountId :: Lens' InviteUsers Text

The Amazon Chime account ID.

inviteUsers_userEmailList :: Lens' InviteUsers [Text]

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

Destructuring the Response

data InviteUsersResponse

See: newInviteUsersResponse smart constructor.

Constructors

InviteUsersResponse'

Fields

• invites :: Maybe [Invite]

  The email invitation details.

• httpStatus :: Int

  The response's http status code.

Instances

Generic InviteUsersResponse

Defined in Amazonka.Chime.InviteUsers

Associated Types

type Rep InviteUsersResponse :: Type -> Type

Methods

from :: InviteUsersResponse -> Rep InviteUsersResponse x

to :: Rep InviteUsersResponse x -> InviteUsersResponse

Show InviteUsersResponse

Defined in Amazonka.Chime.InviteUsers

Methods

showsPrec :: Int -> InviteUsersResponse -> ShowS

show :: InviteUsersResponse -> String

showList :: [InviteUsersResponse] -> ShowS

NFData InviteUsersResponse

Defined in Amazonka.Chime.InviteUsers

Methods

rnf :: InviteUsersResponse -> ()

Eq InviteUsersResponse

Defined in Amazonka.Chime.InviteUsers

Methods

(==) :: InviteUsersResponse -> InviteUsersResponse -> Bool

(/=) :: InviteUsersResponse -> InviteUsersResponse -> Bool

type Rep InviteUsersResponse

Defined in Amazonka.Chime.InviteUsers

type Rep InviteUsersResponse = D1 ('MetaData "InviteUsersResponse" "Amazonka.Chime.InviteUsers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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

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])

The email invitation details.

inviteUsersResponse_httpStatus :: Lens' InviteUsersResponse Int

The response's http status code.