AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

You don't have permissions to perform the requested operation.

Class Account

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

Class 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.

Class Address

A validated address.

Class AlexaForBusinessMetadata

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

Class AppInstance

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Class AppInstanceAdmin

The details of an AppInstanceAdmin.

Class AppInstanceAdminSummary

Summary of the details of an AppInstanceAdmin.

Class AppInstanceRetentionSettings

The details of the data-retention settings for an AppInstance.

Class AppInstanceStreamingConfiguration

The details of the streaming configuration of an AppInstance.

Class AppInstanceSummary

Summary of the data for an AppInstance.

Class AppInstanceUser

The details of an AppInstanceUser.

Class AppInstanceUserMembershipSummary

Summary of the membership details of an AppInstanceUser.

Class AppInstanceUserSummary

Summary of the details of an AppInstanceUser.

Class ArtifactsConfiguration

The configuration for the artifacts.

Class AssociatePhoneNumbersWithVoiceConnectorGroupRequest

Container for the parameters to the AssociatePhoneNumbersWithVoiceConnectorGroup operation. Associates phone numbers with the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class AssociatePhoneNumbersWithVoiceConnectorGroupResponse

This is the response object from the AssociatePhoneNumbersWithVoiceConnectorGroup operation.

Class AssociatePhoneNumbersWithVoiceConnectorRequest

Container for the parameters to the AssociatePhoneNumbersWithVoiceConnector operation. Associates phone numbers with the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class AssociatePhoneNumbersWithVoiceConnectorResponse

This is the response object from the AssociatePhoneNumbersWithVoiceConnector operation.

Class AssociatePhoneNumberWithUserRequest

Container for the parameters to the AssociatePhoneNumberWithUser operation. Associates a phone number with the specified Amazon Chime user.

Class AssociatePhoneNumberWithUserResponse

This is the response object from the AssociatePhoneNumberWithUser operation.

Class AssociateSigninDelegateGroupsWithAccountRequest

Container for the parameters to the AssociateSigninDelegateGroupsWithAccount operation. Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Class AssociateSigninDelegateGroupsWithAccountResponse

This is the response object from the AssociateSigninDelegateGroupsWithAccount operation.

Class Attendee

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

Class AudioArtifactsConfiguration

The audio artifact configuration object.

Class BadRequestException

The input parameters don't match the service's restrictions.

Class BatchChannelMemberships

The membership information, including member ARNs, the channel ARN, and membership types.

Class BatchCreateAttendeeRequest

Container for the parameters to the BatchCreateAttendee operation. Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Class BatchCreateAttendeeResponse

This is the response object from the BatchCreateAttendee operation.

Class BatchCreateChannelMembershipError

A list of failed member ARNs, error codes, and error messages.

Class BatchCreateChannelMembershipRequest

Container for the parameters to the BatchCreateChannelMembership operation. Adds a specified number of users to a channel.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class BatchCreateChannelMembershipResponse

This is the response object from the BatchCreateChannelMembership operation.

Class BatchCreateRoomMembershipRequest

Container for the parameters to the BatchCreateRoomMembership operation. 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.

Class BatchCreateRoomMembershipResponse

This is the response object from the BatchCreateRoomMembership operation.

Class BatchDeletePhoneNumberRequest

Container for the parameters to the BatchDeletePhoneNumber operation. 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.

Class BatchDeletePhoneNumberResponse

This is the response object from the BatchDeletePhoneNumber operation.

Class BatchSuspendUserRequest

Container for the parameters to the BatchSuspendUser operation. 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.

Class BatchSuspendUserResponse

This is the response object from the BatchSuspendUser operation.

Class BatchUnsuspendUserRequest

Container for the parameters to the BatchUnsuspendUser operation. 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.

Class BatchUnsuspendUserResponse

This is the response object from the BatchUnsuspendUser operation.

Class BatchUpdatePhoneNumberRequest

Container for the parameters to the BatchUpdatePhoneNumber operation. 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.

Class BatchUpdatePhoneNumberResponse

This is the response object from the BatchUpdatePhoneNumber operation.

Class BatchUpdateUserRequest

Container for the parameters to the BatchUpdateUser operation. 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.

Class BatchUpdateUserResponse

This is the response object from the BatchUpdateUser operation.

Class Bot

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

Class BusinessCallingSettings

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

Class CandidateAddress

A suggested address.

Class Channel

The details of a channel.

Class ChannelBan

The details of a channel ban.

Class ChannelBanSummary

Summary of the details of a ChannelBan.

Class ChannelMembership

The details of a channel member.

Class ChannelMembershipForAppInstanceUserSummary

Summary of the channel membership details of an AppInstanceUser.

Class ChannelMembershipSummary

Summary of the details of a ChannelMembership.

Class ChannelMessage

The details of a message in a channel.

Class ChannelMessageSummary

Summary of the messages in a Channel.

Class ChannelModeratedByAppInstanceUserSummary

Summary of the details of a moderated channel.

Class ChannelModerator

The details of a channel moderator.

Class ChannelModeratorSummary

Summary of the details of a ChannelModerator.

Class ChannelRetentionSettings

The details of the retention settings for a channel.

Class ChannelSummary

Summary of the details of a Channel.

Class ChimePaginatorFactory

Paginators for the Chime service

Class ChimeSdkMeetingConfiguration

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Class ConflictException

The request could not be processed because of conflict in the current state of the resource.

Class ContentArtifactsConfiguration

The content artifact object.

Class ConversationRetentionSettings

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

Class CreateAccountRequest

Container for the parameters to the CreateAccount operation. 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.

Class CreateAccountResponse

This is the response object from the CreateAccount operation.

Class CreateAppInstanceAdminRequest

Container for the parameters to the CreateAppInstanceAdmin operation. Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Class CreateAppInstanceAdminResponse

This is the response object from the CreateAppInstanceAdmin operation.

Class CreateAppInstanceRequest

Container for the parameters to the CreateAppInstance operation. Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateAppInstanceResponse

This is the response object from the CreateAppInstance operation.

