aws-sdk-chatbot 1.18.0 → 1.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chatbot/client.rb +506 -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 +127 -0
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +128 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4533f62d9008243d2ecfbd3483f497cccc7ab0fa1c65ba133c058fbccd2ed9a1
|
4
|
+
data.tar.gz: 52a9de5aae5b6f96660731e38f687bcb11b146c2c186a2d2f5c1aa09497657e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4f9cb2af5cbfc6821123fb00c7b23eb5256495b6f8a6f14cedb4c1ee09783c2a51affae48570101cf40282f91a8d7b7056d9b991fb862ce4b0b1114b2be952a4
|
7
|
+
data.tar.gz: 8009d76ebf72f75e39c1ff9bc3b2e863c27a669a6065c2077aa0e78fb351e479e7466d7de5aa10416f504a980df0c8bc9117140f91ab0386c69d28b5b17351a5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.19.0 (2024-11-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds support for programmatic management of custom actions and aliases which can be associated with channel configurations.
|
8
|
+
|
4
9
|
1.18.0 (2024-10-18)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.19.0
|
@@ -447,6 +447,47 @@ module Aws::Chatbot
|
|
447
447
|
|
448
448
|
# @!group API Operations
|
449
449
|
|
450
|
+
# Links a resource (for example, a custom action) to a channel
|
451
|
+
# configuration.
|
452
|
+
#
|
453
|
+
# @option params [required, String] :resource
|
454
|
+
# The resource Amazon Resource Name (ARN) to link.
|
455
|
+
#
|
456
|
+
# @option params [required, String] :chat_configuration
|
457
|
+
# The channel configuration to associate with the resource.
|
458
|
+
#
|
459
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
460
|
+
#
|
461
|
+
#
|
462
|
+
# @example Example: Associate a custom action to a configuration
|
463
|
+
#
|
464
|
+
# # Associate a custom action to a channel configuration, allowing it to be used in that channel
|
465
|
+
#
|
466
|
+
# resp = client.associate_to_configuration({
|
467
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
468
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
469
|
+
# })
|
470
|
+
#
|
471
|
+
# resp.to_h outputs the following:
|
472
|
+
# {
|
473
|
+
# }
|
474
|
+
#
|
475
|
+
# @example Request syntax with placeholder values
|
476
|
+
#
|
477
|
+
# resp = client.associate_to_configuration({
|
478
|
+
# resource: "ResourceIdentifier", # required
|
479
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
480
|
+
# })
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/AssociateToConfiguration AWS API Documentation
|
483
|
+
#
|
484
|
+
# @overload associate_to_configuration(params = {})
|
485
|
+
# @param [Hash] params ({})
|
486
|
+
def associate_to_configuration(params = {}, options = {})
|
487
|
+
req = build_request(:associate_to_configuration, params)
|
488
|
+
req.send_request(options)
|
489
|
+
end
|
490
|
+
|
450
491
|
# Creates an AWS Chatbot configuration for Amazon Chime.
|
451
492
|
#
|
452
493
|
# @option params [required, String] :webhook_description
|
@@ -533,6 +574,133 @@ module Aws::Chatbot
|
|
533
574
|
req.send_request(options)
|
534
575
|
end
|
535
576
|
|
577
|
+
# Creates a custom action that can be invoked as an alias or as a button
|
578
|
+
# on a notification.
|
579
|
+
#
|
580
|
+
# @option params [required, Types::CustomActionDefinition] :definition
|
581
|
+
# The definition of the command to run when invoked as an alias or as an
|
582
|
+
# action button.
|
583
|
+
#
|
584
|
+
# @option params [String] :alias_name
|
585
|
+
# The name used to invoke this action in a chat channel. For example,
|
586
|
+
# `@aws run my-alias`.
|
587
|
+
#
|
588
|
+
# @option params [Array<Types::CustomActionAttachment>] :attachments
|
589
|
+
# Defines when this custom action button should be attached to a
|
590
|
+
# notification.
|
591
|
+
#
|
592
|
+
# @option params [Array<Types::Tag>] :tags
|
593
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
594
|
+
# of key-value pairs.
|
595
|
+
#
|
596
|
+
# @option params [String] :client_token
|
597
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
598
|
+
# idempotency of the request. Idempotency ensures that an API request
|
599
|
+
# completes only once. With an idempotent request, if the original
|
600
|
+
# request completes successfully, subsequent retries with the same
|
601
|
+
# client token returns the result from the original successful request.
|
602
|
+
#
|
603
|
+
# If you do not specify a client token, one is automatically generated
|
604
|
+
# by the SDK.
|
605
|
+
#
|
606
|
+
# **A suitable default value is auto-generated.** You should normally
|
607
|
+
# not need to pass this option.**
|
608
|
+
#
|
609
|
+
# @option params [required, String] :action_name
|
610
|
+
# The name of the custom action. This name is included in the Amazon
|
611
|
+
# Resource Name (ARN).
|
612
|
+
#
|
613
|
+
# @return [Types::CreateCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
614
|
+
#
|
615
|
+
# * {Types::CreateCustomActionResult#custom_action_arn #custom_action_arn} => String
|
616
|
+
#
|
617
|
+
#
|
618
|
+
# @example Example: Create an alias that invokes a Lambda function
|
619
|
+
#
|
620
|
+
# # Creates an alias that invokes a Lambda function from chat channels. You can use this alias by entering 'run invoke',
|
621
|
+
# # after which you're prompted for the function name.
|
622
|
+
#
|
623
|
+
# resp = client.create_custom_action({
|
624
|
+
# action_name: "my-custom-action",
|
625
|
+
# alias_name: "invoke",
|
626
|
+
# definition: {
|
627
|
+
# command_text: "lambda invoke $functionName",
|
628
|
+
# },
|
629
|
+
# })
|
630
|
+
#
|
631
|
+
# resp.to_h outputs the following:
|
632
|
+
# {
|
633
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
634
|
+
# }
|
635
|
+
#
|
636
|
+
# @example Example: Create a custom action to list alarms
|
637
|
+
#
|
638
|
+
# # Creates a button on all Cloudwatch notifications that lists alarms in the ‘ALARM’ state.
|
639
|
+
#
|
640
|
+
# resp = client.create_custom_action({
|
641
|
+
# action_name: "describe-alarms",
|
642
|
+
# attachments: [
|
643
|
+
# {
|
644
|
+
# button_text: "List alarms",
|
645
|
+
# notification_type: "CloudWatch",
|
646
|
+
# },
|
647
|
+
# ],
|
648
|
+
# definition: {
|
649
|
+
# command_text: "cloudwatch describe-alarms --state-value ALARM",
|
650
|
+
# },
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# resp.to_h outputs the following:
|
654
|
+
# {
|
655
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/describe-alarms",
|
656
|
+
# }
|
657
|
+
#
|
658
|
+
# @example Request syntax with placeholder values
|
659
|
+
#
|
660
|
+
# resp = client.create_custom_action({
|
661
|
+
# definition: { # required
|
662
|
+
# command_text: "CustomActionDefinitionCommandTextString", # required
|
663
|
+
# },
|
664
|
+
# alias_name: "CustomActionAliasName",
|
665
|
+
# attachments: [
|
666
|
+
# {
|
667
|
+
# notification_type: "CustomActionAttachmentNotificationType",
|
668
|
+
# button_text: "CustomActionButtonText",
|
669
|
+
# criteria: [
|
670
|
+
# {
|
671
|
+
# operator: "HAS_VALUE", # required, accepts HAS_VALUE, EQUALS
|
672
|
+
# variable_name: "CustomActionAttachmentCriteriaVariableNameString", # required
|
673
|
+
# value: "CustomActionAttachmentCriteriaValueString",
|
674
|
+
# },
|
675
|
+
# ],
|
676
|
+
# variables: {
|
677
|
+
# "CustomActionAttachmentVariablesKeyString" => "CustomActionAttachmentVariablesValueString",
|
678
|
+
# },
|
679
|
+
# },
|
680
|
+
# ],
|
681
|
+
# tags: [
|
682
|
+
# {
|
683
|
+
# tag_key: "TagKey", # required
|
684
|
+
# tag_value: "TagValue", # required
|
685
|
+
# },
|
686
|
+
# ],
|
687
|
+
# client_token: "ClientToken",
|
688
|
+
# action_name: "CustomActionName", # required
|
689
|
+
# })
|
690
|
+
#
|
691
|
+
# @example Response structure
|
692
|
+
#
|
693
|
+
# resp.custom_action_arn #=> String
|
694
|
+
#
|
695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateCustomAction AWS API Documentation
|
696
|
+
#
|
697
|
+
# @overload create_custom_action(params = {})
|
698
|
+
# @param [Hash] params ({})
|
699
|
+
def create_custom_action(params = {}, options = {})
|
700
|
+
req = build_request(:create_custom_action, params)
|
701
|
+
req.send_request(options)
|
702
|
+
end
|
703
|
+
|
536
704
|
# Creates an AWS Chatbot configuration for Microsoft Teams.
|
537
705
|
#
|
538
706
|
# @option params [required, String] :channel_id
|
@@ -775,6 +943,39 @@ module Aws::Chatbot
|
|
775
943
|
req.send_request(options)
|
776
944
|
end
|
777
945
|
|
946
|
+
# Deletes a custom action.
|
947
|
+
#
|
948
|
+
# @option params [required, String] :custom_action_arn
|
949
|
+
# The fully defined ARN of the custom action.
|
950
|
+
#
|
951
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
952
|
+
#
|
953
|
+
#
|
954
|
+
# @example Example: Delete a custom action
|
955
|
+
#
|
956
|
+
# resp = client.delete_custom_action({
|
957
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
958
|
+
# })
|
959
|
+
#
|
960
|
+
# resp.to_h outputs the following:
|
961
|
+
# {
|
962
|
+
# }
|
963
|
+
#
|
964
|
+
# @example Request syntax with placeholder values
|
965
|
+
#
|
966
|
+
# resp = client.delete_custom_action({
|
967
|
+
# custom_action_arn: "CustomActionArn", # required
|
968
|
+
# })
|
969
|
+
#
|
970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteCustomAction AWS API Documentation
|
971
|
+
#
|
972
|
+
# @overload delete_custom_action(params = {})
|
973
|
+
# @param [Hash] params ({})
|
974
|
+
def delete_custom_action(params = {}, options = {})
|
975
|
+
req = build_request(:delete_custom_action, params)
|
976
|
+
req.send_request(options)
|
977
|
+
end
|
978
|
+
|
778
979
|
# Deletes a Microsoft Teams channel configuration for AWS Chatbot
|
779
980
|
#
|
780
981
|
# @option params [required, String] :chat_configuration_arn
|
@@ -953,8 +1154,8 @@ module Aws::Chatbot
|
|
953
1154
|
# the value specified by MaxResults.
|
954
1155
|
#
|
955
1156
|
# @option params [String] :chat_configuration_arn
|
956
|
-
# An optional Amazon Resource
|
957
|
-
#
|
1157
|
+
# An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration
|
1158
|
+
# to describe.
|
958
1159
|
#
|
959
1160
|
# @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
1161
|
#
|
@@ -1012,8 +1213,8 @@ module Aws::Chatbot
|
|
1012
1213
|
# the value specified by MaxResults.
|
1013
1214
|
#
|
1014
1215
|
# @option params [String] :chat_configuration_arn
|
1015
|
-
# An optional Amazon Resource
|
1016
|
-
#
|
1216
|
+
# An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration
|
1217
|
+
# to describe.
|
1017
1218
|
#
|
1018
1219
|
# @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1019
1220
|
#
|
@@ -1065,7 +1266,7 @@ module Aws::Chatbot
|
|
1065
1266
|
# Lists all Slack user identities with a mapped role.
|
1066
1267
|
#
|
1067
1268
|
# @option params [String] :chat_configuration_arn
|
1068
|
-
# The Amazon Resource
|
1269
|
+
# The Amazon Resource Name (ARN) of the SlackChannelConfiguration
|
1069
1270
|
# associated with the user identities to describe.
|
1070
1271
|
#
|
1071
1272
|
# @option params [String] :next_token
|
@@ -1159,6 +1360,46 @@ module Aws::Chatbot
|
|
1159
1360
|
req.send_request(options)
|
1160
1361
|
end
|
1161
1362
|
|
1363
|
+
# Unlink a resource, for example a custom action, from a channel
|
1364
|
+
# configuration.
|
1365
|
+
#
|
1366
|
+
# @option params [required, String] :resource
|
1367
|
+
# The resource (for example, a custom action) Amazon Resource Name (ARN)
|
1368
|
+
# to unlink.
|
1369
|
+
#
|
1370
|
+
# @option params [required, String] :chat_configuration
|
1371
|
+
# The channel configuration the resource is being disassociated from.
|
1372
|
+
#
|
1373
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1374
|
+
#
|
1375
|
+
#
|
1376
|
+
# @example Example: Disassociate a custom action from a configuration
|
1377
|
+
#
|
1378
|
+
# resp = client.disassociate_from_configuration({
|
1379
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
1380
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1381
|
+
# })
|
1382
|
+
#
|
1383
|
+
# resp.to_h outputs the following:
|
1384
|
+
# {
|
1385
|
+
# }
|
1386
|
+
#
|
1387
|
+
# @example Request syntax with placeholder values
|
1388
|
+
#
|
1389
|
+
# resp = client.disassociate_from_configuration({
|
1390
|
+
# resource: "ResourceIdentifier", # required
|
1391
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
1392
|
+
# })
|
1393
|
+
#
|
1394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DisassociateFromConfiguration AWS API Documentation
|
1395
|
+
#
|
1396
|
+
# @overload disassociate_from_configuration(params = {})
|
1397
|
+
# @param [Hash] params ({})
|
1398
|
+
def disassociate_from_configuration(params = {}, options = {})
|
1399
|
+
req = build_request(:disassociate_from_configuration, params)
|
1400
|
+
req.send_request(options)
|
1401
|
+
end
|
1402
|
+
|
1162
1403
|
# Returns AWS Chatbot account preferences.
|
1163
1404
|
#
|
1164
1405
|
# @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1179,10 +1420,69 @@ module Aws::Chatbot
|
|
1179
1420
|
req.send_request(options)
|
1180
1421
|
end
|
1181
1422
|
|
1423
|
+
# Returns a custom action.
|
1424
|
+
#
|
1425
|
+
# @option params [required, String] :custom_action_arn
|
1426
|
+
# Returns the fully defined Amazon Resource Name (ARN) of the custom
|
1427
|
+
# action.
|
1428
|
+
#
|
1429
|
+
# @return [Types::GetCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1430
|
+
#
|
1431
|
+
# * {Types::GetCustomActionResult#custom_action #custom_action} => Types::CustomAction
|
1432
|
+
#
|
1433
|
+
#
|
1434
|
+
# @example Example: Get a custom action
|
1435
|
+
#
|
1436
|
+
# resp = client.get_custom_action({
|
1437
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1438
|
+
# })
|
1439
|
+
#
|
1440
|
+
# resp.to_h outputs the following:
|
1441
|
+
# {
|
1442
|
+
# custom_action: {
|
1443
|
+
# action_name: "my-custom-action",
|
1444
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1445
|
+
# definition: {
|
1446
|
+
# command_text: "lambda invoke $functionName",
|
1447
|
+
# },
|
1448
|
+
# },
|
1449
|
+
# }
|
1450
|
+
#
|
1451
|
+
# @example Request syntax with placeholder values
|
1452
|
+
#
|
1453
|
+
# resp = client.get_custom_action({
|
1454
|
+
# custom_action_arn: "CustomActionArn", # required
|
1455
|
+
# })
|
1456
|
+
#
|
1457
|
+
# @example Response structure
|
1458
|
+
#
|
1459
|
+
# resp.custom_action.custom_action_arn #=> String
|
1460
|
+
# resp.custom_action.definition.command_text #=> String
|
1461
|
+
# resp.custom_action.alias_name #=> String
|
1462
|
+
# resp.custom_action.attachments #=> Array
|
1463
|
+
# resp.custom_action.attachments[0].notification_type #=> String
|
1464
|
+
# resp.custom_action.attachments[0].button_text #=> String
|
1465
|
+
# resp.custom_action.attachments[0].criteria #=> Array
|
1466
|
+
# resp.custom_action.attachments[0].criteria[0].operator #=> String, one of "HAS_VALUE", "EQUALS"
|
1467
|
+
# resp.custom_action.attachments[0].criteria[0].variable_name #=> String
|
1468
|
+
# resp.custom_action.attachments[0].criteria[0].value #=> String
|
1469
|
+
# resp.custom_action.attachments[0].variables #=> Hash
|
1470
|
+
# resp.custom_action.attachments[0].variables["CustomActionAttachmentVariablesKeyString"] #=> String
|
1471
|
+
# resp.custom_action.action_name #=> String
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetCustomAction AWS API Documentation
|
1474
|
+
#
|
1475
|
+
# @overload get_custom_action(params = {})
|
1476
|
+
# @param [Hash] params ({})
|
1477
|
+
def get_custom_action(params = {}, options = {})
|
1478
|
+
req = build_request(:get_custom_action, params)
|
1479
|
+
req.send_request(options)
|
1480
|
+
end
|
1481
|
+
|
1182
1482
|
# Returns a Microsoft Teams channel configuration in an AWS account.
|
1183
1483
|
#
|
1184
1484
|
# @option params [required, String] :chat_configuration_arn
|
1185
|
-
# The Amazon Resource
|
1485
|
+
# The Amazon Resource Name (ARN) of the
|
1186
1486
|
# MicrosoftTeamsChannelConfiguration to retrieve.
|
1187
1487
|
#
|
1188
1488
|
# @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1226,6 +1526,123 @@ module Aws::Chatbot
|
|
1226
1526
|
req.send_request(options)
|
1227
1527
|
end
|
1228
1528
|
|
1529
|
+
# Lists resources associated with a channel configuration.
|
1530
|
+
#
|
1531
|
+
# @option params [required, String] :chat_configuration
|
1532
|
+
# The channel configuration to list associations for.
|
1533
|
+
#
|
1534
|
+
# @option params [Integer] :max_results
|
1535
|
+
# The maximum number of results to include in the response. If more
|
1536
|
+
# results exist than the specified MaxResults value, a token is included
|
1537
|
+
# in the response so that the remaining results can be retrieved.
|
1538
|
+
#
|
1539
|
+
# @option params [String] :next_token
|
1540
|
+
# An optional token returned from a prior request. Use this token for
|
1541
|
+
# pagination of results from this action. If this parameter is
|
1542
|
+
# specified, the response includes only results beyond the token, up to
|
1543
|
+
# the value specified by MaxResults.
|
1544
|
+
#
|
1545
|
+
# @return [Types::ListAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1546
|
+
#
|
1547
|
+
# * {Types::ListAssociationsResult#associations #associations} => Array<Types::AssociationListing>
|
1548
|
+
# * {Types::ListAssociationsResult#next_token #next_token} => String
|
1549
|
+
#
|
1550
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1551
|
+
#
|
1552
|
+
#
|
1553
|
+
# @example Example: List custom actions associated with a configuration
|
1554
|
+
#
|
1555
|
+
# resp = client.list_associations({
|
1556
|
+
# chat_configuration: "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
|
1557
|
+
# })
|
1558
|
+
#
|
1559
|
+
# resp.to_h outputs the following:
|
1560
|
+
# {
|
1561
|
+
# associations: [
|
1562
|
+
# {
|
1563
|
+
# resource: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1564
|
+
# },
|
1565
|
+
# ],
|
1566
|
+
# }
|
1567
|
+
#
|
1568
|
+
# @example Request syntax with placeholder values
|
1569
|
+
#
|
1570
|
+
# resp = client.list_associations({
|
1571
|
+
# chat_configuration: "ChatConfigurationArn", # required
|
1572
|
+
# max_results: 1,
|
1573
|
+
# next_token: "ListAssociationsRequestNextTokenString",
|
1574
|
+
# })
|
1575
|
+
#
|
1576
|
+
# @example Response structure
|
1577
|
+
#
|
1578
|
+
# resp.associations #=> Array
|
1579
|
+
# resp.associations[0].resource #=> String
|
1580
|
+
# resp.next_token #=> String
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListAssociations AWS API Documentation
|
1583
|
+
#
|
1584
|
+
# @overload list_associations(params = {})
|
1585
|
+
# @param [Hash] params ({})
|
1586
|
+
def list_associations(params = {}, options = {})
|
1587
|
+
req = build_request(:list_associations, params)
|
1588
|
+
req.send_request(options)
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# Lists custom actions defined in this account.
|
1592
|
+
#
|
1593
|
+
# @option params [Integer] :max_results
|
1594
|
+
# The maximum number of results to include in the response. If more
|
1595
|
+
# results exist than the specified MaxResults value, a token is included
|
1596
|
+
# in the response so that the remaining results can be retrieved.
|
1597
|
+
#
|
1598
|
+
# @option params [String] :next_token
|
1599
|
+
# An optional token returned from a prior request. Use this token for
|
1600
|
+
# pagination of results from this action. If this parameter is
|
1601
|
+
# specified, the response includes only results beyond the token, up to
|
1602
|
+
# the value specified by MaxResults.
|
1603
|
+
#
|
1604
|
+
# @return [Types::ListCustomActionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1605
|
+
#
|
1606
|
+
# * {Types::ListCustomActionsResult#custom_actions #custom_actions} => Array<String>
|
1607
|
+
# * {Types::ListCustomActionsResult#next_token #next_token} => String
|
1608
|
+
#
|
1609
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1610
|
+
#
|
1611
|
+
#
|
1612
|
+
# @example Example: List custom actions
|
1613
|
+
#
|
1614
|
+
# resp = client.list_custom_actions({
|
1615
|
+
# })
|
1616
|
+
#
|
1617
|
+
# resp.to_h outputs the following:
|
1618
|
+
# {
|
1619
|
+
# custom_actions: [
|
1620
|
+
# "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
1621
|
+
# ],
|
1622
|
+
# }
|
1623
|
+
#
|
1624
|
+
# @example Request syntax with placeholder values
|
1625
|
+
#
|
1626
|
+
# resp = client.list_custom_actions({
|
1627
|
+
# max_results: 1,
|
1628
|
+
# next_token: "ListCustomActionsRequestNextTokenString",
|
1629
|
+
# })
|
1630
|
+
#
|
1631
|
+
# @example Response structure
|
1632
|
+
#
|
1633
|
+
# resp.custom_actions #=> Array
|
1634
|
+
# resp.custom_actions[0] #=> String
|
1635
|
+
# resp.next_token #=> String
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListCustomActions AWS API Documentation
|
1638
|
+
#
|
1639
|
+
# @overload list_custom_actions(params = {})
|
1640
|
+
# @param [Hash] params ({})
|
1641
|
+
def list_custom_actions(params = {}, options = {})
|
1642
|
+
req = build_request(:list_custom_actions, params)
|
1643
|
+
req.send_request(options)
|
1644
|
+
end
|
1645
|
+
|
1229
1646
|
# Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS
|
1230
1647
|
# account.
|
1231
1648
|
#
|
@@ -1350,7 +1767,7 @@ module Aws::Chatbot
|
|
1350
1767
|
# A list all Microsoft Teams user identities with a mapped role.
|
1351
1768
|
#
|
1352
1769
|
# @option params [String] :chat_configuration_arn
|
1353
|
-
# The Amazon Resource
|
1770
|
+
# The Amazon Resource Name (ARN) of the
|
1354
1771
|
# MicrosoftTeamsChannelConfiguration associated with the user identities
|
1355
1772
|
# to list.
|
1356
1773
|
#
|
@@ -1405,7 +1822,7 @@ module Aws::Chatbot
|
|
1405
1822
|
# that you specify. The resource can be a user, server, or role.
|
1406
1823
|
#
|
1407
1824
|
# @option params [required, String] :resource_arn
|
1408
|
-
# The ARN
|
1825
|
+
# The ARN of the resource to list tags for.
|
1409
1826
|
#
|
1410
1827
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1411
1828
|
#
|
@@ -1543,7 +1960,7 @@ module Aws::Chatbot
|
|
1543
1960
|
# Updates a Amazon Chime webhook configuration.
|
1544
1961
|
#
|
1545
1962
|
# @option params [required, String] :chat_configuration_arn
|
1546
|
-
# The Amazon Resource
|
1963
|
+
# The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to
|
1547
1964
|
# update.
|
1548
1965
|
#
|
1549
1966
|
# @option params [String] :webhook_description
|
@@ -1616,10 +2033,87 @@ module Aws::Chatbot
|
|
1616
2033
|
req.send_request(options)
|
1617
2034
|
end
|
1618
2035
|
|
2036
|
+
# Updates a custom action.
|
2037
|
+
#
|
2038
|
+
# @option params [required, String] :custom_action_arn
|
2039
|
+
# The fully defined Amazon Resource Name (ARN) of the custom action.
|
2040
|
+
#
|
2041
|
+
# @option params [required, Types::CustomActionDefinition] :definition
|
2042
|
+
# The definition of the command to run when invoked as an alias or as an
|
2043
|
+
# action button.
|
2044
|
+
#
|
2045
|
+
# @option params [String] :alias_name
|
2046
|
+
# The name used to invoke this action in the chat channel. For example,
|
2047
|
+
# `@aws run my-alias`.
|
2048
|
+
#
|
2049
|
+
# @option params [Array<Types::CustomActionAttachment>] :attachments
|
2050
|
+
# Defines when this custom action button should be attached to a
|
2051
|
+
# notification.
|
2052
|
+
#
|
2053
|
+
# @return [Types::UpdateCustomActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2054
|
+
#
|
2055
|
+
# * {Types::UpdateCustomActionResult#custom_action_arn #custom_action_arn} => String
|
2056
|
+
#
|
2057
|
+
#
|
2058
|
+
# @example Example: Update the command definition of an existing action
|
2059
|
+
#
|
2060
|
+
# # Updates the command text of a custom action without altering the existing alias name or attachment criteria
|
2061
|
+
#
|
2062
|
+
# resp = client.update_custom_action({
|
2063
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
2064
|
+
# definition: {
|
2065
|
+
# command_text: "lambda invoke MyNewFunction",
|
2066
|
+
# },
|
2067
|
+
# })
|
2068
|
+
#
|
2069
|
+
# resp.to_h outputs the following:
|
2070
|
+
# {
|
2071
|
+
# custom_action_arn: "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
|
2072
|
+
# }
|
2073
|
+
#
|
2074
|
+
# @example Request syntax with placeholder values
|
2075
|
+
#
|
2076
|
+
# resp = client.update_custom_action({
|
2077
|
+
# custom_action_arn: "CustomActionArn", # required
|
2078
|
+
# definition: { # required
|
2079
|
+
# command_text: "CustomActionDefinitionCommandTextString", # required
|
2080
|
+
# },
|
2081
|
+
# alias_name: "CustomActionAliasName",
|
2082
|
+
# attachments: [
|
2083
|
+
# {
|
2084
|
+
# notification_type: "CustomActionAttachmentNotificationType",
|
2085
|
+
# button_text: "CustomActionButtonText",
|
2086
|
+
# criteria: [
|
2087
|
+
# {
|
2088
|
+
# operator: "HAS_VALUE", # required, accepts HAS_VALUE, EQUALS
|
2089
|
+
# variable_name: "CustomActionAttachmentCriteriaVariableNameString", # required
|
2090
|
+
# value: "CustomActionAttachmentCriteriaValueString",
|
2091
|
+
# },
|
2092
|
+
# ],
|
2093
|
+
# variables: {
|
2094
|
+
# "CustomActionAttachmentVariablesKeyString" => "CustomActionAttachmentVariablesValueString",
|
2095
|
+
# },
|
2096
|
+
# },
|
2097
|
+
# ],
|
2098
|
+
# })
|
2099
|
+
#
|
2100
|
+
# @example Response structure
|
2101
|
+
#
|
2102
|
+
# resp.custom_action_arn #=> String
|
2103
|
+
#
|
2104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateCustomAction AWS API Documentation
|
2105
|
+
#
|
2106
|
+
# @overload update_custom_action(params = {})
|
2107
|
+
# @param [Hash] params ({})
|
2108
|
+
def update_custom_action(params = {}, options = {})
|
2109
|
+
req = build_request(:update_custom_action, params)
|
2110
|
+
req.send_request(options)
|
2111
|
+
end
|
2112
|
+
|
1619
2113
|
# Updates an Microsoft Teams channel configuration.
|
1620
2114
|
#
|
1621
2115
|
# @option params [required, String] :chat_configuration_arn
|
1622
|
-
# The Amazon Resource
|
2116
|
+
# The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to
|
1623
2117
|
# update.
|
1624
2118
|
#
|
1625
2119
|
# @option params [required, String] :channel_id
|
@@ -1705,7 +2199,7 @@ module Aws::Chatbot
|
|
1705
2199
|
# Updates a Slack channel configuration.
|
1706
2200
|
#
|
1707
2201
|
# @option params [required, String] :chat_configuration_arn
|
1708
|
-
# The Amazon Resource
|
2202
|
+
# The Amazon Resource Name (ARN) of the SlackChannelConfiguration to
|
1709
2203
|
# update.
|
1710
2204
|
#
|
1711
2205
|
# @option params [required, String] :slack_channel_id
|
@@ -1809,7 +2303,7 @@ module Aws::Chatbot
|
|
1809
2303
|
tracer: tracer
|
1810
2304
|
)
|
1811
2305
|
context[:gem_name] = 'aws-sdk-chatbot'
|
1812
|
-
context[:gem_version] = '1.
|
2306
|
+
context[:gem_version] = '1.19.0'
|
1813
2307
|
Seahorse::Client::Request.new(handlers, context)
|
1814
2308
|
end
|
1815
2309
|
|