Data retrieval APIs for Amazon Chime
Amazon Chime provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeAppInstance | Get the full details of an AppInstance | Read |
| DescribeAppInstanceAdmin | Get the full details of an AppInstanceAdmin | Read |
| DescribeAppInstanceBot | Get the full details of an AppInstanceBot | Read |
| DescribeAppInstanceUser | Get the full details of an AppInstanceUser | Read |
| DescribeAppInstanceUserEndpoint | Describe an endpoint registered for an app instance user | Read |
| DescribeChannel | Get the full details of a channel | Read |
| DescribeChannelBan | Get the full details of a channel ban | Read |
| DescribeChannelFlow | Get the full details of a channel flow | Read |
| DescribeChannelMembership | Get the full details of a channel membership | Read |
| DescribeChannelMembershipForAppInstanceUser | Get the details of a channel based on the membership of the specified user or bot | Read |
| DescribeChannelModeratedByAppInstanceUser | Get the full details of a channel moderated by the specified user or bot | Read |
| DescribeChannelModerator | Get the full details of a single ChannelModerator | Read |
| GetAccount | Get details for the specified Amazon Chime account | Read |
| GetAccountResource | Get details for the account resource associated with your Amazon Chime account | Read |
| GetAccountSettings | Get account settings for the specified Amazon Chime account ID | Read |
| GetAccountWithOpenIdConfig | Get the account details and OpenIdConfig attributes for your Amazon Chime account | Read |
| GetAppInstanceRetentionSettings | Get retention settings for an app instance | Read |
| GetAppInstanceStreamingConfigurations | Get the streaming configurations for an app instance | Read |
| GetAttendee | Get attendee details for a specified meeting ID and attendee ID | Read |
| GetBot | Retrieve details for the specified bot | Read |
| GetCDRBucket | Get details of a Call Detail Record S3 bucket associated with your Amazon Chime account | Read |
| GetChannelMembershipPreferences | Get the preferences for a channel membership | Read |
| GetChannelMessage | Get the full details of a channel message | Read |
| GetChannelMessageStatus | Get the status of a channel message | Read |
| GetDomain | Get domain details for a domain associated with your Amazon Chime account | Read |
| GetEventsConfiguration | Retrieve details for an events configuration for a bot to receive outgoing events | Read |
| GetGlobalSettings | Get global settings related to Amazon Chime for the AWS account | Read |
| GetMediaCapturePipeline | Get an existing media capture pipeline | Read |
| GetMediaInsightsPipelineConfiguration | Get a media insights pipeline configuration | Read |
| GetMediaPipeline | Get an existing media pipeline | Read |
| GetMediaPipelineKinesisVideoStreamPool | Get an existing media pipeline | Read |
| GetMeeting | Get the meeting record for a specified meeting ID | Read |
| GetMeetingDetail | Get attendee, connection, and other details for a meeting | Read |
| GetMessagingSessionEndpoint | Get the endpoint for the messaging session | Read |
| GetMessagingStreamingConfigurations | Get the data streaming configurations of an AppInstance | Read |
| GetPhoneNumber | Get details for the specified phone number | Read |
| GetPhoneNumberOrder | Get details for the specified phone number order | Read |
| GetPhoneNumberSettings | Get phone number settings related to Amazon Chime for the AWS account | Read |
| GetProxySession | Get details of the specified proxy session for the specified Amazon Chime Voice Connector | Read |
| GetRetentionSettings | Retrieve the retention settings for the specified Amazon Chime account | Read |
| GetRoom | Retrieve a room | Read |
| GetSipMediaApplication | Get details of Amazon Chime SIP media application under the administrator's AWS account | Read |
| GetSipMediaApplicationAlexaSkillConfiguration | Get Alexa Skill configuration settings for Amazon Chime SIP media application under the administrator's AWS account | Read |
| GetSipMediaApplicationLoggingConfiguration | Get logging configuration settings for Amazon Chime SIP media application under the administrator's AWS account | Read |
| GetSipRule | Get details of Amazon Chime SIP rule under the administrator's AWS account | Read |
| GetSpeakerSearchTask | Get a speaker search task on the specified Amazon Chime resource | Read |
| GetTelephonyLimits | Get telephony limits for the AWS account | Read |
| GetUser | Get details for the specified user ID | Read |
| GetUserActivityReportData | Get a summary of user activity on the user details page | Read |
| GetUserByEmail | Get user details for an Amazon Chime user based on the email address in an Amazon Chime Enterprise or Team account | Read |
| GetUserSettings | Get user settings related to the specified Amazon Chime user | Read |
| GetVoiceConnector | Get details for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorEmergencyCallingConfiguration | Get details of the emergency calling configuration for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorExternalSystemsConfiguration | Get the configuration of the external system that is connected with the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorGroup | Get details for the specified Amazon Chime Voice Connector Group | Read |
| GetVoiceConnectorLoggingConfiguration | Get details of the logging configuration for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorOrigination | Get details of the origination settings for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorProxy | Get details of the proxy configuration for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorStreamingConfiguration | Get details of the streaming configuration for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorTermination | Get details of the termination settings for the specified Amazon Chime Voice Connector | Read |
| GetVoiceConnectorTerminationHealth | Get details of the termination health for the specified Amazon Chime Voice Connector | Read |
| GetVoiceProfile | Get a voice profile | Read |
| GetVoiceProfileDomain | Get a voice profile domain | Read |
| GetVoiceToneAnalysisTask | Get a voice tone analysis task on the specified Amazon Chime resource | Read |
| ListAccountUsageReportData | List Amazon Chime account usage reporting data | List |
| ListAccounts | List the Amazon Chime accounts under the administrator's AWS account | List |
| ListApiKeys | List the SCIM access keys defined for your Amazon Chime account and Okta configuration | List |
| ListAppInstanceAdmins | List administrators in the app instance | List |
| ListAppInstanceBots | List all AppInstanceBots created under a single app instance | List |
| ListAppInstanceUserEndpoints | List the endpoints registered for an app instance user | List |
| ListAppInstanceUsers | List all AppInstanceUsers created under a single app instance | List |
| ListAppInstances | List all Amazon Chime app instances created under a single AWS account | List |
| ListAttendeeTags | List the tags applied to an Amazon Chime SDK attendee resource | List |
| ListAttendees | List up to 100 attendees for a specified Amazon Chime SDK meeting | List |
| ListAvailableVoiceConnectorRegions | List the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector | List |
| ListBots | List the bots associated with the administrator's Amazon Chime Enterprise account | List |
| ListCDRBucket | List Call Detail Record S3 buckets | List |
| ListCallingRegions | List the calling regions available for the administrator's AWS account | List |
| ListChannelBans | List all the users and bots banned from a particular channel | List |
| ListChannelFlows | List all the Channel Flows created under a single Chime AppInstance | List |
| ListChannelMemberships | List all channel memberships in a channel | List |
| ListChannelMembershipsForAppInstanceUser | List all channels that a particular user or bot is a part of | List |
| ListChannelMessages | List all the messages in a channel | Read |
| ListChannelModerators | List all the moderators for a channel | List |
| ListChannels | List all the Channels created under a single Chime AppInstance | List |
| ListChannelsAssociatedWithChannelFlow | List all the Channels associated with a single Chime Channel Flow | List |
| ListChannelsModeratedByAppInstanceUser | List all channels moderated by a user or bot | List |
| ListDelegates | List account delegate information associated with your Amazon Chime account | List |
| ListDirectories | List active Active Directories hosted in the Directory Service of your AWS account | List |
| ListDomains | List domains associated with your Amazon Chime account | List |
| ListGroups | List Active Directory or Okta user groups associated with your Amazon Chime Enterprise account | List |
| ListMediaCapturePipelines | List media capture pipelines | List |
| ListMediaInsightsPipelineConfigurations | List all media insights pipeline configurations | List |
| ListMediaPipelineKinesisVideoStreamPools | List media pipelines | List |
| ListMediaPipelines | List media pipelines | List |
| ListMeetingEvents | List all events that occurred for a specified meeting | List |
| ListMeetingTags | List the tags applied to an Amazon Chime SDK meeting resource | List |
| ListMeetings | List up to 100 active Amazon Chime SDK meetings | List |
| ListMeetingsReportData | List meetings ended during the specified date range | List |
| ListPhoneNumberOrders | List the phone number orders under the administrator's AWS account | List |
| ListPhoneNumbers | List the phone numbers under the administrator's AWS account | List |
| ListProxySessions | List proxy sessions for the specified Amazon Chime Voice Connector | List |
| ListRoomMemberships | List all room members | List |
| ListRooms | List rooms | List |
| ListSipMediaApplications | List all Amazon Chime SIP media applications under the administrator's AWS account | List |
| ListSipRules | List all Amazon Chime SIP rules under the administrator's AWS account | List |
| ListSubChannels | List all the SubChannels under a single Channel | List |
| ListSupportedPhoneNumberCountries | List the phone number countries supported by the AWS account | List |
| ListTagsForResource | List the tags applied to an Amazon Chime resource | Read |
| ListUsers | List the users that belong to the specified Amazon Chime account | List |
| ListVoiceConnectorGroups | List the Amazon Chime Voice Connector Groups under the administrator's AWS account | List |
| ListVoiceConnectorTerminationCredentials | List the SIP termination credentials for the specified Amazon Chime Voice Connector | List |
| ListVoiceConnectors | List the Amazon Chime Voice Connectors under the administrator's AWS account | List |
| ListVoiceProfileDomains | List voice profile domains | List |
| ListVoiceProfiles | List voice profiles | List |
| RetrieveDataExports | Download the file containing links to all user attachments returned as part of the "Request attachments" action | Read |
| SearchAvailablePhoneNumbers | Search phone numbers that can be ordered from the carrier | Read |
| SearchChannels | Search channels that an AppInstanceUser belongs to, or search channels across the AppInstance for an AppInstaceAdmin | List |
| ValidateAccountResource | Validate the account resource in your Amazon Chime account | Read |
| ValidateE911Address | Validate an address to be used for 911 calls made with Amazon Chime Voice Connectors | Read |
