Class: Aws::CodeStarNotifications::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeStarNotifications::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb
Overview
An API client for CodeStarNotifications. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CodeStarNotifications::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
API Operations collapse
-
#create_notification_rule(params = {}) ⇒ Types::CreateNotificationRuleResult
Creates a notification rule for a resource.
-
#delete_notification_rule(params = {}) ⇒ Types::DeleteNotificationRuleResult
Deletes a notification rule for a resource.
-
#delete_target(params = {}) ⇒ Struct
Deletes a specified target for notifications.
-
#describe_notification_rule(params = {}) ⇒ Types::DescribeNotificationRuleResult
Returns information about a specified notification rule.
-
#list_event_types(params = {}) ⇒ Types::ListEventTypesResult
Returns information about the event types available for configuring notifications.
-
#list_notification_rules(params = {}) ⇒ Types::ListNotificationRulesResult
Returns a list of the notification rules for an Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Returns a list of the tags associated with a notification rule.
-
#list_targets(params = {}) ⇒ Types::ListTargetsResult
Returns a list of the notification rule targets for an Amazon Web Services account.
-
#subscribe(params = {}) ⇒ Types::SubscribeResult
Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResult
Associates a set of provided tags with a notification rule.
-
#unsubscribe(params = {}) ⇒ Types::UnsubscribeResult
Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association between one or more provided tags and a notification rule.
-
#update_notification_rule(params = {}) ⇒ Struct
Updates a notification rule for a resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
385 386 387 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_notification_rule(params = {}) ⇒ Types::CreateNotificationRuleResult
Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.
479 480 481 482 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 479 def create_notification_rule(params = {}, = {}) req = build_request(:create_notification_rule, params) req.send_request() end |
#delete_notification_rule(params = {}) ⇒ Types::DeleteNotificationRuleResult
Deletes a notification rule for a resource.
508 509 510 511 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 508 def delete_notification_rule(params = {}, = {}) req = build_request(:delete_notification_rule, params) req.send_request() end |
#delete_target(params = {}) ⇒ Struct
Deletes a specified target for notifications.
538 539 540 541 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 538 def delete_target(params = {}, = {}) req = build_request(:delete_target, params) req.send_request() end |
#describe_notification_rule(params = {}) ⇒ Types::DescribeNotificationRuleResult
Returns information about a specified notification rule.
594 595 596 597 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 594 def describe_notification_rule(params = {}, = {}) req = build_request(:describe_notification_rule, params) req.send_request() end |
#list_event_types(params = {}) ⇒ Types::ListEventTypesResult
Returns information about the event types available for configuring notifications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
647 648 649 650 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 647 def list_event_types(params = {}, = {}) req = build_request(:list_event_types, params) req.send_request() end |
#list_notification_rules(params = {}) ⇒ Types::ListNotificationRulesResult
Returns a list of the notification rules for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
704 705 706 707 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 704 def list_notification_rules(params = {}, = {}) req = build_request(:list_notification_rules, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Returns a list of the tags associated with a notification rule.
733 734 735 736 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 733 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_targets(params = {}) ⇒ Types::ListTargetsResult
Returns a list of the notification rule targets for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
791 792 793 794 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 791 def list_targets(params = {}, = {}) req = build_request(:list_targets, params) req.send_request() end |
#subscribe(params = {}) ⇒ Types::SubscribeResult
Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.
835 836 837 838 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 835 def subscribe(params = {}, = {}) req = build_request(:subscribe, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResult
Associates a set of provided tags with a notification rule.
871 872 873 874 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 871 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unsubscribe(params = {}) ⇒ Types::UnsubscribeResult
Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
906 907 908 909 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 906 def unsubscribe(params = {}, = {}) req = build_request(:unsubscribe, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association between one or more provided tags and a notification rule.
934 935 936 937 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 934 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_notification_rule(params = {}) ⇒ Struct
Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 1000 def update_notification_rule(params = {}, = {}) req = build_request(:update_notification_rule, params) req.send_request() end |