| 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.BatchSuspendUser
Description
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.
Synopsis
- data BatchSuspendUser = BatchSuspendUser' {
- accountId :: Text
- userIdList :: [Text]
- newBatchSuspendUser :: Text -> BatchSuspendUser
- batchSuspendUser_accountId :: Lens' BatchSuspendUser Text
- batchSuspendUser_userIdList :: Lens' BatchSuspendUser [Text]
- data BatchSuspendUserResponse = BatchSuspendUserResponse' {
- userErrors :: Maybe [UserError]
- httpStatus :: Int
- newBatchSuspendUserResponse :: Int -> BatchSuspendUserResponse
- batchSuspendUserResponse_userErrors :: Lens' BatchSuspendUserResponse (Maybe [UserError])
- batchSuspendUserResponse_httpStatus :: Lens' BatchSuspendUserResponse Int
Creating a Request
data BatchSuspendUser Source #
See: newBatchSuspendUser smart constructor.
Constructors
| BatchSuspendUser' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:
$sel:accountId: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 Source #
The Amazon Chime account ID.
batchSuspendUser_userIdList :: Lens' BatchSuspendUser [Text] Source #
The request containing the user IDs to suspend.
Destructuring the Response
data BatchSuspendUserResponse Source #
See: newBatchSuspendUserResponse smart constructor.
Constructors
| BatchSuspendUserResponse' | |
Fields
| |
Instances
newBatchSuspendUserResponse Source #
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]) Source #
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 Source #
The response's http status code.