Class CreateAppInstanceUserRequest

Container for the parameters to the CreateAppInstanceUser operation. Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateAppInstanceUserResponse

This is the response object from the CreateAppInstanceUser operation.

Class CreateAttendeeError

The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

Class CreateAttendeeRequest

Container for the parameters to the CreateAttendee operation. Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateAttendeeRequestItem

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

Class CreateAttendeeResponse

This is the response object from the CreateAttendee operation.

Class CreateBotRequest

Container for the parameters to the CreateBot operation. Creates a bot for an Amazon Chime Enterprise account.

Class CreateBotResponse

This is the response object from the CreateBot operation.

Class CreateChannelBanRequest

Container for the parameters to the CreateChannelBan operation. Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateChannelBanResponse

This is the response object from the CreateChannelBan operation.

Class CreateChannelMembershipRequest

Container for the parameters to the CreateChannelMembership operation. Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateChannelMembershipResponse

This is the response object from the CreateChannelMembership operation.

Class CreateChannelModeratorRequest

Container for the parameters to the CreateChannelModerator operation. Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateChannelModeratorResponse

This is the response object from the CreateChannelModerator operation.

Class CreateChannelRequest

Container for the parameters to the CreateChannel operation. Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateChannelResponse

This is the response object from the CreateChannel operation.

Class CreateMediaCapturePipelineRequest

Container for the parameters to the CreateMediaCapturePipeline operation. Creates a media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateMediaCapturePipelineResponse

This is the response object from the CreateMediaCapturePipeline operation.

Class CreateMeetingDialOutRequest

Container for the parameters to the CreateMeetingDialOut operation. 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 is not available in a dedicated namespace.

Class CreateMeetingDialOutResponse

This is the response object from the CreateMeetingDialOut operation.

Class CreateMeetingRequest

Container for the parameters to the CreateMeeting operation. Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateMeetingResponse

This is the response object from the CreateMeeting operation.

Class CreateMeetingWithAttendeesRequest

Container for the parameters to the CreateMeetingWithAttendees operation. Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateMeetingWithAttendeesResponse

This is the response object from the CreateMeetingWithAttendees operation.

Class CreatePhoneNumberOrderRequest

Container for the parameters to the CreatePhoneNumberOrder operation. 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.

Class CreatePhoneNumberOrderResponse

This is the response object from the CreatePhoneNumberOrder operation.

Class CreateProxySessionRequest

Container for the parameters to the CreateProxySession operation. Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateProxySessionResponse

This is the response object from the CreateProxySession operation.

Class CreateRoomMembershipRequest

Container for the parameters to the CreateRoomMembership operation. 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.

Class CreateRoomMembershipResponse

This is the response object from the CreateRoomMembership operation.

Class CreateRoomRequest

Container for the parameters to the CreateRoom operation. Creates a chat room for the specified Amazon Chime Enterprise account.

Class CreateRoomResponse

This is the response object from the CreateRoom operation.

Class CreateSipMediaApplicationCallRequest

Container for the parameters to the CreateSipMediaApplicationCall operation. Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateSipMediaApplicationCallResponse

This is the response object from the CreateSipMediaApplicationCall operation.

Class CreateSipMediaApplicationRequest

Container for the parameters to the CreateSipMediaApplication operation. Creates a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateSipMediaApplicationResponse

This is the response object from the CreateSipMediaApplication operation.

Class CreateSipRuleRequest

Container for the parameters to the CreateSipRule operation. Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateSipRuleResponse

This is the response object from the CreateSipRule operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a user under the specified Amazon Chime account.

Class CreateUserResponse

This is the response object from the CreateUser operation.

Class CreateVoiceConnectorGroupRequest

Container for the parameters to the CreateVoiceConnectorGroup operation. Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateVoiceConnectorGroupResponse

This is the response object from the CreateVoiceConnectorGroup operation.

Class CreateVoiceConnectorRequest

Container for the parameters to the CreateVoiceConnector operation. Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class CreateVoiceConnectorResponse

This is the response object from the CreateVoiceConnector operation.

Class Credential

The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

Class DeleteAccountRequest

Container for the parameters to the DeleteAccount operation. 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.

Class DeleteAccountResponse

This is the response object from the DeleteAccount operation.

Class DeleteAppInstanceAdminRequest

Container for the parameters to the DeleteAppInstanceAdmin operation. Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteAppInstanceAdminResponse

This is the response object from the DeleteAppInstanceAdmin operation.

Class DeleteAppInstanceRequest

Container for the parameters to the DeleteAppInstance operation. Deletes an AppInstance and all associated data asynchronously.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteAppInstanceResponse

This is the response object from the DeleteAppInstance operation.

Class DeleteAppInstanceStreamingConfigurationsRequest

Container for the parameters to the DeleteAppInstanceStreamingConfigurations operation. Deletes the streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteAppInstanceStreamingConfigurationsResponse

This is the response object from the DeleteAppInstanceStreamingConfigurations operation.

Class DeleteAppInstanceUserRequest

Container for the parameters to the DeleteAppInstanceUser operation. Deletes an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteAppInstanceUserResponse

This is the response object from the DeleteAppInstanceUser operation.

Class DeleteAttendeeRequest

Container for the parameters to the DeleteAttendee operation. Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteAttendeeResponse

This is the response object from the DeleteAttendee operation.

Class DeleteChannelBanRequest

Container for the parameters to the DeleteChannelBan operation. Removes a user from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteChannelBanResponse

This is the response object from the DeleteChannelBan operation.

Class DeleteChannelMembershipRequest

Container for the parameters to the DeleteChannelMembership operation. Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteChannelMembershipResponse

This is the response object from the DeleteChannelMembership operation.

Class DeleteChannelMessageRequest

Container for the parameters to the DeleteChannelMessage operation. Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteChannelMessageResponse

This is the response object from the DeleteChannelMessage operation.

Class DeleteChannelModeratorRequest

Container for the parameters to the DeleteChannelModerator operation. Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteChannelModeratorResponse

This is the response object from the DeleteChannelModerator operation.

