Class: Aws::Chatbot::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Chatbot::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Chatbot::EndpointParameters

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



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

Examples:

Request syntax with placeholder values


resp = client.create_chime_webhook_configuration({
  webhook_description: "ChimeWebhookDescription", # required
  webhook_url: "ChimeWebhookUrl", # required
  sns_topic_arns: ["Arn"], # required
  iam_role_arn: "Arn", # required
  configuration_name: "ConfigurationName", # required
  logging_level: "CustomerCwLogLevel",
})

Response structure


resp.webhook_configuration.webhook_description #=> String
resp.webhook_configuration.chat_configuration_arn #=> String
resp.webhook_configuration.iam_role_arn #=> String
resp.webhook_configuration.sns_topic_arns #=> Array
resp.webhook_configuration.sns_topic_arns[0] #=> String
resp.webhook_configuration.configuration_name #=> String
resp.webhook_configuration.logging_level #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :webhook_description (required, String) —

    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.

  • :webhook_url (required, String) —

    URL for the Chime webhook.

  • :sns_topic_arns (required, Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (required, String) —

    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.

  • :configuration_name (required, String) —

    The name of the configuration.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

Returns:

See Also:



469
470
471
472
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 469

def create_chime_webhook_configuration(params = {}, options = {})
  req = build_request(:create_chime_webhook_configuration, params)
  req.send_request(options)
end

#create_microsoft_teams_channel_configuration(params = {}) ⇒ Types::CreateTeamsChannelConfigurationResult

Creates MS Teams Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.create_microsoft_teams_channel_configuration({
  channel_id: "TeamsChannelId", # required
  channel_name: "TeamsChannelName",
  team_id: "UUID", # required
  team_name: "TeamName",
  tenant_id: "UUID", # required
  sns_topic_arns: ["Arn"],
  iam_role_arn: "Arn", # required
  configuration_name: "ConfigurationName", # required
  logging_level: "CustomerCwLogLevel",
  guardrail_policy_arns: ["GuardrailPolicyArn"],
  user_authorization_required: false,
})

Response structure


resp.channel_configuration.channel_id #=> String
resp.channel_configuration.channel_name #=> String
resp.channel_configuration.team_id #=> String
resp.channel_configuration.team_name #=> String
resp.channel_configuration.tenant_id #=> String
resp.channel_configuration.chat_configuration_arn #=> String
resp.channel_configuration.iam_role_arn #=> String
resp.channel_configuration.sns_topic_arns #=> Array
resp.channel_configuration.sns_topic_arns[0] #=> String
resp.channel_configuration.configuration_name #=> String
resp.channel_configuration.logging_level #=> String
resp.channel_configuration.guardrail_policy_arns #=> Array
resp.channel_configuration.guardrail_policy_arns[0] #=> String
resp.channel_configuration.user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_id (required, String) —

    The ID of the Microsoft Teams channel.

  • :channel_name (String) —

    The name of the Microsoft Teams channel.

  • :team_id (required, String) —

    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.

  • :team_name (String) —

    The name of the Microsoft Teams Team.

  • :tenant_id (required, String) —

    The ID of the Microsoft Teams tenant.

  • :sns_topic_arns (Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (required, String) —

    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.

  • :configuration_name (required, String) —

    The name of the configuration.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

  • :guardrail_policy_arns (Array<String>) —

    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.

  • :user_authorization_required (Boolean) —

    Enables use of a user role requirement in your chat configuration.

Returns:

See Also:



560
561
562
563
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 560

def create_microsoft_teams_channel_configuration(params = {}, options = {})
  req = build_request(:create_microsoft_teams_channel_configuration, params)
  req.send_request(options)
end

#create_slack_channel_configuration(params = {}) ⇒ Types::CreateSlackChannelConfigurationResult

Creates Slack Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.create_slack_channel_configuration({
  slack_team_id: "SlackTeamId", # required
  slack_channel_id: "SlackChannelId", # required
  slack_channel_name: "SlackChannelDisplayName",
  sns_topic_arns: ["Arn"],
  iam_role_arn: "Arn", # required
  configuration_name: "ConfigurationName", # required
  logging_level: "CustomerCwLogLevel",
  guardrail_policy_arns: ["GuardrailPolicyArn"],
  user_authorization_required: false,
})

Response structure


resp.channel_configuration.slack_team_name #=> String
resp.channel_configuration.slack_team_id #=> String
resp.channel_configuration.slack_channel_id #=> String
resp.channel_configuration.slack_channel_name #=> String
resp.channel_configuration.chat_configuration_arn #=> String
resp.channel_configuration.iam_role_arn #=> String
resp.channel_configuration.sns_topic_arns #=> Array
resp.channel_configuration.sns_topic_arns[0] #=> String
resp.channel_configuration.configuration_name #=> String
resp.channel_configuration.logging_level #=> String
resp.channel_configuration.guardrail_policy_arns #=> Array
resp.channel_configuration.guardrail_policy_arns[0] #=> String
resp.channel_configuration.user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :slack_team_id (required, String) —

    The ID of the Slack workspace authorized with AWS Chatbot.

  • :slack_channel_id (required, String) —

    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.

  • :slack_channel_name (String) —

    The name of the Slack Channel.

  • :sns_topic_arns (Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (required, String) —

    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.

  • :configuration_name (required, String) —

    The name of the configuration.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

  • :guardrail_policy_arns (Array<String>) —

    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.

  • :user_authorization_required (Boolean) —

    Enables use of a user role requirement in your chat configuration.

Returns:

See Also:



640
641
642
643
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 640

def create_slack_channel_configuration(params = {}, options = {})
  req = build_request(:create_slack_channel_configuration, params)
  req.send_request(options)
end

#delete_chime_webhook_configuration(params = {}) ⇒ Struct

Deletes a Chime Webhook Configuration

Examples:

Request syntax with placeholder values


resp = client.delete_chime_webhook_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the ChimeWebhookConfiguration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



662
663
664
665
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 662

def delete_chime_webhook_configuration(params = {}, options = {})
  req = build_request(:delete_chime_webhook_configuration, params)
  req.send_request(options)
end

#delete_microsoft_teams_channel_configuration(params = {}) ⇒ Struct

Deletes MS Teams Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.delete_microsoft_teams_channel_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the MicrosoftTeamsChannelConfiguration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



684
685
686
687
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 684

def delete_microsoft_teams_channel_configuration(params = {}, options = {})
  req = build_request(:delete_microsoft_teams_channel_configuration, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_microsoft_teams_configured_team({
  team_id: "UUID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :team_id (required, String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



713
714
715
716
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 713

def delete_microsoft_teams_configured_team(params = {}, options = {})
  req = build_request(:delete_microsoft_teams_configured_team, params)
  req.send_request(options)
end

#delete_microsoft_teams_user_identity(params = {}) ⇒ Struct

Deletes a Teams user identity

Examples:

Request syntax with placeholder values


resp = client.delete_microsoft_teams_user_identity({
  chat_configuration_arn: "ChatConfigurationArn", # required
  user_id: "UUID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

  • :user_id (required, String) —

    Id from Microsoft Teams for user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



740
741
742
743
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 740

def delete_microsoft_teams_user_identity(params = {}, options = {})
  req = build_request(:delete_microsoft_teams_user_identity, params)
  req.send_request(options)
end

#delete_slack_channel_configuration(params = {}) ⇒ Struct

Deletes Slack Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.delete_slack_channel_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the SlackChannelConfiguration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



762
763
764
765
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 762

def delete_slack_channel_configuration(params = {}, options = {})
  req = build_request(:delete_slack_channel_configuration, params)
  req.send_request(options)
end

#delete_slack_user_identity(params = {}) ⇒ Struct

Deletes a Slack user identity

Examples:

Request syntax with placeholder values


resp = client.delete_slack_user_identity({
  chat_configuration_arn: "ChatConfigurationArn", # required
  slack_team_id: "SlackTeamId", # required
  slack_user_id: "SlackUserId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the SlackChannelConfiguration associated with the user identity to delete.

  • :slack_team_id (required, String) —

    The ID of the Slack workspace authorized with AWS Chatbot.

  • :slack_user_id (required, String) —

    The ID of the user in Slack.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



793
794
795
796
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 793

def delete_slack_user_identity(params = {}, options = {})
  req = build_request(:delete_slack_user_identity, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_slack_workspace_authorization({
  slack_team_id: "SlackTeamId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :slack_team_id (required, String) —

    The ID of the Slack workspace authorized with AWS Chatbot.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



817
818
819
820
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 817

def delete_slack_workspace_authorization(params = {}, options = {})
  req = build_request(:delete_slack_workspace_authorization, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_chime_webhook_configurations({
  max_results: 1,
  next_token: "PaginationToken",
  chat_configuration_arn: "ChatConfigurationArn",
})

Response structure


resp.next_token #=> String
resp.webhook_configurations #=> Array
resp.webhook_configurations[0].webhook_description #=> String
resp.webhook_configurations[0].chat_configuration_arn #=> String
resp.webhook_configurations[0].iam_role_arn #=> String
resp.webhook_configurations[0].sns_topic_arns #=> Array
resp.webhook_configurations[0].sns_topic_arns[0] #=> String
resp.webhook_configurations[0].configuration_name #=> String
resp.webhook_configurations[0].logging_level #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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 the value specified by MaxResults.

  • :chat_configuration_arn (String) —

    An optional ARN of a ChimeWebhookConfiguration to describe.

Returns:

See Also:



870
871
872
873
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 870

def describe_chime_webhook_configurations(params = {}, options = {})
  req = build_request(:describe_chime_webhook_configurations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_slack_channel_configurations({
  max_results: 1,
  next_token: "PaginationToken",
  chat_configuration_arn: "ChatConfigurationArn",
})

Response structure


resp.next_token #=> String
resp.slack_channel_configurations #=> Array
resp.slack_channel_configurations[0].slack_team_name #=> String
resp.slack_channel_configurations[0].slack_team_id #=> String
resp.slack_channel_configurations[0].slack_channel_id #=> String
resp.slack_channel_configurations[0].slack_channel_name #=> String
resp.slack_channel_configurations[0].chat_configuration_arn #=> String
resp.slack_channel_configurations[0].iam_role_arn #=> String
resp.slack_channel_configurations[0].sns_topic_arns #=> Array
resp.slack_channel_configurations[0].sns_topic_arns[0] #=> String
resp.slack_channel_configurations[0].configuration_name #=> String
resp.slack_channel_configurations[0].logging_level #=> String
resp.slack_channel_configurations[0].guardrail_policy_arns #=> Array
resp.slack_channel_configurations[0].guardrail_policy_arns[0] #=> String
resp.slack_channel_configurations[0].user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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 the value specified by MaxResults.

  • :chat_configuration_arn (String) —

    An optional ARN of a SlackChannelConfiguration to describe.

Returns:

See Also:



929
930
931
932
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 929

def describe_slack_channel_configurations(params = {}, options = {})
  req = build_request(:describe_slack_channel_configurations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_slack_user_identities({
  chat_configuration_arn: "ChatConfigurationArn",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.slack_user_identities #=> Array
resp.slack_user_identities[0].iam_role_arn #=> String
resp.slack_user_identities[0].chat_configuration_arn #=> String
resp.slack_user_identities[0].slack_team_id #=> String
resp.slack_user_identities[0].slack_user_id #=> String
resp.slack_user_identities[0].aws_user_identity #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (String) —

    The ARN of the SlackChannelConfiguration associated with the user identities to describe.

  • :next_token (String) —

    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 the value specified by MaxResults.

  • :max_results (Integer) —

    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.

Returns:

See Also:



980
981
982
983
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 980

def describe_slack_user_identities(params = {}, options = {})
  req = build_request(:describe_slack_user_identities, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_slack_workspaces({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.slack_workspaces #=> Array
resp.slack_workspaces[0].slack_team_id #=> String
resp.slack_workspaces[0].slack_team_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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 the value specified by MaxResults.

Returns:

See Also:



1023
1024
1025
1026
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1023

def describe_slack_workspaces(params = {}, options = {})
  req = build_request(:describe_slack_workspaces, params)
  req.send_request(options)
end

#get_account_preferences(params = {}) ⇒ Types::GetAccountPreferencesResult

Get Chatbot account level preferences

Examples:

Response structure


resp..user_authorization_required #=> Boolean
resp..training_data_collection_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1043
1044
1045
1046
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1043

def (params = {}, options = {})
  req = build_request(:get_account_preferences, params)
  req.send_request(options)
end

#get_microsoft_teams_channel_configuration(params = {}) ⇒ Types::GetTeamsChannelConfigurationResult

Get a single MS Teams Channel Configurations

Examples:

Request syntax with placeholder values


resp = client.get_microsoft_teams_channel_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
})

Response structure


resp.channel_configuration.channel_id #=> String
resp.channel_configuration.channel_name #=> String
resp.channel_configuration.team_id #=> String
resp.channel_configuration.team_name #=> String
resp.channel_configuration.tenant_id #=> String
resp.channel_configuration.chat_configuration_arn #=> String
resp.channel_configuration.iam_role_arn #=> String
resp.channel_configuration.sns_topic_arns #=> Array
resp.channel_configuration.sns_topic_arns[0] #=> String
resp.channel_configuration.configuration_name #=> String
resp.channel_configuration.logging_level #=> String
resp.channel_configuration.guardrail_policy_arns #=> Array
resp.channel_configuration.guardrail_policy_arns[0] #=> String
resp.channel_configuration.user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.

Returns:

See Also:



1084
1085
1086
1087
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1084

def get_microsoft_teams_channel_configuration(params = {}, options = {})
  req = build_request(:get_microsoft_teams_channel_configuration, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_microsoft_teams_channel_configurations({
  max_results: 1,
  next_token: "PaginationToken",
  team_id: "UUID",
})

Response structure


resp.next_token #=> String
resp.team_channel_configurations #=> Array
resp.team_channel_configurations[0].channel_id #=> String
resp.team_channel_configurations[0].channel_name #=> String
resp.team_channel_configurations[0].team_id #=> String
resp.team_channel_configurations[0].team_name #=> String
resp.team_channel_configurations[0].tenant_id #=> String
resp.team_channel_configurations[0].chat_configuration_arn #=> String
resp.team_channel_configurations[0].iam_role_arn #=> String
resp.team_channel_configurations[0].sns_topic_arns #=> Array
resp.team_channel_configurations[0].sns_topic_arns[0] #=> String
resp.team_channel_configurations[0].configuration_name #=> String
resp.team_channel_configurations[0].logging_level #=> String
resp.team_channel_configurations[0].guardrail_policy_arns #=> Array
resp.team_channel_configurations[0].guardrail_policy_arns[0] #=> String
resp.team_channel_configurations[0].user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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 the value specified by MaxResults.

  • :team_id (String) —

    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.

Returns:

See Also:



1148
1149
1150
1151
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1148

def list_microsoft_teams_channel_configurations(params = {}, options = {})
  req = build_request(:list_microsoft_teams_channel_configurations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_microsoft_teams_configured_teams({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.configured_teams #=> Array
resp.configured_teams[0].tenant_id #=> String
resp.configured_teams[0].team_id #=> String
resp.configured_teams[0].team_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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 the value specified by MaxResults.

Returns:

See Also:



1192
1193
1194
1195
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1192

def list_microsoft_teams_configured_teams(params = {}, options = {})
  req = build_request(:list_microsoft_teams_configured_teams, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_microsoft_teams_user_identities({
  chat_configuration_arn: "ChatConfigurationArn",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.teams_user_identities #=> Array
resp.teams_user_identities[0].iam_role_arn #=> String
resp.teams_user_identities[0].chat_configuration_arn #=> String
resp.teams_user_identities[0].team_id #=> String
resp.teams_user_identities[0].user_id #=> String
resp.teams_user_identities[0].aws_user_identity #=> String
resp.teams_user_identities[0].teams_channel_id #=> String
resp.teams_user_identities[0].teams_tenant_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (String) —

    The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

  • :next_token (String) —

    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 the value specified by MaxResults.

  • :max_results (Integer) —

    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.

Returns:

See Also:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1245

def list_microsoft_teams_user_identities(params = {}, options = {})
  req = build_request(:list_microsoft_teams_user_identities, params)
  req.send_request(options)
end

#update_account_preferences(params = {}) ⇒ Types::UpdateAccountPreferencesResult

Update Chatbot account level preferences

Examples:

Request syntax with placeholder values


resp = client.({
  user_authorization_required: false,
  training_data_collection_enabled: false,
})

Response structure


resp..user_authorization_required #=> Boolean
resp..training_data_collection_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_authorization_required (Boolean) —

    Enables use of a user role requirement in your chat configuration.

  • :training_data_collection_enabled (Boolean) —

    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.

Returns:

See Also:



1287
1288
1289
1290
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1287

def (params = {}, options = {})
  req = build_request(:update_account_preferences, params)
  req.send_request(options)
end

#update_chime_webhook_configuration(params = {}) ⇒ Types::UpdateChimeWebhookConfigurationResult

Updates a Chime Webhook Configuration

Examples:

Request syntax with placeholder values


resp = client.update_chime_webhook_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
  webhook_description: "ChimeWebhookDescription",
  webhook_url: "ChimeWebhookUrl",
  sns_topic_arns: ["Arn"],
  iam_role_arn: "Arn",
  logging_level: "CustomerCwLogLevel",
})

Response structure


resp.webhook_configuration.webhook_description #=> String
resp.webhook_configuration.chat_configuration_arn #=> String
resp.webhook_configuration.iam_role_arn #=> String
resp.webhook_configuration.sns_topic_arns #=> Array
resp.webhook_configuration.sns_topic_arns[0] #=> String
resp.webhook_configuration.configuration_name #=> String
resp.webhook_configuration.logging_level #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the ChimeWebhookConfiguration to update.

  • :webhook_description (String) —

    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.

  • :webhook_url (String) —

    URL for the Chime webhook.

  • :sns_topic_arns (Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (String) —

    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.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

Returns:

See Also:



1346
1347
1348
1349
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1346

def update_chime_webhook_configuration(params = {}, options = {})
  req = build_request(:update_chime_webhook_configuration, params)
  req.send_request(options)
end

#update_microsoft_teams_channel_configuration(params = {}) ⇒ Types::UpdateTeamsChannelConfigurationResult

Updates MS Teams Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.update_microsoft_teams_channel_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
  channel_id: "TeamsChannelId", # required
  channel_name: "TeamsChannelName",
  sns_topic_arns: ["Arn"],
  iam_role_arn: "Arn",
  logging_level: "CustomerCwLogLevel",
  guardrail_policy_arns: ["GuardrailPolicyArn"],
  user_authorization_required: false,
})

Response structure


resp.channel_configuration.channel_id #=> String
resp.channel_configuration.channel_name #=> String
resp.channel_configuration.team_id #=> String
resp.channel_configuration.team_name #=> String
resp.channel_configuration.tenant_id #=> String
resp.channel_configuration.chat_configuration_arn #=> String
resp.channel_configuration.iam_role_arn #=> String
resp.channel_configuration.sns_topic_arns #=> Array
resp.channel_configuration.sns_topic_arns[0] #=> String
resp.channel_configuration.configuration_name #=> String
resp.channel_configuration.logging_level #=> String
resp.channel_configuration.guardrail_policy_arns #=> Array
resp.channel_configuration.guardrail_policy_arns[0] #=> String
resp.channel_configuration.user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the MicrosoftTeamsChannelConfiguration to update.

  • :channel_id (required, String) —

    The ID of the Microsoft Teams channel.

  • :channel_name (String) —

    The name of the Microsoft Teams channel.

  • :sns_topic_arns (Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (String) —

    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.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

  • :guardrail_policy_arns (Array<String>) —

    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.

  • :user_authorization_required (Boolean) —

    Enables use of a user role requirement in your chat configuration.

Returns:

See Also:



1420
1421
1422
1423
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1420

def update_microsoft_teams_channel_configuration(params = {}, options = {})
  req = build_request(:update_microsoft_teams_channel_configuration, params)
  req.send_request(options)
end

#update_slack_channel_configuration(params = {}) ⇒ Types::UpdateSlackChannelConfigurationResult

Updates Slack Channel Configuration

Examples:

Request syntax with placeholder values


resp = client.update_slack_channel_configuration({
  chat_configuration_arn: "ChatConfigurationArn", # required
  slack_channel_id: "SlackChannelId", # required
  slack_channel_name: "SlackChannelDisplayName",
  sns_topic_arns: ["Arn"],
  iam_role_arn: "Arn",
  logging_level: "CustomerCwLogLevel",
  guardrail_policy_arns: ["GuardrailPolicyArn"],
  user_authorization_required: false,
})

Response structure


resp.channel_configuration.slack_team_name #=> String
resp.channel_configuration.slack_team_id #=> String
resp.channel_configuration.slack_channel_id #=> String
resp.channel_configuration.slack_channel_name #=> String
resp.channel_configuration.chat_configuration_arn #=> String
resp.channel_configuration.iam_role_arn #=> String
resp.channel_configuration.sns_topic_arns #=> Array
resp.channel_configuration.sns_topic_arns[0] #=> String
resp.channel_configuration.configuration_name #=> String
resp.channel_configuration.logging_level #=> String
resp.channel_configuration.guardrail_policy_arns #=> Array
resp.channel_configuration.guardrail_policy_arns[0] #=> String
resp.channel_configuration.user_authorization_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :chat_configuration_arn (required, String) —

    The ARN of the SlackChannelConfiguration to update.

  • :slack_channel_id (required, String) —

    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.

  • :slack_channel_name (String) —

    The name of the Slack Channel.

  • :sns_topic_arns (Array<String>) —

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • :iam_role_arn (String) —

    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.

  • :logging_level (String) —

    Logging levels include ERROR, INFO, or NONE.

  • :guardrail_policy_arns (Array<String>) —

    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.

  • :user_authorization_required (Boolean) —

    Enables use of a user role requirement in your chat configuration.

Returns:

See Also:



1496
1497
1498
1499
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/client.rb', line 1496

def update_slack_channel_configuration(params = {}, options = {})
  req = build_request(:update_slack_channel_configuration, params)
  req.send_request(options)
end