Class: Aws::Chime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Chime::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb
Overview
An API client for Chime. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Chime::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_phone_number_with_user(params = {}) ⇒ Struct
Associates a phone number with the specified Amazon Chime user.
-
#associate_phone_numbers_with_voice_connector(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorResponse
Associates phone numbers with the specified Amazon Chime Voice Connector.
-
#associate_phone_numbers_with_voice_connector_group(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse
Associates phone numbers with the specified Amazon Chime Voice Connector group.
-
#associate_signin_delegate_groups_with_account(params = {}) ⇒ Struct
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
-
#batch_create_attendee(params = {}) ⇒ Types::BatchCreateAttendeeResponse
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
-
#batch_create_channel_membership(params = {}) ⇒ Types::BatchCreateChannelMembershipResponse
Adds a specified number of users to a channel.
-
#batch_create_room_membership(params = {}) ⇒ Types::BatchCreateRoomMembershipResponse
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
-
#batch_delete_phone_number(params = {}) ⇒ Types::BatchDeletePhoneNumberResponse
Moves phone numbers into the Deletion queue.
-
#batch_suspend_user(params = {}) ⇒ Types::BatchSuspendUserResponse
Suspends up to 50 users from a
Team
orEnterpriseLWA
Amazon Chime account. -
#batch_unsuspend_user(params = {}) ⇒ Types::BatchUnsuspendUserResponse
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA
account. -
#batch_update_phone_number(params = {}) ⇒ Types::BatchUpdatePhoneNumberResponse
Updates phone number product types or calling names.
-
#batch_update_user(params = {}) ⇒ Types::BatchUpdateUserResponse
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.
-
#create_account(params = {}) ⇒ Types::CreateAccountResponse
Creates an Amazon Chime account under the administrator's AWS account.
-
#create_app_instance(params = {}) ⇒ Types::CreateAppInstanceResponse
Creates an Amazon Chime SDK messaging
AppInstance
under an AWS account. -
#create_app_instance_admin(params = {}) ⇒ Types::CreateAppInstanceAdminResponse
Promotes an
AppInstanceUser
to anAppInstanceAdmin
. -
#create_app_instance_user(params = {}) ⇒ Types::CreateAppInstanceUserResponse
Creates a user under an Amazon Chime
AppInstance
. -
#create_attendee(params = {}) ⇒ Types::CreateAttendeeResponse
Creates a new attendee for an active Amazon Chime SDK meeting.
-
#create_bot(params = {}) ⇒ Types::CreateBotResponse
Creates a bot for an Amazon Chime Enterprise account.
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel to which you can add users and send messages.
-
#create_channel_ban(params = {}) ⇒ Types::CreateChannelBanResponse
Permanently bans a member from a channel.
-
#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse
Adds a user to a channel.
-
#create_channel_moderator(params = {}) ⇒ Types::CreateChannelModeratorResponse
Creates a new
ChannelModerator
. -
#create_media_capture_pipeline(params = {}) ⇒ Types::CreateMediaCapturePipelineResponse
Creates a media capture pipeline.
-
#create_meeting(params = {}) ⇒ Types::CreateMeetingResponse
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
-
#create_meeting_dial_out(params = {}) ⇒ Types::CreateMeetingDialOutResponse
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.
-
#create_meeting_with_attendees(params = {}) ⇒ Types::CreateMeetingWithAttendeesResponse
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
-
#create_phone_number_order(params = {}) ⇒ Types::CreatePhoneNumberOrderResponse
Creates an order for phone numbers to be provisioned.
-
#create_proxy_session(params = {}) ⇒ Types::CreateProxySessionResponse
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
-
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a chat room for the specified Amazon Chime Enterprise account.
-
#create_room_membership(params = {}) ⇒ Types::CreateRoomMembershipResponse
Adds a member to a chat room in an Amazon Chime Enterprise account.
-
#create_sip_media_application(params = {}) ⇒ Types::CreateSipMediaApplicationResponse
Creates a SIP media application.
-
#create_sip_media_application_call(params = {}) ⇒ Types::CreateSipMediaApplicationCallResponse
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified
sipMediaApplicationId
. -
#create_sip_rule(params = {}) ⇒ Types::CreateSipRuleResponse
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user under the specified Amazon Chime account.
-
#create_voice_connector(params = {}) ⇒ Types::CreateVoiceConnectorResponse
Creates an Amazon Chime Voice Connector under the administrator's AWS account.
-
#create_voice_connector_group(params = {}) ⇒ Types::CreateVoiceConnectorGroupResponse
Creates an Amazon Chime Voice Connector group under the administrator's AWS account.
-
#delete_account(params = {}) ⇒ Struct
Deletes the specified Amazon Chime account.
-
#delete_app_instance(params = {}) ⇒ Struct
Deletes an
AppInstance
and all associated data asynchronously. -
#delete_app_instance_admin(params = {}) ⇒ Struct
Demotes an
AppInstanceAdmin
to anAppInstanceUser
. -
#delete_app_instance_streaming_configurations(params = {}) ⇒ Struct
Deletes the streaming configurations of an
AppInstance
. -
#delete_app_instance_user(params = {}) ⇒ Struct
Deletes an
AppInstanceUser
. -
#delete_attendee(params = {}) ⇒ Struct
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken
. -
#delete_channel(params = {}) ⇒ Struct
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
-
#delete_channel_ban(params = {}) ⇒ Struct
Removes a user from a channel's ban list.
-
#delete_channel_membership(params = {}) ⇒ Struct
Removes a member from a channel.
-
#delete_channel_message(params = {}) ⇒ Struct
Deletes a channel message.
-
#delete_channel_moderator(params = {}) ⇒ Struct
Deletes a channel moderator.
-
#delete_events_configuration(params = {}) ⇒ Struct
Deletes the events configuration that allows a bot to receive outgoing events.
-
#delete_media_capture_pipeline(params = {}) ⇒ Struct
Deletes the media capture pipeline.
-
#delete_meeting(params = {}) ⇒ Struct
Deletes the specified Amazon Chime SDK meeting.
-
#delete_phone_number(params = {}) ⇒ Struct
Moves the specified phone number into the Deletion queue.
-
#delete_proxy_session(params = {}) ⇒ Struct
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
-
#delete_room(params = {}) ⇒ Struct
Deletes a chat room in an Amazon Chime Enterprise account.
-
#delete_room_membership(params = {}) ⇒ Struct
Removes a member from a chat room in an Amazon Chime Enterprise account.
-
#delete_sip_media_application(params = {}) ⇒ Struct
Deletes a SIP media application.
-
#delete_sip_rule(params = {}) ⇒ Struct
Deletes a SIP rule.
-
#delete_voice_connector(params = {}) ⇒ Struct
Deletes the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_emergency_calling_configuration(params = {}) ⇒ Struct
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_group(params = {}) ⇒ Struct
Deletes the specified Amazon Chime Voice Connector group.
-
#delete_voice_connector_origination(params = {}) ⇒ Struct
Deletes the origination settings for the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_proxy(params = {}) ⇒ Struct
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_streaming_configuration(params = {}) ⇒ Struct
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_termination(params = {}) ⇒ Struct
Deletes the termination settings for the specified Amazon Chime Voice Connector.
-
#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
-
#describe_app_instance(params = {}) ⇒ Types::DescribeAppInstanceResponse
Returns the full details of an
AppInstance
. -
#describe_app_instance_admin(params = {}) ⇒ Types::DescribeAppInstanceAdminResponse
Returns the full details of an
AppInstanceAdmin
. -
#describe_app_instance_user(params = {}) ⇒ Types::DescribeAppInstanceUserResponse
Returns the full details of an
AppInstanceUser
. -
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the full details of a channel in an Amazon Chime
AppInstance
. -
#describe_channel_ban(params = {}) ⇒ Types::DescribeChannelBanResponse
Returns the full details of a channel ban.
-
#describe_channel_membership(params = {}) ⇒ Types::DescribeChannelMembershipResponse
Returns the full details of a user's channel membership.
-
#describe_channel_membership_for_app_instance_user(params = {}) ⇒ Types::DescribeChannelMembershipForAppInstanceUserResponse
Returns the details of a channel based on the membership of the specified
AppInstanceUser
. -
#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse
Returns the full details of a channel moderated by the specified
AppInstanceUser
. -
#describe_channel_moderator(params = {}) ⇒ Types::DescribeChannelModeratorResponse
Returns the full details of a single ChannelModerator.
-
#disassociate_phone_number_from_user(params = {}) ⇒ Struct
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
-
#disassociate_phone_numbers_from_voice_connector(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorResponse
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
-
#disassociate_phone_numbers_from_voice_connector_group(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
-
#disassociate_signin_delegate_groups_from_account(params = {}) ⇒ Struct
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
-
#get_account(params = {}) ⇒ Types::GetAccountResponse
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
-
#get_app_instance_retention_settings(params = {}) ⇒ Types::GetAppInstanceRetentionSettingsResponse
Gets the retention settings for an
AppInstance
. -
#get_app_instance_streaming_configurations(params = {}) ⇒ Types::GetAppInstanceStreamingConfigurationsResponse
Gets the streaming settings for an
AppInstance
. -
#get_attendee(params = {}) ⇒ Types::GetAttendeeResponse
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
-
#get_bot(params = {}) ⇒ Types::GetBotResponse
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
-
#get_channel_message(params = {}) ⇒ Types::GetChannelMessageResponse
Gets the full details of a channel message.
-
#get_events_configuration(params = {}) ⇒ Types::GetEventsConfigurationResponse
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
-
#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsResponse
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
-
#get_media_capture_pipeline(params = {}) ⇒ Types::GetMediaCapturePipelineResponse
Gets an existing media capture pipeline.
-
#get_meeting(params = {}) ⇒ Types::GetMeetingResponse
This API is is no longer supported and will not be updated. We recommend using the latest version, [GetMeeting][1], in the Amazon Chime SDK.
-
#get_messaging_session_endpoint(params = {}) ⇒ Types::GetMessagingSessionEndpointResponse
The details of the endpoint for the messaging session.
-
#get_phone_number(params = {}) ⇒ Types::GetPhoneNumberResponse
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
-
#get_phone_number_order(params = {}) ⇒ Types::GetPhoneNumberOrderResponse
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.
-
#get_phone_number_settings(params = {}) ⇒ Types::GetPhoneNumberSettingsResponse
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
-
#get_proxy_session(params = {}) ⇒ Types::GetProxySessionResponse
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
-
#get_retention_settings(params = {}) ⇒ Types::GetRetentionSettingsResponse
Gets the retention settings for the specified Amazon Chime Enterprise account.
-
#get_room(params = {}) ⇒ Types::GetRoomResponse
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
-
#get_sip_media_application(params = {}) ⇒ Types::GetSipMediaApplicationResponse
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
-
#get_sip_media_application_logging_configuration(params = {}) ⇒ Types::GetSipMediaApplicationLoggingConfigurationResponse
Returns the logging configuration for the specified SIP media application.
-
#get_sip_rule(params = {}) ⇒ Types::GetSipRuleResponse
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
-
#get_user(params = {}) ⇒ Types::GetUserResponse
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
-
#get_user_settings(params = {}) ⇒ Types::GetUserSettingsResponse
Retrieves settings for the specified user ID, such as any associated phone number settings.
-
#get_voice_connector(params = {}) ⇒ Types::GetVoiceConnectorResponse
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
-
#get_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::GetVoiceConnectorEmergencyCallingConfigurationResponse
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_group(params = {}) ⇒ Types::GetVoiceConnectorGroupResponse
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated
VoiceConnectorItems
. -
#get_voice_connector_logging_configuration(params = {}) ⇒ Types::GetVoiceConnectorLoggingConfigurationResponse
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_origination(params = {}) ⇒ Types::GetVoiceConnectorOriginationResponse
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_proxy(params = {}) ⇒ Types::GetVoiceConnectorProxyResponse
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_streaming_configuration(params = {}) ⇒ Types::GetVoiceConnectorStreamingConfigurationResponse
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_termination(params = {}) ⇒ Types::GetVoiceConnectorTerminationResponse
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
-
#get_voice_connector_termination_health(params = {}) ⇒ Types::GetVoiceConnectorTerminationHealthResponse
This API is is no longer supported and will not be updated. We recommend using the latest version, [GetVoiceConnectorTerminationHealth][1], in the Amazon Chime SDK.
-
#invite_users(params = {}) ⇒ Types::InviteUsersResponse
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team
account. -
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
Lists the Amazon Chime accounts under the administrator's AWS account.
-
#list_app_instance_admins(params = {}) ⇒ Types::ListAppInstanceAdminsResponse
Returns a list of the administrators in the
AppInstance
. -
#list_app_instance_users(params = {}) ⇒ Types::ListAppInstanceUsersResponse
List all
AppInstanceUsers
created under a singleAppInstance
. -
#list_app_instances(params = {}) ⇒ Types::ListAppInstancesResponse
Lists all Amazon Chime
AppInstance
s created under a single AWS account. -
#list_attendee_tags(params = {}) ⇒ Types::ListAttendeeTagsResponse
Lists the tags applied to an Amazon Chime SDK attendee resource.
-
#list_attendees(params = {}) ⇒ Types::ListAttendeesResponse
Lists the attendees for the specified Amazon Chime SDK meeting.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
-
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users banned from a particular channel.
-
#list_channel_memberships(params = {}) ⇒ Types::ListChannelMembershipsResponse
Lists all channel memberships in a channel.
-
#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse
Lists all channels that a particular
AppInstanceUser
is a part of. -
#list_channel_messages(params = {}) ⇒ Types::ListChannelMessagesResponse
List all the messages in a channel.
-
#list_channel_moderators(params = {}) ⇒ Types::ListChannelModeratorsResponse
Lists all the moderators for a channel.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Lists all Channels created under a single Chime App as a paginated list.
-
#list_channels_moderated_by_app_instance_user(params = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse
A list of the channels moderated by an
AppInstanceUser
. -
#list_media_capture_pipelines(params = {}) ⇒ Types::ListMediaCapturePipelinesResponse
Returns a list of media capture pipelines.
-
#list_meeting_tags(params = {}) ⇒ Types::ListMeetingTagsResponse
Lists the tags applied to an Amazon Chime SDK meeting resource.
-
#list_meetings(params = {}) ⇒ Types::ListMeetingsResponse
Lists up to 100 active Amazon Chime SDK meetings.
-
#list_phone_number_orders(params = {}) ⇒ Types::ListPhoneNumberOrdersResponse
Lists the phone number orders for the administrator's Amazon Chime account.
-
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
-
#list_proxy_sessions(params = {}) ⇒ Types::ListProxySessionsResponse
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
-
#list_room_memberships(params = {}) ⇒ Types::ListRoomMembershipsResponse
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
-
#list_rooms(params = {}) ⇒ Types::ListRoomsResponse
Lists the room details for the specified Amazon Chime Enterprise account.
-
#list_sip_media_applications(params = {}) ⇒ Types::ListSipMediaApplicationsResponse
Lists the SIP media applications under the administrator's AWS account.
-
#list_sip_rules(params = {}) ⇒ Types::ListSipRulesResponse
Lists the SIP rules under the administrator's AWS account.
-
#list_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse
Lists supported phone number countries.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the users that belong to the specified Amazon Chime account.
-
#list_voice_connector_groups(params = {}) ⇒ Types::ListVoiceConnectorGroupsResponse
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
-
#list_voice_connector_termination_credentials(params = {}) ⇒ Types::ListVoiceConnectorTerminationCredentialsResponse
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
-
#list_voice_connectors(params = {}) ⇒ Types::ListVoiceConnectorsResponse
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
-
#logout_user(params = {}) ⇒ Struct
Logs out the specified user from all of the devices they are currently logged into.
-
#put_app_instance_retention_settings(params = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse
Sets the amount of time in days that a given
AppInstance
retains data. -
#put_app_instance_streaming_configurations(params = {}) ⇒ Types::PutAppInstanceStreamingConfigurationsResponse
The data streaming configurations of an
AppInstance
. -
#put_events_configuration(params = {}) ⇒ Types::PutEventsConfigurationResponse
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
-
#put_retention_settings(params = {}) ⇒ Types::PutRetentionSettingsResponse
Puts retention settings for the specified Amazon Chime Enterprise account.
-
#put_sip_media_application_logging_configuration(params = {}) ⇒ Types::PutSipMediaApplicationLoggingConfigurationResponse
Updates the logging configuration for the specified SIP media application.
-
#put_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::PutVoiceConnectorEmergencyCallingConfigurationResponse
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.
-
#put_voice_connector_logging_configuration(params = {}) ⇒ Types::PutVoiceConnectorLoggingConfigurationResponse
Adds a logging configuration for the specified Amazon Chime Voice Connector.
-
#put_voice_connector_origination(params = {}) ⇒ Types::PutVoiceConnectorOriginationResponse
Adds origination settings for the specified Amazon Chime Voice Connector.
-
#put_voice_connector_proxy(params = {}) ⇒ Types::PutVoiceConnectorProxyResponse
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
-
#put_voice_connector_streaming_configuration(params = {}) ⇒ Types::PutVoiceConnectorStreamingConfigurationResponse
Adds a streaming configuration for the specified Amazon Chime Voice Connector.
-
#put_voice_connector_termination(params = {}) ⇒ Types::PutVoiceConnectorTerminationResponse
Adds termination settings for the specified Amazon Chime Voice Connector.
-
#put_voice_connector_termination_credentials(params = {}) ⇒ Struct
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
-
#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse
Redacts message content, but not metadata.
-
#redact_conversation_message(params = {}) ⇒ Struct
Redacts the specified message from the specified Amazon Chime conversation.
-
#redact_room_message(params = {}) ⇒ Struct
Redacts the specified message from the specified Amazon Chime channel.
-
#regenerate_security_token(params = {}) ⇒ Types::RegenerateSecurityTokenResponse
Regenerates the security token for a bot.
-
#reset_personal_pin(params = {}) ⇒ Types::ResetPersonalPINResponse
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
-
#restore_phone_number(params = {}) ⇒ Types::RestorePhoneNumberResponse
Moves a phone number from the Deletion queue back into the phone number Inventory.
-
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for phone numbers that can be ordered.
-
#send_channel_message(params = {}) ⇒ Types::SendChannelMessageResponse
Sends a message to a particular channel that the member is a part of.
-
#start_meeting_transcription(params = {}) ⇒ Struct
Starts transcription for the specified
meetingId
. -
#stop_meeting_transcription(params = {}) ⇒ Struct
Stops transcription for the specified
meetingId
. -
#tag_attendee(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime attendee.
-
#tag_meeting(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK meeting.
-
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
-
#untag_attendee(params = {}) ⇒ Struct
Untags the specified tags from the specified Amazon Chime SDK attendee.
-
#untag_meeting(params = {}) ⇒ Struct
Untags the specified tags from the specified Amazon Chime SDK meeting.
-
#untag_resource(params = {}) ⇒ Struct
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
-
#update_account(params = {}) ⇒ Types::UpdateAccountResponse
Updates account details for the specified Amazon Chime account.
-
#update_account_settings(params = {}) ⇒ Struct
Updates the settings for the specified Amazon Chime account.
-
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates
AppInstance
metadata. -
#update_app_instance_user(params = {}) ⇒ Types::UpdateAppInstanceUserResponse
Updates the details of an
AppInstanceUser
. -
#update_bot(params = {}) ⇒ Types::UpdateBotResponse
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update a channel's attributes.
-
#update_channel_message(params = {}) ⇒ Types::UpdateChannelMessageResponse
Updates the content of a message.
-
#update_channel_read_marker(params = {}) ⇒ Types::UpdateChannelReadMarkerResponse
The details of the time when a user last read messages in a channel.
-
#update_global_settings(params = {}) ⇒ Struct
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
-
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
Updates phone number details, such as product type or calling name, for the specified phone number ID.
-
#update_phone_number_settings(params = {}) ⇒ Struct
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
-
#update_proxy_session(params = {}) ⇒ Types::UpdateProxySessionResponse
Updates the specified proxy session details, such as voice or SMS capabilities.
-
#update_room(params = {}) ⇒ Types::UpdateRoomResponse
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
-
#update_room_membership(params = {}) ⇒ Types::UpdateRoomMembershipResponse
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
-
#update_sip_media_application(params = {}) ⇒ Types::UpdateSipMediaApplicationResponse
Updates the details of the specified SIP media application.
-
#update_sip_media_application_call(params = {}) ⇒ Types::UpdateSipMediaApplicationCallResponse
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
-
#update_sip_rule(params = {}) ⇒ Types::UpdateSipRuleResponse
Updates the details of the specified SIP rule.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates user details for a specified user ID.
-
#update_user_settings(params = {}) ⇒ Struct
Updates the settings for the specified user, such as phone number settings.
-
#update_voice_connector(params = {}) ⇒ Types::UpdateVoiceConnectorResponse
Updates details for the specified Amazon Chime Voice Connector.
-
#update_voice_connector_group(params = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
-
#validate_e911_address(params = {}) ⇒ Types::ValidateE911AddressResponse
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
440 441 442 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#associate_phone_number_with_user(params = {}) ⇒ Struct
Associates a phone number with the specified Amazon Chime user.
471 472 473 474 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 471 def associate_phone_number_with_user(params = {}, = {}) req = build_request(:associate_phone_number_with_user, params) req.send_request() end |
#associate_phone_numbers_with_voice_connector(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorResponse
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.
527 528 529 530 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 527 def associate_phone_numbers_with_voice_connector(params = {}, = {}) req = build_request(:associate_phone_numbers_with_voice_connector, params) req.send_request() end |
#associate_phone_numbers_with_voice_connector_group(params = {}) ⇒ Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse
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.
584 585 586 587 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 584 def associate_phone_numbers_with_voice_connector_group(params = {}, = {}) req = build_request(:associate_phone_numbers_with_voice_connector_group, params) req.send_request() end |
#associate_signin_delegate_groups_with_account(params = {}) ⇒ Struct
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
615 616 617 618 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 615 def associate_signin_delegate_groups_with_account(params = {}, = {}) req = build_request(:associate_signin_delegate_groups_with_account, params) req.send_request() end |
#batch_create_attendee(params = {}) ⇒ Types::BatchCreateAttendeeResponse
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.
683 684 685 686 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 683 def batch_create_attendee(params = {}, = {}) req = build_request(:batch_create_attendee, params) req.send_request() end |
#batch_create_channel_membership(params = {}) ⇒ Types::BatchCreateChannelMembershipResponse
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.
751 752 753 754 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 751 def batch_create_channel_membership(params = {}, = {}) req = build_request(:batch_create_channel_membership, params) req.send_request() end |
#batch_create_room_membership(params = {}) ⇒ Types::BatchCreateRoomMembershipResponse
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.
798 799 800 801 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 798 def batch_create_room_membership(params = {}, = {}) req = build_request(:batch_create_room_membership, params) req.send_request() end |
#batch_delete_phone_number(params = {}) ⇒ Types::BatchDeletePhoneNumberResponse
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.
834 835 836 837 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 834 def batch_delete_phone_number(params = {}, = {}) req = build_request(:batch_delete_phone_number, params) req.send_request() end |
#batch_suspend_user(params = {}) ⇒ Types::BatchSuspendUserResponse
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime
account. For more information about different account types, see
Managing Your Amazon Chime Accounts in the Amazon Chime
Administration Guide.
Users suspended from a Team
account are disassociated from the
account,but they can continue to use Amazon Chime as free users. To
remove the suspension from suspended Team
account users, invite them
to the Team
account again. You can use the InviteUsers action to do
so.
Users suspended from an EnterpriseLWA
account are immediately signed
out of Amazon Chime and can no longer sign in. To remove the
suspension from suspended EnterpriseLWA
account users, use the
BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
889 890 891 892 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 889 def batch_suspend_user(params = {}, = {}) req = build_request(:batch_suspend_user, params) req.send_request() end |
#batch_unsuspend_user(params = {}) ⇒ Types::BatchUnsuspendUserResponse
Removes the suspension from up to 50 previously suspended users for
the specified Amazon Chime EnterpriseLWA
account. Only users on
EnterpriseLWA
accounts can be unsuspended using this action. For
more information about different account types, see Managing Your
Amazon Chime Accounts in the account types, in the Amazon Chime
Administration Guide.
Previously suspended users who are unsuspended using this action are
returned to Registered
status. Users who are not previously
suspended are ignored.
937 938 939 940 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 937 def batch_unsuspend_user(params = {}, = {}) req = build_request(:batch_unsuspend_user, params) req.send_request() end |
#batch_update_phone_number(params = {}) ⇒ Types::BatchUpdatePhoneNumberResponse
Updates phone number product types or calling names. You can update
one attribute at a time for each UpdatePhoneNumberRequestItem
. For
example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
985 986 987 988 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 985 def batch_update_phone_number(params = {}, = {}) req = build_request(:batch_update_phone_number, params) req.send_request() end |
#batch_update_user(params = {}) ⇒ Types::BatchUpdateUserResponse
Updates user details within the UpdateUserRequestItem object for up to
20 users for the specified Amazon Chime account. Currently, only
LicenseType
updates are supported for this action.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1032 def batch_update_user(params = {}, = {}) req = build_request(:batch_update_user, params) req.send_request() end |
#create_account(params = {}) ⇒ Types::CreateAccountResponse
Creates an Amazon Chime account under the administrator's AWS
account. Only Team
account types are currently supported for this
action. For more information about different account types, see
Managing Your Amazon Chime Accounts in the Amazon Chime
Administration Guide.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1078 def create_account(params = {}, = {}) req = build_request(:create_account, params) req.send_request() end |
#create_app_instance(params = {}) ⇒ Types::CreateAppInstanceResponse
Creates an Amazon Chime SDK messaging AppInstance
under an AWS
account. Only SDK messaging customers use this API.
CreateAppInstance
supports idempotency behavior as described in the
AWS API Standard.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1142 def create_app_instance(params = {}, = {}) req = build_request(:create_app_instance, params) req.send_request() end |
#create_app_instance_admin(params = {}) ⇒ Types::CreateAppInstanceAdminResponse
Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted
user can perform the following actions.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1198 def create_app_instance_admin(params = {}, = {}) req = build_request(:create_app_instance_admin, params) req.send_request() end |
#create_app_instance_user(params = {}) ⇒ Types::CreateAppInstanceUserResponse
Creates a user under an Amazon Chime AppInstance
. The request
consists of a unique appInstanceUserId
and Name
for that user.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1268 def create_app_instance_user(params = {}, = {}) req = build_request(:create_app_instance_user, params) req.send_request() end |
#create_attendee(params = {}) ⇒ Types::CreateAttendeeResponse
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.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1328 def create_attendee(params = {}, = {}) req = build_request(:create_attendee, params) req.send_request() end |
#create_bot(params = {}) ⇒ Types::CreateBotResponse
Creates a bot for an Amazon Chime Enterprise account.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1372 def create_bot(params = {}, = {}) req = build_request(:create_bot, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1462 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_channel_ban(params = {}) ⇒ Types::CreateChannelBanResponse
Permanently bans a member from a channel. Moderators can't add banned
members to a channel. To undo a ban, you first have to
DeleteChannelBan
, and then CreateChannelMembership
. Bans are
cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1526 def create_channel_ban(params = {}, = {}) req = build_request(:create_channel_ban, params) req.send_request() end |
#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse
Adds a user to a channel. The InvitedBy
response field is derived
from the request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1610 1611 1612 1613 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1610 def create_channel_membership(params = {}, = {}) req = build_request(:create_channel_membership, params) req.send_request() end |
#create_channel_moderator(params = {}) ⇒ Types::CreateChannelModeratorResponse
Creates a new ChannelModerator
. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1678 def create_channel_moderator(params = {}, = {}) req = build_request(:create_channel_moderator, params) req.send_request() end |
#create_media_capture_pipeline(params = {}) ⇒ Types::CreateMediaCapturePipelineResponse
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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1783 def create_media_capture_pipeline(params = {}, = {}) req = build_request(:create_media_capture_pipeline, params) req.send_request() end |
#create_meeting(params = {}) ⇒ Types::CreateMeetingResponse
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.
1880 1881 1882 1883 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1880 def create_meeting(params = {}, = {}) req = build_request(:create_meeting, params) req.send_request() end |
#create_meeting_dial_out(params = {}) ⇒ Types::CreateMeetingDialOutResponse
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response
(IVR), use the CreateSipMediaApplicationCall
action with the
corresponding SIP media application ID.
This API is is not available in a dedicated namespace.
1935 1936 1937 1938 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1935 def create_meeting_dial_out(params = {}, = {}) req = build_request(:create_meeting_dial_out, params) req.send_request() end |
#create_meeting_with_attendees(params = {}) ⇒ Types::CreateMeetingWithAttendeesResponse
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.
2058 2059 2060 2061 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2058 def create_meeting_with_attendees(params = {}, = {}) req = build_request(:create_meeting_with_attendees, params) req.send_request() end |
#create_phone_number_order(params = {}) ⇒ Types::CreatePhoneNumberOrderResponse
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.
2100 2101 2102 2103 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2100 def create_phone_number_order(params = {}, = {}) req = build_request(:create_phone_number_order, params) req.send_request() end |
#create_proxy_session(params = {}) ⇒ Types::CreateProxySessionResponse
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.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2191 def create_proxy_session(params = {}, = {}) req = build_request(:create_proxy_session, params) req.send_request() end |
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a chat room for the specified Amazon Chime Enterprise account.
2235 2236 2237 2238 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2235 def create_room(params = {}, = {}) req = build_request(:create_room, params) req.send_request() end |
#create_room_membership(params = {}) ⇒ Types::CreateRoomMembershipResponse
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.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2286 def create_room_membership(params = {}, = {}) req = build_request(:create_room_membership, params) req.send_request() end |
#create_sip_media_application(params = {}) ⇒ Types::CreateSipMediaApplicationResponse
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.
2346 2347 2348 2349 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2346 def create_sip_media_application(params = {}, = {}) req = build_request(:create_sip_media_application, params) req.send_request() end |
#create_sip_media_application_call(params = {}) ⇒ Types::CreateSipMediaApplicationCallResponse
Creates an outbound call to a phone number from the phone number
specified in the request, and it invokes the endpoint of the specified
sipMediaApplicationId
.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2404 def create_sip_media_application_call(params = {}, = {}) req = build_request(:create_sip_media_application_call, params) req.send_request() end |
#create_sip_rule(params = {}) ⇒ Types::CreateSipRuleResponse
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.
2487 2488 2489 2490 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2487 def create_sip_rule(params = {}, = {}) req = build_request(:create_sip_rule, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user under the specified Amazon Chime account.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2540 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#create_voice_connector(params = {}) ⇒ Types::CreateVoiceConnectorResponse
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.
2605 2606 2607 2608 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2605 def create_voice_connector(params = {}, = {}) req = build_request(:create_voice_connector, params) req.send_request() end |
#create_voice_connector_group(params = {}) ⇒ Types::CreateVoiceConnectorGroupResponse
Creates an Amazon Chime Voice Connector group under the
administrator's AWS account. You can associate Amazon Chime Voice
Connectors with the Amazon Chime Voice Connector group by including
VoiceConnectorItems
in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2669 2670 2671 2672 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2669 def create_voice_connector_group(params = {}, = {}) req = build_request(:create_voice_connector_group, params) req.send_request() end |
#delete_account(params = {}) ⇒ Struct
Deletes the specified Amazon Chime account. You must suspend all users
before deleting Team
account. You can use the BatchSuspendUser
action to dodo.
For EnterpriseLWA
and EnterpriseAD
accounts, you must release the
claimed domains for your Amazon Chime account before deletion. As soon
as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled
accounts list for 90 days.
To restore deleted account from your Disabled
accounts list, you
must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your
Disabled
accounts list.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2704 def delete_account(params = {}, = {}) req = build_request(:delete_account, params) req.send_request() end |
#delete_app_instance(params = {}) ⇒ Struct
Deletes an AppInstance
and all associated data asynchronously.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2739 2740 2741 2742 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2739 def delete_app_instance(params = {}, = {}) req = build_request(:delete_app_instance, params) req.send_request() end |
#delete_app_instance_admin(params = {}) ⇒ Struct
Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action
does not delete the user.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2779 2780 2781 2782 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2779 def delete_app_instance_admin(params = {}, = {}) req = build_request(:delete_app_instance_admin, params) req.send_request() end |
#delete_app_instance_streaming_configurations(params = {}) ⇒ Struct
Deletes the streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2815 2816 2817 2818 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2815 def delete_app_instance_streaming_configurations(params = {}, = {}) req = build_request(:delete_app_instance_streaming_configurations, params) req.send_request() end |
#delete_app_instance_user(params = {}) ⇒ Struct
Deletes an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2850 2851 2852 2853 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2850 def delete_app_instance_user(params = {}, = {}) req = build_request(:delete_app_instance_user, params) req.send_request() end |
#delete_attendee(params = {}) ⇒ Struct
Deletes an attendee from the specified Amazon Chime SDK meeting and
deletes their JoinToken
. Attendees are automatically deleted when a
Amazon Chime SDK meeting is deleted. For more information about the
Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon
Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2894 2895 2896 2897 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2894 def delete_attendee(params = {}, = {}) req = build_request(:delete_attendee, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2940 2941 2942 2943 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2940 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_channel_ban(params = {}) ⇒ Struct
Removes a user from a channel's ban list.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
2989 2990 2991 2992 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2989 def delete_channel_ban(params = {}, = {}) req = build_request(:delete_channel_ban, params) req.send_request() end |
#delete_channel_membership(params = {}) ⇒ Struct
Removes a member from a channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3038 3039 3040 3041 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3038 def delete_channel_membership(params = {}, = {}) req = build_request(:delete_channel_membership, params) req.send_request() end |
#delete_channel_message(params = {}) ⇒ Struct
Deletes a channel message. Only admins can perform this action.
Deletion makes messages inaccessible immediately. A background process
deletes any revisions created by UpdateChannelMessage
.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3089 3090 3091 3092 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3089 def (params = {}, = {}) req = build_request(:delete_channel_message, params) req.send_request() end |
#delete_channel_moderator(params = {}) ⇒ Struct
Deletes a channel moderator.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3138 3139 3140 3141 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3138 def delete_channel_moderator(params = {}, = {}) req = build_request(:delete_channel_moderator, params) req.send_request() end |
#delete_events_configuration(params = {}) ⇒ Struct
Deletes the events configuration that allows a bot to receive outgoing events.
3165 3166 3167 3168 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3165 def delete_events_configuration(params = {}, = {}) req = build_request(:delete_events_configuration, params) req.send_request() end |
#delete_media_capture_pipeline(params = {}) ⇒ Struct
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.
3200 3201 3202 3203 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3200 def delete_media_capture_pipeline(params = {}, = {}) req = build_request(:delete_media_capture_pipeline, params) req.send_request() end |
#delete_meeting(params = {}) ⇒ Struct
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.
3240 3241 3242 3243 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3240 def delete_meeting(params = {}, = {}) req = build_request(:delete_meeting, params) req.send_request() end |
#delete_phone_number(params = {}) ⇒ Struct
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.
3267 3268 3269 3270 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3267 def delete_phone_number(params = {}, = {}) req = build_request(:delete_phone_number, params) req.send_request() end |
#delete_proxy_session(params = {}) ⇒ Struct
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.
3307 3308 3309 3310 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3307 def delete_proxy_session(params = {}, = {}) req = build_request(:delete_proxy_session, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes a chat room in an Amazon Chime Enterprise account.
3333 3334 3335 3336 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3333 def delete_room(params = {}, = {}) req = build_request(:delete_room, params) req.send_request() end |
#delete_room_membership(params = {}) ⇒ Struct
Removes a member from a chat room in an Amazon Chime Enterprise account.
3364 3365 3366 3367 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3364 def delete_room_membership(params = {}, = {}) req = build_request(:delete_room_membership, params) req.send_request() end |
#delete_sip_media_application(params = {}) ⇒ Struct
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.
3399 3400 3401 3402 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3399 def delete_sip_media_application(params = {}, = {}) req = build_request(:delete_sip_media_application, params) req.send_request() end |
#delete_sip_rule(params = {}) ⇒ Struct
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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3435 def delete_sip_rule(params = {}, = {}) req = build_request(:delete_sip_rule, params) req.send_request() end |
#delete_voice_connector(params = {}) ⇒ Struct
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.
3472 3473 3474 3475 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3472 def delete_voice_connector(params = {}, = {}) req = build_request(:delete_voice_connector, params) req.send_request() end |
#delete_voice_connector_emergency_calling_configuration(params = {}) ⇒ Struct
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.
3509 3510 3511 3512 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3509 def delete_voice_connector_emergency_calling_configuration(params = {}, = {}) req = build_request(:delete_voice_connector_emergency_calling_configuration, params) req.send_request() end |
#delete_voice_connector_group(params = {}) ⇒ Struct
Deletes the specified Amazon Chime Voice Connector group. Any
VoiceConnectorItems
and phone numbers associated with the group must
be removed before it can be deleted.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3546 3547 3548 3549 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3546 def delete_voice_connector_group(params = {}, = {}) req = build_request(:delete_voice_connector_group, params) req.send_request() end |
#delete_voice_connector_origination(params = {}) ⇒ Struct
Deletes the origination settings 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, 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.
3588 3589 3590 3591 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3588 def delete_voice_connector_origination(params = {}, = {}) req = build_request(:delete_voice_connector_origination, params) req.send_request() end |
#delete_voice_connector_proxy(params = {}) ⇒ Struct
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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3624 def delete_voice_connector_proxy(params = {}, = {}) req = build_request(:delete_voice_connector_proxy, params) req.send_request() end |
#delete_voice_connector_streaming_configuration(params = {}) ⇒ Struct
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.
3661 3662 3663 3664 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3661 def delete_voice_connector_streaming_configuration(params = {}, = {}) req = build_request(:delete_voice_connector_streaming_configuration, params) req.send_request() end |
#delete_voice_connector_termination(params = {}) ⇒ Struct
Deletes the termination settings 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, 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.
3703 3704 3705 3706 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3703 def delete_voice_connector_termination(params = {}, = {}) req = build_request(:delete_voice_connector_termination, params) req.send_request() end |
#delete_voice_connector_termination_credentials(params = {}) ⇒ Struct
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.
3745 3746 3747 3748 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3745 def delete_voice_connector_termination_credentials(params = {}, = {}) req = build_request(:delete_voice_connector_termination_credentials, params) req.send_request() end |
#describe_app_instance(params = {}) ⇒ Types::DescribeAppInstanceResponse
Returns the full details of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3790 def describe_app_instance(params = {}, = {}) req = build_request(:describe_app_instance, params) req.send_request() end |
#describe_app_instance_admin(params = {}) ⇒ Types::DescribeAppInstanceAdminResponse
Returns the full details of an AppInstanceAdmin
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3838 def describe_app_instance_admin(params = {}, = {}) req = build_request(:describe_app_instance_admin, params) req.send_request() end |
#describe_app_instance_user(params = {}) ⇒ Types::DescribeAppInstanceUserResponse
Returns the full details of an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3883 3884 3885 3886 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3883 def describe_app_instance_user(params = {}, = {}) req = build_request(:describe_app_instance_user, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the full details of a channel in an Amazon Chime
AppInstance
.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
3944 3945 3946 3947 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3944 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_channel_ban(params = {}) ⇒ Types::DescribeChannelBanResponse
Returns the full details of a channel ban.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4004 4005 4006 4007 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4004 def describe_channel_ban(params = {}, = {}) req = build_request(:describe_channel_ban, params) req.send_request() end |
#describe_channel_membership(params = {}) ⇒ Types::DescribeChannelMembershipResponse
Returns the full details of a user's channel membership.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4066 4067 4068 4069 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4066 def describe_channel_membership(params = {}, = {}) req = build_request(:describe_channel_membership, params) req.send_request() end |
#describe_channel_membership_for_app_instance_user(params = {}) ⇒ Types::DescribeChannelMembershipForAppInstanceUserResponse
Returns the details of a channel based on the membership of the
specified AppInstanceUser
.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4130 4131 4132 4133 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4130 def describe_channel_membership_for_app_instance_user(params = {}, = {}) req = build_request(:describe_channel_membership_for_app_instance_user, params) req.send_request() end |
#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse
Returns the full details of a channel moderated by the specified
AppInstanceUser
.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4192 4193 4194 4195 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4192 def describe_channel_moderated_by_app_instance_user(params = {}, = {}) req = build_request(:describe_channel_moderated_by_app_instance_user, params) req.send_request() end |
#describe_channel_moderator(params = {}) ⇒ Types::DescribeChannelModeratorResponse
Returns the full details of a single ChannelModerator.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4252 4253 4254 4255 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4252 def describe_channel_moderator(params = {}, = {}) req = build_request(:describe_channel_moderator, params) req.send_request() end |
#disassociate_phone_number_from_user(params = {}) ⇒ Struct
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
4279 4280 4281 4282 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4279 def disassociate_phone_number_from_user(params = {}, = {}) req = build_request(:disassociate_phone_number_from_user, params) req.send_request() end |
#disassociate_phone_numbers_from_voice_connector(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorResponse
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.
4329 4330 4331 4332 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4329 def disassociate_phone_numbers_from_voice_connector(params = {}, = {}) req = build_request(:disassociate_phone_numbers_from_voice_connector, params) req.send_request() end |
#disassociate_phone_numbers_from_voice_connector_group(params = {}) ⇒ Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse
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.
4379 4380 4381 4382 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4379 def disassociate_phone_numbers_from_voice_connector_group(params = {}, = {}) req = build_request(:disassociate_phone_numbers_from_voice_connector_group, params) req.send_request() end |
#disassociate_signin_delegate_groups_from_account(params = {}) ⇒ Struct
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
4406 4407 4408 4409 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4406 def disassociate_signin_delegate_groups_from_account(params = {}, = {}) req = build_request(:disassociate_signin_delegate_groups_from_account, params) req.send_request() end |
#get_account(params = {}) ⇒ Types::GetAccountResponse
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
4445 4446 4447 4448 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4445 def get_account(params = {}, = {}) req = build_request(:get_account, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
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.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4481 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_app_instance_retention_settings(params = {}) ⇒ Types::GetAppInstanceRetentionSettingsResponse
Gets the retention settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4524 4525 4526 4527 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4524 def get_app_instance_retention_settings(params = {}, = {}) req = build_request(:get_app_instance_retention_settings, params) req.send_request() end |
#get_app_instance_streaming_configurations(params = {}) ⇒ Types::GetAppInstanceStreamingConfigurationsResponse
Gets the streaming settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4567 4568 4569 4570 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4567 def get_app_instance_streaming_configurations(params = {}, = {}) req = build_request(:get_app_instance_streaming_configurations, params) req.send_request() end |
#get_attendee(params = {}) ⇒ Types::GetAttendeeResponse
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.
4618 4619 4620 4621 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4618 def get_attendee(params = {}, = {}) req = build_request(:get_attendee, params) req.send_request() end |
#get_bot(params = {}) ⇒ Types::GetBotResponse
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
4659 4660 4661 4662 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4659 def get_bot(params = {}, = {}) req = build_request(:get_bot, params) req.send_request() end |
#get_channel_message(params = {}) ⇒ Types::GetChannelMessageResponse
Gets the full details of a channel message.
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
4725 4726 4727 4728 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4725 def (params = {}, = {}) req = build_request(:get_channel_message, params) req.send_request() end |
#get_events_configuration(params = {}) ⇒ Types::GetEventsConfigurationResponse
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
4760 4761 4762 4763 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4760 def get_events_configuration(params = {}, = {}) req = build_request(:get_events_configuration, params) req.send_request() end |
#get_global_settings(params = {}) ⇒ Types::GetGlobalSettingsResponse
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
4783 4784 4785 4786 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4783 def get_global_settings(params = {}, = {}) req = build_request(:get_global_settings, params) req.send_request() end |
#get_media_capture_pipeline(params = {}) ⇒ Types::GetMediaCapturePipelineResponse
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.
4840 4841 4842 4843 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4840 def get_media_capture_pipeline(params = {}, = {}) req = build_request(:get_media_capture_pipeline, params) req.send_request() end |
#get_meeting(params = {}) ⇒ Types::GetMeetingResponse
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 .
4894 4895 4896 4897 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4894 def get_meeting(params = {}, = {}) req = build_request(:get_meeting, params) req.send_request() end |
#get_messaging_session_endpoint(params = {}) ⇒ Types::GetMessagingSessionEndpointResponse
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.
4926 4927 4928 4929 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4926 def get_messaging_session_endpoint(params = {}, = {}) req = build_request(:get_messaging_session_endpoint, params) req.send_request() end |
#get_phone_number(params = {}) ⇒ Types::GetPhoneNumberResponse
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
4975 4976 4977 4978 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4975 def get_phone_number(params = {}, = {}) req = build_request(:get_phone_number, params) req.send_request() end |
#get_phone_number_order(params = {}) ⇒ Types::GetPhoneNumberOrderResponse
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.
5012 5013 5014 5015 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5012 def get_phone_number_order(params = {}, = {}) req = build_request(:get_phone_number_order, params) req.send_request() end |
#get_phone_number_settings(params = {}) ⇒ Types::GetPhoneNumberSettingsResponse
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
5034 5035 5036 5037 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5034 def get_phone_number_settings(params = {}, = {}) req = build_request(:get_phone_number_settings, params) req.send_request() end |
#get_proxy_session(params = {}) ⇒ Types::GetProxySessionResponse
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.
5096 5097 5098 5099 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5096 def get_proxy_session(params = {}, = {}) req = build_request(:get_proxy_session, params) req.send_request() end |
#get_retention_settings(params = {}) ⇒ Types::GetRetentionSettingsResponse
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.
5134 5135 5136 5137 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5134 def get_retention_settings(params = {}, = {}) req = build_request(:get_retention_settings, params) req.send_request() end |
#get_room(params = {}) ⇒ Types::GetRoomResponse
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
5172 5173 5174 5175 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5172 def get_room(params = {}, = {}) req = build_request(:get_room, params) req.send_request() end |
#get_sip_media_application(params = {}) ⇒ Types::GetSipMediaApplicationResponse
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.
5220 5221 5222 5223 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5220 def get_sip_media_application(params = {}, = {}) req = build_request(:get_sip_media_application, params) req.send_request() end |
#get_sip_media_application_logging_configuration(params = {}) ⇒ Types::GetSipMediaApplicationLoggingConfigurationResponse
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.
5263 5264 5265 5266 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5263 def get_sip_media_application_logging_configuration(params = {}, = {}) req = build_request(:get_sip_media_application_logging_configuration, params) req.send_request() end |
#get_sip_rule(params = {}) ⇒ Types::GetSipRuleResponse
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.
5315 5316 5317 5318 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5315 def get_sip_rule(params = {}, = {}) req = build_request(:get_sip_rule, params) req.send_request() end |
#get_user(params = {}) ⇒ Types::GetUserResponse
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.
5364 5365 5366 5367 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5364 def get_user(params = {}, = {}) req = build_request(:get_user, params) req.send_request() end |
#get_user_settings(params = {}) ⇒ Types::GetUserSettingsResponse
Retrieves settings for the specified user ID, such as any associated phone number settings.
5399 5400 5401 5402 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5399 def get_user_settings(params = {}, = {}) req = build_request(:get_user_settings, params) req.send_request() end |
#get_voice_connector(params = {}) ⇒ Types::GetVoiceConnectorResponse
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.
5448 5449 5450 5451 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5448 def get_voice_connector(params = {}, = {}) req = build_request(:get_voice_connector, params) req.send_request() end |
#get_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::GetVoiceConnectorEmergencyCallingConfigurationResponse
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.
5494 5495 5496 5497 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5494 def get_voice_connector_emergency_calling_configuration(params = {}, = {}) req = build_request(:get_voice_connector_emergency_calling_configuration, params) req.send_request() end |
#get_voice_connector_group(params = {}) ⇒ Types::GetVoiceConnectorGroupResponse
Retrieves details for the specified Amazon Chime Voice Connector
group, such as timestamps,name, and associated VoiceConnectorItems
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
5543 5544 5545 5546 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5543 def get_voice_connector_group(params = {}, = {}) req = build_request(:get_voice_connector_group, params) req.send_request() end |
#get_voice_connector_logging_configuration(params = {}) ⇒ Types::GetVoiceConnectorLoggingConfigurationResponse
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.
5587 5588 5589 5590 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5587 def get_voice_connector_logging_configuration(params = {}, = {}) req = build_request(:get_voice_connector_logging_configuration, params) req.send_request() end |
#get_voice_connector_origination(params = {}) ⇒ Types::GetVoiceConnectorOriginationResponse
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.
5635 5636 5637 5638 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5635 def get_voice_connector_origination(params = {}, = {}) req = build_request(:get_voice_connector_origination, params) req.send_request() end |
#get_voice_connector_proxy(params = {}) ⇒ Types::GetVoiceConnectorProxyResponse
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.
5681 5682 5683 5684 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5681 def get_voice_connector_proxy(params = {}, = {}) req = build_request(:get_voice_connector_proxy, params) req.send_request() end |
#get_voice_connector_streaming_configuration(params = {}) ⇒ Types::GetVoiceConnectorStreamingConfigurationResponse
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.
5728 5729 5730 5731 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5728 def get_voice_connector_streaming_configuration(params = {}, = {}) req = build_request(:get_voice_connector_streaming_configuration, params) req.send_request() end |
#get_voice_connector_termination(params = {}) ⇒ Types::GetVoiceConnectorTerminationResponse
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.
5776 5777 5778 5779 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5776 def get_voice_connector_termination(params = {}, = {}) req = build_request(:get_voice_connector_termination, params) req.send_request() end |
#get_voice_connector_termination_health(params = {}) ⇒ Types::GetVoiceConnectorTerminationHealthResponse
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves information about the last time a SIP OPTIONS
ping was
received from your SIP infrastructure for the specified Amazon Chime
Voice Connector.
5820 5821 5822 5823 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5820 def get_voice_connector_termination_health(params = {}, = {}) req = build_request(:get_voice_connector_termination_health, params) req.send_request() end |
#invite_users(params = {}) ⇒ Types::InviteUsersResponse
Sends email to a maximum of 50 users, inviting them to the specified
Amazon Chime Team
account. Only Team
account types are currently
supported for this action.
5862 5863 5864 5865 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5862 def invite_users(params = {}, = {}) req = build_request(:invite_users, params) req.send_request() end |
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5921 5922 5923 5924 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5921 def list_accounts(params = {}, = {}) req = build_request(:list_accounts, params) req.send_request() end |
#list_app_instance_admins(params = {}) ⇒ Types::ListAppInstanceAdminsResponse
Returns a list of the administrators in the AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5979 5980 5981 5982 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5979 def list_app_instance_admins(params = {}, = {}) req = build_request(:list_app_instance_admins, params) req.send_request() end |
#list_app_instance_users(params = {}) ⇒ Types::ListAppInstanceUsersResponse
List all AppInstanceUsers
created under a single AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6038 6039 6040 6041 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6038 def list_app_instance_users(params = {}, = {}) req = build_request(:list_app_instance_users, params) req.send_request() end |
#list_app_instances(params = {}) ⇒ Types::ListAppInstancesResponse
Lists all Amazon Chime AppInstance
s created under a single AWS
account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6092 6093 6094 6095 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6092 def list_app_instances(params = {}, = {}) req = build_request(:list_app_instances, params) req.send_request() end |
#list_attendee_tags(params = {}) ⇒ Types::ListAttendeeTagsResponse
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.
6129 6130 6131 6132 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6129 def (params = {}, = {}) req = build_request(:list_attendee_tags, params) req.send_request() end |
#list_attendees(params = {}) ⇒ Types::ListAttendeesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6188 6189 6190 6191 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6188 def list_attendees(params = {}, = {}) req = build_request(:list_attendees, params) req.send_request() end |
#list_bots(params = {}) ⇒ Types::ListBotsResponse
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6239 6240 6241 6242 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6239 def list_bots(params = {}, = {}) req = build_request(:list_bots, params) req.send_request() end |
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users banned from a particular channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6307 6308 6309 6310 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6307 def list_channel_bans(params = {}, = {}) req = build_request(:list_channel_bans, params) req.send_request() end |
#list_channel_memberships(params = {}) ⇒ Types::ListChannelMembershipsResponse
Lists all channel memberships in a channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6383 6384 6385 6386 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6383 def list_channel_memberships(params = {}, = {}) req = build_request(:list_channel_memberships, params) req.send_request() end |
#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse
Lists all channels that a particular AppInstanceUser
is a part of.
Only an AppInstanceAdmin
can call the API with a user ARN that is
not their own.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6458 6459 6460 6461 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6458 def list_channel_memberships_for_app_instance_user(params = {}, = {}) req = build_request(:list_channel_memberships_for_app_instance_user, params) req.send_request() end |
#list_channel_messages(params = {}) ⇒ Types::ListChannelMessagesResponse
List all the messages in a channel. Returns a paginated list of
ChannelMessages
. By default, sorted by creation timestamp in
descending order.
Also, the x-amz-chime-bearer request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6553 6554 6555 6556 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6553 def (params = {}, = {}) req = build_request(:list_channel_messages, params) req.send_request() end |
#list_channel_moderators(params = {}) ⇒ Types::ListChannelModeratorsResponse
Lists all the moderators for a channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6621 6622 6623 6624 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6621 def list_channel_moderators(params = {}, = {}) req = build_request(:list_channel_moderators, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy =
PUBLIC
to retrieve all public channels in the account.Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6706 6707 6708 6709 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6706 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_channels_moderated_by_app_instance_user(params = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse
A list of the channels moderated by an AppInstanceUser
.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6776 6777 6778 6779 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6776 def list_channels_moderated_by_app_instance_user(params = {}, = {}) req = build_request(:list_channels_moderated_by_app_instance_user, params) req.send_request() end |
#list_media_capture_pipelines(params = {}) ⇒ Types::ListMediaCapturePipelinesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6843 6844 6845 6846 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6843 def list_media_capture_pipelines(params = {}, = {}) req = build_request(:list_media_capture_pipelines, params) req.send_request() end |
#list_meeting_tags(params = {}) ⇒ Types::ListMeetingTagsResponse
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.
6886 6887 6888 6889 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6886 def (params = {}, = {}) req = build_request(:list_meeting_tags, params) req.send_request() end |
#list_meetings(params = {}) ⇒ Types::ListMeetingsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6943 6944 6945 6946 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6943 def list_meetings(params = {}, = {}) req = build_request(:list_meetings, params) req.send_request() end |
#list_phone_number_orders(params = {}) ⇒ Types::ListPhoneNumberOrdersResponse
Lists the phone number orders for the administrator's Amazon Chime account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6988 6989 6990 6991 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 6988 def list_phone_number_orders(params = {}, = {}) req = build_request(:list_phone_number_orders, params) req.send_request() end |
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7063 7064 7065 7066 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7063 def list_phone_numbers(params = {}, = {}) req = build_request(:list_phone_numbers, params) req.send_request() end |
#list_proxy_sessions(params = {}) ⇒ Types::ListProxySessionsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7138 7139 7140 7141 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7138 def list_proxy_sessions(params = {}, = {}) req = build_request(:list_proxy_sessions, params) req.send_request() end |
#list_room_memberships(params = {}) ⇒ Types::ListRoomMembershipsResponse
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7193 7194 7195 7196 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7193 def list_room_memberships(params = {}, = {}) req = build_request(:list_room_memberships, params) req.send_request() end |
#list_rooms(params = {}) ⇒ Types::ListRoomsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7245 7246 7247 7248 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7245 def list_rooms(params = {}, = {}) req = build_request(:list_rooms, params) req.send_request() end |
#list_sip_media_applications(params = {}) ⇒ Types::ListSipMediaApplicationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7303 7304 7305 7306 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7303 def list_sip_media_applications(params = {}, = {}) req = build_request(:list_sip_media_applications, params) req.send_request() end |
#list_sip_rules(params = {}) ⇒ Types::ListSipRulesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7368 7369 7370 7371 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7368 def list_sip_rules(params = {}, = {}) req = build_request(:list_sip_rules, params) req.send_request() end |
#list_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse
Lists supported phone number countries.
7399 7400 7401 7402 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7399 def list_supported_phone_number_countries(params = {}, = {}) req = build_request(:list_supported_phone_number_countries, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
7447 7448 7449 7450 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7447 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7512 7513 7514 7515 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7512 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_voice_connector_groups(params = {}) ⇒ Types::ListVoiceConnectorGroupsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7570 7571 7572 7573 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7570 def list_voice_connector_groups(params = {}, = {}) req = build_request(:list_voice_connector_groups, params) req.send_request() end |
#list_voice_connector_termination_credentials(params = {}) ⇒ Types::ListVoiceConnectorTerminationCredentialsResponse
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.
7614 7615 7616 7617 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7614 def list_voice_connector_termination_credentials(params = {}, = {}) req = build_request(:list_voice_connector_termination_credentials, params) req.send_request() end |
#list_voice_connectors(params = {}) ⇒ Types::ListVoiceConnectorsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7672 7673 7674 7675 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7672 def list_voice_connectors(params = {}, = {}) req = build_request(:list_voice_connectors, params) req.send_request() end |
#logout_user(params = {}) ⇒ Struct
Logs out the specified user from all of the devices they are currently logged into.
7699 7700 7701 7702 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7699 def logout_user(params = {}, = {}) req = build_request(:logout_user, params) req.send_request() end |
#put_app_instance_retention_settings(params = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse
Sets the amount of time in days that a given AppInstance
retains
data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
7751 7752 7753 7754 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7751 def put_app_instance_retention_settings(params = {}, = {}) req = build_request(:put_app_instance_retention_settings, params) req.send_request() end |
#put_app_instance_streaming_configurations(params = {}) ⇒ Types::PutAppInstanceStreamingConfigurationsResponse
The data streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
7803 7804 7805 7806 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7803 def put_app_instance_streaming_configurations(params = {}, = {}) req = build_request(:put_app_instance_streaming_configurations, params) req.send_request() end |
#put_events_configuration(params = {}) ⇒ Types::PutEventsConfigurationResponse
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.
7847 7848 7849 7850 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7847 def put_events_configuration(params = {}, = {}) req = build_request(:put_events_configuration, params) req.send_request() end |
#put_retention_settings(params = {}) ⇒ Types::PutRetentionSettingsResponse
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.
7904 7905 7906 7907 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7904 def put_retention_settings(params = {}, = {}) req = build_request(:put_retention_settings, params) req.send_request() end |
#put_sip_media_application_logging_configuration(params = {}) ⇒ Types::PutSipMediaApplicationLoggingConfigurationResponse
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.
7953 7954 7955 7956 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 7953 def put_sip_media_application_logging_configuration(params = {}, = {}) req = build_request(:put_sip_media_application_logging_configuration, params) req.send_request() end |
#put_voice_connector_emergency_calling_configuration(params = {}) ⇒ Types::PutVoiceConnectorEmergencyCallingConfigurationResponse
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.
8014 8015 8016 8017 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8014 def put_voice_connector_emergency_calling_configuration(params = {}, = {}) req = build_request(:put_voice_connector_emergency_calling_configuration, params) req.send_request() end |
#put_voice_connector_logging_configuration(params = {}) ⇒ Types::PutVoiceConnectorLoggingConfigurationResponse
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.
8065 8066 8067 8068 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8065 def put_voice_connector_logging_configuration(params = {}, = {}) req = build_request(:put_voice_connector_logging_configuration, params) req.send_request() end |
#put_voice_connector_origination(params = {}) ⇒ Types::PutVoiceConnectorOriginationResponse
Adds origination settings 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, 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.
8134 8135 8136 8137 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8134 def put_voice_connector_origination(params = {}, = {}) req = build_request(:put_voice_connector_origination, params) req.send_request() end |
#put_voice_connector_proxy(params = {}) ⇒ Types::PutVoiceConnectorProxyResponse
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.
8197 8198 8199 8200 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8197 def put_voice_connector_proxy(params = {}, = {}) req = build_request(:put_voice_connector_proxy, params) req.send_request() end |
#put_voice_connector_streaming_configuration(params = {}) ⇒ Types::PutVoiceConnectorStreamingConfigurationResponse
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.
8256 8257 8258 8259 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8256 def put_voice_connector_streaming_configuration(params = {}, = {}) req = build_request(:put_voice_connector_streaming_configuration, params) req.send_request() end |
#put_voice_connector_termination(params = {}) ⇒ Types::PutVoiceConnectorTerminationResponse
Adds termination settings 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, 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.
8320 8321 8322 8323 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8320 def put_voice_connector_termination(params = {}, = {}) req = build_request(:put_voice_connector_termination, params) req.send_request() end |
#put_voice_connector_termination_credentials(params = {}) ⇒ Struct
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.
8365 8366 8367 8368 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8365 def put_voice_connector_termination_credentials(params = {}, = {}) req = build_request(:put_voice_connector_termination_credentials, params) req.send_request() end |
#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse
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.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
8425 8426 8427 8428 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8425 def (params = {}, = {}) req = build_request(:redact_channel_message, params) req.send_request() end |
#redact_conversation_message(params = {}) ⇒ Struct
Redacts the specified message from the specified Amazon Chime conversation.
8456 8457 8458 8459 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8456 def (params = {}, = {}) req = build_request(:redact_conversation_message, params) req.send_request() end |
#redact_room_message(params = {}) ⇒ Struct
Redacts the specified message from the specified Amazon Chime channel.
8486 8487 8488 8489 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8486 def (params = {}, = {}) req = build_request(:redact_room_message, params) req.send_request() end |
#regenerate_security_token(params = {}) ⇒ Types::RegenerateSecurityTokenResponse
Regenerates the security token for a bot.
8526 8527 8528 8529 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8526 def regenerate_security_token(params = {}, = {}) req = build_request(:regenerate_security_token, params) req.send_request() end |
#reset_personal_pin(params = {}) ⇒ Types::ResetPersonalPINResponse
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
8573 8574 8575 8576 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8573 def reset_personal_pin(params = {}, = {}) req = build_request(:reset_personal_pin, params) req.send_request() end |
#restore_phone_number(params = {}) ⇒ Types::RestorePhoneNumberResponse
Moves a phone number from the Deletion queue back into the phone number Inventory.
8622 8623 8624 8625 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8622 def restore_phone_number(params = {}, = {}) req = build_request(:restore_phone_number, params) req.send_request() end |
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for phone numbers that can be ordered. For US numbers,
provide at least one of the following search filters: AreaCode
,
City
, State
, or TollFreePrefix
. If you provide City
, you must
also provide State
. Numbers outside the US only support the
PhoneNumberType
filter, which you must use.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8691 8692 8693 8694 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8691 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, params) req.send_request() end |
#send_channel_message(params = {}) ⇒ Types::SendChannelMessageResponse
Sends a message to a particular channel that the member is a part of.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
Also, STANDARD
messages can contain 4KB of data and the 1KB of
metadata. CONTROL
messages can contain 30 bytes of data and no
metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
8772 8773 8774 8775 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8772 def (params = {}, = {}) req = build_request(:send_channel_message, params) req.send_request() end |
#start_meeting_transcription(params = {}) ⇒ Struct
Starts transcription for the specified meetingId
. For more
information, refer to Using Amazon Chime SDK live transcription
in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed
event
will be sent with the contents of the BadRequestException
generated
by Amazon Transcribe. For more information on each parameter and which
combinations are valid, refer to the StartStreamTranscription API
in the Amazon Transcribe Developer Guide.
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.
8858 8859 8860 8861 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8858 def start_meeting_transcription(params = {}, = {}) req = build_request(:start_meeting_transcription, params) req.send_request() end |
#stop_meeting_transcription(params = {}) ⇒ Struct
Stops transcription for the specified meetingId
.
This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
8893 8894 8895 8896 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8893 def stop_meeting_transcription(params = {}, = {}) req = build_request(:stop_meeting_transcription, params) req.send_request() end |
#tag_attendee(params = {}) ⇒ Struct
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.
8931 8932 8933 8934 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8931 def tag_attendee(params = {}, = {}) req = build_request(:tag_attendee, params) req.send_request() end |
#tag_meeting(params = {}) ⇒ Struct
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.
8975 8976 8977 8978 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 8975 def tag_meeting(params = {}, = {}) req = build_request(:tag_meeting, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
9020 9021 9022 9023 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9020 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_attendee(params = {}) ⇒ Struct
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.
9054 9055 9056 9057 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9054 def untag_attendee(params = {}, = {}) req = build_request(:untag_attendee, params) req.send_request() end |
#untag_meeting(params = {}) ⇒ Struct
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.
9093 9094 9095 9096 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9093 def untag_meeting(params = {}, = {}) req = build_request(:untag_meeting, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
9136 9137 9138 9139 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9136 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account(params = {}) ⇒ Types::UpdateAccountResponse
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
9185 9186 9187 9188 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9185 def update_account(params = {}, = {}) req = build_request(:update_account, params) req.send_request() end |
#update_account_settings(params = {}) ⇒ Struct
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.
9221 9222 9223 9224 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9221 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates AppInstance
metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
9270 9271 9272 9273 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9270 def update_app_instance(params = {}, = {}) req = build_request(:update_app_instance, params) req.send_request() end |
#update_app_instance_user(params = {}) ⇒ Types::UpdateAppInstanceUserResponse
Updates the details of an AppInstanceUser
. You can update names and
metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
9320 9321 9322 9323 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9320 def update_app_instance_user(params = {}, = {}) req = build_request(:update_app_instance_user, params) req.send_request() end |
#update_bot(params = {}) ⇒ Types::UpdateBotResponse
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
9365 9366 9367 9368 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9365 def update_bot(params = {}, = {}) req = build_request(:update_bot, params) req.send_request() end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
9430 9431 9432 9433 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9430 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_channel_message(params = {}) ⇒ Types::UpdateChannelMessageResponse
Updates the content of a message.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
9495 9496 9497 9498 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9495 def (params = {}, = {}) req = build_request(:update_channel_message, params) req.send_request() end |
#update_channel_read_marker(params = {}) ⇒ Types::UpdateChannelReadMarkerResponse
The details of the time when a user last read messages in a channel.
x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
9546 9547 9548 9549 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9546 def update_channel_read_marker(params = {}, = {}) req = build_request(:update_channel_read_marker, params) req.send_request() end |
#update_global_settings(params = {}) ⇒ Struct
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
9578 9579 9580 9581 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9578 def update_global_settings(params = {}, = {}) req = build_request(:update_global_settings, params) req.send_request() end |
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
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.
9645 9646 9647 9648 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9645 def update_phone_number(params = {}, = {}) req = build_request(:update_phone_number, params) req.send_request() end |
#update_phone_number_settings(params = {}) ⇒ Struct
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.
9670 9671 9672 9673 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9670 def update_phone_number_settings(params = {}, = {}) req = build_request(:update_phone_number_settings, params) req.send_request() end |
#update_proxy_session(params = {}) ⇒ Types::UpdateProxySessionResponse
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.
9740 9741 9742 9743 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9740 def update_proxy_session(params = {}, = {}) req = build_request(:update_proxy_session, params) req.send_request() end |
#update_room(params = {}) ⇒ Types::UpdateRoomResponse
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
9782 9783 9784 9785 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9782 def update_room(params = {}, = {}) req = build_request(:update_room, params) req.send_request() end |
#update_room_membership(params = {}) ⇒ Types::UpdateRoomMembershipResponse
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.
9833 9834 9835 9836 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9833 def update_room_membership(params = {}, = {}) req = build_request(:update_room_membership, params) req.send_request() end |
#update_sip_media_application(params = {}) ⇒ Types::UpdateSipMediaApplicationResponse
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.
9892 9893 9894 9895 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9892 def update_sip_media_application(params = {}, = {}) req = build_request(:update_sip_media_application, params) req.send_request() end |
#update_sip_media_application_call(params = {}) ⇒ Types::UpdateSipMediaApplicationCallResponse
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.
9946 9947 9948 9949 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 9946 def update_sip_media_application_call(params = {}, = {}) req = build_request(:update_sip_media_application_call, params) req.send_request() end |
#update_sip_rule(params = {}) ⇒ Types::UpdateSipRuleResponse
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.
10015 10016 10017 10018 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10015 def update_sip_rule(params = {}, = {}) req = build_request(:update_sip_rule, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates user details for a specified user ID. Currently, only
LicenseType
updates are supported for this action.
10077 10078 10079 10080 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10077 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_user_settings(params = {}) ⇒ Struct
Updates the settings for the specified user, such as phone number settings.
10114 10115 10116 10117 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10114 def update_user_settings(params = {}, = {}) req = build_request(:update_user_settings, params) req.send_request() end |
#update_voice_connector(params = {}) ⇒ Types::UpdateVoiceConnectorResponse
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.
10171 10172 10173 10174 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10171 def update_voice_connector(params = {}, = {}) req = build_request(:update_voice_connector, params) req.send_request() end |
#update_voice_connector_group(params = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse
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.
10233 10234 10235 10236 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10233 def update_voice_connector_group(params = {}, = {}) req = build_request(:update_voice_connector_group, params) req.send_request() end |
#validate_e911_address(params = {}) ⇒ Types::ValidateE911AddressResponse
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.
10324 10325 10326 10327 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 10324 def validate_e911_address(params = {}, = {}) req = build_request(:validate_e911_address, params) req.send_request() end |