Class DeleteChannelRequest

Container for the parameters to the DeleteChannel operation. Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteChannelResponse

This is the response object from the DeleteChannel operation.

Class DeleteEventsConfigurationRequest

Container for the parameters to the DeleteEventsConfiguration operation. Deletes the events configuration that allows a bot to receive outgoing events.

Class DeleteEventsConfigurationResponse

This is the response object from the DeleteEventsConfiguration operation.

Class DeleteMediaCapturePipelineRequest

Container for the parameters to the DeleteMediaCapturePipeline operation. Deletes the media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteMediaCapturePipelineResponse

This is the response object from the DeleteMediaCapturePipeline operation.

Class DeleteMeetingRequest

Container for the parameters to the DeleteMeeting operation. Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteMeetingResponse

This is the response object from the DeleteMeeting operation.

Class DeletePhoneNumberRequest

Container for the parameters to the DeletePhoneNumber operation. 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.

Class DeletePhoneNumberResponse

This is the response object from the DeletePhoneNumber operation.

Class DeleteProxySessionRequest

Container for the parameters to the DeleteProxySession operation. Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteProxySessionResponse

This is the response object from the DeleteProxySession operation.

Class DeleteRoomMembershipRequest

Container for the parameters to the DeleteRoomMembership operation. Removes a member from a chat room in an Amazon Chime Enterprise account.

Class DeleteRoomMembershipResponse

This is the response object from the DeleteRoomMembership operation.

Class DeleteRoomRequest

Container for the parameters to the DeleteRoom operation. Deletes a chat room in an Amazon Chime Enterprise account.

Class DeleteRoomResponse

This is the response object from the DeleteRoom operation.

Class DeleteSipMediaApplicationRequest

Container for the parameters to the DeleteSipMediaApplication operation. Deletes a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteSipMediaApplicationResponse

This is the response object from the DeleteSipMediaApplication operation.

Class DeleteSipRuleRequest

Container for the parameters to the DeleteSipRule operation. Deletes a SIP rule. You must disable a SIP rule before you can delete it.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteSipRuleResponse

This is the response object from the DeleteSipRule operation.

Class DeleteVoiceConnectorEmergencyCallingConfigurationRequest

Container for the parameters to the DeleteVoiceConnectorEmergencyCallingConfiguration operation. Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorEmergencyCallingConfigurationResponse

This is the response object from the DeleteVoiceConnectorEmergencyCallingConfiguration operation.

Class DeleteVoiceConnectorGroupRequest

Container for the parameters to the DeleteVoiceConnectorGroup operation. Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorGroupResponse

This is the response object from the DeleteVoiceConnectorGroup operation.

Class DeleteVoiceConnectorOriginationRequest

Container for the parameters to the DeleteVoiceConnectorOrigination operation. Deletes the origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorOriginationResponse

This is the response object from the DeleteVoiceConnectorOrigination operation.

Class DeleteVoiceConnectorProxyRequest

Container for the parameters to the DeleteVoiceConnectorProxy operation. Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorProxyResponse

This is the response object from the DeleteVoiceConnectorProxy operation.

Class DeleteVoiceConnectorRequest

Container for the parameters to the DeleteVoiceConnector operation. Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorResponse

This is the response object from the DeleteVoiceConnector operation.

Class DeleteVoiceConnectorStreamingConfigurationRequest

Container for the parameters to the DeleteVoiceConnectorStreamingConfiguration operation. Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorStreamingConfigurationResponse

This is the response object from the DeleteVoiceConnectorStreamingConfiguration operation.

Class DeleteVoiceConnectorTerminationCredentialsRequest

Container for the parameters to the DeleteVoiceConnectorTerminationCredentials operation. Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorTerminationCredentialsResponse

This is the response object from the DeleteVoiceConnectorTerminationCredentials operation.

Class DeleteVoiceConnectorTerminationRequest

Container for the parameters to the DeleteVoiceConnectorTermination operation. Deletes the termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DeleteVoiceConnectorTerminationResponse

This is the response object from the DeleteVoiceConnectorTermination operation.

Class DescribeAppInstanceAdminRequest

Container for the parameters to the DescribeAppInstanceAdmin operation. Returns the full details of an AppInstanceAdmin.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeAppInstanceAdminResponse

This is the response object from the DescribeAppInstanceAdmin operation.

Class DescribeAppInstanceRequest

Container for the parameters to the DescribeAppInstance operation. Returns the full details of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeAppInstanceResponse

This is the response object from the DescribeAppInstance operation.

Class DescribeAppInstanceUserRequest

Container for the parameters to the DescribeAppInstanceUser operation. Returns the full details of an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeAppInstanceUserResponse

This is the response object from the DescribeAppInstanceUser operation.

Class DescribeChannelBanRequest

Container for the parameters to the DescribeChannelBan operation. Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelBanResponse

This is the response object from the DescribeChannelBan operation.

Class DescribeChannelMembershipForAppInstanceUserRequest

Container for the parameters to the DescribeChannelMembershipForAppInstanceUser operation. Returns the details of a channel based on the membership of the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelMembershipForAppInstanceUserResponse

This is the response object from the DescribeChannelMembershipForAppInstanceUser operation.

Class DescribeChannelMembershipRequest

Container for the parameters to the DescribeChannelMembership operation. Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelMembershipResponse

This is the response object from the DescribeChannelMembership operation.

Class DescribeChannelModeratedByAppInstanceUserRequest

Container for the parameters to the DescribeChannelModeratedByAppInstanceUser operation. Returns the full details of a channel moderated by the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelModeratedByAppInstanceUserResponse

This is the response object from the DescribeChannelModeratedByAppInstanceUser operation.

Class DescribeChannelModeratorRequest

Container for the parameters to the DescribeChannelModerator operation. Returns the full details of a single ChannelModerator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelModeratorResponse

This is the response object from the DescribeChannelModerator operation.

Class DescribeChannelRequest

Container for the parameters to the DescribeChannel operation. Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DescribeChannelResponse

This is the response object from the DescribeChannel operation.

