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.
409 410 411 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 409 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.
503 504 505 506 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 503 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.
532 533 534 535 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 532 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.
562 563 564 565 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 562 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.
618 619 620 621 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 618 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.
671 672 673 674 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 671 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.
728 729 730 731 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 728 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.
757 758 759 760 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 757 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.
815 816 817 818 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 815 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.
859 860 861 862 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 859 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.
895 896 897 898 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 895 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.
930 931 932 933 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 930 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.
958 959 960 961 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 958 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.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/client.rb', line 1024 def update_notification_rule(params = {}, = {}) req = build_request(:update_notification_rule, params) req.send_request() end |