aws-sdk-chatbot 1.18.0 → 1.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chatbot/client.rb +529 -12
- data/lib/aws-sdk-chatbot/client_api.rb +246 -0
- data/lib/aws-sdk-chatbot/errors.rb +16 -0
- data/lib/aws-sdk-chatbot/types.rb +435 -12
- data/lib/aws-sdk-chatbot.rb +2 -2
- data/sig/client.rbs +129 -0
- data/sig/errors.rbs +3 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +128 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4d63b01722f0909fde925bbe8b426c36a3844d097b39b4dbac6fccc9cbbd87f2
|
4
|
+
data.tar.gz: fd8c53bf770a30e14a247e34f50ce938d66c8975146db0912b4f1bb1b88d6caf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2b11183f09dc428dc9e3d7fea7b54b7506f8be97b2896c52219dbb7f09911ae4bbf04c77f7b55f35ae7c5a3c2c55b636c7219f60a429e2081dfbb401b875950d
|
7
|
+
data.tar.gz: 867909ae06781a3a50af81145f5dc12c682751329004c2dc58d0d07acdfba940b928b5333485460726fb8a5dc9c140d71315049867c8407f8c20309daa9c1d1f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.20.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.19.0 (2024-11-22)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adds support for programmatic management of custom actions and aliases which can be associated with channel configurations.
|
13
|
+
|
4
14
|
1.18.0 (2024-10-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.20.0
|
@@ -257,11 +257,34 @@ module Aws::Chatbot
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -447,6 +470,47 @@ module Aws::Chatbot
|
|
447
470
|
|
448
471
|
# @!group API Operations
|
449
472
|
|
473
|
+
# Links a resource (for example, a custom action) to a channel
|
474
|
+
# configuration.
|
475
|
+
#
|
476
|
+
# @option params [required, String] :resource
|
477
|
+
# The resource Amazon Resource Name (ARN) to link.
|
478
|
+
#
|
479
|
+
# @option params [required, String] :chat_configuration
|
480
|
+
# The channel configuration to associate with the resource.
|
481
|
+
#
|
482
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
483
|
+
#
|
484
|
+
#
|
485
|
+
# @example Example: Associate a custom action to a configuration
|
486
|
+
#
|
487
|
+
# # Associate a custom action to a channel configuration, allowing it to be used in that channel
|
488
|
+
#
|
489
|
+
# resp = client.associate_to_configuration({
|
490
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
491
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
492
|
+
# })
|
493
|
+
#
|
494
|
+
# resp.to_h outputs the following:
|
495
|
+
# {
|
496
|
+
# }
|
497
|
+
#
|
498
|
+
# @example Request syntax with placeholder values
|
499
|
+
#
|
500
|
+
# resp = client.associate_to_configuration({
|
501
|
+
# resource: "ResourceIdentifier", # required
|
502
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
503
|
+
# })
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/AssociateToConfiguration AWS API Documentation
|
506
|
+
#
|
507
|
+
# @overload associate_to_configuration(params = {})
|
508
|
+
# @param [Hash] params ({})
|
509
|
+
def associate_to_configuration(params = {}, options = {})
|
510
|
+
req = build_request(:associate_to_configuration, params)
|
511
|
+
req.send_request(options)
|
512
|
+
end
|
513
|
+
|
450
514
|
# Creates an AWS Chatbot configuration for Amazon Chime.
|
451
515
|
#
|
452
516
|
# @option params [required, String] :webhook_description
|
@@ -533,6 +597,133 @@ module Aws::Chatbot
|
|
533
597
|
req.send_request(options)
|
534
598
|
end
|
535
599
|
|
600
|
+
# Creates a custom action that can be invoked as an alias or as a button
|
601
|
+
# on a notification.
|
602
|
+
#
|
603
|
+
# @option params [required, Types::CustomActionDefinition] :definition
|
604
|
+
# The definition of the command to run when invoked as an alias or as an
|
605
|
+
# action button.
|
606
|
+
#
|
607
|
+
# @option params [String] :alias_name
|
608
|
+
# The name used to invoke this action in a chat channel. For example,
|
609
|
+
# `@aws run my-alias`.
|
610
|
+
#
|
611
|
+
# @option params [Array<Types::CustomActionAttachment>] :attachments
|
612
|
+
# Defines when this custom action button should be attached to a
|
613
|
+
# notification.
|
614
|
+
#
|
615
|
+
# @option params [Array<Types::Tag>] :tags
|
616
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
617
|
+
# of key-value pairs.
|
618
|
+
#
|
619
|
+
# @option params [String] :client_token
|
620
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
621
|
+
# idempotency of the request. Idempotency ensures that an API request
|
622
|
+
# completes only once. With an idempotent request, if the original
|
623
|
+
# request completes successfully, subsequent retries with the same
|
624
|
+
# client token returns the result from the original successful request.
|
625
|
+
#
|
626
|
+
# If you do not specify a client token, one is automatically generated
|
627
|
+
# by the SDK.
|
628
|
+
#
|
629
|
+
# **A suitable default value is auto-generated.** You should normally
|
630
|
+
# not need to pass this option.**
|
631
|
+
#
|
632
|
+
# @option params [required, String] :action_name
|
633
|
+
# The name of the custom action. This name is included in the Amazon
|
634
|
+
# Resource Name (ARN).
|
635
|
+
#
|
636
|
+
# @return [Types::CreateCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
637
|
+
#
|
638
|
+
# * {Types::CreateCustomActionResult#custom_action_arn #custom_action_arn} => String
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# @example Example: Create an alias that invokes a Lambda function
|
642
|
+
#
|
643
|
+
# # Creates an alias that invokes a Lambda function from chat channels. You can use this alias by entering 'run invoke',
|
644
|
+
# # after which you're prompted for the function name.
|
645
|
+
#
|
646
|
+
# resp = client.create_custom_action({
|
647
|
+
# action_name: "my-custom-action",
|
648
|
+
# alias_name: "invoke",
|
649
|
+
# definition: {
|
650
|
+
# command_text: "lambda invoke $functionName",
|
651
|
+
# },
|
652
|
+
# })
|
653
|
+
#
|
654
|
+
# resp.to_h outputs the following:
|
655
|
+
# {
|
656
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
657
|
+
# }
|
658
|
+
#
|
659
|
+
# @example Example: Create a custom action to list alarms
|
660
|
+
#
|
661
|
+
# # Creates a button on all Cloudwatch notifications that lists alarms in the ‘ALARM’ state.
|
662
|
+
#
|
663
|
+
# resp = client.create_custom_action({
|
664
|
+
# action_name: "describe-alarms",
|
665
|
+
# attachments: [
|
666
|
+
# {
|
667
|
+
# button_text: "List alarms",
|
668
|
+
# notification_type: "CloudWatch",
|
669
|
+
# },
|
670
|
+
# ],
|
671
|
+
# definition: {
|
672
|
+
# command_text: "cloudwatch describe-alarms --state-value ALARM",
|
673
|
+
# },
|
674
|
+
# })
|
675
|
+
#
|
676
|
+
# resp.to_h outputs the following:
|
677
|
+
# {
|
678
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/describe-alarms",
|
679
|
+
# }
|
680
|
+
#
|
681
|
+
# @example Request syntax with placeholder values
|
682
|
+
#
|
683
|
+
# resp = client.create_custom_action({
|
684
|
+
# definition: { # required
|
685
|
+
# command_text: "CustomActionDefinitionCommandTextString", # required
|
686
|
+
# },
|
687
|
+
# alias_name: "CustomActionAliasName",
|
688
|
+
# attachments: [
|
689
|
+
# {
|
690
|
+
# notification_type: "CustomActionAttachmentNotificationType",
|
691
|
+
# button_text: "CustomActionButtonText",
|
692
|
+
# criteria: [
|
693
|
+
# {
|
694
|
+
# operator: "HAS_VALUE", # required, accepts HAS_VALUE, EQUALS
|
695
|
+
# variable_name: "CustomActionAttachmentCriteriaVariableNameString", # required
|
696
|
+
# value: "CustomActionAttachmentCriteriaValueString",
|
697
|
+
# },
|
698
|
+
# ],
|
699
|
+
# variables: {
|
700
|
+
# "CustomActionAttachmentVariablesKeyString" => "CustomActionAttachmentVariablesValueString",
|
701
|
+
# },
|
702
|
+
# },
|
703
|
+
# ],
|
704
|
+
# tags: [
|
705
|
+
# {
|
706
|
+
# tag_key: "TagKey", # required
|
707
|
+
# tag_value: "TagValue", # required
|
708
|
+
# },
|
709
|
+
# ],
|
710
|
+
# client_token: "ClientToken",
|
711
|
+
# action_name: "CustomActionName", # required
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# @example Response structure
|
715
|
+
#
|
716
|
+
# resp.custom_action_arn #=> String
|
717
|
+
#
|
718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateCustomAction AWS API Documentation
|
719
|
+
#
|
720
|
+
# @overload create_custom_action(params = {})
|
721
|
+
# @param [Hash] params ({})
|
722
|
+
def create_custom_action(params = {}, options = {})
|
723
|
+
req = build_request(:create_custom_action, params)
|
724
|
+
req.send_request(options)
|
725
|
+
end
|
726
|
+
|
536
727
|
# Creates an AWS Chatbot configuration for Microsoft Teams.
|
537
728
|
#
|
538
729
|
# @option params [required, String] :channel_id
|
@@ -775,6 +966,39 @@ module Aws::Chatbot
|
|
775
966
|
req.send_request(options)
|
776
967
|
end
|
777
968
|
|
969
|
+
# Deletes a custom action.
|
970
|
+
#
|
971
|
+
# @option params [required, String] :custom_action_arn
|
972
|
+
# The fully defined ARN of the custom action.
|
973
|
+
#
|
974
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
975
|
+
#
|
976
|
+
#
|
977
|
+
# @example Example: Delete a custom action
|
978
|
+
#
|
979
|
+
# resp = client.delete_custom_action({
|
980
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
981
|
+
# })
|
982
|
+
#
|
983
|
+
# resp.to_h outputs the following:
|
984
|
+
# {
|
985
|
+
# }
|
986
|
+
#
|
987
|
+
# @example Request syntax with placeholder values
|
988
|
+
#
|
989
|
+
# resp = client.delete_custom_action({
|
990
|
+
# custom_action_arn: "CustomActionArn", # required
|
991
|
+
# })
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteCustomAction AWS API Documentation
|
994
|
+
#
|
995
|
+
# @overload delete_custom_action(params = {})
|
996
|
+
# @param [Hash] params ({})
|
997
|
+
def delete_custom_action(params = {}, options = {})
|
998
|
+
req = build_request(:delete_custom_action, params)
|
999
|
+
req.send_request(options)
|
1000
|
+
end
|
1001
|
+
|
778
1002
|
# Deletes a Microsoft Teams channel configuration for AWS Chatbot
|
779
1003
|
#
|
780
1004
|
# @option params [required, String] :chat_configuration_arn
|
@@ -953,8 +1177,8 @@ module Aws::Chatbot
|
|
953
1177
|
# the value specified by MaxResults.
|
954
1178
|
#
|
955
1179
|
# @option params [String] :chat_configuration_arn
|
956
|
-
# An optional Amazon Resource
|
957
|
-
#
|
1180
|
+
# An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration
|
1181
|
+
# to describe.
|
958
1182
|
#
|
959
1183
|
# @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
1184
|
#
|
@@ -1012,8 +1236,8 @@ module Aws::Chatbot
|
|
1012
1236
|
# the value specified by MaxResults.
|
1013
1237
|
#
|
1014
1238
|
# @option params [String] :chat_configuration_arn
|
1015
|
-
# An optional Amazon Resource
|
1016
|
-
#
|
1239
|
+
# An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration
|
1240
|
+
# to describe.
|
1017
1241
|
#
|
1018
1242
|
# @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1019
1243
|
#
|
@@ -1065,7 +1289,7 @@ module Aws::Chatbot
|
|
1065
1289
|
# Lists all Slack user identities with a mapped role.
|
1066
1290
|
#
|
1067
1291
|
# @option params [String] :chat_configuration_arn
|
1068
|
-
# The Amazon Resource
|
1292
|
+
# The Amazon Resource Name (ARN) of the SlackChannelConfiguration
|
1069
1293
|
# associated with the user identities to describe.
|
1070
1294
|
#
|
1071
1295
|
# @option params [String] :next_token
|
@@ -1159,6 +1383,46 @@ module Aws::Chatbot
|
|
1159
1383
|
req.send_request(options)
|
1160
1384
|
end
|
1161
1385
|
|
1386
|
+
# Unlink a resource, for example a custom action, from a channel
|
1387
|
+
# configuration.
|
1388
|
+
#
|
1389
|
+
# @option params [required, String] :resource
|
1390
|
+
# The resource (for example, a custom action) Amazon Resource Name (ARN)
|
1391
|
+
# to unlink.
|
1392
|
+
#
|
1393
|
+
# @option params [required, String] :chat_configuration
|
1394
|
+
# The channel configuration the resource is being disassociated from.
|
1395
|
+
#
|
1396
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1397
|
+
#
|
1398
|
+
#
|
1399
|
+
# @example Example: Disassociate a custom action from a configuration
|
1400
|
+
#
|
1401
|
+
# resp = client.disassociate_from_configuration({
|
1402
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
1403
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1404
|
+
# })
|
1405
|
+
#
|
1406
|
+
# resp.to_h outputs the following:
|
1407
|
+
# {
|
1408
|
+
# }
|
1409
|
+
#
|
1410
|
+
# @example Request syntax with placeholder values
|
1411
|
+
#
|
1412
|
+
# resp = client.disassociate_from_configuration({
|
1413
|
+
# resource: "ResourceIdentifier", # required
|
1414
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
1415
|
+
# })
|
1416
|
+
#
|
1417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DisassociateFromConfiguration AWS API Documentation
|
1418
|
+
#
|
1419
|
+
# @overload disassociate_from_configuration(params = {})
|
1420
|
+
# @param [Hash] params ({})
|
1421
|
+
def disassociate_from_configuration(params = {}, options = {})
|
1422
|
+
req = build_request(:disassociate_from_configuration, params)
|
1423
|
+
req.send_request(options)
|
1424
|
+
end
|
1425
|
+
|
1162
1426
|
# Returns AWS Chatbot account preferences.
|
1163
1427
|
#
|
1164
1428
|
# @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1179,10 +1443,69 @@ module Aws::Chatbot
|
|
1179
1443
|
req.send_request(options)
|
1180
1444
|
end
|
1181
1445
|
|
1446
|
+
# Returns a custom action.
|
1447
|
+
#
|
1448
|
+
# @option params [required, String] :custom_action_arn
|
1449
|
+
# Returns the fully defined Amazon Resource Name (ARN) of the custom
|
1450
|
+
# action.
|
1451
|
+
#
|
1452
|
+
# @return [Types::GetCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1453
|
+
#
|
1454
|
+
# * {Types::GetCustomActionResult#custom_action #custom_action} => Types::CustomAction
|
1455
|
+
#
|
1456
|
+
#
|
1457
|
+
# @example Example: Get a custom action
|
1458
|
+
#
|
1459
|
+
# resp = client.get_custom_action({
|
1460
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1461
|
+
# })
|
1462
|
+
#
|
1463
|
+
# resp.to_h outputs the following:
|
1464
|
+
# {
|
1465
|
+
# custom_action: {
|
1466
|
+
# action_name: "my-custom-action",
|
1467
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1468
|
+
# definition: {
|
1469
|
+
# command_text: "lambda invoke $functionName",
|
1470
|
+
# },
|
1471
|
+
# },
|
1472
|
+
# }
|
1473
|
+
#
|
1474
|
+
# @example Request syntax with placeholder values
|
1475
|
+
#
|
1476
|
+
# resp = client.get_custom_action({
|
1477
|
+
# custom_action_arn: "CustomActionArn", # required
|
1478
|
+
# })
|
1479
|
+
#
|
1480
|
+
# @example Response structure
|
1481
|
+
#
|
1482
|
+
# resp.custom_action.custom_action_arn #=> String
|
1483
|
+
# resp.custom_action.definition.command_text #=> String
|
1484
|
+
# resp.custom_action.alias_name #=> String
|
1485
|
+
# resp.custom_action.attachments #=> Array
|
1486
|
+
# resp.custom_action.attachments[0].notification_type #=> String
|
1487
|
+
# resp.custom_action.attachments[0].button_text #=> String
|
1488
|
+
# resp.custom_action.attachments[0].criteria #=> Array
|
1489
|
+
# resp.custom_action.attachments[0].criteria[0].operator #=> String, one of "HAS_VALUE", "EQUALS"
|
1490
|
+
# resp.custom_action.attachments[0].criteria[0].variable_name #=> String
|
1491
|
+
# resp.custom_action.attachments[0].criteria[0].value #=> String
|
1492
|
+
# resp.custom_action.attachments[0].variables #=> Hash
|
1493
|
+
# resp.custom_action.attachments[0].variables["CustomActionAttachmentVariablesKeyString"] #=> String
|
1494
|
+
# resp.custom_action.action_name #=> String
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetCustomAction AWS API Documentation
|
1497
|
+
#
|
1498
|
+
# @overload get_custom_action(params = {})
|
1499
|
+
# @param [Hash] params ({})
|
1500
|
+
def get_custom_action(params = {}, options = {})
|
1501
|
+
req = build_request(:get_custom_action, params)
|
1502
|
+
req.send_request(options)
|
1503
|
+
end
|
1504
|
+
|
1182
1505
|
# Returns a Microsoft Teams channel configuration in an AWS account.
|
1183
1506
|
#
|
1184
1507
|
# @option params [required, String] :chat_configuration_arn
|
1185
|
-
# The Amazon Resource
|
1508
|
+
# The Amazon Resource Name (ARN) of the
|
1186
1509
|
# MicrosoftTeamsChannelConfiguration to retrieve.
|
1187
1510
|
#
|
1188
1511
|
# @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1226,6 +1549,123 @@ module Aws::Chatbot
|
|
1226
1549
|
req.send_request(options)
|
1227
1550
|
end
|
1228
1551
|
|
1552
|
+
# Lists resources associated with a channel configuration.
|
1553
|
+
#
|
1554
|
+
# @option params [required, String] :chat_configuration
|
1555
|
+
# The channel configuration to list associations for.
|
1556
|
+
#
|
1557
|
+
# @option params [Integer] :max_results
|
1558
|
+
# The maximum number of results to include in the response. If more
|
1559
|
+
# results exist than the specified MaxResults value, a token is included
|
1560
|
+
# in the response so that the remaining results can be retrieved.
|
1561
|
+
#
|
1562
|
+
# @option params [String] :next_token
|
1563
|
+
# An optional token returned from a prior request. Use this token for
|
1564
|
+
# pagination of results from this action. If this parameter is
|
1565
|
+
# specified, the response includes only results beyond the token, up to
|
1566
|
+
# the value specified by MaxResults.
|
1567
|
+
#
|
1568
|
+
# @return [Types::ListAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1569
|
+
#
|
1570
|
+
# * {Types::ListAssociationsResult#associations #associations} => Array<Types::AssociationListing>
|
1571
|
+
# * {Types::ListAssociationsResult#next_token #next_token} => String
|
1572
|
+
#
|
1573
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1574
|
+
#
|
1575
|
+
#
|
1576
|
+
# @example Example: List custom actions associated with a configuration
|
1577
|
+
#
|
1578
|
+
# resp = client.list_associations({
|
1579
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
1580
|
+
# })
|
1581
|
+
#
|
1582
|
+
# resp.to_h outputs the following:
|
1583
|
+
# {
|
1584
|
+
# associations: [
|
1585
|
+
# {
|
1586
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1587
|
+
# },
|
1588
|
+
# ],
|
1589
|
+
# }
|
1590
|
+
#
|
1591
|
+
# @example Request syntax with placeholder values
|
1592
|
+
#
|
1593
|
+
# resp = client.list_associations({
|
1594
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
1595
|
+
# max_results: 1,
|
1596
|
+
# next_token: "ListAssociationsRequestNextTokenString",
|
1597
|
+
# })
|
1598
|
+
#
|
1599
|
+
# @example Response structure
|
1600
|
+
#
|
1601
|
+
# resp.associations #=> Array
|
1602
|
+
# resp.associations[0].resource #=> String
|
1603
|
+
# resp.next_token #=> String
|
1604
|
+
#
|
1605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListAssociations AWS API Documentation
|
1606
|
+
#
|
1607
|
+
# @overload list_associations(params = {})
|
1608
|
+
# @param [Hash] params ({})
|
1609
|
+
def list_associations(params = {}, options = {})
|
1610
|
+
req = build_request(:list_associations, params)
|
1611
|
+
req.send_request(options)
|
1612
|
+
end
|
1613
|
+
|
1614
|
+
# Lists custom actions defined in this account.
|
1615
|
+
#
|
1616
|
+
# @option params [Integer] :max_results
|
1617
|
+
# The maximum number of results to include in the response. If more
|
1618
|
+
# results exist than the specified MaxResults value, a token is included
|
1619
|
+
# in the response so that the remaining results can be retrieved.
|
1620
|
+
#
|
1621
|
+
# @option params [String] :next_token
|
1622
|
+
# An optional token returned from a prior request. Use this token for
|
1623
|
+
# pagination of results from this action. If this parameter is
|
1624
|
+
# specified, the response includes only results beyond the token, up to
|
1625
|
+
# the value specified by MaxResults.
|
1626
|
+
#
|
1627
|
+
# @return [Types::ListCustomActionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1628
|
+
#
|
1629
|
+
# * {Types::ListCustomActionsResult#custom_actions #custom_actions} => Array<String>
|
1630
|
+
# * {Types::ListCustomActionsResult#next_token #next_token} => String
|
1631
|
+
#
|
1632
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1633
|
+
#
|
1634
|
+
#
|
1635
|
+
# @example Example: List custom actions
|
1636
|
+
#
|
1637
|
+
# resp = client.list_custom_actions({
|
1638
|
+
# })
|
1639
|
+
#
|
1640
|
+
# resp.to_h outputs the following:
|
1641
|
+
# {
|
1642
|
+
# custom_actions: [
|
1643
|
+
# "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1644
|
+
# ],
|
1645
|
+
# }
|
1646
|
+
#
|
1647
|
+
# @example Request syntax with placeholder values
|
1648
|
+
#
|
1649
|
+
# resp = client.list_custom_actions({
|
1650
|
+
# max_results: 1,
|
1651
|
+
# next_token: "ListCustomActionsRequestNextTokenString",
|
1652
|
+
# })
|
1653
|
+
#
|
1654
|
+
# @example Response structure
|
1655
|
+
#
|
1656
|
+
# resp.custom_actions #=> Array
|
1657
|
+
# resp.custom_actions[0] #=> String
|
1658
|
+
# resp.next_token #=> String
|
1659
|
+
#
|
1660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListCustomActions AWS API Documentation
|
1661
|
+
#
|
1662
|
+
# @overload list_custom_actions(params = {})
|
1663
|
+
# @param [Hash] params ({})
|
1664
|
+
def list_custom_actions(params = {}, options = {})
|
1665
|
+
req = build_request(:list_custom_actions, params)
|
1666
|
+
req.send_request(options)
|
1667
|
+
end
|
1668
|
+
|
1229
1669
|
# Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS
|
1230
1670
|
# account.
|
1231
1671
|
#
|
@@ -1350,7 +1790,7 @@ module Aws::Chatbot
|
|
1350
1790
|
# A list all Microsoft Teams user identities with a mapped role.
|
1351
1791
|
#
|
1352
1792
|
# @option params [String] :chat_configuration_arn
|
1353
|
-
# The Amazon Resource
|
1793
|
+
# The Amazon Resource Name (ARN) of the
|
1354
1794
|
# MicrosoftTeamsChannelConfiguration associated with the user identities
|
1355
1795
|
# to list.
|
1356
1796
|
#
|
@@ -1405,7 +1845,7 @@ module Aws::Chatbot
|
|
1405
1845
|
# that you specify. The resource can be a user, server, or role.
|
1406
1846
|
#
|
1407
1847
|
# @option params [required, String] :resource_arn
|
1408
|
-
# The ARN
|
1848
|
+
# The ARN of the resource to list tags for.
|
1409
1849
|
#
|
1410
1850
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1411
1851
|
#
|
@@ -1543,7 +1983,7 @@ module Aws::Chatbot
|
|
1543
1983
|
# Updates a Amazon Chime webhook configuration.
|
1544
1984
|
#
|
1545
1985
|
# @option params [required, String] :chat_configuration_arn
|
1546
|
-
# The Amazon Resource
|
1986
|
+
# The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to
|
1547
1987
|
# update.
|
1548
1988
|
#
|
1549
1989
|
# @option params [String] :webhook_description
|
@@ -1616,10 +2056,87 @@ module Aws::Chatbot
|
|
1616
2056
|
req.send_request(options)
|
1617
2057
|
end
|
1618
2058
|
|
2059
|
+
# Updates a custom action.
|
2060
|
+
#
|
2061
|
+
# @option params [required, String] :custom_action_arn
|
2062
|
+
# The fully defined Amazon Resource Name (ARN) of the custom action.
|
2063
|
+
#
|
2064
|
+
# @option params [required, Types::CustomActionDefinition] :definition
|
2065
|
+
# The definition of the command to run when invoked as an alias or as an
|
2066
|
+
# action button.
|
2067
|
+
#
|
2068
|
+
# @option params [String] :alias_name
|
2069
|
+
# The name used to invoke this action in the chat channel. For example,
|
2070
|
+
# `@aws run my-alias`.
|
2071
|
+
#
|
2072
|
+
# @option params [Array<Types::CustomActionAttachment>] :attachments
|
2073
|
+
# Defines when this custom action button should be attached to a
|
2074
|
+
# notification.
|
2075
|
+
#
|
2076
|
+
# @return [Types::UpdateCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2077
|
+
#
|
2078
|
+
# * {Types::UpdateCustomActionResult#custom_action_arn #custom_action_arn} => String
|
2079
|
+
#
|
2080
|
+
#
|
2081
|
+
# @example Example: Update the command definition of an existing action
|
2082
|
+
#
|
2083
|
+
# # Updates the command text of a custom action without altering the existing alias name or attachment criteria
|
2084
|
+
#
|
2085
|
+
# resp = client.update_custom_action({
|
2086
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
2087
|
+
# definition: {
|
2088
|
+
# command_text: "lambda invoke MyNewFunction",
|
2089
|
+
# },
|
2090
|
+
# })
|
2091
|
+
#
|
2092
|
+
# resp.to_h outputs the following:
|
2093
|
+
# {
|
2094
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
2095
|
+
# }
|
2096
|
+
#
|
2097
|
+
# @example Request syntax with placeholder values
|
2098
|
+
#
|
2099
|
+
# resp = client.update_custom_action({
|
2100
|
+
# custom_action_arn: "CustomActionArn", # required
|
2101
|
+
# definition: { # required
|
2102
|
+
# command_text: "CustomActionDefinitionCommandTextString", # required
|
2103
|
+
# },
|
2104
|
+
# alias_name: "CustomActionAliasName",
|
2105
|
+
# attachments: [
|
2106
|
+
# {
|
2107
|
+
# notification_type: "CustomActionAttachmentNotificationType",
|
2108
|
+
# button_text: "CustomActionButtonText",
|
2109
|
+
# criteria: [
|
2110
|
+
# {
|
2111
|
+
# operator: "HAS_VALUE", # required, accepts HAS_VALUE, EQUALS
|
2112
|
+
# variable_name: "CustomActionAttachmentCriteriaVariableNameString", # required
|
2113
|
+
# value: "CustomActionAttachmentCriteriaValueString",
|
2114
|
+
# },
|
2115
|
+
# ],
|
2116
|
+
# variables: {
|
2117
|
+
# "CustomActionAttachmentVariablesKeyString" => "CustomActionAttachmentVariablesValueString",
|
2118
|
+
# },
|
2119
|
+
# },
|
2120
|
+
# ],
|
2121
|
+
# })
|
2122
|
+
#
|
2123
|
+
# @example Response structure
|
2124
|
+
#
|
2125
|
+
# resp.custom_action_arn #=> String
|
2126
|
+
#
|
2127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateCustomAction AWS API Documentation
|
2128
|
+
#
|
2129
|
+
# @overload update_custom_action(params = {})
|
2130
|
+
# @param [Hash] params ({})
|
2131
|
+
def update_custom_action(params = {}, options = {})
|
2132
|
+
req = build_request(:update_custom_action, params)
|
2133
|
+
req.send_request(options)
|
2134
|
+
end
|
2135
|
+
|
1619
2136
|
# Updates an Microsoft Teams channel configuration.
|
1620
2137
|
#
|
1621
2138
|
# @option params [required, String] :chat_configuration_arn
|
1622
|
-
# The Amazon Resource
|
2139
|
+
# The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to
|
1623
2140
|
# update.
|
1624
2141
|
#
|
1625
2142
|
# @option params [required, String] :channel_id
|
@@ -1705,7 +2222,7 @@ module Aws::Chatbot
|
|
1705
2222
|
# Updates a Slack channel configuration.
|
1706
2223
|
#
|
1707
2224
|
# @option params [required, String] :chat_configuration_arn
|
1708
|
-
# The Amazon Resource
|
2225
|
+
# The Amazon Resource Name (ARN) of the SlackChannelConfiguration to
|
1709
2226
|
# update.
|
1710
2227
|
#
|
1711
2228
|
# @option params [required, String] :slack_channel_id
|
@@ -1809,7 +2326,7 @@ module Aws::Chatbot
|
|
1809
2326
|
tracer: tracer
|
1810
2327
|
)
|
1811
2328
|
context[:gem_name] = 'aws-sdk-chatbot'
|
1812
|
-
context[:gem_version] = '1.
|
2329
|
+
context[:gem_version] = '1.20.0'
|
1813
2330
|
Seahorse::Client::Request.new(handlers, context)
|
1814
2331
|
end
|
1815
2332
|
|