Class DisassociatePhoneNumberFromUserRequest

Container for the parameters to the DisassociatePhoneNumberFromUser operation. Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Class DisassociatePhoneNumberFromUserResponse

This is the response object from the DisassociatePhoneNumberFromUser operation.

Class DisassociatePhoneNumbersFromVoiceConnectorGroupRequest

Container for the parameters to the DisassociatePhoneNumbersFromVoiceConnectorGroup operation. Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DisassociatePhoneNumbersFromVoiceConnectorGroupResponse

This is the response object from the DisassociatePhoneNumbersFromVoiceConnectorGroup operation.

Class DisassociatePhoneNumbersFromVoiceConnectorRequest

Container for the parameters to the DisassociatePhoneNumbersFromVoiceConnector operation. Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class DisassociatePhoneNumbersFromVoiceConnectorResponse

This is the response object from the DisassociatePhoneNumbersFromVoiceConnector operation.

Class DisassociateSigninDelegateGroupsFromAccountRequest

Container for the parameters to the DisassociateSigninDelegateGroupsFromAccount operation. Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Class DisassociateSigninDelegateGroupsFromAccountResponse

This is the response object from the DisassociateSigninDelegateGroupsFromAccount operation.

Class DNISEmergencyCallingConfiguration

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

Class EmergencyCallingConfiguration

The emergency calling configuration details associated with an Amazon Chime Voice Connector.

Class EngineTranscribeMedicalSettings

Settings specific to the Amazon Transcribe Medical engine.

Class EngineTranscribeSettings

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Class EventsConfiguration

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

Class ForbiddenException

The client is permanently forbidden from making the request.

Class GeoMatchParams

The country and area code for a proxy phone number in a proxy phone session.

Class GetAccountRequest

Container for the parameters to the GetAccount operation. Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Class GetAccountResponse

This is the response object from the GetAccount operation.

Class GetAccountSettingsRequest

Container for the parameters to the GetAccountSettings operation. 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.

Class GetAccountSettingsResponse

This is the response object from the GetAccountSettings operation.

Class GetAppInstanceRetentionSettingsRequest

Container for the parameters to the GetAppInstanceRetentionSettings operation. Gets the retention settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetAppInstanceRetentionSettingsResponse

This is the response object from the GetAppInstanceRetentionSettings operation.

Class GetAppInstanceStreamingConfigurationsRequest

Container for the parameters to the GetAppInstanceStreamingConfigurations operation. Gets the streaming settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetAppInstanceStreamingConfigurationsResponse

This is the response object from the GetAppInstanceStreamingConfigurations operation.

Class GetAttendeeRequest

Container for the parameters to the GetAttendee operation. Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetAttendeeResponse

This is the response object from the GetAttendee operation.

Class GetBotRequest

Container for the parameters to the GetBot operation. Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Class GetBotResponse

This is the response object from the GetBot operation.

Class GetChannelMessageRequest

Container for the parameters to the GetChannelMessage operation. Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetChannelMessageResponse

This is the response object from the GetChannelMessage operation.

Class GetEventsConfigurationRequest

Container for the parameters to the GetEventsConfiguration operation. Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Class GetEventsConfigurationResponse

This is the response object from the GetEventsConfiguration operation.

Class GetGlobalSettingsRequest

Container for the parameters to the GetGlobalSettings operation. Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Class GetGlobalSettingsResponse

This is the response object from the GetGlobalSettings operation.

Class GetMediaCapturePipelineRequest

Container for the parameters to the GetMediaCapturePipeline operation. Gets an existing media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetMediaCapturePipelineResponse

This is the response object from the GetMediaCapturePipeline operation.

Class GetMeetingRequest

Container for the parameters to the GetMeeting operation.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Class GetMeetingResponse

This is the response object from the GetMeeting operation.

Class GetMessagingSessionEndpointRequest

Container for the parameters to the GetMessagingSessionEndpoint operation. The details of the endpoint for the messaging session.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetMessagingSessionEndpointResponse

This is the response object from the GetMessagingSessionEndpoint operation.

Class GetPhoneNumberOrderRequest

Container for the parameters to the GetPhoneNumberOrder operation. 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.

Class GetPhoneNumberOrderResponse

This is the response object from the GetPhoneNumberOrder operation.

Class GetPhoneNumberRequest

Container for the parameters to the GetPhoneNumber operation. Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Class GetPhoneNumberResponse

This is the response object from the GetPhoneNumber operation.

Class GetPhoneNumberSettingsRequest

Container for the parameters to the GetPhoneNumberSettings operation. Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Class GetPhoneNumberSettingsResponse

This is the response object from the GetPhoneNumberSettings operation.

Class GetProxySessionRequest

Container for the parameters to the GetProxySession operation. Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetProxySessionResponse

This is the response object from the GetProxySession operation.

Class GetRetentionSettingsRequest

Container for the parameters to the GetRetentionSettings operation. 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.

Class GetRetentionSettingsResponse

This is the response object from the GetRetentionSettings operation.

Class GetRoomRequest

Container for the parameters to the GetRoom operation. Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Class GetRoomResponse

This is the response object from the GetRoom operation.

Class GetSipMediaApplicationLoggingConfigurationRequest

Container for the parameters to the GetSipMediaApplicationLoggingConfiguration operation. Returns the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetSipMediaApplicationLoggingConfigurationResponse

This is the response object from the GetSipMediaApplicationLoggingConfiguration operation.

Class GetSipMediaApplicationRequest

Container for the parameters to the GetSipMediaApplication operation. Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetSipMediaApplicationResponse

This is the response object from the GetSipMediaApplication operation.

Class GetSipRuleRequest

Container for the parameters to the GetSipRule operation. Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetSipRuleResponse

This is the response object from the GetSipRule operation.

Class GetUserRequest

Container for the parameters to the GetUser operation. 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.

Class GetUserResponse

This is the response object from the GetUser operation.

Class GetUserSettingsRequest

Container for the parameters to the GetUserSettings operation. Retrieves settings for the specified user ID, such as any associated phone number settings.

