Class: Aws::Chatbot::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Chatbot::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb
Overview
An API client for Chatbot. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Chatbot::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
-
#create_chime_webhook_configuration(params = {}) ⇒ Types::CreateChimeWebhookConfigurationResult
Creates Chime Webhook Configuration.
-
#create_microsoft_teams_channel_configuration(params = {}) ⇒ Types::CreateTeamsChannelConfigurationResult
Creates MS Teams Channel Configuration.
-
#create_slack_channel_configuration(params = {}) ⇒ Types::CreateSlackChannelConfigurationResult
Creates Slack Channel Configuration.
-
#delete_chime_webhook_configuration(params = {}) ⇒ Struct
Deletes a Chime Webhook Configuration.
-
#delete_microsoft_teams_channel_configuration(params = {}) ⇒ Struct
Deletes MS Teams Channel Configuration.
-
#delete_microsoft_teams_configured_team(params = {}) ⇒ Struct
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.
-
#delete_microsoft_teams_user_identity(params = {}) ⇒ Struct
Deletes a Teams user identity.
-
#delete_slack_channel_configuration(params = {}) ⇒ Struct
Deletes Slack Channel Configuration.
-
#delete_slack_user_identity(params = {}) ⇒ Struct
Deletes a Slack user identity.
-
#delete_slack_workspace_authorization(params = {}) ⇒ Struct
Deletes the Slack workspace authorization that allows channels to be configured in that workspace.
-
#describe_chime_webhook_configurations(params = {}) ⇒ Types::DescribeChimeWebhookConfigurationsResult
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn.
-
#describe_slack_channel_configurations(params = {}) ⇒ Types::DescribeSlackChannelConfigurationsResult
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn.
-
#describe_slack_user_identities(params = {}) ⇒ Types::DescribeSlackUserIdentitiesResult
Lists all Slack user identities with a mapped role.
-
#describe_slack_workspaces(params = {}) ⇒ Types::DescribeSlackWorkspacesResult
Lists all authorized Slack Workspaces for AWS Account.
-
#get_account_preferences(params = {}) ⇒ Types::GetAccountPreferencesResult
Get Chatbot account level preferences.
-
#get_microsoft_teams_channel_configuration(params = {}) ⇒ Types::GetTeamsChannelConfigurationResult
Get a single MS Teams Channel Configurations.
-
#list_microsoft_teams_channel_configurations(params = {}) ⇒ Types::ListTeamsChannelConfigurationsResult
Lists MS Teams Channel Configurations optionally filtered by TeamId.
-
#list_microsoft_teams_configured_teams(params = {}) ⇒ Types::ListMicrosoftTeamsConfiguredTeamsResult
Lists all authorized MS teams for AWS Account.
-
#list_microsoft_teams_user_identities(params = {}) ⇒ Types::ListMicrosoftTeamsUserIdentitiesResult
Lists all Microsoft Teams user identities with a mapped role.
-
#update_account_preferences(params = {}) ⇒ Types::UpdateAccountPreferencesResult
Update Chatbot account level preferences.
-
#update_chime_webhook_configuration(params = {}) ⇒ Types::UpdateChimeWebhookConfigurationResult
Updates a Chime Webhook Configuration.
-
#update_microsoft_teams_channel_configuration(params = {}) ⇒ Types::UpdateTeamsChannelConfigurationResult
Updates MS Teams Channel Configuration.
-
#update_slack_channel_configuration(params = {}) ⇒ Types::UpdateSlackChannelConfigurationResult
Updates Slack Channel Configuration.
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.
409 410 411 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#create_chime_webhook_configuration(params = {}) ⇒ Types::CreateChimeWebhookConfigurationResult
Creates Chime Webhook Configuration
468 469 470 471 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 468 def create_chime_webhook_configuration(params = {}, = {}) req = build_request(:create_chime_webhook_configuration, params) req.send_request() end |
#create_microsoft_teams_channel_configuration(params = {}) ⇒ Types::CreateTeamsChannelConfigurationResult
Creates MS Teams Channel Configuration
559 560 561 562 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 559 def create_microsoft_teams_channel_configuration(params = {}, = {}) req = build_request(:create_microsoft_teams_channel_configuration, params) req.send_request() end |
#create_slack_channel_configuration(params = {}) ⇒ Types::CreateSlackChannelConfigurationResult
Creates Slack Channel Configuration
639 640 641 642 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 639 def create_slack_channel_configuration(params = {}, = {}) req = build_request(:create_slack_channel_configuration, params) req.send_request() end |
#delete_chime_webhook_configuration(params = {}) ⇒ Struct
Deletes a Chime Webhook Configuration
661 662 663 664 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 661 def delete_chime_webhook_configuration(params = {}, = {}) req = build_request(:delete_chime_webhook_configuration, params) req.send_request() end |
#delete_microsoft_teams_channel_configuration(params = {}) ⇒ Struct
Deletes MS Teams Channel Configuration
683 684 685 686 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 683 def delete_microsoft_teams_channel_configuration(params = {}, = {}) req = build_request(:delete_microsoft_teams_channel_configuration, params) req.send_request() end |
#delete_microsoft_teams_configured_team(params = {}) ⇒ Struct
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.
712 713 714 715 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 712 def delete_microsoft_teams_configured_team(params = {}, = {}) req = build_request(:delete_microsoft_teams_configured_team, params) req.send_request() end |
#delete_microsoft_teams_user_identity(params = {}) ⇒ Struct
Deletes a Teams user identity
739 740 741 742 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 739 def delete_microsoft_teams_user_identity(params = {}, = {}) req = build_request(:delete_microsoft_teams_user_identity, params) req.send_request() end |
#delete_slack_channel_configuration(params = {}) ⇒ Struct
Deletes Slack Channel Configuration
761 762 763 764 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 761 def delete_slack_channel_configuration(params = {}, = {}) req = build_request(:delete_slack_channel_configuration, params) req.send_request() end |
#delete_slack_user_identity(params = {}) ⇒ Struct
Deletes a Slack user identity
792 793 794 795 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 792 def delete_slack_user_identity(params = {}, = {}) req = build_request(:delete_slack_user_identity, params) req.send_request() end |
#delete_slack_workspace_authorization(params = {}) ⇒ Struct
Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.
816 817 818 819 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 816 def (params = {}, = {}) req = build_request(:delete_slack_workspace_authorization, params) req.send_request() end |
#describe_chime_webhook_configurations(params = {}) ⇒ Types::DescribeChimeWebhookConfigurationsResult
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
869 870 871 872 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 869 def describe_chime_webhook_configurations(params = {}, = {}) req = build_request(:describe_chime_webhook_configurations, params) req.send_request() end |
#describe_slack_channel_configurations(params = {}) ⇒ Types::DescribeSlackChannelConfigurationsResult
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
928 929 930 931 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 928 def describe_slack_channel_configurations(params = {}, = {}) req = build_request(:describe_slack_channel_configurations, params) req.send_request() end |
#describe_slack_user_identities(params = {}) ⇒ Types::DescribeSlackUserIdentitiesResult
Lists all Slack user identities with a mapped role.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
979 980 981 982 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 979 def describe_slack_user_identities(params = {}, = {}) req = build_request(:describe_slack_user_identities, params) req.send_request() end |
#describe_slack_workspaces(params = {}) ⇒ Types::DescribeSlackWorkspacesResult
Lists all authorized Slack Workspaces for AWS Account
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1022 def describe_slack_workspaces(params = {}, = {}) req = build_request(:describe_slack_workspaces, params) req.send_request() end |
#get_account_preferences(params = {}) ⇒ Types::GetAccountPreferencesResult
Get Chatbot account level preferences
1042 1043 1044 1045 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1042 def get_account_preferences(params = {}, = {}) req = build_request(:get_account_preferences, params) req.send_request() end |
#get_microsoft_teams_channel_configuration(params = {}) ⇒ Types::GetTeamsChannelConfigurationResult
Get a single MS Teams Channel Configurations
1083 1084 1085 1086 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1083 def get_microsoft_teams_channel_configuration(params = {}, = {}) req = build_request(:get_microsoft_teams_channel_configuration, params) req.send_request() end |
#list_microsoft_teams_channel_configurations(params = {}) ⇒ Types::ListTeamsChannelConfigurationsResult
Lists MS Teams Channel Configurations optionally filtered by TeamId
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1147 1148 1149 1150 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1147 def list_microsoft_teams_channel_configurations(params = {}, = {}) req = build_request(:list_microsoft_teams_channel_configurations, params) req.send_request() end |
#list_microsoft_teams_configured_teams(params = {}) ⇒ Types::ListMicrosoftTeamsConfiguredTeamsResult
Lists all authorized MS teams for AWS Account
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1191 def list_microsoft_teams_configured_teams(params = {}, = {}) req = build_request(:list_microsoft_teams_configured_teams, params) req.send_request() end |
#list_microsoft_teams_user_identities(params = {}) ⇒ Types::ListMicrosoftTeamsUserIdentitiesResult
Lists all Microsoft Teams user identities with a mapped role.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1244 1245 1246 1247 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1244 def list_microsoft_teams_user_identities(params = {}, = {}) req = build_request(:list_microsoft_teams_user_identities, params) req.send_request() end |
#update_account_preferences(params = {}) ⇒ Types::UpdateAccountPreferencesResult
Update Chatbot account level preferences
1286 1287 1288 1289 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1286 def update_account_preferences(params = {}, = {}) req = build_request(:update_account_preferences, params) req.send_request() end |
#update_chime_webhook_configuration(params = {}) ⇒ Types::UpdateChimeWebhookConfigurationResult
Updates a Chime Webhook Configuration
1345 1346 1347 1348 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1345 def update_chime_webhook_configuration(params = {}, = {}) req = build_request(:update_chime_webhook_configuration, params) req.send_request() end |
#update_microsoft_teams_channel_configuration(params = {}) ⇒ Types::UpdateTeamsChannelConfigurationResult
Updates MS Teams Channel Configuration
1419 1420 1421 1422 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1419 def update_microsoft_teams_channel_configuration(params = {}, = {}) req = build_request(:update_microsoft_teams_channel_configuration, params) req.send_request() end |
#update_slack_channel_configuration(params = {}) ⇒ Types::UpdateSlackChannelConfigurationResult
Updates Slack Channel Configuration
1495 1496 1497 1498 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1495 def update_slack_channel_configuration(params = {}, = {}) req = build_request(:update_slack_channel_configuration, params) req.send_request() end |