Crate rusoto_chime
source · [−]Expand description
The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
- Using an AWS SDK
-
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
- Using the AWS CLI
-
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
- Using REST APIs
-
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name
chime
and REST endpointhttps://service.chime.aws.amazon.com
.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
If you’re using the service, you’re probably looking for ChimeClient and Chime.
Structs
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
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.
The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
The details of an AppInstance
, an instance of an Amazon Chime SDK messaging application.
The details of an AppInstanceAdmin
.
Summary of the details of an AppInstanceAdmin
.
The details of the data-retention settings for an AppInstance
.
The details of the streaming configuration of an AppInstance
.
Summary of the data for an AppInstance
.
The details of an AppInstanceUser
.
Summary of the membership details of an AppInstanceUser
.
Summary of the details of an AppInstanceUser
.
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId
and JoinToken
. The JoinToken
allows a client to authenticate and join as the specified attendee. The JoinToken
expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken
from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
The membership information, including member ARNs, the channel ARN, and membership types.
A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
The details of a channel.
The details of a channel ban.
Summary of the details of a ChannelBan
.
The details of a channel member.
Summary of the channel membership details of an AppInstanceUser
.
Summary of the details of a ChannelMembership
.
The details of a message in a channel.
Summary of the messages in a Channel
.
Summary of the details of a moderated channel.
The details of a channel moderator.
Summary of the details of a ChannelModerator
.
The details of the retention settings for a channel.
Summary of the details of a Channel
.
A list of failed member ARNs, error codes, and error messages.
A client for the Amazon Chime API.
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.
The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
The emergency calling configuration details associated with an Amazon Chime Voice Connector.
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
The country and area code for a proxy phone number in a proxy phone session.
The details of a user.
Invitation object returned after emailing users to invite them to join the Amazon Chime Team
account.
The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
A set of endpoints used by clients to connect to the media service group for a Amazon Chime SDK meeting.
A meeting created using the Amazon Chime SDK.
The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1
).
The member details, such as email address, name, member ID, and member type.
The list of errors returned when a member action results in an error.
Membership details, such as member ID and member role.
The websocket endpoint used to connect to Amazon Chime SDK messaging.
A phone number for which an order has been placed.
Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.
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 phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
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.
The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
The phone number country.
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.
The details of a phone number order created for Amazon Chime.
The proxy configuration for an Amazon Chime Voice Connector.
The proxy session for an Amazon Chime Voice Connector.
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.
The Amazon Chime chat room details.
The room membership details.
The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
An Active Directory (AD) group whose members are granted permission to act as delegates.
The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
A Call
instance for a SIP media application.
The endpoint assigned to the SIP media application.
Logging configuration of the SIP media application.
The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
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.
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.
The targeted recipient for a streaming configuration notification.
Describes a tag applied to a resource.
Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.
Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.
The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS
message from your SIP infrastructure.
The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
The user ID and user fields to update, used with the BatchUpdateUser action.
The user on the Amazon Chime account.
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.
Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
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.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems
per Amazon Chime Voice Connector group.
The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
Enums
Errors returned by AssociatePhoneNumberWithUser
Errors returned by AssociatePhoneNumbersWithVoiceConnector
Errors returned by AssociatePhoneNumbersWithVoiceConnectorGroup
Errors returned by AssociateSigninDelegateGroupsWithAccount
Errors returned by BatchCreateAttendee
Errors returned by BatchCreateChannelMembership
Errors returned by BatchCreateRoomMembership
Errors returned by BatchDeletePhoneNumber
Errors returned by BatchSuspendUser
Errors returned by BatchUnsuspendUser
Errors returned by BatchUpdatePhoneNumber
Errors returned by BatchUpdateUser
Errors returned by CreateAccount
Errors returned by CreateAppInstanceAdmin
Errors returned by CreateAppInstance
Errors returned by CreateAppInstanceUser
Errors returned by CreateAttendee
Errors returned by CreateBot
Errors returned by CreateChannelBan
Errors returned by CreateChannel
Errors returned by CreateChannelMembership
Errors returned by CreateChannelModerator
Errors returned by CreateMeetingDialOut
Errors returned by CreateMeeting
Errors returned by CreateMeetingWithAttendees
Errors returned by CreatePhoneNumberOrder
Errors returned by CreateProxySession
Errors returned by CreateRoom
Errors returned by CreateRoomMembership
Errors returned by CreateSipMediaApplicationCall
Errors returned by CreateSipMediaApplication
Errors returned by CreateSipRule
Errors returned by CreateUser
Errors returned by CreateVoiceConnector
Errors returned by CreateVoiceConnectorGroup
Errors returned by DeleteAccount
Errors returned by DeleteAppInstanceAdmin
Errors returned by DeleteAppInstance
Errors returned by DeleteAppInstanceStreamingConfigurations
Errors returned by DeleteAppInstanceUser
Errors returned by DeleteAttendee
Errors returned by DeleteChannelBan
Errors returned by DeleteChannel
Errors returned by DeleteChannelMembership
Errors returned by DeleteChannelMessage
Errors returned by DeleteChannelModerator
Errors returned by DeleteEventsConfiguration
Errors returned by DeleteMeeting
Errors returned by DeletePhoneNumber
Errors returned by DeleteProxySession
Errors returned by DeleteRoom
Errors returned by DeleteRoomMembership
Errors returned by DeleteSipMediaApplication
Errors returned by DeleteSipRule
Errors returned by DeleteVoiceConnectorEmergencyCallingConfiguration
Errors returned by DeleteVoiceConnector
Errors returned by DeleteVoiceConnectorGroup
Errors returned by DeleteVoiceConnectorOrigination
Errors returned by DeleteVoiceConnectorProxy
Errors returned by DeleteVoiceConnectorStreamingConfiguration
Errors returned by DeleteVoiceConnectorTerminationCredentials
Errors returned by DeleteVoiceConnectorTermination
Errors returned by DescribeAppInstanceAdmin
Errors returned by DescribeAppInstance
Errors returned by DescribeAppInstanceUser
Errors returned by DescribeChannelBan
Errors returned by DescribeChannel
Errors returned by DescribeChannelMembership
Errors returned by DescribeChannelMembershipForAppInstanceUser
Errors returned by DescribeChannelModeratedByAppInstanceUser
Errors returned by DescribeChannelModerator
Errors returned by DisassociatePhoneNumberFromUser
Errors returned by DisassociatePhoneNumbersFromVoiceConnector
Errors returned by DisassociatePhoneNumbersFromVoiceConnectorGroup
Errors returned by DisassociateSigninDelegateGroupsFromAccount
Errors returned by GetAccount
Errors returned by GetAccountSettings
Errors returned by GetAppInstanceRetentionSettings
Errors returned by GetAppInstanceStreamingConfigurations
Errors returned by GetAttendee
Errors returned by GetBot
Errors returned by GetChannelMessage
Errors returned by GetEventsConfiguration
Errors returned by GetGlobalSettings
Errors returned by GetMeeting
Errors returned by GetMessagingSessionEndpoint
Errors returned by GetPhoneNumber
Errors returned by GetPhoneNumberOrder
Errors returned by GetPhoneNumberSettings
Errors returned by GetProxySession
Errors returned by GetRetentionSettings
Errors returned by GetRoom
Errors returned by GetSipMediaApplication
Errors returned by GetSipMediaApplicationLoggingConfiguration
Errors returned by GetSipRule
Errors returned by GetUser
Errors returned by GetUserSettings
Errors returned by GetVoiceConnectorEmergencyCallingConfiguration
Errors returned by GetVoiceConnector
Errors returned by GetVoiceConnectorGroup
Errors returned by GetVoiceConnectorLoggingConfiguration
Errors returned by GetVoiceConnectorOrigination
Errors returned by GetVoiceConnectorProxy
Errors returned by GetVoiceConnectorStreamingConfiguration
Errors returned by GetVoiceConnectorTermination
Errors returned by GetVoiceConnectorTerminationHealth
Errors returned by InviteUsers
Errors returned by ListAccounts
Errors returned by ListAppInstanceAdmins
Errors returned by ListAppInstanceUsers
Errors returned by ListAppInstances
Errors returned by ListAttendeeTags
Errors returned by ListAttendees
Errors returned by ListBots
Errors returned by ListChannelBans
Errors returned by ListChannelMemberships
Errors returned by ListChannelMembershipsForAppInstanceUser
Errors returned by ListChannelMessages
Errors returned by ListChannelModerators
Errors returned by ListChannels
Errors returned by ListChannelsModeratedByAppInstanceUser
Errors returned by ListMeetingTags
Errors returned by ListMeetings
Errors returned by ListPhoneNumberOrders
Errors returned by ListPhoneNumbers
Errors returned by ListProxySessions
Errors returned by ListRoomMemberships
Errors returned by ListRooms
Errors returned by ListSipMediaApplications
Errors returned by ListSipRules
Errors returned by ListSupportedPhoneNumberCountries
Errors returned by ListTagsForResource
Errors returned by ListUsers
Errors returned by ListVoiceConnectorGroups
Errors returned by ListVoiceConnectorTerminationCredentials
Errors returned by ListVoiceConnectors
Errors returned by LogoutUser
Errors returned by PutAppInstanceRetentionSettings
Errors returned by PutAppInstanceStreamingConfigurations
Errors returned by PutEventsConfiguration
Errors returned by PutRetentionSettings
Errors returned by PutSipMediaApplicationLoggingConfiguration
Errors returned by PutVoiceConnectorEmergencyCallingConfiguration
Errors returned by PutVoiceConnectorLoggingConfiguration
Errors returned by PutVoiceConnectorOrigination
Errors returned by PutVoiceConnectorProxy
Errors returned by PutVoiceConnectorStreamingConfiguration
Errors returned by PutVoiceConnectorTerminationCredentials
Errors returned by PutVoiceConnectorTermination
Errors returned by RedactChannelMessage
Errors returned by RedactConversationMessage
Errors returned by RedactRoomMessage
Errors returned by RegenerateSecurityToken
Errors returned by ResetPersonalPIN
Errors returned by RestorePhoneNumber
Errors returned by SearchAvailablePhoneNumbers
Errors returned by SendChannelMessage
Errors returned by TagAttendee
Errors returned by TagMeeting
Errors returned by TagResource
Errors returned by UntagAttendee
Errors returned by UntagMeeting
Errors returned by UntagResource
Errors returned by UpdateAccount
Errors returned by UpdateAccountSettings
Errors returned by UpdateAppInstance
Errors returned by UpdateAppInstanceUser
Errors returned by UpdateBot
Errors returned by UpdateChannel
Errors returned by UpdateChannelMessage
Errors returned by UpdateChannelReadMarker
Errors returned by UpdateGlobalSettings
Errors returned by UpdatePhoneNumber
Errors returned by UpdatePhoneNumberSettings
Errors returned by UpdateProxySession
Errors returned by UpdateRoom
Errors returned by UpdateRoomMembership
Errors returned by UpdateSipMediaApplicationCall
Errors returned by UpdateSipMediaApplication
Errors returned by UpdateSipRule
Errors returned by UpdateUser
Errors returned by UpdateUserSettings
Errors returned by UpdateVoiceConnector
Errors returned by UpdateVoiceConnectorGroup
Traits
Trait representing the capabilities of the Amazon Chime API. Amazon Chime clients implement this trait.