Class GetUserSettingsResponse

This is the response object from the GetUserSettings operation.

Class GetVoiceConnectorEmergencyCallingConfigurationRequest

Container for the parameters to the GetVoiceConnectorEmergencyCallingConfiguration operation. Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorEmergencyCallingConfigurationResponse

This is the response object from the GetVoiceConnectorEmergencyCallingConfiguration operation.

Class GetVoiceConnectorGroupRequest

Container for the parameters to the GetVoiceConnectorGroup operation. Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorGroupResponse

This is the response object from the GetVoiceConnectorGroup operation.

Class GetVoiceConnectorLoggingConfigurationRequest

Container for the parameters to the GetVoiceConnectorLoggingConfiguration operation. Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorLoggingConfigurationResponse

This is the response object from the GetVoiceConnectorLoggingConfiguration operation.

Class GetVoiceConnectorOriginationRequest

Container for the parameters to the GetVoiceConnectorOrigination operation. Retrieves origination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorOriginationResponse

This is the response object from the GetVoiceConnectorOrigination operation.

Class GetVoiceConnectorProxyRequest

Container for the parameters to the GetVoiceConnectorProxy operation. Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorProxyResponse

This is the response object from the GetVoiceConnectorProxy operation.

Class GetVoiceConnectorRequest

Container for the parameters to the GetVoiceConnector operation. Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorResponse

This is the response object from the GetVoiceConnector operation.

Class GetVoiceConnectorStreamingConfigurationRequest

Container for the parameters to the GetVoiceConnectorStreamingConfiguration operation. Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorStreamingConfigurationResponse

This is the response object from the GetVoiceConnectorStreamingConfiguration operation.

Class GetVoiceConnectorTerminationHealthRequest

Container for the parameters to the GetVoiceConnectorTerminationHealth operation.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Class GetVoiceConnectorTerminationHealthResponse

This is the response object from the GetVoiceConnectorTerminationHealth operation.

Class GetVoiceConnectorTerminationRequest

Container for the parameters to the GetVoiceConnectorTermination operation. Retrieves termination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class GetVoiceConnectorTerminationResponse

This is the response object from the GetVoiceConnectorTermination operation.

Class Identity

The details of a user.

Class Invite

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

Class InviteUsersRequest

Container for the parameters to the InviteUsers operation. 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.

Class InviteUsersResponse

This is the response object from the InviteUsers operation.

Class ListAccountsRequest

Container for the parameters to the ListAccounts operation. 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.

Class ListAccountsResponse

This is the response object from the ListAccounts operation.

Class ListAppInstanceAdminsRequest

Container for the parameters to the ListAppInstanceAdmins operation. Returns a list of the administrators in the AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListAppInstanceAdminsResponse

This is the response object from the ListAppInstanceAdmins operation.

Class ListAppInstancesRequest

Container for the parameters to the ListAppInstances operation. Lists all Amazon Chime AppInstances created under a single AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListAppInstancesResponse

This is the response object from the ListAppInstances operation.

Class ListAppInstanceUsersRequest

Container for the parameters to the ListAppInstanceUsers operation. List all AppInstanceUsers created under a single AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListAppInstanceUsersResponse

This is the response object from the ListAppInstanceUsers operation.

Class ListAttendeesRequest

Container for the parameters to the ListAttendees operation. Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListAttendeesResponse

This is the response object from the ListAttendees operation.

Class ListAttendeeTagsRequest

Container for the parameters to the ListAttendeeTags operation. Lists the tags applied to an Amazon Chime SDK attendee resource.

ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Class ListAttendeeTagsResponse

This is the response object from the ListAttendeeTags operation.

Class ListBotsRequest

Container for the parameters to the ListBots operation. Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Class ListBotsResponse

This is the response object from the ListBots operation.

Class ListChannelBansRequest

Container for the parameters to the ListChannelBans operation. Lists all the users banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelBansResponse

This is the response object from the ListChannelBans operation.

Class ListChannelMembershipsForAppInstanceUserRequest

Container for the parameters to the ListChannelMembershipsForAppInstanceUser operation. Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelMembershipsForAppInstanceUserResponse

This is the response object from the ListChannelMembershipsForAppInstanceUser operation.

Class ListChannelMembershipsRequest

Container for the parameters to the ListChannelMemberships operation. Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelMembershipsResponse

This is the response object from the ListChannelMemberships operation.

Class ListChannelMessagesRequest

Container for the parameters to the ListChannelMessages operation. List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelMessagesResponse

This is the response object from the ListChannelMessages operation.

Class ListChannelModeratorsRequest

Container for the parameters to the ListChannelModerators operation. Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelModeratorsResponse

This is the response object from the ListChannelModerators operation.

Class ListChannelsModeratedByAppInstanceUserRequest

Container for the parameters to the ListChannelsModeratedByAppInstanceUser operation. A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelsModeratedByAppInstanceUserResponse

This is the response object from the ListChannelsModeratedByAppInstanceUser operation.

Class ListChannelsRequest

Container for the parameters to the ListChannels operation. Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

  • Use privacy = PUBLIC to retrieve all public channels in the account.

  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListChannelsResponse

This is the response object from the ListChannels operation.

Class ListMediaCapturePipelinesRequest

Container for the parameters to the ListMediaCapturePipelines operation. Returns a list of media capture pipelines.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListMediaCapturePipelinesResponse

This is the response object from the ListMediaCapturePipelines operation.

Class ListMeetingsRequest

Container for the parameters to the ListMeetings operation. Lists up to 100 active Amazon Chime SDK meetings.

ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Class ListMeetingsResponse

This is the response object from the ListMeetings operation.

Class ListMeetingTagsRequest

Container for the parameters to the ListMeetingTags operation. Lists the tags applied to an Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListMeetingTagsResponse

This is the response object from the ListMeetingTags operation.

Class ListPhoneNumberOrdersRequest

Container for the parameters to the ListPhoneNumberOrders operation. Lists the phone number orders for the administrator's Amazon Chime account.

Class ListPhoneNumberOrdersResponse

