@datafire/amazonaws_chime v5.0.0

@datafire/amazonaws_chime

Client library for Amazon Chime

Installation and Usage

npm install --save @datafire/amazonaws_chime

let amazonaws_chime = require('@datafire/amazonaws_chime').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_chime.ListAccounts({}).then(data => {
  console.log(data);
});

Description

Actions

ListAccounts

amazonaws_chime.ListAccounts({}, context)

Input

• input object
  • MaxResults string
  • NextToken string

Output

• output ListAccountsResponse

CreateAccount

amazonaws_chime.CreateAccount({
  "Name": ""
}, context)

Input

• input object
  • Name required AccountName

Output

Output schema unknown

DeleteAccount

amazonaws_chime.DeleteAccount({
  "accountId": ""
}, context)

Input

• input object
  • accountId required string

Output

Output schema unknown

GetAccount

amazonaws_chime.GetAccount({
  "accountId": ""
}, context)

Input

• input object
  • accountId required string

Output

• output GetAccountResponse

UpdateAccount

amazonaws_chime.UpdateAccount({
  "accountId": ""
}, context)

Input

• input object
  • accountId required string
  • Name AccountName

Output

• output UpdateAccountResponse

GetAccountSettings

amazonaws_chime.GetAccountSettings({
  "accountId": ""
}, context)

Input

• input object
  • accountId required string

Output

• output GetAccountSettingsResponse

UpdateAccountSettings

amazonaws_chime.UpdateAccountSettings({
  "accountId": "",
  "AccountSettings": {}
}, context)

Input

• input object
  • accountId required string
  • AccountSettings required AccountSettings

Output

Output schema unknown

ListUsers

