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_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_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_meeting(params = {}) ⇒ Struct
Deletes the specified Amazon Chime SDK meeting.
-
#delete_phone_number(params = {}) ⇒ Struct
Moves the specified phone number into the Deletionqueue.
-
#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_meeting(params = {}) ⇒ Types::GetMeetingResponse
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
-
#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
Retrieves information about the last time a SIP
OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. -
#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_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_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK meeting resource.
-
#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 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.
-
#tag_attendee(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK 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_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.
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.
324 325 326 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 324 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.
355 356 357 358 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 355 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.
398 399 400 401 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 398 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.
441 442 443 444 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 441 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.
472 473 474 475 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 472 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. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
528 529 530 531 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 528 def batch_create_attendee(params = {}, = {}) req = build_request(:batch_create_attendee, 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.
575 576 577 578 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 575 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.
611 612 613 614 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 611 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.
666 667 668 669 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 666 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 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.
713 714 715 716 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 713 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 either the product type or the calling name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector 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.
761 762 763 764 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 761 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.
808 809 810 811 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 808 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.
853 854 855 856 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 853 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.
904 905 906 907 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 904 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.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
947 948 949 950 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 947 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1004 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 Developer Guide.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1054 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.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1098 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1175 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.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1226 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.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1297 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1352 def create_channel_moderator(params = {}, = {}) req = build_request(:create_channel_moderator, 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 Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
1438 1439 1440 1441 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1438 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.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1491 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 Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
1602 1603 1604 1605 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1602 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. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
1644 1645 1646 1647 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1644 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1722 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.
1766 1767 1768 1769 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1766 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.
1817 1818 1819 1820 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1817 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.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1864 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
.
1902 1903 1904 1905 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1902 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.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1972 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.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2025 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.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2076 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2126 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.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2161 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2183 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.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2210 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
.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2232 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
.
2254 2255 2256 2257 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2254 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 Developer Guide .
2288 2289 2290 2291 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2288 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.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2321 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.
2357 2358 2359 2360 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2357 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.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2393 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.
2431 2432 2433 2434 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2431 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.
2467 2468 2469 2470 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2467 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.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2494 def delete_events_configuration(params = {}, = {}) req = build_request(:delete_events_configuration, params) req.send_request() end |
#delete_meeting(params = {}) ⇒ Struct
Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted, clients connected to the meeting are disconnected, and clients can no longer join the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
2524 2525 2526 2527 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2524 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 Deletionqueue. 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.
2551 2552 2553 2554 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2551 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.
2578 2579 2580 2581 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2578 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.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2604 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.
2635 2636 2637 2638 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2635 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.
2657 2658 2659 2660 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2657 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.
2680 2681 2682 2683 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2680 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2704 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.
2727 2728 2729 2730 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2727 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.
2751 2752 2753 2754 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2751 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.
2780 2781 2782 2783 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2780 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.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2803 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.
2826 2827 2828 2829 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2826 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.
2855 2856 2857 2858 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2855 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.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2883 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
.
2915 2916 2917 2918 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2915 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
.
2950 2951 2952 2953 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2950 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
.
2982 2983 2984 2985 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2982 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.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3030 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.
3077 3078 3079 3080 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3077 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.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3126 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.
3176 3177 3178 3179 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3176 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.
3224 3225 3226 3227 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3224 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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3271 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.
3298 3299 3300 3301 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3298 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.
3334 3335 3336 3337 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3334 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.
3370 3371 3372 3373 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3370 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.
3397 3398 3399 3400 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3397 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3435 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.
3471 3472 3473 3474 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3471 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
.
3501 3502 3503 3504 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3501 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
.
3531 3532 3533 3534 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3531 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 Developer Guide .
3572 3573 3574 3575 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3572 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.
3613 3614 3615 3616 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3613 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.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3666 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.
3701 3702 3703 3704 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3701 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.
3724 3725 3726 3727 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3724 def get_global_settings(params = {}, = {}) req = build_request(:get_global_settings, params) req.send_request() end |
#get_meeting(params = {}) ⇒ Types::GetMeetingResponse
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 Developer Guide .
3767 3768 3769 3770 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3767 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.
3786 3787 3788 3789 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3786 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.
3834 3835 3836 3837 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3834 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.
3871 3872 3873 3874 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3871 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.
3893 3894 3895 3896 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3893 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.
3942 3943 3944 3945 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3942 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 .
3980 3981 3982 3983 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3980 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.
4018 4019 4020 4021 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4018 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.
4053 4054 4055 4056 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4053 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.
4082 4083 4084 4085 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4082 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.
4121 4122 4123 4124 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4121 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.
4170 4171 4172 4173 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4170 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.
4205 4206 4207 4208 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4205 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.
4240 4241 4242 4243 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4240 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.
4272 4273 4274 4275 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4272 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
.
4307 4308 4309 4310 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4307 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.
4337 4338 4339 4340 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4337 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.
4372 4373 4374 4375 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4372 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.
4405 4406 4407 4408 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4405 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.
4439 4440 4441 4442 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4439 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.
4474 4475 4476 4477 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4474 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
Retrieves information about the last time a SIP OPTIONS
ping was
received from your SIP infrastructure for the specified Amazon Chime
Voice Connector.
4505 4506 4507 4508 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4505 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.
4547 4548 4549 4550 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4547 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, toucan 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.
4605 4606 4607 4608 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4605 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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4650 4651 4652 4653 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4650 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
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4696 4697 4698 4699 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4696 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4737 4738 4739 4740 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4737 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.
4771 4772 4773 4774 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4771 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 Developer Guide .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4820 4821 4822 4823 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4820 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.
4871 4872 4873 4874 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4871 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4926 4927 4928 4929 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4926 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4989 4990 4991 4992 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 4989 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5050 5051 5052 5053 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5050 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5132 5133 5134 5135 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5132 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5187 5188 5189 5190 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5187 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 accountOnly 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5259 5260 5261 5262 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5259 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5316 5317 5318 5319 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5316 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_meeting_tags(params = {}) ⇒ Types::ListMeetingTagsResponse
Lists the tags applied to an Amazon Chime SDK meeting resource.
5346 5347 5348 5349 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5346 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. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5398 5399 5400 5401 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 5398 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.