This is the response object from the ListPhoneNumberOrders operation.

Class ListPhoneNumbersRequest

Container for the parameters to the ListPhoneNumbers operation. Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Class ListPhoneNumbersResponse

This is the response object from the ListPhoneNumbers operation.

Class ListProxySessionsRequest

Container for the parameters to the ListProxySessions operation. Lists the proxy sessions for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListProxySessionsResponse

This is the response object from the ListProxySessions operation.

Class ListRoomMembershipsRequest

Container for the parameters to the ListRoomMemberships operation. Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

Class ListRoomMembershipsResponse

This is the response object from the ListRoomMemberships operation.

Class ListRoomsRequest

Container for the parameters to the ListRooms operation. 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.

Class ListRoomsResponse

This is the response object from the ListRooms operation.

Class ListSipMediaApplicationsRequest

Container for the parameters to the ListSipMediaApplications operation. Lists the SIP media applications under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListSipMediaApplicationsResponse

This is the response object from the ListSipMediaApplications operation.

Class ListSipRulesRequest

Container for the parameters to the ListSipRules operation. Lists the SIP rules under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListSipRulesResponse

This is the response object from the ListSipRules operation.

Class ListSupportedPhoneNumberCountriesRequest

Container for the parameters to the ListSupportedPhoneNumberCountries operation. Lists supported phone number countries.

Class ListSupportedPhoneNumberCountriesResponse

This is the response object from the ListSupportedPhoneNumberCountries operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListUsersRequest

Container for the parameters to the ListUsers operation. 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.

Class ListUsersResponse

This is the response object from the ListUsers operation.

Class ListVoiceConnectorGroupsRequest

Container for the parameters to the ListVoiceConnectorGroups operation. Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListVoiceConnectorGroupsResponse

This is the response object from the ListVoiceConnectorGroups operation.

Class ListVoiceConnectorsRequest

Container for the parameters to the ListVoiceConnectors operation. Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListVoiceConnectorsResponse

This is the response object from the ListVoiceConnectors operation.

Class ListVoiceConnectorTerminationCredentialsRequest

Container for the parameters to the ListVoiceConnectorTerminationCredentials operation. Lists the SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ListVoiceConnectorTerminationCredentialsResponse

This is the response object from the ListVoiceConnectorTerminationCredentials operation.

Class LoggingConfiguration

The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Class LogoutUserRequest

Container for the parameters to the LogoutUser operation. Logs out the specified user from all of the devices they are currently logged into.

Class LogoutUserResponse

This is the response object from the LogoutUser operation.

Class MediaCapturePipeline

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

Class MediaPlacement

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

Class Meeting

A meeting created using the Amazon Chime SDK.

Class MeetingNotificationConfiguration

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

Class Member

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

Class MemberError

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

Class MembershipItem

Membership details, such as member ID and member role.

Class MessagingSessionEndpoint

The websocket endpoint used to connect to Amazon Chime SDK messaging.

Class NotFoundException

One or more of the resources in the request does not exist in the system.

Class OrderedPhoneNumber

A phone number for which an order has been placed.

Class Origination

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.

The parameters listed below are not required, but you must use at least one.

Class OriginationRoute

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

The parameters listed below are not required, but you must use at least one.

Class Participant

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

Class PhoneNumber

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

Class 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.

Class PhoneNumberCapabilities

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

Class PhoneNumberCountry

The phone number country.

Class 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.

Class PhoneNumberOrder

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

Class Proxy

The proxy configuration for an Amazon Chime Voice Connector.

Class ProxySession

The proxy session for an Amazon Chime Voice Connector.

Class PutAppInstanceRetentionSettingsRequest

Container for the parameters to the PutAppInstanceRetentionSettings operation. Sets the amount of time in days that a given AppInstance retains data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutAppInstanceRetentionSettingsResponse

This is the response object from the PutAppInstanceRetentionSettings operation.

Class PutAppInstanceStreamingConfigurationsRequest

Container for the parameters to the PutAppInstanceStreamingConfigurations operation. The data streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutAppInstanceStreamingConfigurationsResponse

This is the response object from the PutAppInstanceStreamingConfigurations operation.

Class PutEventsConfigurationRequest

Container for the parameters to the PutEventsConfiguration operation. 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.

Class PutEventsConfigurationResponse

This is the response object from the PutEventsConfiguration operation.

Class PutRetentionSettingsRequest

Container for the parameters to the PutRetentionSettings operation. 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.

Class PutRetentionSettingsResponse

This is the response object from the PutRetentionSettings operation.

Class PutSipMediaApplicationLoggingConfigurationRequest

Container for the parameters to the PutSipMediaApplicationLoggingConfiguration operation. Updates the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutSipMediaApplicationLoggingConfigurationResponse

This is the response object from the PutSipMediaApplicationLoggingConfiguration operation.

Class PutVoiceConnectorEmergencyCallingConfigurationRequest

Container for the parameters to the PutVoiceConnectorEmergencyCallingConfiguration operation. Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorEmergencyCallingConfigurationResponse

This is the response object from the PutVoiceConnectorEmergencyCallingConfiguration operation.

Class PutVoiceConnectorLoggingConfigurationRequest

Container for the parameters to the PutVoiceConnectorLoggingConfiguration operation. Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorLoggingConfigurationResponse

This is the response object from the PutVoiceConnectorLoggingConfiguration operation.

Class PutVoiceConnectorOriginationRequest

Container for the parameters to the PutVoiceConnectorOrigination operation. Adds origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorOriginationResponse

This is the response object from the PutVoiceConnectorOrigination operation.

Class PutVoiceConnectorProxyRequest

Container for the parameters to the PutVoiceConnectorProxy operation. Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorProxyResponse

This is the response object from the PutVoiceConnectorProxy operation.

Class PutVoiceConnectorStreamingConfigurationRequest

Container for the parameters to the PutVoiceConnectorStreamingConfiguration operation. Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorStreamingConfigurationResponse

This is the response object from the PutVoiceConnectorStreamingConfiguration operation.

