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_signin_delegate_groups_with_account(params = {}) ⇒ Struct
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
-
#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_bot(params = {}) ⇒ Types::CreateBotResponse
Creates a bot for an Amazon Chime Enterprise account.
-
#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_phone_number_order(params = {}) ⇒ Types::CreatePhoneNumberOrderResponse
Creates an order for phone numbers to be provisioned.
-
#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_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user under the specified Amazon Chime account.
-
#delete_account(params = {}) ⇒ Struct
Deletes the specified Amazon Chime account.
-
#delete_events_configuration(params = {}) ⇒ Struct
Deletes the events configuration that allows a bot to receive outgoing events.
-
#delete_phone_number(params = {}) ⇒ Struct
Moves the specified phone number into the Deletion queue.
-
#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.
-
#disassociate_phone_number_from_user(params = {}) ⇒ Struct
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
-
#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_bot(params = {}) ⇒ Types::GetBotResponse
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
-
#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_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_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_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.
-
#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_bots(params = {}) ⇒ Types::ListBotsResponse
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
-
#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_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_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse
Lists supported phone number countries.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the users that belong to the specified Amazon Chime account.
-
#logout_user(params = {}) ⇒ Struct
Logs out the specified user from all of the devices they are currently logged into.
-
#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.
-
#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.
-
#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_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_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_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_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.
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.
476 477 478 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 476 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.
507 508 509 510 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 507 def associate_phone_number_with_user(params = {}, = {}) req = build_request(:associate_phone_number_with_user, 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.
538 539 540 541 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 538 def associate_signin_delegate_groups_with_account(params = {}, = {}) req = build_request(:associate_signin_delegate_groups_with_account, 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.
585 586 587 588 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 585 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.
621 622 623 624 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 621 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.
676 677 678 679 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 676 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.
724 725 726 727 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 724 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.
772 773 774 775 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 772 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.
819 820 821 822 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 819 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.
865 866 867 868 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 865 def create_account(params = {}, = {}) req = build_request(:create_account, params) req.send_request() end |
#create_bot(params = {}) ⇒ Types::CreateBotResponse
Creates a bot for an Amazon Chime Enterprise account.
909 910 911 912 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 909 def create_bot(params = {}, = {}) req = build_request(:create_bot, 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 not available in a dedicated namespace.
964 965 966 967 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 964 def create_meeting_dial_out(params = {}, = {}) req = build_request(:create_meeting_dial_out, 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.
1006 1007 1008 1009 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1006 def create_phone_number_order(params = {}, = {}) req = build_request(:create_phone_number_order, params) req.send_request() end |
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a chat room for the specified Amazon Chime Enterprise account.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1050 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.
1101 1102 1103 1104 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1101 def create_room_membership(params = {}, = {}) req = build_request(:create_room_membership, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user under the specified Amazon Chime account.
1154 1155 1156 1157 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1154 def create_user(params = {}, = {}) req = build_request(:create_user, 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.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1189 def delete_account(params = {}, = {}) req = build_request(:delete_account, params) req.send_request() end |
#delete_events_configuration(params = {}) ⇒ Struct
Deletes the events configuration that allows a bot to receive outgoing events.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1216 def delete_events_configuration(params = {}, = {}) req = build_request(:delete_events_configuration, 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.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1243 def delete_phone_number(params = {}, = {}) req = build_request(:delete_phone_number, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes a chat room in an Amazon Chime Enterprise account.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1269 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.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1300 def delete_room_membership(params = {}, = {}) req = build_request(:delete_room_membership, params) req.send_request() end |
#disassociate_phone_number_from_user(params = {}) ⇒ Struct
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
1327 1328 1329 1330 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1327 def disassociate_phone_number_from_user(params = {}, = {}) req = build_request(:disassociate_phone_number_from_user, 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1354 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.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1393 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.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1429 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, 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.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1470 def get_bot(params = {}, = {}) req = build_request(:get_bot, 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.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1505 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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1528 def get_global_settings(params = {}, = {}) req = build_request(:get_global_settings, 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.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1577 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.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1614 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.
1636 1637 1638 1639 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1636 def get_phone_number_settings(params = {}, = {}) req = build_request(:get_phone_number_settings, 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1674 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.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1712 def get_room(params = {}, = {}) req = build_request(:get_room, 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.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1761 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.
1796 1797 1798 1799 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1796 def get_user_settings(params = {}, = {}) req = build_request(:get_user_settings, 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.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1838 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.
1897 1898 1899 1900 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1897 def list_accounts(params = {}, = {}) req = build_request(:list_accounts, 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.
1948 1949 1950 1951 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1948 def list_bots(params = {}, = {}) req = build_request(:list_bots, 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.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 1993 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.
2068 2069 2070 2071 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2068 def list_phone_numbers(params = {}, = {}) req = build_request(:list_phone_numbers, 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.
2123 2124 2125 2126 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2123 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.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2175 def list_rooms(params = {}, = {}) req = build_request(:list_rooms, params) req.send_request() end |
#list_supported_phone_number_countries(params = {}) ⇒ Types::ListSupportedPhoneNumberCountriesResponse
Lists supported phone number countries.
2206 2207 2208 2209 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2206 def list_supported_phone_number_countries(params = {}, = {}) req = build_request(:list_supported_phone_number_countries, 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.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2271 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#logout_user(params = {}) ⇒ Struct
Logs out the specified user from all of the devices they are currently logged into.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2298 def logout_user(params = {}, = {}) req = build_request(:logout_user, 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.
2342 2343 2344 2345 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2342 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.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2399 def put_retention_settings(params = {}, = {}) req = build_request(:put_retention_settings, params) req.send_request() end |
#redact_conversation_message(params = {}) ⇒ Struct
Redacts the specified message from the specified Amazon Chime conversation.
2430 2431 2432 2433 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2430 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.
2460 2461 2462 2463 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2460 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.
2500 2501 2502 2503 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2500 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.
2547 2548 2549 2550 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2547 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.
2596 2597 2598 2599 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2596 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.
2665 2666 2667 2668 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2665 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, 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.
2714 2715 2716 2717 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2714 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.
2750 2751 2752 2753 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2750 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, 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.
2795 2796 2797 2798 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2795 def update_bot(params = {}, = {}) req = build_request(:update_bot, 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.
2827 2828 2829 2830 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2827 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.
2894 2895 2896 2897 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2894 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.
2919 2920 2921 2922 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2919 def update_phone_number_settings(params = {}, = {}) req = build_request(:update_phone_number_settings, 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.
2961 2962 2963 2964 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 2961 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.
3012 3013 3014 3015 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3012 def update_room_membership(params = {}, = {}) req = build_request(:update_room_membership, 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.
3074 3075 3076 3077 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3074 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.
3111 3112 3113 3114 |
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/client.rb', line 3111 def update_user_settings(params = {}, = {}) req = build_request(:update_user_settings, params) req.send_request() end |