amazonaws_chime.ListUsers({
  "accountId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • accountId required string

Output

• output ListUsersResponse

BatchUpdateUser

amazonaws_chime.BatchUpdateUser({
  "accountId": "",
  "UpdateUserRequestItems": []
}, context)

Input

• input object
  • accountId required string
  • UpdateUserRequestItems required UpdateUserRequestItemList

Output

• output BatchUpdateUserResponse

GetUser

amazonaws_chime.GetUser({
  "accountId": "",
  "userId": ""
}, context)

Input

• input object
  • accountId required string
  • userId required string

Output

• output GetUserResponse

UpdateUser

amazonaws_chime.UpdateUser({
  "accountId": "",
  "userId": ""
}, context)

Input

• input object
  • accountId required string
  • userId required string
  • LicenseType License

Output

• output UpdateUserResponse

LogoutUser

amazonaws_chime.LogoutUser({
  "accountId": "",
  "userId": ""
}, context)

Input

• input object
  • accountId required string
  • userId required string

Output

Output schema unknown

ResetPersonalPIN

amazonaws_chime.ResetPersonalPIN({
  "accountId": "",
  "userId": ""
}, context)

Input

• input object
  • accountId required string
  • userId required string

Output

• output ResetPersonalPINResponse

InviteUsers

amazonaws_chime.InviteUsers({
  "accountId": "",
  "UserEmailList": []
}, context)

Input

• input object
  • accountId required string
  • UserEmailList required UserEmailList

Output

Output schema unknown

BatchSuspendUser

amazonaws_chime.BatchSuspendUser({
  "accountId": "",
  "UserIdList": []
}, context)

Input

• input object
  • accountId required string
  • UserIdList required UserIdList

Output

• output BatchSuspendUserResponse

BatchUnsuspendUser

amazonaws_chime.BatchUnsuspendUser({
  "accountId": "",
  "UserIdList": []
}, context)

Input

• input object
  • accountId required string
  • UserIdList required UserIdList

Output

• output BatchUnsuspendUserResponse

Definitions

Account

• Account object: The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
  • AccountId required String
  • AccountType AccountType
  • AwsAccountId required String
  • CreatedTimestamp Iso8601Timestamp
  • DefaultLicense License
  • Name required String
  • SupportedLicenses LicenseList

AccountList

• AccountList array
  • items Account

AccountName

• AccountName string

AccountSettings

• AccountSettings object: Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
  • DisableRemoteControl Boolean
  • EnableDialOut Boolean

AccountType

• AccountType string (values: Team, EnterpriseDirectory, EnterpriseLWA, EnterpriseOIDC)

BadRequestException

BatchSuspendUserRequest

• BatchSuspendUserRequest object
  • UserIdList required UserIdList

BatchSuspendUserResponse

• BatchSuspendUserResponse object
  • UserErrors UserErrorList

BatchUnsuspendUserRequest

• BatchUnsuspendUserRequest object
  • UserIdList required UserIdList

BatchUnsuspendUserResponse

• BatchUnsuspendUserResponse object
  • UserErrors UserErrorList

BatchUpdateUserRequest

• BatchUpdateUserRequest object
  • UpdateUserRequestItems required UpdateUserRequestItemList

BatchUpdateUserResponse

• BatchUpdateUserResponse object
  • UserErrors UserErrorList

Boolean

• Boolean boolean

ConflictException

CreateAccountRequest

• CreateAccountRequest object
  • Name required AccountName

CreateAccountResponse

• CreateAccountResponse object
  • Account Account

DeleteAccountRequest

• DeleteAccountRequest object

DeleteAccountResponse

• DeleteAccountResponse object

EmailAddress

• EmailAddress string

EmailStatus

• EmailStatus string (values: NotSent, Sent, Failed)

ErrorCode

• ErrorCode string (values: Unauthorized, Forbidden, NotFound, BadRequest, Conflict, ServiceFailure, ServiceUnavailable, Unprocessable, Throttled, PreconditionFailed)

ForbiddenException

GetAccountRequest

• GetAccountRequest object

GetAccountResponse

• GetAccountResponse object
  • Account Account

GetAccountSettingsRequest

• GetAccountSettingsRequest object

GetAccountSettingsResponse

• GetAccountSettingsResponse object
  • AccountSettings AccountSettings

GetUserRequest

• GetUserRequest object

GetUserResponse

• GetUserResponse object
  • User User

Invite

• Invite object: Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
  • EmailAddress EmailAddress
  • EmailStatus EmailStatus
  • InviteId String
  • Status InviteStatus

InviteList

• InviteList array
  • items Invite

InviteStatus

• InviteStatus string (values: Pending, Accepted, Failed)

InviteUsersRequest

• InviteUsersRequest object
  • UserEmailList required UserEmailList

InviteUsersResponse

• InviteUsersResponse object
  • Invites InviteList

Iso8601Timestamp

• Iso8601Timestamp string

License

• License string (values: Basic, Plus, Pro, ProTrial)

LicenseList

• LicenseList array
  • items License

ListAccountsRequest

• ListAccountsRequest object

ListAccountsResponse

• ListAccountsResponse object
  • Accounts AccountList
  • NextToken String

ListUsersRequest

• ListUsersRequest object

ListUsersResponse

• ListUsersResponse object
  • NextToken String
  • Users UserList

LogoutUserRequest

• LogoutUserRequest object

LogoutUserResponse

• LogoutUserResponse object

NonEmptyString

• NonEmptyString string

NotFoundException

ProfileServiceMaxResults

• ProfileServiceMaxResults integer

RegistrationStatus

• RegistrationStatus string (values: Unregistered, Registered, Suspended)

ResetPersonalPINRequest

• ResetPersonalPINRequest object

ResetPersonalPINResponse

• ResetPersonalPINResponse object
  • User User

SensitiveString

• SensitiveString string

ServiceFailureException

ServiceUnavailableException

String

• String string

ThrottledClientException

UnauthorizedClientException

UnprocessableEntityException

UpdateAccountRequest

• UpdateAccountRequest object
  • Name AccountName

UpdateAccountResponse

• UpdateAccountResponse object
  • Account Account

UpdateAccountSettingsRequest

• UpdateAccountSettingsRequest object
  • AccountSettings required AccountSettings

UpdateAccountSettingsResponse

• UpdateAccountSettingsResponse object

UpdateUserRequest

• UpdateUserRequest object
  • LicenseType License

UpdateUserRequestItem

• UpdateUserRequestItem object: The user ID and user fields to update, used with the BatchUpdateUser action.
  • LicenseType License
  • UserId required NonEmptyString

UpdateUserRequestItemList

• UpdateUserRequestItemList array
  • items UpdateUserRequestItem

UpdateUserResponse

• UpdateUserResponse object
  • User User

User

• User object: The user on the Amazon Chime account.
  • AccountId String
  • DisplayName SensitiveString
  • InvitedOn Iso8601Timestamp
  • LicenseType License
  • PersonalPIN String
  • PrimaryEmail EmailAddress
  • RegisteredOn Iso8601Timestamp
  • UserId required String
  • UserInvitationStatus InviteStatus
  • UserRegistrationStatus RegistrationStatus

UserEmailList

• UserEmailList array
  • items EmailAddress

UserError

• UserError object: The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
  • ErrorCode ErrorCode
  • ErrorMessage String
  • UserId NonEmptyString

UserErrorList

• UserErrorList array
  • items UserError

UserIdList

• UserIdList array
  • items NonEmptyString

UserList

• UserList array
  • items User