Class PutVoiceConnectorTerminationCredentialsRequest

Container for the parameters to the PutVoiceConnectorTerminationCredentials operation. Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorTerminationCredentialsResponse

This is the response object from the PutVoiceConnectorTerminationCredentials operation.

Class PutVoiceConnectorTerminationRequest

Container for the parameters to the PutVoiceConnectorTermination operation. Adds termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class PutVoiceConnectorTerminationResponse

This is the response object from the PutVoiceConnectorTermination operation.

Class RedactChannelMessageRequest

Container for the parameters to the RedactChannelMessage operation. Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class RedactChannelMessageResponse

This is the response object from the RedactChannelMessage operation.

Class RedactConversationMessageRequest

Container for the parameters to the RedactConversationMessage operation. Redacts the specified message from the specified Amazon Chime conversation.

Class RedactConversationMessageResponse

This is the response object from the RedactConversationMessage operation.

Class RedactRoomMessageRequest

Container for the parameters to the RedactRoomMessage operation. Redacts the specified message from the specified Amazon Chime channel.

Class RedactRoomMessageResponse

This is the response object from the RedactRoomMessage operation.

Class RegenerateSecurityTokenRequest

Container for the parameters to the RegenerateSecurityToken operation. Regenerates the security token for a bot.

Class RegenerateSecurityTokenResponse

This is the response object from the RegenerateSecurityToken operation.

Class ResetPersonalPINRequest

Container for the parameters to the ResetPersonalPIN operation. Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Class ResetPersonalPINResponse

This is the response object from the ResetPersonalPIN operation.

Class ResourceLimitExceededException

The request exceeds the resource limit.

Class RestorePhoneNumberRequest

Container for the parameters to the RestorePhoneNumber operation. Moves a phone number from the Deletion queue back into the phone number Inventory.

Class RestorePhoneNumberResponse

This is the response object from the RestorePhoneNumber operation.

Class 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.

Class Room

The Amazon Chime chat room details.

Class RoomMembership

The room membership details.

Class RoomRetentionSettings

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

Class SearchAvailablePhoneNumbersRequest

Container for the parameters to the SearchAvailablePhoneNumbers operation. 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.

Class SearchAvailablePhoneNumbersResponse

This is the response object from the SearchAvailablePhoneNumbers operation.

Class SelectedVideoStreams

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

Class SendChannelMessageRequest

Container for the parameters to the SendChannelMessage operation. Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class SendChannelMessageResponse

This is the response object from the SendChannelMessage operation.

Class ServiceFailureException

The service encountered an unexpected error.

Class ServiceUnavailableException

The service is currently unavailable.

Class SigninDelegateGroup

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

Class SipMediaApplication

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

Class SipMediaApplicationCall

A Call instance for a SIP media application.

Class SipMediaApplicationEndpoint

The endpoint assigned to the SIP media application.

Class SipMediaApplicationLoggingConfiguration

Logging configuration of the SIP media application.

Class SipRule

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

Class SipRuleTargetApplication

Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

Class SourceConfiguration

Source configuration for a specified media capture pipeline.

Class StartMeetingTranscriptionRequest

Container for the parameters to the StartMeetingTranscription operation. Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class StartMeetingTranscriptionResponse

This is the response object from the StartMeetingTranscription operation.

Class StopMeetingTranscriptionRequest

Container for the parameters to the StopMeetingTranscription operation. Stops transcription for the specified meetingId.

This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class StopMeetingTranscriptionResponse

This is the response object from the StopMeetingTranscription operation.

Class StreamingConfiguration

The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

Class StreamingNotificationTarget

The targeted recipient for a streaming configuration notification.

Class Tag

Describes a tag applied to a resource.

Class TagAttendeeRequest

Container for the parameters to the TagAttendee operation. Applies the specified tags to the specified Amazon Chime attendee.

TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Class TagAttendeeResponse

This is the response object from the TagAttendee operation.

Class TagMeetingRequest

Container for the parameters to the TagMeeting operation. Applies the specified tags to the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class TagMeetingResponse

This is the response object from the TagMeeting operation.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TelephonySettings

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

Class Termination

Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.

Class TerminationHealth

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

Class ThrottledClientException

The client exceeded its request rate limit.

Class TranscriptionConfiguration

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Class UnauthorizedClientException

The client is not currently authorized to make the request.

Class UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

Class UntagAttendeeRequest

Container for the parameters to the UntagAttendee operation. Untags the specified tags from the specified Amazon Chime SDK attendee.

UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

Class UntagAttendeeResponse

This is the response object from the UntagAttendee operation.

Class UntagMeetingRequest

Container for the parameters to the UntagMeeting operation. Untags the specified tags from the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UntagMeetingResponse

This is the response object from the UntagMeeting operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateAccountRequest

Container for the parameters to the UpdateAccount operation. Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

Class UpdateAccountResponse

This is the response object from the UpdateAccount operation.

Class UpdateAccountSettingsRequest

Container for the parameters to the UpdateAccountSettings operation. 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.

Class UpdateAccountSettingsResponse

This is the response object from the UpdateAccountSettings operation.

Class UpdateAppInstanceRequest

Container for the parameters to the UpdateAppInstance operation. Updates AppInstance metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateAppInstanceResponse

This is the response object from the UpdateAppInstance operation.

Class UpdateAppInstanceUserRequest

Container for the parameters to the UpdateAppInstanceUser operation. Updates the details of an AppInstanceUser. You can update names and metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateAppInstanceUserResponse

This is the response object from the UpdateAppInstanceUser operation.

Class UpdateBotRequest

Container for the parameters to the UpdateBot operation. Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Class UpdateBotResponse

This is the response object from the UpdateBot operation.

Class UpdateChannelMessageRequest

Container for the parameters to the UpdateChannelMessage operation. Updates the content of a message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateChannelMessageResponse

This is the response object from the UpdateChannelMessage operation.

Class UpdateChannelReadMarkerRequest

Container for the parameters to the UpdateChannelReadMarker operation. The details of the time when a user last read messages in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateChannelReadMarkerResponse

