Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
", "operations": { "AssociatePhoneNumberWithUser": "Associates a phone number with the specified Amazon Chime user.
", "AssociateSigninDelegateGroupsWithAccount": "Associates the specified sign-in delegate groups with the specified Amazon Chime account.
", "BatchCreateRoomMembership": "Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
", "BatchDeletePhoneNumber": "Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", "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.
", "BatchUnsuspendUser": "Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "BatchUpdateUser": "Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Creates a bot for an Amazon Chime Enterprise account.
", "CreateMeetingDialOut": "Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.
This API is not available in a dedicated namespace.
Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
", "CreateRoom": "Creates a chat room for the specified Amazon Chime Enterprise account.
", "CreateRoomMembership": "Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
", "CreateUser": "Creates a user under the specified Amazon Chime account.
", "DeleteAccount": "Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
Deletes the events configuration that allows a bot to receive outgoing events.
", "DeletePhoneNumber": "Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", "DeleteRoom": "Deletes a chat room in an Amazon Chime Enterprise account.
", "DeleteRoomMembership": "Removes a member from a chat room in an Amazon Chime Enterprise account.
", "DisassociatePhoneNumberFromUser": "Disassociates the primary provisioned phone number from the specified Amazon Chime user.
", "DisassociateSigninDelegateGroupsFromAccount": "Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
", "GetAccount": "Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
", "GetAccountSettings": "Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
", "GetBot": "Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
", "GetEventsConfiguration": "Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
", "GetGlobalSettings": "Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", "GetPhoneNumber": "Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
", "GetPhoneNumberOrder": "Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
", "GetPhoneNumberSettings": "Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
", "GetRetentionSettings": "Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
", "GetRoom": "Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "GetUser": "Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
", "GetUserSettings": "Retrieves settings for the specified user ID, such as any associated phone number settings.
", "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.
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
", "ListBots": "Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
", "ListPhoneNumberOrders": "Lists the phone number orders for the administrator's Amazon Chime account.
", "ListPhoneNumbers": "Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
", "ListRoomMemberships": "Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
", "ListRooms": "Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
", "ListSupportedPhoneNumberCountries": "Lists supported phone number countries.
", "ListUsers": "Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
", "LogoutUser": "Logs out the specified user from all of the devices they are currently logged into.
", "PutEventsConfiguration": "Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
", "PutRetentionSettings": "Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
", "RedactConversationMessage": "Redacts the specified message from the specified Amazon Chime conversation.
", "RedactRoomMessage": "Redacts the specified message from the specified Amazon Chime channel.
", "RegenerateSecurityToken": "Regenerates the security token for a bot.
", "ResetPersonalPIN": "Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
", "RestorePhoneNumber": "Moves a phone number from the Deletion queue back into the phone number Inventory.
", "SearchAvailablePhoneNumbers": "Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
", "UpdateAccountSettings": "Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
", "UpdateBot": "Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
", "UpdateGlobalSettings": "Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", "UpdatePhoneNumber": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "UpdatePhoneNumberSettings": "Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
", "UpdateRoom": "Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "UpdateRoomMembership": "Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
", "UpdateUser": "Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
Updates the settings for the specified user, such as phone number settings.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have permissions to perform the requested operation.
", "refs": {} }, "Account": { "base": "The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
", "refs": { "AccountList$member": null, "CreateAccountResponse$Account": "The Amazon Chime account details.
", "GetAccountResponse$Account": "The Amazon Chime account details.
", "UpdateAccountResponse$Account": "The updated Amazon Chime account details.
" } }, "AccountList": { "base": null, "refs": { "ListAccountsResponse$Accounts": "List of Amazon Chime accounts and account details.
" } }, "AccountName": { "base": null, "refs": { "CreateAccountRequest$Name": "The name of the Amazon Chime account.
", "ListAccountsRequest$Name": "Amazon Chime account name prefix with which to filter results.
", "UpdateAccountRequest$Name": "The new name for the specified Amazon Chime account.
" } }, "AccountSettings": { "base": "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.
", "refs": { "GetAccountSettingsResponse$AccountSettings": "The Amazon Chime account settings.
", "UpdateAccountSettingsRequest$AccountSettings": "The Amazon Chime account settings to update.
" } }, "AccountStatus": { "base": null, "refs": { "Account$AccountStatus": "The status of the account.
" } }, "AccountType": { "base": null, "refs": { "Account$AccountType": "The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
" } }, "AlexaForBusinessMetadata": { "base": "The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
", "refs": { "UpdateUserRequest$AlexaForBusinessMetadata": "The Alexa for Business metadata.
", "UpdateUserRequestItem$AlexaForBusinessMetadata": "The Alexa for Business metadata.
", "User$AlexaForBusinessMetadata": "The Alexa for Business metadata.
" } }, "Alpha2CountryCode": { "base": null, "refs": { "PhoneNumber$Country": "The phone number country. Format: ISO 3166-1 alpha-2.
", "PhoneNumberCountry$CountryCode": "The phone number country code. Format: ISO 3166-1 alpha-2.
", "SearchAvailablePhoneNumbersRequest$Country": "The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
" } }, "AssociatePhoneNumberWithUserRequest": { "base": null, "refs": {} }, "AssociatePhoneNumberWithUserResponse": { "base": null, "refs": {} }, "AssociateSigninDelegateGroupsWithAccountRequest": { "base": null, "refs": {} }, "AssociateSigninDelegateGroupsWithAccountResponse": { "base": null, "refs": {} }, "BadRequestException": { "base": "The input parameters don't match the service's restrictions.
", "refs": {} }, "BatchCreateRoomMembershipRequest": { "base": null, "refs": {} }, "BatchCreateRoomMembershipResponse": { "base": null, "refs": {} }, "BatchDeletePhoneNumberRequest": { "base": null, "refs": {} }, "BatchDeletePhoneNumberResponse": { "base": null, "refs": {} }, "BatchSuspendUserRequest": { "base": null, "refs": {} }, "BatchSuspendUserResponse": { "base": null, "refs": {} }, "BatchUnsuspendUserRequest": { "base": null, "refs": {} }, "BatchUnsuspendUserResponse": { "base": null, "refs": {} }, "BatchUpdatePhoneNumberRequest": { "base": null, "refs": {} }, "BatchUpdatePhoneNumberResponse": { "base": null, "refs": {} }, "BatchUpdateUserRequest": { "base": null, "refs": {} }, "BatchUpdateUserResponse": { "base": null, "refs": {} }, "Boolean": { "base": null, "refs": { "AccountSettings$DisableRemoteControl": "Setting that stops or starts remote control of shared screens during meetings.
", "AccountSettings$EnableDialOut": "Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.
", "AlexaForBusinessMetadata$IsAlexaForBusinessEnabled": "Starts or stops Alexa for Business.
", "TelephonySettings$InboundCalling": "Allows or denies inbound calling.
", "TelephonySettings$OutboundCalling": "Allows or denies outbound calling.
", "TelephonySettings$SMS": "Allows or denies SMS messaging.
" } }, "Bot": { "base": "A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
", "refs": { "BotList$member": null, "CreateBotResponse$Bot": "The bot details.
", "GetBotResponse$Bot": "The chat bot details.
", "RegenerateSecurityTokenResponse$Bot": "A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
", "UpdateBotResponse$Bot": "The updated bot details.
" } }, "BotList": { "base": null, "refs": { "ListBotsResponse$Bots": "List of bots and bot details.
" } }, "BotType": { "base": null, "refs": { "Bot$BotType": "The bot type.
" } }, "BusinessCallingSettings": { "base": "The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
", "refs": { "GetGlobalSettingsResponse$BusinessCalling": "The Amazon Chime Business Calling settings.
", "UpdateGlobalSettingsRequest$BusinessCalling": "The Amazon Chime Business Calling settings.
" } }, "CallingName": { "base": null, "refs": { "GetPhoneNumberSettingsResponse$CallingName": "The default outbound calling name for the account.
", "PhoneNumber$CallingName": "The outbound calling name associated with the phone number.
", "UpdatePhoneNumberRequest$CallingName": "The outbound calling name associated with the phone number.
", "UpdatePhoneNumberRequestItem$CallingName": "The outbound calling name to update.
", "UpdatePhoneNumberSettingsRequest$CallingName": "The default outbound calling name for the account.
" } }, "CallingNameStatus": { "base": null, "refs": { "PhoneNumber$CallingNameStatus": "The outbound calling name status.
" } }, "ClientRequestToken": { "base": null, "refs": { "CreateRoomRequest$ClientRequestToken": "The idempotency token for the request.
" } }, "ConflictException": { "base": "The request could not be processed because of conflict in the current state of the resource.
", "refs": {} }, "ConversationRetentionSettings": { "base": "The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
", "refs": { "RetentionSettings$ConversationRetentionSettings": "The chat conversation retention settings.
" } }, "CreateAccountRequest": { "base": null, "refs": {} }, "CreateAccountResponse": { "base": null, "refs": {} }, "CreateBotRequest": { "base": null, "refs": {} }, "CreateBotResponse": { "base": null, "refs": {} }, "CreateMeetingDialOutRequest": { "base": null, "refs": {} }, "CreateMeetingDialOutResponse": { "base": null, "refs": {} }, "CreatePhoneNumberOrderRequest": { "base": null, "refs": {} }, "CreatePhoneNumberOrderResponse": { "base": null, "refs": {} }, "CreateRoomMembershipRequest": { "base": null, "refs": {} }, "CreateRoomMembershipResponse": { "base": null, "refs": {} }, "CreateRoomRequest": { "base": null, "refs": {} }, "CreateRoomResponse": { "base": null, "refs": {} }, "CreateUserRequest": { "base": null, "refs": {} }, "CreateUserResponse": { "base": null, "refs": {} }, "DeleteAccountRequest": { "base": null, "refs": {} }, "DeleteAccountResponse": { "base": null, "refs": {} }, "DeleteEventsConfigurationRequest": { "base": null, "refs": {} }, "DeletePhoneNumberRequest": { "base": null, "refs": {} }, "DeleteRoomMembershipRequest": { "base": null, "refs": {} }, "DeleteRoomRequest": { "base": null, "refs": {} }, "DisassociatePhoneNumberFromUserRequest": { "base": null, "refs": {} }, "DisassociatePhoneNumberFromUserResponse": { "base": null, "refs": {} }, "DisassociateSigninDelegateGroupsFromAccountRequest": { "base": null, "refs": {} }, "DisassociateSigninDelegateGroupsFromAccountResponse": { "base": null, "refs": {} }, "E164PhoneNumber": { "base": null, "refs": { "AssociatePhoneNumberWithUserRequest$E164PhoneNumber": "The phone number, in E.164 format.
", "CreateMeetingDialOutRequest$FromPhoneNumber": "Phone number used as the caller ID when the remote party receives a call.
", "CreateMeetingDialOutRequest$ToPhoneNumber": "Phone number called when inviting someone to a meeting.
", "E164PhoneNumberList$member": null, "OrderedPhoneNumber$E164PhoneNumber": "The phone number, in E.164 format.
", "PhoneNumber$E164PhoneNumber": "The phone number, in E.164 format.
" } }, "E164PhoneNumberList": { "base": null, "refs": { "CreatePhoneNumberOrderRequest$E164PhoneNumbers": "List of phone numbers, in E.164 format.
", "SearchAvailablePhoneNumbersResponse$E164PhoneNumbers": "List of phone numbers, in E.164 format.
" } }, "EmailAddress": { "base": null, "refs": { "CreateUserRequest$Email": "The user's email address.
", "Invite$EmailAddress": "The email address to which the invite is sent.
", "ListAccountsRequest$UserEmail": "User email address with which to filter results.
", "ListUsersRequest$UserEmail": "Optional. The user email address used to filter results. Maximum 1.
", "User$PrimaryEmail": "The primary email address of the user.
", "UserEmailList$member": null } }, "EmailStatus": { "base": null, "refs": { "Invite$EmailStatus": "The status of the invite email.
" } }, "ErrorCode": { "base": null, "refs": { "AccessDeniedException$Code": null, "BadRequestException$Code": null, "ConflictException$Code": null, "ForbiddenException$Code": null, "MemberError$ErrorCode": "The error code.
", "NotFoundException$Code": null, "PhoneNumberError$ErrorCode": "The error code.
", "ResourceLimitExceededException$Code": null, "ServiceFailureException$Code": null, "ServiceUnavailableException$Code": null, "ThrottledClientException$Code": null, "UnauthorizedClientException$Code": null, "UnprocessableEntityException$Code": null, "UserError$ErrorCode": "The error code.
" } }, "EventsConfiguration": { "base": "The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
", "refs": { "GetEventsConfigurationResponse$EventsConfiguration": "The events configuration details.
", "PutEventsConfigurationResponse$EventsConfiguration": "The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.
" } }, "ForbiddenException": { "base": "The client is permanently forbidden from making the request.
", "refs": {} }, "GetAccountRequest": { "base": null, "refs": {} }, "GetAccountResponse": { "base": null, "refs": {} }, "GetAccountSettingsRequest": { "base": null, "refs": {} }, "GetAccountSettingsResponse": { "base": null, "refs": {} }, "GetBotRequest": { "base": null, "refs": {} }, "GetBotResponse": { "base": null, "refs": {} }, "GetEventsConfigurationRequest": { "base": null, "refs": {} }, "GetEventsConfigurationResponse": { "base": null, "refs": {} }, "GetGlobalSettingsResponse": { "base": null, "refs": {} }, "GetPhoneNumberOrderRequest": { "base": null, "refs": {} }, "GetPhoneNumberOrderResponse": { "base": null, "refs": {} }, "GetPhoneNumberRequest": { "base": null, "refs": {} }, "GetPhoneNumberResponse": { "base": null, "refs": {} }, "GetPhoneNumberSettingsResponse": { "base": null, "refs": {} }, "GetRetentionSettingsRequest": { "base": null, "refs": {} }, "GetRetentionSettingsResponse": { "base": null, "refs": {} }, "GetRoomRequest": { "base": null, "refs": {} }, "GetRoomResponse": { "base": null, "refs": {} }, "GetUserRequest": { "base": null, "refs": {} }, "GetUserResponse": { "base": null, "refs": {} }, "GetUserSettingsRequest": { "base": null, "refs": {} }, "GetUserSettingsResponse": { "base": null, "refs": {} }, "GuidString": { "base": null, "refs": { "CreateMeetingDialOutRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "CreateMeetingDialOutResponse$TransactionId": "Unique ID that tracks API calls.
", "GetPhoneNumberOrderRequest$PhoneNumberOrderId": "The ID for the phone number order.
", "PhoneNumberOrder$PhoneNumberOrderId": "The phone number order ID.
" } }, "Invite": { "base": "Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
The email invitation details.
" } }, "InviteStatus": { "base": null, "refs": { "Invite$Status": "The status of the invite.
", "User$UserInvitationStatus": "The user invite status.
" } }, "InviteUsersRequest": { "base": null, "refs": {} }, "InviteUsersResponse": { "base": null, "refs": {} }, "Iso8601Timestamp": { "base": null, "refs": { "Account$CreatedTimestamp": "The Amazon Chime account creation timestamp, in ISO 8601 format.
", "Bot$CreatedTimestamp": "The bot creation timestamp, in ISO 8601 format.
", "Bot$UpdatedTimestamp": "The updated bot timestamp, in ISO 8601 format.
", "GetPhoneNumberSettingsResponse$CallingNameUpdatedTimestamp": "The updated outbound calling name timestamp, in ISO 8601 format.
", "GetRetentionSettingsResponse$InitiateDeletionTimestamp": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
", "PhoneNumber$CreatedTimestamp": "The phone number creation timestamp, in ISO 8601 format.
", "PhoneNumber$UpdatedTimestamp": "The updated phone number timestamp, in ISO 8601 format.
", "PhoneNumber$DeletionTimestamp": "The deleted phone number timestamp, in ISO 8601 format.
", "PhoneNumberAssociation$AssociatedTimestamp": "The timestamp of the phone number association, in ISO 8601 format.
", "PhoneNumberOrder$CreatedTimestamp": "The phone number order creation time stamp, in ISO 8601 format.
", "PhoneNumberOrder$UpdatedTimestamp": "The updated phone number order time stamp, in ISO 8601 format.
", "PutRetentionSettingsResponse$InitiateDeletionTimestamp": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
", "Room$CreatedTimestamp": "The room creation timestamp, in ISO 8601 format.
", "Room$UpdatedTimestamp": "The room update timestamp, in ISO 8601 format.
", "RoomMembership$UpdatedTimestamp": "The room membership update timestamp, in ISO 8601 format.
", "User$RegisteredOn": "Date and time when the user is registered, in ISO 8601 format.
", "User$InvitedOn": "Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
" } }, "JoinTokenString": { "base": null, "refs": { "CreateMeetingDialOutRequest$JoinToken": "Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
" } }, "License": { "base": null, "refs": { "Account$DefaultLicense": "The default license for the Amazon Chime account.
", "LicenseList$member": null, "UpdateAccountRequest$DefaultLicense": "The default license applied when you add users to an Amazon Chime account.
", "UpdateUserRequest$LicenseType": "The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
", "UpdateUserRequestItem$LicenseType": "The user license type.
", "User$LicenseType": "The license type for the user.
" } }, "LicenseList": { "base": null, "refs": { "Account$SupportedLicenses": "Supported licenses for the Amazon Chime account.
" } }, "ListAccountsRequest": { "base": null, "refs": {} }, "ListAccountsResponse": { "base": null, "refs": {} }, "ListBotsRequest": { "base": null, "refs": {} }, "ListBotsResponse": { "base": null, "refs": {} }, "ListPhoneNumberOrdersRequest": { "base": null, "refs": {} }, "ListPhoneNumberOrdersResponse": { "base": null, "refs": {} }, "ListPhoneNumbersRequest": { "base": null, "refs": {} }, "ListPhoneNumbersResponse": { "base": null, "refs": {} }, "ListRoomMembershipsRequest": { "base": null, "refs": {} }, "ListRoomMembershipsResponse": { "base": null, "refs": {} }, "ListRoomsRequest": { "base": null, "refs": {} }, "ListRoomsResponse": { "base": null, "refs": {} }, "ListSupportedPhoneNumberCountriesRequest": { "base": null, "refs": {} }, "ListSupportedPhoneNumberCountriesResponse": { "base": null, "refs": {} }, "ListUsersRequest": { "base": null, "refs": {} }, "ListUsersResponse": { "base": null, "refs": {} }, "LogoutUserRequest": { "base": null, "refs": {} }, "LogoutUserResponse": { "base": null, "refs": {} }, "Member": { "base": "The member details, such as email address, name, member ID, and member type.
", "refs": { "RoomMembership$Member": "The member details, such as email address, name, member ID, and member type.
" } }, "MemberError": { "base": "The list of errors returned when a member action results in an error.
", "refs": { "MemberErrorList$member": null } }, "MemberErrorList": { "base": null, "refs": { "BatchCreateRoomMembershipResponse$Errors": "If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.
" } }, "MemberType": { "base": null, "refs": { "Member$MemberType": "The member type.
" } }, "MembershipItem": { "base": "Membership details, such as member ID and member role.
", "refs": { "MembershipItemList$member": null } }, "MembershipItemList": { "base": null, "refs": { "BatchCreateRoomMembershipRequest$MembershipItemList": "The list of membership items.
" } }, "NonEmptyString": { "base": null, "refs": { "AssociateSigninDelegateGroupsWithAccountRequest$AccountId": "The Amazon Chime account ID.
", "BatchCreateRoomMembershipRequest$AccountId": "The Amazon Chime account ID.
", "BatchCreateRoomMembershipRequest$RoomId": "The room ID.
", "BatchSuspendUserRequest$AccountId": "The Amazon Chime account ID.
", "BatchUnsuspendUserRequest$AccountId": "The Amazon Chime account ID.
", "BatchUpdateUserRequest$AccountId": "The Amazon Chime account ID.
", "CreateBotRequest$AccountId": "The Amazon Chime account ID.
", "CreateBotRequest$Domain": "The domain of the Amazon Chime Enterprise account.
", "CreateRoomMembershipRequest$AccountId": "The Amazon Chime account ID.
", "CreateRoomMembershipRequest$RoomId": "The room ID.
", "CreateRoomMembershipRequest$MemberId": "The Amazon Chime member ID (user ID or bot ID).
", "CreateRoomRequest$AccountId": "The Amazon Chime account ID.
", "CreateUserRequest$AccountId": "The Amazon Chime account ID.
", "DeleteAccountRequest$AccountId": "The Amazon Chime account ID.
", "DeleteEventsConfigurationRequest$AccountId": "The Amazon Chime account ID.
", "DeleteEventsConfigurationRequest$BotId": "The bot ID.
", "DeleteRoomMembershipRequest$AccountId": "The Amazon Chime account ID.
", "DeleteRoomMembershipRequest$RoomId": "The room ID.
", "DeleteRoomMembershipRequest$MemberId": "The member ID (user ID or bot ID).
", "DeleteRoomRequest$AccountId": "The Amazon Chime account ID.
", "DeleteRoomRequest$RoomId": "The chat room ID.
", "DisassociateSigninDelegateGroupsFromAccountRequest$AccountId": "The Amazon Chime account ID.
", "GetAccountRequest$AccountId": "The Amazon Chime account ID.
", "GetAccountSettingsRequest$AccountId": "The Amazon Chime account ID.
", "GetBotRequest$AccountId": "The Amazon Chime account ID.
", "GetBotRequest$BotId": "The bot ID.
", "GetEventsConfigurationRequest$AccountId": "The Amazon Chime account ID.
", "GetEventsConfigurationRequest$BotId": "The bot ID.
", "GetRetentionSettingsRequest$AccountId": "The Amazon Chime account ID.
", "GetRoomRequest$AccountId": "The Amazon Chime account ID.
", "GetRoomRequest$RoomId": "The room ID.
", "GetUserRequest$AccountId": "The Amazon Chime account ID.
", "GetUserRequest$UserId": "The user ID.
", "InviteUsersRequest$AccountId": "The Amazon Chime account ID.
", "ListBotsRequest$AccountId": "The Amazon Chime account ID.
", "ListRoomMembershipsRequest$AccountId": "The Amazon Chime account ID.
", "ListRoomMembershipsRequest$RoomId": "The room ID.
", "ListRoomsRequest$AccountId": "The Amazon Chime account ID.
", "ListUsersRequest$AccountId": "The Amazon Chime account ID.
", "LogoutUserRequest$AccountId": "The Amazon Chime account ID.
", "LogoutUserRequest$UserId": "The user ID.
", "Member$MemberId": "The member ID (user ID or bot ID).
", "Member$AccountId": "The Amazon Chime account ID.
", "MemberError$MemberId": "The member ID.
", "MembershipItem$MemberId": "The member ID.
", "PhoneNumberError$PhoneNumberId": "The phone number ID for which the action failed.
", "PutEventsConfigurationRequest$AccountId": "The Amazon Chime account ID.
", "PutEventsConfigurationRequest$BotId": "The bot ID.
", "PutRetentionSettingsRequest$AccountId": "The Amazon Chime account ID.
", "RedactConversationMessageRequest$AccountId": "The Amazon Chime account ID.
", "RedactConversationMessageRequest$ConversationId": "The conversation ID.
", "RedactConversationMessageRequest$MessageId": "The message ID.
", "RedactRoomMessageRequest$AccountId": "The Amazon Chime account ID.
", "RedactRoomMessageRequest$RoomId": "The room ID.
", "RedactRoomMessageRequest$MessageId": "The message ID.
", "RegenerateSecurityTokenRequest$AccountId": "The Amazon Chime account ID.
", "RegenerateSecurityTokenRequest$BotId": "The bot ID.
", "ResetPersonalPINRequest$AccountId": "The Amazon Chime account ID.
", "ResetPersonalPINRequest$UserId": "The user ID.
", "RestorePhoneNumberRequest$PhoneNumberId": "The phone number.
", "Room$RoomId": "The room ID.
", "Room$AccountId": "The Amazon Chime account ID.
", "Room$CreatedBy": "The identifier of the room creator.
", "RoomMembership$RoomId": "The room ID.
", "RoomMembership$InvitedBy": "The identifier of the user that invited the room member.
", "SigninDelegateGroup$GroupName": "The group name.
", "UpdateAccountRequest$AccountId": "The Amazon Chime account ID.
", "UpdateAccountSettingsRequest$AccountId": "The Amazon Chime account ID.
", "UpdateBotRequest$AccountId": "The Amazon Chime account ID.
", "UpdateBotRequest$BotId": "The bot ID.
", "UpdatePhoneNumberRequestItem$PhoneNumberId": "The phone number ID to update.
", "UpdateRoomMembershipRequest$AccountId": "The Amazon Chime account ID.
", "UpdateRoomMembershipRequest$RoomId": "The room ID.
", "UpdateRoomMembershipRequest$MemberId": "The member ID.
", "UpdateRoomRequest$AccountId": "The Amazon Chime account ID.
", "UpdateRoomRequest$RoomId": "The room ID.
", "UpdateUserRequest$AccountId": "The Amazon Chime account ID.
", "UpdateUserRequest$UserId": "The user ID.
", "UpdateUserRequestItem$UserId": "The user ID.
", "UserError$UserId": "The user ID for which the action failed.
", "UserIdList$member": null } }, "NonEmptyStringList": { "base": null, "refs": { "BatchDeletePhoneNumberRequest$PhoneNumberIds": "List of phone number IDs.
", "DisassociateSigninDelegateGroupsFromAccountRequest$GroupNames": "The sign-in delegate group names.
" } }, "NotFoundException": { "base": "One or more of the resources in the request does not exist in the system.
", "refs": {} }, "NullableBoolean": { "base": null, "refs": { "Bot$Disabled": "When true, the bot is stopped from running in your account.
", "PhoneNumberCapabilities$InboundCall": "Allows or denies inbound calling for the specified phone number.
", "PhoneNumberCapabilities$OutboundCall": "Allows or denies outbound calling for the specified phone number.
", "PhoneNumberCapabilities$InboundSMS": "Allows or denies inbound SMS messaging for the specified phone number.
", "PhoneNumberCapabilities$OutboundSMS": "Allows or denies outbound SMS messaging for the specified phone number.
", "PhoneNumberCapabilities$InboundMMS": "Allows or denies inbound MMS messaging for the specified phone number.
", "PhoneNumberCapabilities$OutboundMMS": "Allows or denies outbound MMS messaging for the specified phone number.
", "UpdateBotRequest$Disabled": "When true, stops the specified bot from running in your account.
" } }, "OrderedPhoneNumber": { "base": "A phone number for which an order has been placed.
", "refs": { "OrderedPhoneNumberList$member": null } }, "OrderedPhoneNumberList": { "base": null, "refs": { "PhoneNumberOrder$OrderedPhoneNumbers": "The ordered phone number details, such as the phone number in E.164 format and the phone number status.
" } }, "OrderedPhoneNumberStatus": { "base": null, "refs": { "OrderedPhoneNumber$Status": "The phone number status.
" } }, "PhoneNumber": { "base": "A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
", "refs": { "GetPhoneNumberResponse$PhoneNumber": "The phone number details.
", "PhoneNumberList$member": null, "RestorePhoneNumberResponse$PhoneNumber": "The phone number details.
", "UpdatePhoneNumberResponse$PhoneNumber": "The updated phone number details.
" } }, "PhoneNumberAssociation": { "base": "The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
", "refs": { "PhoneNumberAssociationList$member": null } }, "PhoneNumberAssociationList": { "base": null, "refs": { "PhoneNumber$Associations": "The phone number associations.
" } }, "PhoneNumberAssociationName": { "base": null, "refs": { "ListPhoneNumbersRequest$FilterName": "The filter to use to limit the number of results.
", "PhoneNumberAssociation$Name": "Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
" } }, "PhoneNumberCapabilities": { "base": "The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
", "refs": { "PhoneNumber$Capabilities": "The phone number capabilities.
" } }, "PhoneNumberCountriesList": { "base": null, "refs": { "ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries": "The supported phone number countries.
" } }, "PhoneNumberCountry": { "base": "The phone number country.
", "refs": { "PhoneNumberCountriesList$member": null } }, "PhoneNumberError": { "base": "If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
", "refs": { "PhoneNumberErrorList$member": null } }, "PhoneNumberErrorList": { "base": null, "refs": { "BatchDeletePhoneNumberResponse$PhoneNumberErrors": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
", "BatchUpdatePhoneNumberResponse$PhoneNumberErrors": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } }, "PhoneNumberList": { "base": null, "refs": { "ListPhoneNumbersResponse$PhoneNumbers": "The phone number details.
" } }, "PhoneNumberMaxResults": { "base": null, "refs": { "SearchAvailablePhoneNumbersRequest$MaxResults": "The maximum number of results to return in a single call.
" } }, "PhoneNumberOrder": { "base": "The details of a phone number order created for Amazon Chime.
", "refs": { "CreatePhoneNumberOrderResponse$PhoneNumberOrder": "The phone number order details.
", "GetPhoneNumberOrderResponse$PhoneNumberOrder": "The phone number order details.
", "PhoneNumberOrderList$member": null } }, "PhoneNumberOrderList": { "base": null, "refs": { "ListPhoneNumberOrdersResponse$PhoneNumberOrders": "The phone number order details.
" } }, "PhoneNumberOrderStatus": { "base": null, "refs": { "PhoneNumberOrder$Status": "The status of the phone number order.
" } }, "PhoneNumberProductType": { "base": null, "refs": { "CreatePhoneNumberOrderRequest$ProductType": "The phone number product type.
", "ListPhoneNumbersRequest$ProductType": "The phone number product type.
", "ListSupportedPhoneNumberCountriesRequest$ProductType": "The phone number product type.
", "PhoneNumber$ProductType": "The phone number product type.
", "PhoneNumberOrder$ProductType": "The phone number order product type.
", "UpdatePhoneNumberRequest$ProductType": "The product type.
", "UpdatePhoneNumberRequestItem$ProductType": "The product type to update.
" } }, "PhoneNumberStatus": { "base": null, "refs": { "ListPhoneNumbersRequest$Status": "The phone number status.
", "PhoneNumber$Status": "The phone number status.
" } }, "PhoneNumberType": { "base": null, "refs": { "PhoneNumber$Type": "The phone number type.
", "PhoneNumberTypeList$member": null, "SearchAvailablePhoneNumbersRequest$PhoneNumberType": "The phone number type used to filter results. Required for non-US numbers.
" } }, "PhoneNumberTypeList": { "base": null, "refs": { "PhoneNumberCountry$SupportedPhoneNumberTypes": "The supported phone number types.
" } }, "ProfileServiceMaxResults": { "base": null, "refs": { "ListAccountsRequest$MaxResults": "The maximum number of results to return in a single call. Defaults to 100.
", "ListUsersRequest$MaxResults": "The maximum number of results to return in a single call. Defaults to 100.
" } }, "PutEventsConfigurationRequest": { "base": null, "refs": {} }, "PutEventsConfigurationResponse": { "base": null, "refs": {} }, "PutRetentionSettingsRequest": { "base": null, "refs": {} }, "PutRetentionSettingsResponse": { "base": null, "refs": {} }, "RedactConversationMessageRequest": { "base": null, "refs": {} }, "RedactConversationMessageResponse": { "base": null, "refs": {} }, "RedactRoomMessageRequest": { "base": null, "refs": {} }, "RedactRoomMessageResponse": { "base": null, "refs": {} }, "RegenerateSecurityTokenRequest": { "base": null, "refs": {} }, "RegenerateSecurityTokenResponse": { "base": null, "refs": {} }, "RegistrationStatus": { "base": null, "refs": { "User$UserRegistrationStatus": "The user registration status.
" } }, "ResetPersonalPINRequest": { "base": null, "refs": {} }, "ResetPersonalPINResponse": { "base": null, "refs": {} }, "ResourceLimitExceededException": { "base": "The request exceeds the resource limit.
", "refs": {} }, "RestorePhoneNumberRequest": { "base": null, "refs": {} }, "RestorePhoneNumberResponse": { "base": null, "refs": {} }, "ResultMax": { "base": null, "refs": { "ListBotsRequest$MaxResults": "The maximum number of results to return in a single call. The default is 10.
", "ListPhoneNumberOrdersRequest$MaxResults": "The maximum number of results to return in a single call.
", "ListPhoneNumbersRequest$MaxResults": "The maximum number of results to return in a single call.
", "ListRoomMembershipsRequest$MaxResults": "The maximum number of results to return in a single call.
", "ListRoomsRequest$MaxResults": "The maximum number of results to return in a single call.
" } }, "RetentionDays": { "base": null, "refs": { "ConversationRetentionSettings$RetentionDays": "The number of days for which to retain conversation messages.
", "RoomRetentionSettings$RetentionDays": "The number of days for which to retain chat-room messages.
" } }, "RetentionSettings": { "base": "The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.
", "refs": { "GetRetentionSettingsResponse$RetentionSettings": "The retention settings.
", "PutRetentionSettingsRequest$RetentionSettings": "The retention settings.
", "PutRetentionSettingsResponse$RetentionSettings": "The retention settings.
" } }, "Room": { "base": "The Amazon Chime chat room details.
", "refs": { "CreateRoomResponse$Room": "The room details.
", "GetRoomResponse$Room": "The room details.
", "RoomList$member": null, "UpdateRoomResponse$Room": "The room details.
" } }, "RoomList": { "base": null, "refs": { "ListRoomsResponse$Rooms": "The room details.
" } }, "RoomMembership": { "base": "The room membership details.
", "refs": { "CreateRoomMembershipResponse$RoomMembership": "The room membership details.
", "RoomMembershipList$member": null, "UpdateRoomMembershipResponse$RoomMembership": "The room membership details.
" } }, "RoomMembershipList": { "base": null, "refs": { "ListRoomMembershipsResponse$RoomMemberships": "The room membership details.
" } }, "RoomMembershipRole": { "base": null, "refs": { "CreateRoomMembershipRequest$Role": "The role of the member.
", "MembershipItem$Role": "The member role.
", "RoomMembership$Role": "The membership role.
", "UpdateRoomMembershipRequest$Role": "The role of the member.
" } }, "RoomRetentionSettings": { "base": "The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
", "refs": { "RetentionSettings$RoomRetentionSettings": "The chat room retention settings.
" } }, "SearchAvailablePhoneNumbersRequest": { "base": null, "refs": {} }, "SearchAvailablePhoneNumbersResponse": { "base": null, "refs": {} }, "SensitiveString": { "base": null, "refs": { "AlexaForBusinessMetadata$AlexaForBusinessRoomArn": "The ARN of the room resource.
", "Bot$DisplayName": "The bot display name.
", "Bot$BotEmail": "The bot email address.
", "Bot$SecurityToken": "The security token used to authenticate Amazon Chime with the outgoing event endpoint.
", "CreateBotRequest$DisplayName": "The bot display name.
", "CreateRoomRequest$Name": "The room name.
", "EventsConfiguration$OutboundEventsHTTPSEndpoint": "HTTPS endpoint that allows a bot to receive outgoing events.
", "EventsConfiguration$LambdaFunctionArn": "Lambda function ARN that allows a bot to receive outgoing events.
", "Member$Email": "The member email address.
", "Member$FullName": "The member name.
", "PutEventsConfigurationRequest$OutboundEventsHTTPSEndpoint": "HTTPS endpoint that allows the bot to receive outgoing events.
", "PutEventsConfigurationRequest$LambdaFunctionArn": "Lambda function ARN that allows the bot to receive outgoing events.
", "Room$Name": "The room name.
", "UpdateRoomRequest$Name": "The room name.
", "User$PrimaryProvisionedNumber": "The primary phone number associated with the user.
", "User$DisplayName": "The display name of the user.
" } }, "ServiceFailureException": { "base": "The service encountered an unexpected error.
", "refs": {} }, "ServiceUnavailableException": { "base": "The service is currently unavailable.
", "refs": {} }, "SigninDelegateGroup": { "base": "An Active Directory (AD) group whose members are granted permission to act as delegates.
", "refs": { "SigninDelegateGroupList$member": null } }, "SigninDelegateGroupList": { "base": null, "refs": { "Account$SigninDelegateGroups": "The sign-in delegate groups associated with the account.
", "AssociateSigninDelegateGroupsWithAccountRequest$SigninDelegateGroups": "The sign-in delegate groups.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": null, "Account$AwsAccountId": "The AWS account ID.
", "Account$AccountId": "The Amazon Chime account ID.
", "Account$Name": "The Amazon Chime account name.
", "AssociatePhoneNumberWithUserRequest$AccountId": "The Amazon Chime account ID.
", "AssociatePhoneNumberWithUserRequest$UserId": "The user ID.
", "BadRequestException$Message": null, "Bot$BotId": "The bot ID.
", "Bot$UserId": "The unique ID for the bot user.
", "BusinessCallingSettings$CdrBucket": "The Amazon S3 bucket designated for call detail record storage.
", "ConflictException$Message": null, "CreateUserRequest$Username": "The user name.
", "DeletePhoneNumberRequest$PhoneNumberId": "The phone number ID.
", "DisassociatePhoneNumberFromUserRequest$AccountId": "The Amazon Chime account ID.
", "DisassociatePhoneNumberFromUserRequest$UserId": "The user ID.
", "EventsConfiguration$BotId": "The bot ID.
", "ForbiddenException$Message": null, "GetPhoneNumberRequest$PhoneNumberId": "The phone number ID.
", "GetUserSettingsRequest$AccountId": "The Amazon Chime account ID.
", "GetUserSettingsRequest$UserId": "The user ID.
", "Invite$InviteId": "The invite ID.
", "ListAccountsRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListAccountsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListBotsRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListBotsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListPhoneNumberOrdersRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListPhoneNumberOrdersResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListPhoneNumbersRequest$FilterValue": "The value to use for the filter.
", "ListPhoneNumbersRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListPhoneNumbersResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListRoomMembershipsRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListRoomMembershipsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListRoomsRequest$MemberId": "The member ID (user ID or bot ID).
", "ListRoomsRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListRoomsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListUsersRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListUsersResponse$NextToken": "The token to use to retrieve the next page of results.
", "MemberError$ErrorMessage": "The error message.
", "NonEmptyStringList$member": null, "NotFoundException$Message": null, "PhoneNumber$PhoneNumberId": "The phone number ID.
", "PhoneNumberAssociation$Value": "Contains the ID for the entity specified in Name.
", "PhoneNumberError$ErrorMessage": "The error message.
", "ResourceLimitExceededException$Message": null, "SearchAvailablePhoneNumbersRequest$AreaCode": "The area code used to filter results. Only applies to the US.
", "SearchAvailablePhoneNumbersRequest$City": "The city used to filter results. Only applies to the US.
", "SearchAvailablePhoneNumbersRequest$State": "The state used to filter results. Required only if you provide City. Only applies to the US.
The token used to retrieve the next page of results.
", "SearchAvailablePhoneNumbersResponse$NextToken": "The token used to retrieve the next page of search results.
", "ServiceFailureException$Message": null, "ServiceUnavailableException$Message": null, "ThrottledClientException$Message": null, "UnauthorizedClientException$Message": null, "UnprocessableEntityException$Message": null, "UpdatePhoneNumberRequest$PhoneNumberId": "The phone number ID.
", "UpdateUserSettingsRequest$AccountId": "The Amazon Chime account ID.
", "UpdateUserSettingsRequest$UserId": "The user ID.
", "User$UserId": "The user ID.
", "User$AccountId": "The Amazon Chime account ID.
", "User$PersonalPIN": "The user's personal meeting PIN.
", "UserError$ErrorMessage": "The error message.
", "VoiceConnectorSettings$CdrBucket": "The Amazon S3 bucket designated for call detail record storage.
" } }, "TelephonySettings": { "base": "Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.
", "refs": { "UserSettings$Telephony": "The telephony settings associated with the user.
" } }, "ThrottledClientException": { "base": "The client exceeded its request rate limit.
", "refs": {} }, "TollFreePrefix": { "base": null, "refs": { "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "The toll-free prefix that you use to filter results. Only applies to the US.
" } }, "UnauthorizedClientException": { "base": "The client is not currently authorized to make the request.
", "refs": {} }, "UnprocessableEntityException": { "base": "The request was well-formed but was unable to be followed due to semantic errors.
", "refs": {} }, "UpdateAccountRequest": { "base": null, "refs": {} }, "UpdateAccountResponse": { "base": null, "refs": {} }, "UpdateAccountSettingsRequest": { "base": null, "refs": {} }, "UpdateAccountSettingsResponse": { "base": null, "refs": {} }, "UpdateBotRequest": { "base": null, "refs": {} }, "UpdateBotResponse": { "base": null, "refs": {} }, "UpdateGlobalSettingsRequest": { "base": null, "refs": {} }, "UpdatePhoneNumberRequest": { "base": null, "refs": {} }, "UpdatePhoneNumberRequestItem": { "base": "The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
", "refs": { "UpdatePhoneNumberRequestItemList$member": null } }, "UpdatePhoneNumberRequestItemList": { "base": null, "refs": { "BatchUpdatePhoneNumberRequest$UpdatePhoneNumberRequestItems": "The request containing the phone number IDs and product types or calling names to update.
" } }, "UpdatePhoneNumberResponse": { "base": null, "refs": {} }, "UpdatePhoneNumberSettingsRequest": { "base": null, "refs": {} }, "UpdateRoomMembershipRequest": { "base": null, "refs": {} }, "UpdateRoomMembershipResponse": { "base": null, "refs": {} }, "UpdateRoomRequest": { "base": null, "refs": {} }, "UpdateRoomResponse": { "base": null, "refs": {} }, "UpdateUserRequest": { "base": null, "refs": {} }, "UpdateUserRequestItem": { "base": "The user ID and user fields to update, used with the BatchUpdateUser action.
", "refs": { "UpdateUserRequestItemList$member": null } }, "UpdateUserRequestItemList": { "base": null, "refs": { "BatchUpdateUserRequest$UpdateUserRequestItems": "The request containing the user IDs and details to update.
" } }, "UpdateUserResponse": { "base": null, "refs": {} }, "UpdateUserSettingsRequest": { "base": null, "refs": {} }, "User": { "base": "The user on the Amazon Chime account.
", "refs": { "CreateUserResponse$User": "The user on the Amazon Chime account.
", "GetUserResponse$User": "The user details.
", "ResetPersonalPINResponse$User": "The user details and new personal meeting PIN.
", "UpdateUserResponse$User": "The updated user details.
", "UserList$member": null } }, "UserEmailList": { "base": null, "refs": { "InviteUsersRequest$UserEmailList": "The user email addresses to which to send the email invitation.
" } }, "UserError": { "base": "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.
", "refs": { "UserErrorList$member": null } }, "UserErrorList": { "base": null, "refs": { "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.
", "BatchUnsuspendUserResponse$UserErrors": "If the BatchUnsuspendUser 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.
", "BatchUpdateUserResponse$UserErrors": "If the BatchUpdateUser 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.
" } }, "UserIdList": { "base": null, "refs": { "BatchSuspendUserRequest$UserIdList": "The request containing the user IDs to suspend.
", "BatchUnsuspendUserRequest$UserIdList": "The request containing the user IDs to unsuspend.
" } }, "UserList": { "base": null, "refs": { "ListUsersResponse$Users": "List of users and user details.
" } }, "UserSettings": { "base": "Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
", "refs": { "GetUserSettingsResponse$UserSettings": "The user settings.
", "UpdateUserSettingsRequest$UserSettings": "The user settings to update.
" } }, "UserType": { "base": null, "refs": { "CreateUserRequest$UserType": "The user type.
", "InviteUsersRequest$UserType": "The user type.
", "ListUsersRequest$UserType": "The user type.
", "UpdateUserRequest$UserType": "The user type.
", "UpdateUserRequestItem$UserType": "The user type.
", "User$UserType": "The user type.
" } }, "VoiceConnectorSettings": { "base": "The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
", "refs": { "GetGlobalSettingsResponse$VoiceConnector": "The Amazon Chime Voice Connector settings.
", "UpdateGlobalSettingsRequest$VoiceConnector": "The Amazon Chime Voice Connector settings.
" } } } }