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.
Name | Description | |
---|---|---|
AccessDeniedException |
You don't have permissions to perform the requested operation. |
|
Account |
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts. |
|
AccountSettings |
Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. |
|
Address |
A validated address. |
|
AlexaForBusinessMetadata |
The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device. |
|
AppInstance |
The details of an |
|
AppInstanceAdmin |
The details of an |
|
AppInstanceAdminSummary |
Summary of the details of an |
|
AppInstanceRetentionSettings |
The details of the data-retention settings for an |
|
AppInstanceStreamingConfiguration |
The details of the streaming configuration of an |
|
AppInstanceSummary |
Summary of the data for an |
|
AppInstanceUser |
The details of an |
|
AppInstanceUserMembershipSummary |
Summary of the membership details of an |
|
AppInstanceUserSummary |
Summary of the details of an |
|
ArtifactsConfiguration |
The configuration for the artifacts. |
|
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.
|
|
AssociatePhoneNumbersWithVoiceConnectorGroupResponse |
This is the response object from the AssociatePhoneNumbersWithVoiceConnectorGroup operation. |
|
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.
|
|
AssociatePhoneNumbersWithVoiceConnectorResponse |
This is the response object from the AssociatePhoneNumbersWithVoiceConnector operation. |
|
AssociatePhoneNumberWithUserRequest |
Container for the parameters to the AssociatePhoneNumberWithUser operation. Associates a phone number with the specified Amazon Chime user. |
|
AssociatePhoneNumberWithUserResponse |
This is the response object from the AssociatePhoneNumberWithUser operation. |
|
AssociateSigninDelegateGroupsWithAccountRequest |
Container for the parameters to the AssociateSigninDelegateGroupsWithAccount operation. Associates the specified sign-in delegate groups with the specified Amazon Chime account. |
|
AssociateSigninDelegateGroupsWithAccountResponse |
This is the response object from the AssociateSigninDelegateGroupsWithAccount operation. |
|
Attendee |
An Amazon Chime SDK meeting attendee. Includes a unique
We recommend securely transferring each |
|
AudioArtifactsConfiguration |
The audio artifact configuration object. |
|
BadRequestException |
The input parameters don't match the service's restrictions. |
|
BatchChannelMemberships |
The membership information, including member ARNs, the channel ARN, and membership types. |
|
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. |
|
BatchCreateAttendeeResponse |
This is the response object from the BatchCreateAttendee operation. |
|
BatchCreateChannelMembershipError |
A list of failed member ARNs, error codes, and error messages. |
|
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.
|
|
BatchCreateChannelMembershipResponse |
This is the response object from the BatchCreateChannelMembership operation. |
|
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. |
|
BatchCreateRoomMembershipResponse |
This is the response object from the BatchCreateRoomMembership operation. |
|
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. |
|
BatchDeletePhoneNumberResponse |
This is the response object from the BatchDeletePhoneNumber operation. |
|
BatchSuspendUserRequest |
Container for the parameters to the BatchSuspendUser operation.
Suspends up to 50 users from a
Users suspended from a
Users suspended from an To sign out users without suspending them, use the LogoutUser action. |
|
BatchSuspendUserResponse |
This is the response object from the BatchSuspendUser operation. |
|
BatchUnsuspendUserRequest |
Container for the parameters to the BatchUnsuspendUser operation.
Removes the suspension from up to 50 previously suspended users for the specified
Amazon Chime
Previously suspended users who are unsuspended using this action are returned to |
|
BatchUnsuspendUserResponse |
This is the response object from the BatchUnsuspendUser operation. |
|
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 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. |
|
BatchUpdatePhoneNumberResponse |
This is the response object from the BatchUpdatePhoneNumber operation. |
|
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 |
|
BatchUpdateUserResponse |
This is the response object from the BatchUpdateUser operation. |
|
Bot |
A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime. |
|
BusinessCallingSettings |
The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records. |
|
CandidateAddress |
A suggested address. |
|
Channel |
The details of a channel. |
|
ChannelBan |
The details of a channel ban. |
|
ChannelBanSummary |
Summary of the details of a |
|
ChannelMembership |
The details of a channel member. |
|
ChannelMembershipForAppInstanceUserSummary |
Summary of the channel membership details of an |
|
ChannelMembershipSummary |
Summary of the details of a |
|
ChannelMessage |
The details of a message in a channel. |
|
ChannelMessageSummary |
Summary of the messages in a |
|
ChannelModeratedByAppInstanceUserSummary |
Summary of the details of a moderated channel. |
|
ChannelModerator |
The details of a channel moderator. |
|
ChannelModeratorSummary |
Summary of the details of a |
|
ChannelRetentionSettings |
The details of the retention settings for a channel. |
|
ChannelSummary |
Summary of the details of a |
|
ChimePaginatorFactory |
Paginators for the Chime service |
|
ChimeSdkMeetingConfiguration |
The configuration object of the Amazon Chime SDK meeting for a specified media capture
pipeline. |
|
ConflictException |
The request could not be processed because of conflict in the current state of the resource. |
|
ContentArtifactsConfiguration |
The content artifact object. |
|
ConversationRetentionSettings |
The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account. |
|
CreateAccountRequest |
Container for the parameters to the CreateAccount operation.
Creates an Amazon Chime account under the administrator's AWS account. Only |
|
CreateAccountResponse |
This is the response object from the CreateAccount operation. |
|
CreateAppInstanceAdminRequest |
Container for the parameters to the CreateAppInstanceAdmin operation.
Promotes an
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.
Only an |
|
CreateAppInstanceAdminResponse |
This is the response object from the CreateAppInstanceAdmin operation. |
|
CreateAppInstanceRequest |
Container for the parameters to the CreateAppInstance operation.
Creates an Amazon Chime SDK messaging
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.
|
|
CreateAppInstanceResponse |
This is the response object from the CreateAppInstance operation. |
|
CreateAppInstanceUserRequest |
Container for the parameters to the CreateAppInstanceUser operation.
Creates a user under an Amazon Chime
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.
|
|
CreateAppInstanceUserResponse |
This is the response object from the CreateAppInstanceUser operation. |
|
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. |
|
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.
|
|
CreateAttendeeRequestItem |
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action. |
|
CreateAttendeeResponse |
This is the response object from the CreateAttendee operation. |
|
CreateBotRequest |
Container for the parameters to the CreateBot operation. Creates a bot for an Amazon Chime Enterprise account. |
|
CreateBotResponse |
This is the response object from the CreateBot operation. |
|
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 If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The 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. |
|
CreateChannelBanResponse |
This is the response object from the CreateChannelBan operation. |
|
CreateChannelMembershipRequest |
Container for the parameters to the CreateChannelMembership operation.
Adds a user to a channel. The
Privacy settings impact this action as follows:
The 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. |
|
CreateChannelMembershipResponse |
This is the response object from the CreateChannelMembership operation. |
|
CreateChannelModeratorRequest |
Container for the parameters to the CreateChannelModerator operation.
Creates a new
The 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. |
|
CreateChannelModeratorResponse |
This is the response object from the CreateChannelModerator operation. |
|
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 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. |
|
CreateChannelResponse |
This is the response object from the CreateChannel operation. |
|
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.
|
|
CreateMediaCapturePipelineResponse |
This is the response object from the CreateMediaCapturePipeline operation. |
|
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 This API is is not available in a dedicated namespace. |
|
CreateMeetingDialOutResponse |
This is the response object from the CreateMeetingDialOut operation. |
|
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.
|
|
CreateMeetingResponse |
This is the response object from the CreateMeeting operation. |
|
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.
|
|
CreateMeetingWithAttendeesResponse |
This is the response object from the CreateMeetingWithAttendees operation. |
|
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. |
|
CreatePhoneNumberOrderResponse |
This is the response object from the CreatePhoneNumberOrder operation. |
|
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.
|
|
CreateProxySessionResponse |
This is the response object from the CreateProxySession operation. |
|
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. |
|
CreateRoomMembershipResponse |
This is the response object from the CreateRoomMembership operation. |
|
CreateRoomRequest |
Container for the parameters to the CreateRoom operation. Creates a chat room for the specified Amazon Chime Enterprise account. |
|
CreateRoomResponse |
This is the response object from the CreateRoom operation. |
|
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
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.
|
|
CreateSipMediaApplicationCallResponse |
This is the response object from the CreateSipMediaApplicationCall operation. |
|
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.
|
|
CreateSipMediaApplicationResponse |
This is the response object from the CreateSipMediaApplication operation. |
|
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.
|
|
CreateSipRuleResponse |
This is the response object from the CreateSipRule operation. |
|
CreateUserRequest |
Container for the parameters to the CreateUser operation. Creates a user under the specified Amazon Chime account. |
|
CreateUserResponse |
This is the response object from the CreateUser operation. |
|
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 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. |
|
CreateVoiceConnectorGroupResponse |
This is the response object from the CreateVoiceConnectorGroup operation. |
|
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. |
|
CreateVoiceConnectorResponse |
This is the response object from the CreateVoiceConnector operation. |
|
Credential |
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector. |
|
DeleteAccountRequest |
Container for the parameters to the DeleteAccount operation.
Deletes the specified Amazon Chime account. You must suspend all users before deleting
For
Deleted accounts appear in your
After 90 days, deleted accounts are permanently removed from your |
|
DeleteAccountResponse |
This is the response object from the DeleteAccount operation. |
|
DeleteAppInstanceAdminRequest |
Container for the parameters to the DeleteAppInstanceAdmin operation.
Demotes an
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.
|
|
DeleteAppInstanceAdminResponse |
This is the response object from the DeleteAppInstanceAdmin operation. |
|
DeleteAppInstanceRequest |
Container for the parameters to the DeleteAppInstance operation.
Deletes an
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.
|
|
DeleteAppInstanceResponse |
This is the response object from the DeleteAppInstance operation. |
|
DeleteAppInstanceStreamingConfigurationsRequest |
Container for the parameters to the DeleteAppInstanceStreamingConfigurations operation.
Deletes the streaming configurations of an
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.
|
|
DeleteAppInstanceStreamingConfigurationsResponse |
This is the response object from the DeleteAppInstanceStreamingConfigurations operation. |
|
DeleteAppInstanceUserRequest |
Container for the parameters to the DeleteAppInstanceUser operation.
Deletes an
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.
|
|
DeleteAppInstanceUserResponse |
This is the response object from the DeleteAppInstanceUser operation. |
|
DeleteAttendeeRequest |
Container for the parameters to the DeleteAttendee operation.
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
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.
|
|
DeleteAttendeeResponse |
This is the response object from the DeleteAttendee operation. |
|
DeleteChannelBanRequest |
Container for the parameters to the DeleteChannelBan operation.
Removes a user from a channel's ban list.
The
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.
|
|
DeleteChannelBanResponse |
This is the response object from the DeleteChannelBan operation. |
|
DeleteChannelMembershipRequest |
Container for the parameters to the DeleteChannelMembership operation.
Removes a member from a channel.
The
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.
|
|
DeleteChannelMembershipResponse |
This is the response object from the DeleteChannelMembership operation. |
|
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
The
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.
|
|
DeleteChannelMessageResponse |
This is the response object from the DeleteChannelMessage operation. |
|
DeleteChannelModeratorRequest |
Container for the parameters to the DeleteChannelModerator operation.
Deletes a channel moderator.
The
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.
|
|
DeleteChannelModeratorResponse |
This is the response object from the DeleteChannelModerator operation. |
|
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
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.
|
|
DeleteChannelResponse |
This is the response object from the DeleteChannel operation. |
|
DeleteEventsConfigurationRequest |
Container for the parameters to the DeleteEventsConfiguration operation. Deletes the events configuration that allows a bot to receive outgoing events. |
|
DeleteEventsConfigurationResponse |
This is the response object from the DeleteEventsConfiguration operation. |
|
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.
|
|
DeleteMediaCapturePipelineResponse |
This is the response object from the DeleteMediaCapturePipeline operation. |
|
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.
|
|
DeleteMeetingResponse |
This is the response object from the DeleteMeeting operation. |
|
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. |
|
DeletePhoneNumberResponse |
This is the response object from the DeletePhoneNumber operation. |
|
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.
|
|
DeleteProxySessionResponse |
This is the response object from the DeleteProxySession operation. |
|
DeleteRoomMembershipRequest |
Container for the parameters to the DeleteRoomMembership operation. Removes a member from a chat room in an Amazon Chime Enterprise account. |
|
DeleteRoomMembershipResponse |
This is the response object from the DeleteRoomMembership operation. |
|
DeleteRoomRequest |
Container for the parameters to the DeleteRoom operation. Deletes a chat room in an Amazon Chime Enterprise account. |
|
DeleteRoomResponse |
This is the response object from the DeleteRoom operation. |
|
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.
|
|
DeleteSipMediaApplicationResponse |
This is the response object from the DeleteSipMediaApplication operation. |
|
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.
|
|
DeleteSipRuleResponse |
This is the response object from the DeleteSipRule operation. |
|
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.
|
|
DeleteVoiceConnectorEmergencyCallingConfigurationResponse |
This is the response object from the DeleteVoiceConnectorEmergencyCallingConfiguration operation. |
|
DeleteVoiceConnectorGroupRequest |
Container for the parameters to the DeleteVoiceConnectorGroup operation.
Deletes the specified Amazon Chime Voice Connector group. Any
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.
|
|
DeleteVoiceConnectorGroupResponse |
This is the response object from the DeleteVoiceConnectorGroup operation. |
|
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.
|
|
DeleteVoiceConnectorOriginationResponse |
This is the response object from the DeleteVoiceConnectorOrigination operation. |
|
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.
|
|
DeleteVoiceConnectorProxyResponse |
This is the response object from the DeleteVoiceConnectorProxy operation. |
|
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.
|
|
DeleteVoiceConnectorResponse |
This is the response object from the DeleteVoiceConnector operation. |
|
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.
|
|
DeleteVoiceConnectorStreamingConfigurationResponse |
This is the response object from the DeleteVoiceConnectorStreamingConfiguration operation. |
|
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.
|
|
DeleteVoiceConnectorTerminationCredentialsResponse |
This is the response object from the DeleteVoiceConnectorTerminationCredentials operation. |
|
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.
|
|
DeleteVoiceConnectorTerminationResponse |
This is the response object from the DeleteVoiceConnectorTermination operation. |
|
DescribeAppInstanceAdminRequest |
Container for the parameters to the DescribeAppInstanceAdmin operation.
Returns the full details of an
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.
|
|
DescribeAppInstanceAdminResponse |
This is the response object from the DescribeAppInstanceAdmin operation. |
|
DescribeAppInstanceRequest |
Container for the parameters to the DescribeAppInstance operation.
Returns the full details of an
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.
|
|
DescribeAppInstanceResponse |
This is the response object from the DescribeAppInstance operation. |
|
DescribeAppInstanceUserRequest |
Container for the parameters to the DescribeAppInstanceUser operation.
Returns the full details of an
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.
|
|
DescribeAppInstanceUserResponse |
This is the response object from the DescribeAppInstanceUser operation. |
|
DescribeChannelBanRequest |
Container for the parameters to the DescribeChannelBan operation.
Returns the full details of a channel ban.
The
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.
|
|
DescribeChannelBanResponse |
This is the response object from the DescribeChannelBan operation. |
|
DescribeChannelMembershipForAppInstanceUserRequest |
Container for the parameters to the DescribeChannelMembershipForAppInstanceUser operation.
Returns the details of a channel based on the membership of the specified
The
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.
|
|
DescribeChannelMembershipForAppInstanceUserResponse |
This is the response object from the DescribeChannelMembershipForAppInstanceUser operation. |
|
DescribeChannelMembershipRequest |
Container for the parameters to the DescribeChannelMembership operation.
Returns the full details of a user's channel membership.
The
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.
|
|
DescribeChannelMembershipResponse |
This is the response object from the DescribeChannelMembership operation. |
|
DescribeChannelModeratedByAppInstanceUserRequest |
Container for the parameters to the DescribeChannelModeratedByAppInstanceUser operation.
Returns the full details of a channel moderated by the specified
The
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.
|
|
DescribeChannelModeratedByAppInstanceUserResponse |
This is the response object from the DescribeChannelModeratedByAppInstanceUser operation. |
|
DescribeChannelModeratorRequest |
Container for the parameters to the DescribeChannelModerator operation.
Returns the full details of a single ChannelModerator.
The
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.
|
|
DescribeChannelModeratorResponse |
This is the response object from the DescribeChannelModerator operation. |
|
DescribeChannelRequest |
Container for the parameters to the DescribeChannel operation.
Returns the full details of a channel in an Amazon Chime
The
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.
|
|
DescribeChannelResponse |
This is the response object from the DescribeChannel operation. |
|
DisassociatePhoneNumberFromUserRequest |
Container for the parameters to the DisassociatePhoneNumberFromUser operation. Disassociates the primary provisioned phone number from the specified Amazon Chime user. |
|
DisassociatePhoneNumberFromUserResponse |
This is the response object from the DisassociatePhoneNumberFromUser operation. |
|
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.
|
|
DisassociatePhoneNumbersFromVoiceConnectorGroupResponse |
This is the response object from the DisassociatePhoneNumbersFromVoiceConnectorGroup operation. |
|
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.
|
|
DisassociatePhoneNumbersFromVoiceConnectorResponse |
This is the response object from the DisassociatePhoneNumbersFromVoiceConnector operation. |
|
DisassociateSigninDelegateGroupsFromAccountRequest |
Container for the parameters to the DisassociateSigninDelegateGroupsFromAccount operation. Disassociates the specified sign-in delegate groups from the specified Amazon Chime account. |
|
DisassociateSigninDelegateGroupsFromAccountResponse |
This is the response object from the DisassociateSigninDelegateGroupsFromAccount operation. |
|
DNISEmergencyCallingConfiguration |
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration. |
|
EmergencyCallingConfiguration |
The emergency calling configuration details associated with an Amazon Chime Voice Connector. |
|
EngineTranscribeMedicalSettings |
Settings specific to the Amazon Transcribe Medical engine. |
|
EngineTranscribeSettings |
Settings specific for Amazon Transcribe as the live transcription engine.
If you specify an invalid combination of parameters, a |
|
EventsConfiguration |
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN. |
|
ForbiddenException |
The client is permanently forbidden from making the request. |
|
GeoMatchParams |
The country and area code for a proxy phone number in a proxy phone session. |
|
GetAccountRequest |
Container for the parameters to the GetAccount operation. Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. |
|
GetAccountResponse |
This is the response object from the GetAccount operation. |
|
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. |
|
GetAccountSettingsResponse |
This is the response object from the GetAccountSettings operation. |
|
GetAppInstanceRetentionSettingsRequest |
Container for the parameters to the GetAppInstanceRetentionSettings operation.
Gets the retention settings for an
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.
|
|
GetAppInstanceRetentionSettingsResponse |
This is the response object from the GetAppInstanceRetentionSettings operation. |
|
GetAppInstanceStreamingConfigurationsRequest |
Container for the parameters to the GetAppInstanceStreamingConfigurations operation.
Gets the streaming settings for an
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.
|
|
GetAppInstanceStreamingConfigurationsResponse |
This is the response object from the GetAppInstanceStreamingConfigurations operation. |
|
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.
|
|
GetAttendeeResponse |
This is the response object from the GetAttendee operation. |
|
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. |
|
GetBotResponse |
This is the response object from the GetBot operation. |
|
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
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.
|
|
GetChannelMessageResponse |
This is the response object from the GetChannelMessage operation. |
|
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. |
|
GetEventsConfigurationResponse |
This is the response object from the GetEventsConfiguration operation. |
|
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. |
|
GetGlobalSettingsResponse |
This is the response object from the GetGlobalSettings operation. |
|
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.
|
|
GetMediaCapturePipelineResponse |
This is the response object from the GetMediaCapturePipeline operation. |
|
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 . |
|
GetMeetingResponse |
This is the response object from the GetMeeting operation. |
|
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.
|
|
GetMessagingSessionEndpointResponse |
This is the response object from the GetMessagingSessionEndpoint operation. |
|
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. |
|
GetPhoneNumberOrderResponse |
This is the response object from the GetPhoneNumberOrder operation. |
|
GetPhoneNumberRequest |
Container for the parameters to the GetPhoneNumber operation. Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. |
|
GetPhoneNumberResponse |
This is the response object from the GetPhoneNumber operation. |
|
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. |
|
GetPhoneNumberSettingsResponse |
This is the response object from the GetPhoneNumberSettings operation. |
|
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.
|
|
GetProxySessionResponse |
This is the response object from the GetProxySession operation. |
|
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. |
|
GetRetentionSettingsResponse |
This is the response object from the GetRetentionSettings operation. |
|
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. |
|
GetRoomResponse |
This is the response object from the GetRoom operation. |
|
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.
|
|
GetSipMediaApplicationLoggingConfigurationResponse |
This is the response object from the GetSipMediaApplicationLoggingConfiguration operation. |
|
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.
|
|
GetSipMediaApplicationResponse |
This is the response object from the GetSipMediaApplication operation. |
|
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.
|
|
GetSipRuleResponse |
This is the response object from the GetSipRule operation. |
|
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. |
|
GetUserResponse |
This is the response object from the GetUser operation. |
|
GetUserSettingsRequest |
Container for the parameters to the GetUserSettings operation. Retrieves settings for the specified user ID, such as any associated phone number settings. |
|
GetUserSettingsResponse |
This is the response object from the GetUserSettings operation. |
|
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.
|
|
GetVoiceConnectorEmergencyCallingConfigurationResponse |
This is the response object from the GetVoiceConnectorEmergencyCallingConfiguration operation. |
|
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
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.
|
|
GetVoiceConnectorGroupResponse |
This is the response object from the GetVoiceConnectorGroup operation. |
|
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.
|
|
GetVoiceConnectorLoggingConfigurationResponse |
This is the response object from the GetVoiceConnectorLoggingConfiguration operation. |
|
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.
|
|
GetVoiceConnectorOriginationResponse |
This is the response object from the GetVoiceConnectorOrigination operation. |
|
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.
|
|
GetVoiceConnectorProxyResponse |
This is the response object from the GetVoiceConnectorProxy operation. |
|
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.
|
|
GetVoiceConnectorResponse |
This is the response object from the GetVoiceConnector operation. |
|
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.
|
|
GetVoiceConnectorStreamingConfigurationResponse |
This is the response object from the GetVoiceConnectorStreamingConfiguration operation. |
|
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 |
|
GetVoiceConnectorTerminationHealthResponse |
This is the response object from the GetVoiceConnectorTerminationHealth operation. |
|
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.
|
|
GetVoiceConnectorTerminationResponse |
This is the response object from the GetVoiceConnectorTermination operation. |
|
Identity |
The details of a user. |
|
Invite |
Invitation object returned after emailing users to invite them to join the Amazon
Chime |
|
InviteUsersRequest |
Container for the parameters to the InviteUsers operation.
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
|
|
InviteUsersResponse |
This is the response object from the InviteUsers operation. |
|
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. |
|
ListAccountsResponse |
This is the response object from the ListAccounts operation. |
|
ListAppInstanceAdminsRequest |
Container for the parameters to the ListAppInstanceAdmins operation.
Returns a list of the administrators in the
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.
|
|
ListAppInstanceAdminsResponse |
This is the response object from the ListAppInstanceAdmins operation. |
|
ListAppInstancesRequest |
Container for the parameters to the ListAppInstances operation.
Lists all Amazon Chime
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.
|
|
ListAppInstancesResponse |
This is the response object from the ListAppInstances operation. |
|
ListAppInstanceUsersRequest |
Container for the parameters to the ListAppInstanceUsers operation.
List all
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.
|
|
ListAppInstanceUsersResponse |
This is the response object from the ListAppInstanceUsers operation. |
|
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.
|
|
ListAttendeesResponse |
This is the response object from the ListAttendees operation. |
|
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.
|
|
ListAttendeeTagsResponse |
This is the response object from the ListAttendeeTags operation. |
|
ListBotsRequest |
Container for the parameters to the ListBots operation. Lists the bots associated with the administrator's Amazon Chime Enterprise account ID. |
|
ListBotsResponse |
This is the response object from the ListBots operation. |
|
ListChannelBansRequest |
Container for the parameters to the ListChannelBans operation.
Lists all the users banned from a particular channel.
The
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.
|
|
ListChannelBansResponse |
This is the response object from the ListChannelBans operation. |
|
ListChannelMembershipsForAppInstanceUserRequest |
Container for the parameters to the ListChannelMembershipsForAppInstanceUser operation.
Lists all channels that a particular
The
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.
|
|
ListChannelMembershipsForAppInstanceUserResponse |
This is the response object from the ListChannelMembershipsForAppInstanceUser operation. |
|
ListChannelMembershipsRequest |
Container for the parameters to the ListChannelMemberships operation.
Lists all channel memberships in a channel.
The
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.
|
|
ListChannelMembershipsResponse |
This is the response object from the ListChannelMemberships operation. |
|
ListChannelMessagesRequest |
Container for the parameters to the ListChannelMessages operation.
List all the messages in a channel. Returns a paginated list of
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
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.
|
|
ListChannelMessagesResponse |
This is the response object from the ListChannelMessages operation. |
|
ListChannelModeratorsRequest |
Container for the parameters to the ListChannelModerators operation.
Lists all the moderators for a channel.
The
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.
|
|
ListChannelModeratorsResponse |
This is the response object from the ListChannelModerators operation. |
|
ListChannelsModeratedByAppInstanceUserRequest |
Container for the parameters to the ListChannelsModeratedByAppInstanceUser operation.
A list of the channels moderated by an
The
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.
|
|
ListChannelsModeratedByAppInstanceUserResponse |
This is the response object from the ListChannelsModeratedByAppInstanceUser operation. |
|
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
The 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. |
|
ListChannelsResponse |
This is the response object from the ListChannels operation. |
|
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.
|
|
ListMediaCapturePipelinesResponse |
This is the response object from the ListMediaCapturePipelines operation. |
|
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. |
|
ListMeetingsResponse |
This is the response object from the ListMeetings operation. |
|
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.
|
|
ListMeetingTagsResponse |
This is the response object from the ListMeetingTags operation. |
|
ListPhoneNumberOrdersRequest |
Container for the parameters to the ListPhoneNumberOrders operation. Lists the phone number orders for the administrator's Amazon Chime account. |
|
ListPhoneNumberOrdersResponse |
This is the response object from the ListPhoneNumberOrders operation. |
|
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. |
|
ListPhoneNumbersResponse |
This is the response object from the ListPhoneNumbers operation. |
|
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.
|
|
ListProxySessionsResponse |
This is the response object from the ListProxySessions operation. |
|
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. |
|
ListRoomMembershipsResponse |
This is the response object from the ListRoomMemberships operation. |
|
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. |
|
ListRoomsResponse |
This is the response object from the ListRooms operation. |
|
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.
|
|
ListSipMediaApplicationsResponse |
This is the response object from the ListSipMediaApplications operation. |
|
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.
|
|
ListSipRulesResponse |
This is the response object from the ListSipRules operation. |
|
ListSupportedPhoneNumberCountriesRequest |
Container for the parameters to the ListSupportedPhoneNumberCountries operation. Lists supported phone number countries. |
|
ListSupportedPhoneNumberCountriesResponse |
This is the response object from the ListSupportedPhoneNumberCountries operation. |
|
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.
For meetings: ListTagsForResource.
For messaging: ListTagsForResource.
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.
|
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
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. |
|
ListUsersResponse |
This is the response object from the ListUsers operation. |
|
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.
|
|
ListVoiceConnectorGroupsResponse |
This is the response object from the ListVoiceConnectorGroups operation. |
|
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.
|
|
ListVoiceConnectorsResponse |
This is the response object from the ListVoiceConnectors operation. |
|
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.
|
|
ListVoiceConnectorTerminationCredentialsResponse |
This is the response object from the ListVoiceConnectorTerminationCredentials operation. |
|
LoggingConfiguration |
The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. |
|
LogoutUserRequest |
Container for the parameters to the LogoutUser operation. Logs out the specified user from all of the devices they are currently logged into. |
|
LogoutUserResponse |
This is the response object from the LogoutUser operation. |
|
MediaCapturePipeline |
A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object. |
|
MediaPlacement |
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting. |
|
Meeting |
A meeting created using the Amazon Chime SDK. |
|
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 ( |
|
Member |
The member details, such as email address, name, member ID, and member type. |
|
MemberError |
The list of errors returned when a member action results in an error. |
|
MembershipItem |
Membership details, such as member ID and member role. |
|
MessagingSessionEndpoint |
The websocket endpoint used to connect to Amazon Chime SDK messaging. |
|
NotFoundException |
One or more of the resources in the request does not exist in the system. |
|
OrderedPhoneNumber |
A phone number for which an order has been placed. |
|
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.
|
|
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.
|
|
Participant |
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session. |
|
PhoneNumber |
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector. |
|
PhoneNumberAssociation |
The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. |
|
PhoneNumberCapabilities |
The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging. |
|
PhoneNumberCountry |
The phone number country. |
|
PhoneNumberError |
If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. |
|
PhoneNumberOrder |
The details of a phone number order created for Amazon Chime. |
|
Proxy |
The proxy configuration for an Amazon Chime Voice Connector. |
|
ProxySession |
The proxy session for an Amazon Chime Voice Connector. |
|
PutAppInstanceRetentionSettingsRequest |
Container for the parameters to the PutAppInstanceRetentionSettings operation.
Sets the amount of time in days that a given
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.
|
|
PutAppInstanceRetentionSettingsResponse |
This is the response object from the PutAppInstanceRetentionSettings operation. |
|
PutAppInstanceStreamingConfigurationsRequest |
Container for the parameters to the PutAppInstanceStreamingConfigurations operation.
The data streaming configurations of an
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.
|
|
PutAppInstanceStreamingConfigurationsResponse |
This is the response object from the PutAppInstanceStreamingConfigurations operation. |
|
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. |
|
PutEventsConfigurationResponse |
This is the response object from the PutEventsConfiguration operation. |
|
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. |
|
PutRetentionSettingsResponse |
This is the response object from the PutRetentionSettings operation. |
|
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.
|
|
PutSipMediaApplicationLoggingConfigurationResponse |
This is the response object from the PutSipMediaApplicationLoggingConfiguration operation. |
|
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.
|
|
PutVoiceConnectorEmergencyCallingConfigurationResponse |
This is the response object from the PutVoiceConnectorEmergencyCallingConfiguration operation. |
|
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.
|
|
PutVoiceConnectorLoggingConfigurationResponse |
This is the response object from the PutVoiceConnectorLoggingConfiguration operation. |
|
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.
|
|
PutVoiceConnectorOriginationResponse |
This is the response object from the PutVoiceConnectorOrigination operation. |
|
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.
|
|
PutVoiceConnectorProxyResponse |
This is the response object from the PutVoiceConnectorProxy operation. |
|
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.
|
|
PutVoiceConnectorStreamingConfigurationResponse |
This is the response object from the PutVoiceConnectorStreamingConfiguration operation. |
|
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.
|
|
PutVoiceConnectorTerminationCredentialsResponse |
This is the response object from the PutVoiceConnectorTerminationCredentials operation. |
|
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.
|
|
PutVoiceConnectorTerminationResponse |
This is the response object from the PutVoiceConnectorTermination operation. |
|
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
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.
|
|
RedactChannelMessageResponse |
This is the response object from the RedactChannelMessage operation. |
|
RedactConversationMessageRequest |
Container for the parameters to the RedactConversationMessage operation. Redacts the specified message from the specified Amazon Chime conversation. |
|
RedactConversationMessageResponse |
This is the response object from the RedactConversationMessage operation. |
|
RedactRoomMessageRequest |
Container for the parameters to the RedactRoomMessage operation. Redacts the specified message from the specified Amazon Chime channel. |
|
RedactRoomMessageResponse |
This is the response object from the RedactRoomMessage operation. |
|
RegenerateSecurityTokenRequest |
Container for the parameters to the RegenerateSecurityToken operation. Regenerates the security token for a bot. |
|
RegenerateSecurityTokenResponse |
This is the response object from the RegenerateSecurityToken operation. |
|
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. |
|
ResetPersonalPINResponse |
This is the response object from the ResetPersonalPIN operation. |
|
ResourceLimitExceededException |
The request exceeds the resource limit. |
|
RestorePhoneNumberRequest |
Container for the parameters to the RestorePhoneNumber operation. Moves a phone number from the Deletion queue back into the phone number Inventory. |
|
RestorePhoneNumberResponse |
This is the response object from the RestorePhoneNumber operation. |
|
RetentionSettings |
The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages. |
|
Room |
The Amazon Chime chat room details. |
|
RoomMembership |
The room membership details. |
|
RoomRetentionSettings |
The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account. |
|
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: |
|
SearchAvailablePhoneNumbersResponse |
This is the response object from the SearchAvailablePhoneNumbers operation. |
|
SelectedVideoStreams |
The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25. |
|
SendChannelMessageRequest |
Container for the parameters to the SendChannelMessage operation.
Sends a message to a particular channel that the member is a part of.
The
Also,
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.
|
|
SendChannelMessageResponse |
This is the response object from the SendChannelMessage operation. |
|
ServiceFailureException |
The service encountered an unexpected error. |
|
ServiceUnavailableException |
The service is currently unavailable. |
|
SigninDelegateGroup |
An Active Directory (AD) group whose members are granted permission to act as delegates. |
|
SipMediaApplication |
The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications. |
|
SipMediaApplicationCall |
A |
|
SipMediaApplicationEndpoint |
The endpoint assigned to the SIP media application. |
|
SipMediaApplicationLoggingConfiguration |
Logging configuration of the SIP media application. |
|
SipRule |
The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules. |
|
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. |
|
SourceConfiguration |
Source configuration for a specified media capture pipeline. |
|
StartMeetingTranscriptionRequest |
Container for the parameters to the StartMeetingTranscription operation.
Starts transcription for the specified
If you specify an invalid configuration, a 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. |
|
StartMeetingTranscriptionResponse |
This is the response object from the StartMeetingTranscription operation. |
|
StopMeetingTranscriptionRequest |
Container for the parameters to the StopMeetingTranscription operation.
Stops transcription for the specified
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.
|
|
StopMeetingTranscriptionResponse |
This is the response object from the StopMeetingTranscription operation. |
|
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. |
|
StreamingNotificationTarget |
The targeted recipient for a streaming configuration notification. |
|
Tag |
Describes a tag applied to a resource. |
|
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.
|
|
TagAttendeeResponse |
This is the response object from the TagAttendee operation. |
|
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.
|
|
TagMeetingResponse |
This is the response object from the TagMeeting operation. |
|
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.
|
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TelephonySettings |
Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging. |
|
Termination |
Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector. |
|
TerminationHealth |
The termination health details, including the source IP address and timestamp of the
last successful SIP |
|
ThrottledClientException |
The client exceeded its request rate limit. |
|
TranscriptionConfiguration |
The configuration for the current transcription operation. Must contain |
|
UnauthorizedClientException |
The client is not currently authorized to make the request. |
|
UnprocessableEntityException |
The request was well-formed but was unable to be followed due to semantic errors. |
|
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.
|
|
UntagAttendeeResponse |
This is the response object from the UntagAttendee operation. |
|
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.
|
|
UntagMeetingResponse |
This is the response object from the UntagMeeting operation. |
|
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. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
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. |
|
UpdateAccountResponse |
This is the response object from the UpdateAccount operation. |
|
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. |
|
UpdateAccountSettingsResponse |
This is the response object from the UpdateAccountSettings operation. |
|
UpdateAppInstanceRequest |
Container for the parameters to the UpdateAppInstance operation.
Updates
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.
|
|
UpdateAppInstanceResponse |
This is the response object from the UpdateAppInstance operation. |
|
UpdateAppInstanceUserRequest |
Container for the parameters to the UpdateAppInstanceUser operation.
Updates the details of an
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.
|
|
UpdateAppInstanceUserResponse |
This is the response object from the UpdateAppInstanceUser operation. |
|
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. |
|
UpdateBotResponse |
This is the response object from the UpdateBot operation. |
|
UpdateChannelMessageRequest |
Container for the parameters to the UpdateChannelMessage operation.
Updates the content of a message.
The
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.
|
|
UpdateChannelMessageResponse |
This is the response object from the UpdateChannelMessage operation. |
|
UpdateChannelReadMarkerRequest |
Container for the parameters to the UpdateChannelReadMarker operation.
The details of the time when a user last read messages in a channel.
The
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.
|
|
UpdateChannelReadMarkerResponse |
This is the response object from the UpdateChannelReadMarker operation. |
|
UpdateChannelRequest |
Container for the parameters to the UpdateChannel operation. Update a channel's attributes. Restriction: You can't change a channel's privacy.
The 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. |
|
UpdateChannelResponse |
This is the response object from the UpdateChannel operation. |
|
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. |
|
UpdateGlobalSettingsResponse |
This is the response object from the UpdateGlobalSettings operation. |
|
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. |
|
UpdatePhoneNumberRequestItem |
The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. |
|
UpdatePhoneNumberResponse |
This is the response object from the UpdatePhoneNumber operation. |
|
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. |
|
UpdatePhoneNumberSettingsResponse |
This is the response object from the UpdatePhoneNumberSettings operation. |
|
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.
|
|
UpdateProxySessionResponse |
This is the response object from the UpdateProxySession operation. |
|
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. |
|
UpdateRoomMembershipResponse |
This is the response object from the UpdateRoomMembership operation. |
|
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. |
|
UpdateRoomResponse |
This is the response object from the UpdateRoom operation. |
|
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.
|
|
UpdateSipMediaApplicationCallResponse |
This is the response object from the UpdateSipMediaApplicationCall operation. |
|
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.
|
|
UpdateSipMediaApplicationResponse |
This is the response object from the UpdateSipMediaApplication operation. |
|
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.
|
|
UpdateSipRuleResponse |
This is the response object from the UpdateSipRule operation. |
|
UpdateUserRequest |
Container for the parameters to the UpdateUser operation.
Updates user details for a specified user ID. Currently, only |
|
UpdateUserRequestItem |
The user ID and user fields to update, used with the BatchUpdateUser action. |
|
UpdateUserResponse |
This is the response object from the UpdateUser operation. |
|
UpdateUserSettingsRequest |
Container for the parameters to the UpdateUserSettings operation. Updates the settings for the specified user, such as phone number settings. |
|
UpdateUserSettingsResponse |
This is the response object from the UpdateUserSettings operation. |
|
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.
|
|
UpdateVoiceConnectorGroupResponse |
This is the response object from the UpdateVoiceConnectorGroup operation. |
|
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.
|
|
UpdateVoiceConnectorResponse |
This is the response object from the UpdateVoiceConnector operation. |
|
User |
The user on the Amazon Chime account. |
|
UserError |
The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages. |
|
UserSettings |
Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging. |
|
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.
|
|
ValidateE911AddressResponse |
This is the response object from the ValidateE911Address operation. |
|
VideoArtifactsConfiguration |
The video artifact configuration object. |
|
VoiceConnector |
The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings. |
|
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. |
|
VoiceConnectorItem |
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which
to route inbound calls. Includes priority configuration settings. Limit: 3 |
|
VoiceConnectorSettings |
The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records. |
Name | Description | |
---|---|---|
IChimePaginatorFactory |
Paginators for the Chime service |
|
IListAccountsPaginator |
Paginator for the ListAccounts operation |
|
IListAppInstanceAdminsPaginator |
Paginator for the ListAppInstanceAdmins operation |
|
IListAppInstancesPaginator |
Paginator for the ListAppInstances operation |
|
IListAppInstanceUsersPaginator |
Paginator for the ListAppInstanceUsers operation |
|
IListAttendeesPaginator |
Paginator for the ListAttendees operation |
|
IListBotsPaginator |
Paginator for the ListBots operation |
|
IListChannelBansPaginator |
Paginator for the ListChannelBans operation |
|
IListChannelMembershipsForAppInstanceUserPaginator |
Paginator for the ListChannelMembershipsForAppInstanceUser operation |
|
IListChannelMembershipsPaginator |
Paginator for the ListChannelMemberships operation |
|
IListChannelMessagesPaginator |
Paginator for the ListChannelMessages operation |
|
IListChannelModeratorsPaginator |
Paginator for the ListChannelModerators operation |
|
IListChannelsModeratedByAppInstanceUserPaginator |
Paginator for the ListChannelsModeratedByAppInstanceUser operation |
|
IListChannelsPaginator |
Paginator for the ListChannels operation |
|
IListMediaCapturePipelinesPaginator |
Paginator for the ListMediaCapturePipelines operation |
|
IListMeetingsPaginator |
Paginator for the ListMeetings operation |
|
IListPhoneNumberOrdersPaginator |
Paginator for the ListPhoneNumberOrders operation |
|
IListPhoneNumbersPaginator |
Paginator for the ListPhoneNumbers operation |
|
IListProxySessionsPaginator |
Paginator for the ListProxySessions operation |
|
IListRoomMembershipsPaginator |
Paginator for the ListRoomMemberships operation |
|
IListRoomsPaginator |
Paginator for the ListRooms operation |
|
IListSipMediaApplicationsPaginator |
Paginator for the ListSipMediaApplications operation |
|
IListSipRulesPaginator |
Paginator for the ListSipRules operation |
|
IListUsersPaginator |
Paginator for the ListUsers operation |
|
IListVoiceConnectorGroupsPaginator |
Paginator for the ListVoiceConnectorGroups operation |
|
IListVoiceConnectorsPaginator |
Paginator for the ListVoiceConnectors operation |
|
ISearchAvailablePhoneNumbersPaginator |
Paginator for the SearchAvailablePhoneNumbers operation |