This is the response object from the UpdateChannelReadMarker operation.

Class UpdateChannelRequest

Container for the parameters to the UpdateChannel operation. Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateChannelResponse

This is the response object from the UpdateChannel operation.

Class UpdateGlobalSettingsRequest

Container for the parameters to the UpdateGlobalSettings operation. Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Class UpdateGlobalSettingsResponse

This is the response object from the UpdateGlobalSettings operation.

Class UpdatePhoneNumberRequest

Container for the parameters to the UpdatePhoneNumber operation. 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.

Class UpdatePhoneNumberRequestItem

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

Class UpdatePhoneNumberResponse

This is the response object from the UpdatePhoneNumber operation.

Class UpdatePhoneNumberSettingsRequest

Container for the parameters to the UpdatePhoneNumberSettings operation. 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.

Class UpdatePhoneNumberSettingsResponse

This is the response object from the UpdatePhoneNumberSettings operation.

Class UpdateProxySessionRequest

Container for the parameters to the UpdateProxySession operation. Updates the specified proxy session details, such as voice or SMS capabilities.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateProxySessionResponse

This is the response object from the UpdateProxySession operation.

Class UpdateRoomMembershipRequest

Container for the parameters to the UpdateRoomMembership operation. 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.

Class UpdateRoomMembershipResponse

This is the response object from the UpdateRoomMembership operation.

Class UpdateRoomRequest

Container for the parameters to the UpdateRoom operation. Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Class UpdateRoomResponse

This is the response object from the UpdateRoom operation.

Class UpdateSipMediaApplicationCallRequest

Container for the parameters to the UpdateSipMediaApplicationCall operation. Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateSipMediaApplicationCallResponse

This is the response object from the UpdateSipMediaApplicationCall operation.

Class UpdateSipMediaApplicationRequest

Container for the parameters to the UpdateSipMediaApplication operation. Updates the details of the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateSipMediaApplicationResponse

This is the response object from the UpdateSipMediaApplication operation.

Class UpdateSipRuleRequest

Container for the parameters to the UpdateSipRule operation. Updates the details of the specified SIP rule.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateSipRuleResponse

This is the response object from the UpdateSipRule operation.

Class UpdateUserRequest

Container for the parameters to the UpdateUser operation. Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Class UpdateUserRequestItem

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

Class UpdateUserResponse

This is the response object from the UpdateUser operation.

Class UpdateUserSettingsRequest

Container for the parameters to the UpdateUserSettings operation. Updates the settings for the specified user, such as phone number settings.

Class UpdateUserSettingsResponse

This is the response object from the UpdateUserSettings operation.

Class UpdateVoiceConnectorGroupRequest

Container for the parameters to the UpdateVoiceConnectorGroup operation. Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateVoiceConnectorGroupResponse

This is the response object from the UpdateVoiceConnectorGroup operation.

Class UpdateVoiceConnectorRequest

Container for the parameters to the UpdateVoiceConnector operation. Updates details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class UpdateVoiceConnectorResponse

This is the response object from the UpdateVoiceConnector operation.

Class User

The user on the Amazon Chime account.

Class 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.

Class UserSettings

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

Class ValidateE911AddressRequest

Container for the parameters to the ValidateE911Address operation. Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Class ValidateE911AddressResponse

This is the response object from the ValidateE911Address operation.

Class VideoArtifactsConfiguration

The video artifact configuration object.

Class VoiceConnector

The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

Class VoiceConnectorGroup

The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Class VoiceConnectorItem

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

Class VoiceConnectorSettings

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

Interfaces

NameDescription
Interface IChimePaginatorFactory

Paginators for the Chime service

Interface IListAccountsPaginator

Paginator for the ListAccounts operation

Interface IListAppInstanceAdminsPaginator

Paginator for the ListAppInstanceAdmins operation

Interface IListAppInstancesPaginator

Paginator for the ListAppInstances operation

Interface IListAppInstanceUsersPaginator

Paginator for the ListAppInstanceUsers operation

Interface IListAttendeesPaginator

Paginator for the ListAttendees operation

Interface IListBotsPaginator

Paginator for the ListBots operation

Interface IListChannelBansPaginator

Paginator for the ListChannelBans operation

Interface IListChannelMembershipsForAppInstanceUserPaginator

Paginator for the ListChannelMembershipsForAppInstanceUser operation

Interface IListChannelMembershipsPaginator

Paginator for the ListChannelMemberships operation

Interface IListChannelMessagesPaginator

Paginator for the ListChannelMessages operation

Interface IListChannelModeratorsPaginator

Paginator for the ListChannelModerators operation

Interface IListChannelsModeratedByAppInstanceUserPaginator

Paginator for the ListChannelsModeratedByAppInstanceUser operation

Interface IListChannelsPaginator

Paginator for the ListChannels operation

Interface IListMediaCapturePipelinesPaginator

Paginator for the ListMediaCapturePipelines operation

Interface IListMeetingsPaginator

Paginator for the ListMeetings operation

Interface IListPhoneNumberOrdersPaginator

Paginator for the ListPhoneNumberOrders operation

Interface IListPhoneNumbersPaginator

Paginator for the ListPhoneNumbers operation

Interface IListProxySessionsPaginator

Paginator for the ListProxySessions operation

Interface IListRoomMembershipsPaginator

Paginator for the ListRoomMemberships operation

Interface IListRoomsPaginator

Paginator for the ListRooms operation

Interface IListSipMediaApplicationsPaginator

Paginator for the ListSipMediaApplications operation

Interface IListSipRulesPaginator

Paginator for the ListSipRules operation

Interface IListUsersPaginator

Paginator for the ListUsers operation

Interface IListVoiceConnectorGroupsPaginator

Paginator for the ListVoiceConnectorGroups operation

Interface IListVoiceConnectorsPaginator

Paginator for the ListVoiceConnectors operation

Interface ISearchAvailablePhoneNumbersPaginator

Paginator for the SearchAvailablePhoneNumbers operation