@@ -352,31 +352,33 @@ def initialize(*args)
352
352
# @!group API Operations
353
353
354
354
# Creates a notification rule for a resource. The rule specifies the
355
- # events you want notifications about and the targets (such as SNS
356
- # topics) where you want to receive them.
355
+ # events you want notifications about and the targets (such as Chatbot
356
+ # topics or Chatbot clients configured for Slack) where you want to
357
+ # receive them.
357
358
#
358
359
# @option params [required, String] :name
359
- # The name for the notification rule. Notifictaion rule names must be
360
- # unique in your AWS account.
360
+ # The name for the notification rule. Notification rule names must be
361
+ # unique in your Amazon Web Services account.
361
362
#
362
363
# @option params [required, Array<String>] :event_type_ids
363
364
# A list of event types associated with this notification rule. For a
364
365
# list of allowed events, see EventTypeSummary.
365
366
#
366
367
# @option params [required, String] :resource
367
368
# The Amazon Resource Name (ARN) of the resource to associate with the
368
- # notification rule. Supported resources include pipelines in AWS
369
- # CodePipeline, repositories in AWS CodeCommit, and build projects in
370
- # AWS CodeBuild.
369
+ # notification rule. Supported resources include pipelines in
370
+ # CodePipeline, repositories in CodeCommit, and build projects in
371
+ # CodeBuild.
371
372
#
372
373
# @option params [required, Array<Types::Target>] :targets
373
- # A list of Amazon Resource Names (ARNs) of SNS topics to associate with
374
- # the notification rule.
374
+ # A list of Amazon Resource Names (ARNs) of Amazon Simple Notification
375
+ # Service topics and Chatbot clients to associate with the notification
376
+ # rule.
375
377
#
376
378
# @option params [required, String] :detail_type
377
379
# The level of detail to include in the notifications for this resource.
378
- # BASIC will include only the contents of the event as it would appear
379
- # in AWS CloudWatch. FULL will include any supplemental information
380
+ # ` BASIC` will include only the contents of the event as it would appear
381
+ # in Amazon CloudWatch. ` FULL` will include any supplemental information
380
382
# provided by AWS CodeStar Notifications and/or the service for the
381
383
# resource for which the notification is created.
382
384
#
@@ -387,8 +389,9 @@ def initialize(*args)
387
389
# token is included, the request returns information about the initial
388
390
# request that used that token.
389
391
#
390
- # <note markdown="1"> The AWS SDKs prepopulate client request tokens. If you are using an
391
- # AWS SDK, an idempotency token is created for you.
392
+ # <note markdown="1"> The Amazon Web Services SDKs prepopulate client request tokens. If you
393
+ # are using an Amazon Web Services SDK, an idempotency token is created
394
+ # for you.
392
395
#
393
396
# </note>
394
397
#
@@ -397,11 +400,11 @@ def initialize(*args)
397
400
#
398
401
# @option params [Hash<String,String>] :tags
399
402
# A list of tags to apply to this notification rule. Key names cannot
400
- # start with "aws".
403
+ # start with "` aws` ".
401
404
#
402
405
# @option params [String] :status
403
- # The status of the notification rule. The default value is ENABLED. If
404
- # the status is set to DISABLED, notifications aren't sent for the
406
+ # The status of the notification rule. The default value is ` ENABLED`.
407
+ # If the status is set to ` DISABLED` , notifications aren't sent for the
405
408
# notification rule.
406
409
#
407
410
# @return [Types::CreateNotificationRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -473,13 +476,14 @@ def delete_notification_rule(params = {}, options = {})
473
476
# Deletes a specified target for notifications.
474
477
#
475
478
# @option params [required, String] :target_address
476
- # The Amazon Resource Name (ARN) of the SNS topic to delete.
479
+ # The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client
480
+ # to delete.
477
481
#
478
482
# @option params [Boolean] :force_unsubscribe_all
479
483
# A Boolean value that can be used to delete all associations with this
480
- # SNS topic. The default value is FALSE. If set to TRUE, all
484
+ # Chatbot topic. The default value is FALSE. If set to TRUE, all
481
485
# associations between that target and every notification rule in your
482
- # AWS account are deleted.
486
+ # Amazon Web Services account are deleted.
483
487
#
484
488
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
485
489
#
@@ -608,7 +612,8 @@ def list_event_types(params = {}, options = {})
608
612
req . send_request ( options )
609
613
end
610
614
611
- # Returns a list of the notification rules for an AWS account.
615
+ # Returns a list of the notification rules for an Amazon Web Services
616
+ # account.
612
617
#
613
618
# @option params [Array<Types::ListNotificationRulesFilter>] :filters
614
619
# The filters to use to return information by service or resource type.
@@ -693,7 +698,8 @@ def list_tags_for_resource(params = {}, options = {})
693
698
req . send_request ( options )
694
699
end
695
700
696
- # Returns a list of the notification rule targets for an AWS account.
701
+ # Returns a list of the notification rule targets for an Amazon Web
702
+ # Services account.
697
703
#
698
704
# @option params [Array<Types::ListTargetsFilter>] :filters
699
705
# The filters to use to return information by service or resource type.
@@ -750,16 +756,17 @@ def list_targets(params = {}, options = {})
750
756
req . send_request ( options )
751
757
end
752
758
753
- # Creates an association between a notification rule and an SNS topic so
754
- # that the associated target can receive notifications when the events
755
- # described in the rule are triggered.
759
+ # Creates an association between a notification rule and an Chatbot
760
+ # topic or Chatbot client so that the associated target can receive
761
+ # notifications when the events described in the rule are triggered.
756
762
#
757
763
# @option params [required, String] :arn
758
764
# The Amazon Resource Name (ARN) of the notification rule for which you
759
765
# want to create the association.
760
766
#
761
767
# @option params [required, Types::Target] :target
762
- # Information about the SNS topics associated with a notification rule.
768
+ # Information about the Chatbot topics or Chatbot clients associated
769
+ # with a notification rule.
763
770
#
764
771
# @option params [String] :client_request_token
765
772
# An enumeration token that, when provided in a request, returns the
@@ -800,7 +807,7 @@ def subscribe(params = {}, options = {})
800
807
#
801
808
# @option params [required, Hash<String,String>] :tags
802
809
# The list of tags to associate with the resource. Tag key names cannot
803
- # start with "aws".
810
+ # start with "` aws` ".
804
811
#
805
812
# @return [Types::TagResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
806
813
#
@@ -829,15 +836,16 @@ def tag_resource(params = {}, options = {})
829
836
req . send_request ( options )
830
837
end
831
838
832
- # Removes an association between a notification rule and an Amazon SNS
839
+ # Removes an association between a notification rule and an Chatbot
833
840
# topic so that subscribers to that topic stop receiving notifications
834
841
# when the events described in the rule are triggered.
835
842
#
836
843
# @option params [required, String] :arn
837
844
# The Amazon Resource Name (ARN) of the notification rule.
838
845
#
839
846
# @option params [required, String] :target_address
840
- # The ARN of the SNS topic to unsubscribe from the notification rule.
847
+ # The ARN of the Chatbot topic to unsubscribe from the notification
848
+ # rule.
841
849
#
842
850
# @return [Types::UnsubscribeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
843
851
#
@@ -911,7 +919,13 @@ def untag_resource(params = {}, options = {})
911
919
# (sending notifications) or disabled (not sending notifications).
912
920
#
913
921
# @option params [Array<String>] :event_type_ids
914
- # A list of event types associated with this notification rule.
922
+ # A list of event types associated with this notification rule. For a
923
+ # complete list of event types and IDs, see [Notification concepts][1]
924
+ # in the *Developer Tools Console User Guide*.
925
+ #
926
+ #
927
+ #
928
+ # [1]: https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api
915
929
#
916
930
# @option params [Array<Types::Target>] :targets
917
931
# The address and type of the targets to receive notifications from this
@@ -920,7 +934,7 @@ def untag_resource(params = {}, options = {})
920
934
# @option params [String] :detail_type
921
935
# The level of detail to include in the notifications for this resource.
922
936
# BASIC will include only the contents of the event as it would appear
923
- # in AWS CloudWatch. FULL will include any supplemental information
937
+ # in Amazon CloudWatch. FULL will include any supplemental information
924
938
# provided by AWS CodeStar Notifications and/or the service for the
925
939
# resource for which the notification is created.
926
940
#
@@ -964,7 +978,7 @@ def build_request(operation_name, params = {})
964
978
params : params ,
965
979
config : config )
966
980
context [ :gem_name ] = 'aws-sdk-codestarnotifications'
967
- context [ :gem_version ] = '1.19 .0'
981
+ context [ :gem_version ] = '1.20 .0'
968
982
Seahorse ::Client ::Request . new ( handlers , context )
969
983
end
970
984
0 commit comments