lib/aws-sdk-chatbot/client.rb in aws-sdk-chatbot-1.9.0 vs lib/aws-sdk-chatbot/client.rb in aws-sdk-chatbot-1.10.0

- old
+ new

@@ -423,36 +423,50 @@ super end # @!group API Operations - # Creates Chime Webhook Configuration + # Creates an AWS Chatbot configuration for Amazon Chime. # # @option params [required, String] :webhook_description - # Description of the webhook. Recommend using the convention - # `RoomName/WebhookName`. See Chime setup tutorial for more details: - # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. + # A description of the webhook. We recommend using the convention + # `RoomName/WebhookName`. # + # For more information, see [Tutorial: Get started with Amazon Chime][1] + # in the <i> AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html + # # @option params [required, String] :webhook_url - # URL for the Chime webhook. + # The URL for the Amazon Chime webhook. # # @option params [required, Array<String>] :sns_topic_arns - # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + # The Amazon Resource Names (ARNs) of the SNS topics that deliver + # notifications to AWS Chatbot. # # @option params [required, String] :iam_role_arn - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [required, String] :configuration_name # The name of the configuration. # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @option params [Array<Types::Tag>] :tags - # A list of tags to apply to the configuration. + # A map of tags assigned to a resource. A tag is a string-to-string map + # of key-value pairs. # # @return [Types::CreateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateChimeWebhookConfigurationResult#webhook_configuration #webhook_configuration} => Types::ChimeWebhookConfiguration # @@ -493,57 +507,69 @@ def create_chime_webhook_configuration(params = {}, options = {}) req = build_request(:create_chime_webhook_configuration, params) req.send_request(options) end - # Creates MS Teams Channel Configuration + # Creates an AWS Chatbot configuration for Microsoft Teams. # # @option params [required, String] :channel_id # The ID of the Microsoft Teams channel. # # @option params [String] :channel_name # The name of the Microsoft Teams channel. # # @option params [required, String] :team_id - # The ID of the Microsoft Team authorized with AWS Chatbot. To get the - # team ID, you must perform the initial authorization flow with - # Microsoft Teams in the AWS Chatbot console. Then you can copy and - # paste the team ID from the console. For more details, see steps 1-4 in - # Get started with Microsoft Teams in the AWS Chatbot Administrator - # Guide. + # The ID of the Microsoft Teams authorized with AWS Chatbot. # + # To get the team ID, you must perform the initial authorization flow + # with Microsoft Teams in the AWS Chatbot console. Then you can copy and + # paste the team ID from the console. For more information, see [Step 1: + # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot + # Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup + # # @option params [String] :team_name # The name of the Microsoft Teams Team. # # @option params [required, String] :tenant_id # The ID of the Microsoft Teams tenant. # # @option params [Array<String>] :sns_topic_arns - # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + # The Amazon Resource Names (ARNs) of the SNS topics that deliver + # notifications to AWS Chatbot. # # @option params [required, String] :iam_role_arn - # The ARN of the IAM role that defines the permissions for AWS Chatbot. - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [required, String] :configuration_name # The name of the configuration. # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @option params [Array<String>] :guardrail_policy_arns # The list of IAM policy ARNs that are applied as channel guardrails. - # The AWS managed 'AdministratorAccess' policy is applied by default - # if this is not set. + # The AWS managed `AdministratorAccess` policy is applied by default if + # this is not set. # # @option params [Boolean] :user_authorization_required # Enables use of a user role requirement in your chat configuration. # # @option params [Array<Types::Tag>] :tags - # A list of tags to apply to the configuration. + # A map of tags assigned to a resource. A tag is a string-to-string map + # of key-value pairs. # # @return [Types::CreateTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateTeamsChannelConfigurationResult#channel_configuration #channel_configuration} => Types::TeamsChannelConfiguration # @@ -596,49 +622,57 @@ def create_microsoft_teams_channel_configuration(params = {}, options = {}) req = build_request(:create_microsoft_teams_channel_configuration, params) req.send_request(options) end - # Creates Slack Channel Configuration + # Creates an AWS Chatbot confugration for Slack. # # @option params [required, String] :slack_team_id # The ID of the Slack workspace authorized with AWS Chatbot. # # @option params [required, String] :slack_channel_id - # The ID of the Slack channel. To get the ID, open Slack, right click on - # the channel name in the left pane, then choose Copy Link. The channel - # ID is the 9-character string at the end of the URL. For example, - # ABCBBLZZZ. + # The ID of the Slack channel. # + # To get this ID, open Slack, right click on the channel name in the + # left pane, then choose Copy Link. The channel ID is the 9-character + # string at the end of the URL. For example, ABCBBLZZZ. + # # @option params [String] :slack_channel_name - # The name of the Slack Channel. + # The name of the Slack channel. # # @option params [Array<String>] :sns_topic_arns - # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + # The Amazon Resource Names (ARNs) of the SNS topics that deliver + # notifications to AWS Chatbot. # # @option params [required, String] :iam_role_arn - # The ARN of the IAM role that defines the permissions for AWS Chatbot. - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [required, String] :configuration_name # The name of the configuration. # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @option params [Array<String>] :guardrail_policy_arns # The list of IAM policy ARNs that are applied as channel guardrails. - # The AWS managed 'AdministratorAccess' policy is applied by default - # if this is not set. + # The AWS managed `AdministratorAccess` policy is applied by default if + # this is not set. # # @option params [Boolean] :user_authorization_required # Enables use of a user role requirement in your chat configuration. # # @option params [Array<Types::Tag>] :tags - # A list of tags to apply to the configuration. + # A map of tags assigned to a resource. A tag is a string-to-string map + # of key-value pairs. # # @return [Types::CreateSlackChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateSlackChannelConfigurationResult#channel_configuration #channel_configuration} => Types::SlackChannelConfiguration # @@ -688,14 +722,15 @@ def create_slack_channel_configuration(params = {}, options = {}) req = build_request(:create_slack_channel_configuration, params) req.send_request(options) end - # Deletes a Chime Webhook Configuration + # Deletes a Amazon Chime webhook configuration for AWS Chatbot. # # @option params [required, String] :chat_configuration_arn - # The ARN of the ChimeWebhookConfiguration to delete. + # The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to + # delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -710,14 +745,16 @@ def delete_chime_webhook_configuration(params = {}, options = {}) req = build_request(:delete_chime_webhook_configuration, params) req.send_request(options) end - # Deletes MS Teams Channel Configuration + # Deletes a Microsoft Teams channel configuration for AWS Chatbot # # @option params [required, String] :chat_configuration_arn - # The ARN of the MicrosoftTeamsChannelConfiguration to delete. + # The Amazon Resource Name (ARN) of the + # MicrosoftTeamsChannelConfiguration associated with the user identity + # to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -737,17 +774,22 @@ # 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. # # @option params [required, String] :team_id - # The ID of the Microsoft Team authorized with AWS Chatbot. To get the - # team ID, you must perform the initial authorization flow with - # Microsoft Teams in the AWS Chatbot console. Then you can copy and - # paste the team ID from the console. For more details, see steps 1-4 in - # Get started with Microsoft Teams in the AWS Chatbot Administrator - # Guide. + # The ID of the Microsoft Teams team authorized with AWS Chatbot. # + # To get the team ID, you must perform the initial authorization flow + # with Microsoft Teams in the AWS Chatbot console. Then you can copy and + # paste the team ID from the console. For more information, see [Step 1: + # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot + # Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_microsoft_teams_configured_team({ @@ -761,18 +803,18 @@ def delete_microsoft_teams_configured_team(params = {}, options = {}) req = build_request(:delete_microsoft_teams_configured_team, params) req.send_request(options) end - # Deletes a Teams user identity + # Identifes a user level permission for a channel configuration. # # @option params [required, String] :chat_configuration_arn # The ARN of the MicrosoftTeamsChannelConfiguration associated with the # user identity to delete. # # @option params [required, String] :user_id - # Id from Microsoft Teams for user. + # The Microsoft Teams user ID. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -788,14 +830,15 @@ def delete_microsoft_teams_user_identity(params = {}, options = {}) req = build_request(:delete_microsoft_teams_user_identity, params) req.send_request(options) end - # Deletes Slack Channel Configuration + # Deletes a Slack channel configuration for AWS Chatbot # # @option params [required, String] :chat_configuration_arn - # The ARN of the SlackChannelConfiguration to delete. + # The Amazon Resource Name (ARN) of the SlackChannelConfiguration to + # delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -810,21 +853,21 @@ def delete_slack_channel_configuration(params = {}, options = {}) req = build_request(:delete_slack_channel_configuration, params) req.send_request(options) end - # Deletes a Slack user identity + # Deletes a user level permission for a Slack channel configuration. # # @option params [required, String] :chat_configuration_arn # The ARN of the SlackChannelConfiguration associated with the user # identity to delete. # # @option params [required, String] :slack_team_id # The ID of the Slack workspace authorized with AWS Chatbot. # # @option params [required, String] :slack_user_id - # The ID of the user in Slack. + # The ID of the user in Slack # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -865,11 +908,11 @@ def delete_slack_workspace_authorization(params = {}, options = {}) req = build_request(:delete_slack_workspace_authorization, params) req.send_request(options) end - # Lists Chime Webhook Configurations optionally filtered by + # Lists Amazon Chime webhook configurations optionally filtered by # ChatConfigurationArn # # @option params [Integer] :max_results # The maximum number of results to include in the response. If more # results exist than the specified MaxResults value, a token is included @@ -880,11 +923,12 @@ # pagination of results from this action. If this parameter is # specified, the response includes only results beyond the token, up to # the value specified by MaxResults. # # @option params [String] :chat_configuration_arn - # An optional ARN of a ChimeWebhookConfiguration to describe. + # An optional Amazon Resource Number (ARN) of a + # ChimeWebhookConfiguration to describe. # # @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeChimeWebhookConfigurationsResult#next_token #next_token} => String # * {Types::DescribeChimeWebhookConfigurationsResult#webhook_configurations #webhook_configurations} => Array&lt;Types::ChimeWebhookConfiguration&gt; @@ -921,11 +965,11 @@ def describe_chime_webhook_configurations(params = {}, options = {}) req = build_request(:describe_chime_webhook_configurations, params) req.send_request(options) end - # Lists Slack Channel Configurations optionally filtered by + # Lists Slack channel configurations optionally filtered by # ChatConfigurationArn # # @option params [Integer] :max_results # The maximum number of results to include in the response. If more # results exist than the specified MaxResults value, a token is included @@ -936,11 +980,12 @@ # pagination of results from this action. If this parameter is # specified, the response includes only results beyond the token, up to # the value specified by MaxResults. # # @option params [String] :chat_configuration_arn - # An optional ARN of a SlackChannelConfiguration to describe. + # An optional Amazon Resource Number (ARN) of a + # SlackChannelConfiguration to describe. # # @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeSlackChannelConfigurationsResult#next_token #next_token} => String # * {Types::DescribeSlackChannelConfigurationsResult#slack_channel_configurations #slack_channel_configurations} => Array&lt;Types::SlackChannelConfiguration&gt; @@ -986,12 +1031,12 @@ end # Lists all Slack user identities with a mapped role. # # @option params [String] :chat_configuration_arn - # The ARN of the SlackChannelConfiguration associated with the user - # identities to describe. + # The Amazon Resource Number (ARN) of the SlackChannelConfiguration + # associated with the user identities to describe. # # @option params [String] :next_token # An optional token returned from a prior request. Use this token for # pagination of results from this action. If this parameter is # specified, the response includes only results beyond the token, up to @@ -1034,11 +1079,12 @@ def describe_slack_user_identities(params = {}, options = {}) req = build_request(:describe_slack_user_identities, params) req.send_request(options) end - # Lists all authorized Slack Workspaces for AWS Account + # List all authorized Slack workspaces connected to the AWS Account + # onboarded with AWS Chatbot. # # @option params [Integer] :max_results # The maximum number of results to include in the response. If more # results exist than the specified MaxResults value, a token is included # in the response so that the remaining results can be retrieved. @@ -1077,11 +1123,11 @@ def describe_slack_workspaces(params = {}, options = {}) req = build_request(:describe_slack_workspaces, params) req.send_request(options) end - # Get Chatbot account level preferences + # Returns AWS Chatbot account preferences. # # @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetAccountPreferencesResult#account_preferences #account_preferences} => Types::AccountPreferences # @@ -1097,14 +1143,15 @@ def get_account_preferences(params = {}, options = {}) req = build_request(:get_account_preferences, params) req.send_request(options) end - # Get a single MS Teams Channel Configurations + # Returns a Microsoft Teams channel configuration in an AWS account. # # @option params [required, String] :chat_configuration_arn - # The ARN of the MicrosoftTeamsChannelConfiguration to retrieve. + # The Amazon Resource Number (ARN) of the + # MicrosoftTeamsChannelConfiguration to retrieve. # # @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetTeamsChannelConfigurationResult#channel_configuration #channel_configuration} => Types::TeamsChannelConfiguration # @@ -1141,11 +1188,12 @@ def get_microsoft_teams_channel_configuration(params = {}, options = {}) req = build_request(:get_microsoft_teams_channel_configuration, params) req.send_request(options) end - # Lists MS Teams Channel Configurations optionally filtered by TeamId + # Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS + # account. # # @option params [Integer] :max_results # The maximum number of results to include in the response. If more # results exist than the specified MaxResults value, a token is included # in the response so that the remaining results can be retrieved. @@ -1155,17 +1203,22 @@ # pagination of results from this action. If this parameter is # specified, the response includes only results beyond the token, up to # the value specified by MaxResults. # # @option params [String] :team_id - # The ID of the Microsoft Team authorized with AWS Chatbot. To get the - # team ID, you must perform the initial authorization flow with - # Microsoft Teams in the AWS Chatbot console. Then you can copy and - # paste the team ID from the console. For more details, see steps 1-4 in - # Get started with Microsoft Teams in the AWS Chatbot Administrator - # Guide. + # The ID of the Microsoft Teams authorized with AWS Chatbot. # + # To get the team ID, you must perform the initial authorization flow + # with Microsoft Teams in the AWS Chatbot console. Then you can copy and + # paste the team ID from the console. For more information, see [Step 1: + # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot + # Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup + # # @return [Types::ListTeamsChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTeamsChannelConfigurationsResult#next_token #next_token} => String # * {Types::ListTeamsChannelConfigurationsResult#team_channel_configurations #team_channel_configurations} => Array&lt;Types::TeamsChannelConfiguration&gt; # @@ -1208,11 +1261,11 @@ def list_microsoft_teams_channel_configurations(params = {}, options = {}) req = build_request(:list_microsoft_teams_channel_configurations, params) req.send_request(options) end - # Lists all authorized MS teams for AWS Account + # Lists all authorized Microsoft Teams for an AWS Account # # @option params [Integer] :max_results # The maximum number of results to include in the response. If more # results exist than the specified MaxResults value, a token is included # in the response so that the remaining results can be retrieved. @@ -1252,15 +1305,16 @@ def list_microsoft_teams_configured_teams(params = {}, options = {}) req = build_request(:list_microsoft_teams_configured_teams, params) req.send_request(options) end - # Lists all Microsoft Teams user identities with a mapped role. + # A list all Microsoft Teams user identities with a mapped role. # # @option params [String] :chat_configuration_arn - # The ARN of the MicrosoftTeamsChannelConfiguration associated with the - # user identities to list. + # The Amazon Resource Number (ARN) of the + # MicrosoftTeamsChannelConfiguration associated with the user identities + # to list. # # @option params [String] :next_token # An optional token returned from a prior request. Use this token for # pagination of results from this action. If this parameter is # specified, the response includes only results beyond the token, up to @@ -1305,14 +1359,15 @@ def list_microsoft_teams_user_identities(params = {}, options = {}) req = build_request(:list_microsoft_teams_user_identities, params) req.send_request(options) end - # Retrieves the list of tags applied to a configuration. + # Lists all of the tags associated with the Amazon Resource Name (ARN) + # that you specify. The resource can be a user, server, or role. # # @option params [required, String] :resource_arn - # The ARN of the configuration. + # The ARN you specified to list the tags of. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt; # @@ -1335,11 +1390,13 @@ def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end - # Applies the supplied tags to a configuration. + # Attaches a key-value pair to a resource, as identified by its Amazon + # Resource Name (ARN). Resources are users, servers, roles, and other + # entities. # # @option params [required, String] :resource_arn # The ARN of the configuration. # # @option params [required, Array<Types::Tag>] :tags @@ -1366,17 +1423,23 @@ def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end - # Removes the supplied tags from a configuration + # Detaches a key-value pair from a resource, as identified by its Amazon + # Resource Name (ARN). Resources are users, servers, roles, and other + # entities. # # @option params [required, String] :resource_arn - # The ARN of the configuration. + # The value of the resource that will have the tag removed. An Amazon + # Resource Name (ARN) is an identifier for a specific AWS resource, such + # as a server, user, or role. # # @option params [required, Array<String>] :tag_keys - # A list of tag keys to remove from the configuration. + # TagKeys are key-value pairs assigned to ARNs that can be used to group + # and search for resources by type. This metadata can be attached to + # resources for any purpose. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1392,27 +1455,28 @@ def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end - # Update Chatbot account level preferences + # Updates AWS Chatbot account preferences. # # @option params [Boolean] :user_authorization_required # Enables use of a user role requirement in your chat configuration. # # @option params [Boolean] :training_data_collection_enabled - # Turns on training data collection. This helps improve the AWS Chatbot - # experience by allowing AWS Chatbot to store and use your customer - # information, such as AWS Chatbot configurations, notifications, user - # inputs, AWS Chatbot generated responses, and interaction data. This - # data helps us to continuously improve and develop Artificial - # Intelligence (AI) technologies. Your data is not shared with any third - # parties and is protected using sophisticated controls to prevent - # unauthorized access and misuse. AWS Chatbot does not store or use - # interactions in chat channels with Amazon Q for training AWS Chatbot’s - # AI technologies. + # Turns on training data collection. # + # This helps improve the AWS Chatbot experience by allowing AWS Chatbot + # to store and use your customer information, such as AWS Chatbot + # configurations, notifications, user inputs, AWS Chatbot generated + # responses, and interaction data. This data helps us to continuously + # improve and develop Artificial Intelligence (AI) technologies. Your + # data is not shared with any third parties and is protected using + # sophisticated controls to prevent unauthorized access and misuse. AWS + # Chatbot does not store or use interactions in chat channels with + # Amazon Q for training AI technologies for AWS Chatbot. + # # @return [Types::UpdateAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateAccountPreferencesResult#account_preferences #account_preferences} => Types::AccountPreferences # # @example Request syntax with placeholder values @@ -1434,34 +1498,46 @@ def update_account_preferences(params = {}, options = {}) req = build_request(:update_account_preferences, params) req.send_request(options) end - # Updates a Chime Webhook Configuration + # Updates a Amazon Chime webhook configuration. # # @option params [required, String] :chat_configuration_arn - # The ARN of the ChimeWebhookConfiguration to update. + # The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to + # update. # # @option params [String] :webhook_description - # Description of the webhook. Recommend using the convention - # `RoomName/WebhookName`. See Chime setup tutorial for more details: - # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. + # A description of the webhook. We recommend using the convention + # `RoomName/WebhookName`. # + # For more information, see [Tutorial: Get started with Amazon Chime][1] + # in the <i> AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html + # # @option params [String] :webhook_url - # URL for the Chime webhook. + # The URL for the Amazon Chime webhook. # # @option params [Array<String>] :sns_topic_arns # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. # # @option params [String] :iam_role_arn - # The ARN of the IAM role that defines the permissions for AWS Chatbot. - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @return [Types::UpdateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateChimeWebhookConfigurationResult#webhook_configuration #webhook_configuration} => Types::ChimeWebhookConfiguration # @@ -1496,37 +1572,44 @@ def update_chime_webhook_configuration(params = {}, options = {}) req = build_request(:update_chime_webhook_configuration, params) req.send_request(options) end - # Updates MS Teams Channel Configuration + # Updates an Microsoft Teams channel configuration. # # @option params [required, String] :chat_configuration_arn - # The ARN of the MicrosoftTeamsChannelConfiguration to update. + # The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to + # update. # # @option params [required, String] :channel_id # The ID of the Microsoft Teams channel. # # @option params [String] :channel_name # The name of the Microsoft Teams channel. # # @option params [Array<String>] :sns_topic_arns - # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + # The Amazon Resource Names (ARNs) of the SNS topics that deliver + # notifications to AWS Chatbot. # # @option params [String] :iam_role_arn - # The ARN of the IAM role that defines the permissions for AWS Chatbot. - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @option params [Array<String>] :guardrail_policy_arns # The list of IAM policy ARNs that are applied as channel guardrails. - # The AWS managed 'AdministratorAccess' policy is applied by default - # if this is not set. + # The AWS managed `AdministratorAccess` policy is applied by default if + # this is not set. # # @option params [Boolean] :user_authorization_required # Enables use of a user role requirement in your chat configuration. # # @return [Types::UpdateTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1573,40 +1656,48 @@ def update_microsoft_teams_channel_configuration(params = {}, options = {}) req = build_request(:update_microsoft_teams_channel_configuration, params) req.send_request(options) end - # Updates Slack Channel Configuration + # Updates a Slack channel configuration. # # @option params [required, String] :chat_configuration_arn - # The ARN of the SlackChannelConfiguration to update. + # The Amazon Resource Number (ARN) of the SlackChannelConfiguration to + # update. # # @option params [required, String] :slack_channel_id - # The ID of the Slack channel. To get the ID, open Slack, right click on - # the channel name in the left pane, then choose Copy Link. The channel - # ID is the 9-character string at the end of the URL. For example, - # ABCBBLZZZ. + # The ID of the Slack channel. # + # To get this ID, open Slack, right click on the channel name in the + # left pane, then choose Copy Link. The channel ID is the 9-character + # string at the end of the URL. For example, ABCBBLZZZ. + # # @option params [String] :slack_channel_name - # The name of the Slack Channel. + # The name of the Slack channel. # # @option params [Array<String>] :sns_topic_arns - # The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + # The Amazon Resource Names (ARNs) of the SNS topics that deliver + # notifications to AWS Chatbot. # # @option params [String] :iam_role_arn - # The ARN of the IAM role that defines the permissions for AWS Chatbot. - # This is a user-defined role that AWS Chatbot will assume. This is not - # the service-linked role. For more information, see IAM Policies for - # AWS Chatbot. + # A user-defined role that AWS Chatbot assumes. This is not the + # service-linked role. # + # For more information, see [IAM policies for AWS Chatbot][1] in the <i> + # AWS Chatbot Administrator Guide</i>. + # + # + # + # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html + # # @option params [String] :logging_level - # Logging levels include ERROR, INFO, or NONE. + # Logging levels include `ERROR`, `INFO`, or `NONE`. # # @option params [Array<String>] :guardrail_policy_arns # The list of IAM policy ARNs that are applied as channel guardrails. - # The AWS managed 'AdministratorAccess' policy is applied by default - # if this is not set. + # The AWS managed `AdministratorAccess` policy is applied by default if + # this is not set. # # @option params [Boolean] :user_authorization_required # Enables use of a user role requirement in your chat configuration. # # @return [Types::UpdateSlackChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1665,10 +1756,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-chatbot' - context[:gem_version] = '1.9.0' + context[:gem_version] = '1.10.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated