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.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags applied to a configuration.
-
#tag_resource(params = {}) ⇒ Struct
Applies the supplied tags to a configuration.
-
#untag_resource(params = {}) ⇒ Struct
Removes the supplied tags from a configuration.
-
#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.
410 411 412 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_chime_webhook_configuration(params = {}) ⇒ Types::CreateChimeWebhookConfigurationResult
Creates Chime Webhook Configuration
481 482 483 484 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 481 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
584 585 586 587 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 584 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
676 677 678 679 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 676 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
698 699 700 701 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 698 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
720 721 722 723 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 720 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.
749 750 751 752 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 749 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
776 777 778 779 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 776 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
798 799 800 801 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 798 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
829 830 831 832 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 829 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.
853 854 855 856 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 853 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.
909 910 911 912 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 909 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.
971 972 973 974 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 971 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.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1022 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1065 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
1085 1086 1087 1088 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1085 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
1129 1130 1131 1132 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1129 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1196 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.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1240 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.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1293 def list_microsoft_teams_user_identities(params = {}, = {}) req = build_request(:list_microsoft_teams_user_identities, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags applied to a configuration.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1323 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies the supplied tags to a configuration.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1354 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the supplied tags from a configuration
1380 1381 1382 1383 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1380 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_preferences(params = {}) ⇒ Types::UpdateAccountPreferencesResult
Update Chatbot account level preferences
1422 1423 1424 1425 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1422 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
1484 1485 1486 1487 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1484 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
1561 1562 1563 1564 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1561 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
1640 1641 1642 1643 |
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1640 def update_slack_channel_configuration(params = {}, = {}) req = build_request(:update_slack_channel_configuration, params) req.send_request() end |