Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Chime can respond with.

Structs

Account

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

AccountSettings

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.

AlexaForBusinessMetadata

The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.

Bot

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

BusinessCallingSettings

The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.

ConversationRetentionSettings

The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.

EventsConfiguration

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

Invite

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

Member

The member details, such as email address, name, member ID, and member type.

MemberError

The list of errors returned when a member action results in an error.

MembershipItem

Membership details, such as member ID and member role.

OrderedPhoneNumber

A phone number for which an order has been placed.

PhoneNumber

A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

PhoneNumberAssociation

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.

PhoneNumberCapabilities

The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.

PhoneNumberCountry

The phone number country.

PhoneNumberError

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.

PhoneNumberOrder

The details of a phone number order created for Amazon Chime.

RetentionSettings

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.

Room

The Amazon Chime chat room details.

RoomMembership

The room membership details.

RoomRetentionSettings

The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.

SigninDelegateGroup

An Active Directory (AD) group whose members are granted permission to act as delegates.

TelephonySettings

Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.

UpdatePhoneNumberRequestItem

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

UpdateUserRequestItem

The user ID and user fields to update, used with the BatchUpdateUser action.

User

The user on the Amazon Chime account.

UserError

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.

UserSettings

Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.

VoiceConnectorSettings

The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

Enums

AccountStatus

When writing a match expression against AccountStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AccountType

When writing a match expression against AccountType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

BotType

When writing a match expression against BotType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CallingNameStatus

When writing a match expression against CallingNameStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EmailStatus

When writing a match expression against EmailStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ErrorCode

When writing a match expression against ErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InviteStatus

When writing a match expression against InviteStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

License

When writing a match expression against License, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MemberType

When writing a match expression against MemberType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OrderedPhoneNumberStatus

When writing a match expression against OrderedPhoneNumberStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberAssociationName

When writing a match expression against PhoneNumberAssociationName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberOrderStatus

When writing a match expression against PhoneNumberOrderStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberProductType

When writing a match expression against PhoneNumberProductType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberStatus

When writing a match expression against PhoneNumberStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberType

When writing a match expression against PhoneNumberType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RegistrationStatus

When writing a match expression against RegistrationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RoomMembershipRole

When writing a match expression against RoomMembershipRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UserType

When writing a match expression against UserType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.