Amazonka.Chime.BatchSuspendUser

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Creating a Request

data BatchSuspendUser

See: newBatchSuspendUser smart constructor.

Constructors

BatchSuspendUser'

Fields

• accountId :: Text

  The Amazon Chime account ID.

• userIdList :: [Text]

  The request containing the user IDs to suspend.

Instances

ToJSON BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

toJSON :: BatchSuspendUser -> Value

toEncoding :: BatchSuspendUser -> Encoding

toJSONList :: [BatchSuspendUser] -> Value

toEncodingList :: [BatchSuspendUser] -> Encoding

ToHeaders BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

toHeaders :: BatchSuspendUser -> [Header]

ToPath BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

toPath :: BatchSuspendUser -> ByteString

ToQuery BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

toQuery :: BatchSuspendUser -> QueryString

AWSRequest BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Associated Types

type AWSResponse BatchSuspendUser

Methods

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

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

Generic BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Associated Types

type Rep BatchSuspendUser :: Type -> Type

Methods

from :: BatchSuspendUser -> Rep BatchSuspendUser x

to :: Rep BatchSuspendUser x -> BatchSuspendUser

Read BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

readsPrec :: Int -> ReadS BatchSuspendUser

readList :: ReadS [BatchSuspendUser]

readPrec :: ReadPrec BatchSuspendUser

readListPrec :: ReadPrec [BatchSuspendUser]

Show BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

showsPrec :: Int -> BatchSuspendUser -> ShowS

show :: BatchSuspendUser -> String

showList :: [BatchSuspendUser] -> ShowS

NFData BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

rnf :: BatchSuspendUser -> ()

Eq BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

(==) :: BatchSuspendUser -> BatchSuspendUser -> Bool

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

Hashable BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

Methods

hashWithSalt :: Int -> BatchSuspendUser -> Int

hash :: BatchSuspendUser -> Int

type AWSResponse BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

type AWSResponse BatchSuspendUser = BatchSuspendUserResponse

type Rep BatchSuspendUser

Defined in Amazonka.Chime.BatchSuspendUser

type Rep BatchSuspendUser = D1 ('MetaData "BatchSuspendUser" "Amazonka.Chime.BatchSuspendUser" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "BatchSuspendUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userIdList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newBatchSuspendUser

Arguments

:: Text

BatchSuspendUser

-> BatchSuspendUser

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

BatchSuspendUser, batchSuspendUser_accountId - The Amazon Chime account ID.

$sel:userIdList:BatchSuspendUser', batchSuspendUser_userIdList - The request containing the user IDs to suspend.

Request Lenses

batchSuspendUser_accountId :: Lens' BatchSuspendUser Text

The Amazon Chime account ID.

batchSuspendUser_userIdList :: Lens' BatchSuspendUser [Text]

The request containing the user IDs to suspend.

Destructuring the Response

data BatchSuspendUserResponse

See: newBatchSuspendUserResponse smart constructor.

Constructors

BatchSuspendUserResponse'

Fields

• userErrors :: Maybe [UserError]

  If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

• httpStatus :: Int

  The response's http status code.

Instances

Generic BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

Associated Types

type Rep BatchSuspendUserResponse :: Type -> Type

Methods

from :: BatchSuspendUserResponse -> Rep BatchSuspendUserResponse x

to :: Rep BatchSuspendUserResponse x -> BatchSuspendUserResponse

Read BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

Methods

readsPrec :: Int -> ReadS BatchSuspendUserResponse

readList :: ReadS [BatchSuspendUserResponse]

readPrec :: ReadPrec BatchSuspendUserResponse

readListPrec :: ReadPrec [BatchSuspendUserResponse]

Show BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

Methods

showsPrec :: Int -> BatchSuspendUserResponse -> ShowS

show :: BatchSuspendUserResponse -> String

showList :: [BatchSuspendUserResponse] -> ShowS

NFData BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

Methods

rnf :: BatchSuspendUserResponse -> ()

Eq BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

Methods

(==) :: BatchSuspendUserResponse -> BatchSuspendUserResponse -> Bool

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

type Rep BatchSuspendUserResponse

Defined in Amazonka.Chime.BatchSuspendUser

type Rep BatchSuspendUserResponse = D1 ('MetaData "BatchSuspendUserResponse" "Amazonka.Chime.BatchSuspendUser" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "BatchSuspendUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserError])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchSuspendUserResponse

Arguments

:: Int

$sel:httpStatus:BatchSuspendUserResponse'

-> BatchSuspendUserResponse

Create a value of BatchSuspendUserResponse 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:userErrors:BatchSuspendUserResponse', batchSuspendUserResponse_userErrors - If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

$sel:httpStatus:BatchSuspendUserResponse', batchSuspendUserResponse_httpStatus - The response's http status code.

Response Lenses

batchSuspendUserResponse_userErrors :: Lens' BatchSuspendUserResponse (Maybe [UserError])

If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

batchSuspendUserResponse_httpStatus :: Lens' BatchSuspendUserResponse Int

The response's http status code.