aws-sdk-cloudwatchevents 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatchevents.rb +2 -2
- data/lib/aws-sdk-cloudwatchevents/client.rb +717 -563
- data/lib/aws-sdk-cloudwatchevents/client_api.rb +397 -422
- data/lib/aws-sdk-cloudwatchevents/errors.rb +4 -13
- data/lib/aws-sdk-cloudwatchevents/resource.rb +12 -14
- data/lib/aws-sdk-cloudwatchevents/types.rb +943 -653
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: df7192364528bc96e659bf121f7a267a18d0ae84
|
|
4
|
+
data.tar.gz: 8a28f4fa5c23cfe46e895a363d6731fc1042f48b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a4ca04de0c7e7e1827fd5bdee64373368065e840dac1981ab8bbf43cd004fd4635753117ee5057a2a372e7907f68cf308fe21554df72a21e5c70ef12cb24fe7c
|
|
7
|
+
data.tar.gz: f7eaaa896408064eac51be209032075e942a3046f97ac697aca3503fc99345f6b1010259788832f07c3966536a488dcbdd903a6597ada0b65393a5be3b25def8
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloudwatchevents/customizations'
|
|
|
42
42
|
# @service
|
|
43
43
|
module Aws::CloudWatchEvents
|
|
44
44
|
|
|
45
|
-
GEM_VERSION = '1.0.0.
|
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
|
46
46
|
|
|
47
47
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -18,598 +18,752 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
22
23
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
23
24
|
|
|
24
25
|
Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchevents)
|
|
25
26
|
|
|
26
|
-
module Aws
|
|
27
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
27
|
+
module Aws::CloudWatchEvents
|
|
28
|
+
class Client < Seahorse::Client::Base
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
include Aws::ClientStubs
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
@identifier = :cloudwatchevents
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
set_api(ClientApi::API)
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
51
52
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
55
|
+
# following classes:
|
|
56
|
+
#
|
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
58
|
+
# credentials.
|
|
59
|
+
#
|
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
62
|
+
#
|
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
64
|
+
# shared file, such as `~/.aws/config`.
|
|
65
|
+
#
|
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
67
|
+
#
|
|
68
|
+
# When `:credentials` are not configured directly, the following
|
|
69
|
+
# locations will be searched for credentials:
|
|
70
|
+
#
|
|
71
|
+
# * `Aws.config[:credentials]`
|
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
74
|
+
# * `~/.aws/credentials`
|
|
75
|
+
# * `~/.aws/config`
|
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
77
|
+
# very aggressive. Construct and pass an instance of
|
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
79
|
+
# timeouts.
|
|
80
|
+
#
|
|
81
|
+
# @option options [required, String] :region
|
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
84
|
+
# a default `:region` is search for in the following locations:
|
|
85
|
+
#
|
|
86
|
+
# * `Aws.config[:region]`
|
|
87
|
+
# * `ENV['AWS_REGION']`
|
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
90
|
+
# * `~/.aws/credentials`
|
|
91
|
+
# * `~/.aws/config`
|
|
92
|
+
#
|
|
93
|
+
# @option options [String] :access_key_id
|
|
94
|
+
#
|
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
97
|
+
# the required types.
|
|
98
|
+
#
|
|
99
|
+
# @option options [String] :endpoint
|
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
103
|
+
#
|
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
105
|
+
# The log formatter.
|
|
106
|
+
#
|
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
|
108
|
+
# The log level to send messages to the `:logger` at.
|
|
109
|
+
#
|
|
110
|
+
# @option options [Logger] :logger
|
|
111
|
+
# The Logger instance to send log messages to. If this option
|
|
112
|
+
# is not set, logging will be disabled.
|
|
113
|
+
#
|
|
114
|
+
# @option options [String] :profile ("default")
|
|
115
|
+
# Used when loading credentials from the shared credentials file
|
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
117
|
+
#
|
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
123
|
+
# errors from expired credentials.
|
|
124
|
+
#
|
|
125
|
+
# @option options [String] :secret_access_key
|
|
126
|
+
#
|
|
127
|
+
# @option options [String] :session_token
|
|
128
|
+
#
|
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
|
131
|
+
# Also disable response data type conversions. This option is useful
|
|
132
|
+
# when you want to ensure the highest level of performance by
|
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
|
134
|
+
# structures.
|
|
135
|
+
#
|
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
|
138
|
+
#
|
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
|
140
|
+
# Causes the client to return stubbed responses. By default
|
|
141
|
+
# fake responses are generated and returned. You can specify
|
|
142
|
+
# the response data to return or errors to raise by calling
|
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
144
|
+
#
|
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
146
|
+
# requests are made, and retries are disabled.
|
|
147
|
+
#
|
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
|
149
|
+
# When `true`, request parameters are validated before
|
|
150
|
+
# sending the request.
|
|
151
|
+
#
|
|
152
|
+
def initialize(*args)
|
|
153
|
+
super
|
|
154
|
+
end
|
|
139
155
|
|
|
140
|
-
|
|
156
|
+
# @!group API Operations
|
|
141
157
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
# * {Types::DescribeRuleResponse#event_pattern #EventPattern} => String
|
|
171
|
-
# * {Types::DescribeRuleResponse#schedule_expression #ScheduleExpression} => String
|
|
172
|
-
# * {Types::DescribeRuleResponse#state #State} => String
|
|
173
|
-
# * {Types::DescribeRuleResponse#description #Description} => String
|
|
174
|
-
# * {Types::DescribeRuleResponse#role_arn #RoleArn} => String
|
|
175
|
-
#
|
|
176
|
-
# @example Request syntax with placeholder values
|
|
177
|
-
# resp = client.describe_rule({
|
|
178
|
-
# name: "RuleName", # required
|
|
179
|
-
# })
|
|
180
|
-
#
|
|
181
|
-
# @example Response structure
|
|
182
|
-
# resp.name #=> String
|
|
183
|
-
# resp.arn #=> String
|
|
184
|
-
# resp.event_pattern #=> String
|
|
185
|
-
# resp.schedule_expression #=> String
|
|
186
|
-
# resp.state #=> String, one of "ENABLED", "DISABLED"
|
|
187
|
-
# resp.description #=> String
|
|
188
|
-
# resp.role_arn #=> String
|
|
189
|
-
# @overload describe_rule(params = {})
|
|
190
|
-
# @param [Hash] params ({})
|
|
191
|
-
def describe_rule(params = {}, options = {})
|
|
192
|
-
req = build_request(:describe_rule, params)
|
|
193
|
-
req.send_request(options)
|
|
194
|
-
end
|
|
158
|
+
# Deletes the specified rule.
|
|
159
|
+
#
|
|
160
|
+
# You must remove all targets from a rule using RemoveTargets before you
|
|
161
|
+
# can delete the rule.
|
|
162
|
+
#
|
|
163
|
+
# When you delete a rule, incoming events might continue to match to the
|
|
164
|
+
# deleted rule. Please allow a short period of time for changes to take
|
|
165
|
+
# effect.
|
|
166
|
+
#
|
|
167
|
+
# @option params [required, String] :name
|
|
168
|
+
# The name of the rule.
|
|
169
|
+
#
|
|
170
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
171
|
+
#
|
|
172
|
+
# @example Request syntax with placeholder values
|
|
173
|
+
#
|
|
174
|
+
# resp = client.delete_rule({
|
|
175
|
+
# name: "RuleName", # required
|
|
176
|
+
# })
|
|
177
|
+
#
|
|
178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRule AWS API Documentation
|
|
179
|
+
#
|
|
180
|
+
# @overload delete_rule(params = {})
|
|
181
|
+
# @param [Hash] params ({})
|
|
182
|
+
def delete_rule(params = {}, options = {})
|
|
183
|
+
req = build_request(:delete_rule, params)
|
|
184
|
+
req.send_request(options)
|
|
185
|
+
end
|
|
195
186
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
187
|
+
# Describes the specified rule.
|
|
188
|
+
#
|
|
189
|
+
# @option params [required, String] :name
|
|
190
|
+
# The name of the rule.
|
|
191
|
+
#
|
|
192
|
+
# @return [Types::DescribeRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
193
|
+
#
|
|
194
|
+
# * {Types::DescribeRuleResponse#name #name} => String
|
|
195
|
+
# * {Types::DescribeRuleResponse#arn #arn} => String
|
|
196
|
+
# * {Types::DescribeRuleResponse#event_pattern #event_pattern} => String
|
|
197
|
+
# * {Types::DescribeRuleResponse#schedule_expression #schedule_expression} => String
|
|
198
|
+
# * {Types::DescribeRuleResponse#state #state} => String
|
|
199
|
+
# * {Types::DescribeRuleResponse#description #description} => String
|
|
200
|
+
# * {Types::DescribeRuleResponse#role_arn #role_arn} => String
|
|
201
|
+
#
|
|
202
|
+
# @example Request syntax with placeholder values
|
|
203
|
+
#
|
|
204
|
+
# resp = client.describe_rule({
|
|
205
|
+
# name: "RuleName", # required
|
|
206
|
+
# })
|
|
207
|
+
#
|
|
208
|
+
# @example Response structure
|
|
209
|
+
#
|
|
210
|
+
# resp.name #=> String
|
|
211
|
+
# resp.arn #=> String
|
|
212
|
+
# resp.event_pattern #=> String
|
|
213
|
+
# resp.schedule_expression #=> String
|
|
214
|
+
# resp.state #=> String, one of "ENABLED", "DISABLED"
|
|
215
|
+
# resp.description #=> String
|
|
216
|
+
# resp.role_arn #=> String
|
|
217
|
+
#
|
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule AWS API Documentation
|
|
219
|
+
#
|
|
220
|
+
# @overload describe_rule(params = {})
|
|
221
|
+
# @param [Hash] params ({})
|
|
222
|
+
def describe_rule(params = {}, options = {})
|
|
223
|
+
req = build_request(:describe_rule, params)
|
|
224
|
+
req.send_request(options)
|
|
225
|
+
end
|
|
216
226
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
227
|
+
# Disables the specified rule. A disabled rule won't match any events,
|
|
228
|
+
# and won't self-trigger if it has a schedule expression.
|
|
229
|
+
#
|
|
230
|
+
# When you disable a rule, incoming events might continue to match to
|
|
231
|
+
# the disabled rule. Please allow a short period of time for changes to
|
|
232
|
+
# take effect.
|
|
233
|
+
#
|
|
234
|
+
# @option params [required, String] :name
|
|
235
|
+
# The name of the rule.
|
|
236
|
+
#
|
|
237
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
238
|
+
#
|
|
239
|
+
# @example Request syntax with placeholder values
|
|
240
|
+
#
|
|
241
|
+
# resp = client.disable_rule({
|
|
242
|
+
# name: "RuleName", # required
|
|
243
|
+
# })
|
|
244
|
+
#
|
|
245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule AWS API Documentation
|
|
246
|
+
#
|
|
247
|
+
# @overload disable_rule(params = {})
|
|
248
|
+
# @param [Hash] params ({})
|
|
249
|
+
def disable_rule(params = {}, options = {})
|
|
250
|
+
req = build_request(:disable_rule, params)
|
|
251
|
+
req.send_request(options)
|
|
252
|
+
end
|
|
236
253
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
#
|
|
264
|
-
# @example Response structure
|
|
265
|
-
# resp.rule_names #=> Array
|
|
266
|
-
# resp.rule_names[0] #=> String
|
|
267
|
-
# resp.next_token #=> String
|
|
268
|
-
# @overload list_rule_names_by_target(params = {})
|
|
269
|
-
# @param [Hash] params ({})
|
|
270
|
-
def list_rule_names_by_target(params = {}, options = {})
|
|
271
|
-
req = build_request(:list_rule_names_by_target, params)
|
|
272
|
-
req.send_request(options)
|
|
273
|
-
end
|
|
254
|
+
# Enables the specified rule. If the rule does not exist, the operation
|
|
255
|
+
# fails.
|
|
256
|
+
#
|
|
257
|
+
# When you enable a rule, incoming events might not immediately start
|
|
258
|
+
# matching to a newly enabled rule. Please allow a short period of time
|
|
259
|
+
# for changes to take effect.
|
|
260
|
+
#
|
|
261
|
+
# @option params [required, String] :name
|
|
262
|
+
# The name of the rule.
|
|
263
|
+
#
|
|
264
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
265
|
+
#
|
|
266
|
+
# @example Request syntax with placeholder values
|
|
267
|
+
#
|
|
268
|
+
# resp = client.enable_rule({
|
|
269
|
+
# name: "RuleName", # required
|
|
270
|
+
# })
|
|
271
|
+
#
|
|
272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule AWS API Documentation
|
|
273
|
+
#
|
|
274
|
+
# @overload enable_rule(params = {})
|
|
275
|
+
# @param [Hash] params ({})
|
|
276
|
+
def enable_rule(params = {}, options = {})
|
|
277
|
+
req = build_request(:enable_rule, params)
|
|
278
|
+
req.send_request(options)
|
|
279
|
+
end
|
|
274
280
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
281
|
+
# Lists the rules for the specified target. You can see which of the
|
|
282
|
+
# rules in Amazon CloudWatch Events can invoke a specific target in your
|
|
283
|
+
# account.
|
|
284
|
+
#
|
|
285
|
+
# @option params [required, String] :target_arn
|
|
286
|
+
# The Amazon Resource Name (ARN) of the target resource.
|
|
287
|
+
#
|
|
288
|
+
# @option params [String] :next_token
|
|
289
|
+
# The token returned by a previous call to retrieve the next set of
|
|
290
|
+
# results.
|
|
291
|
+
#
|
|
292
|
+
# @option params [Integer] :limit
|
|
293
|
+
# The maximum number of results to return.
|
|
294
|
+
#
|
|
295
|
+
# @return [Types::ListRuleNamesByTargetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
296
|
+
#
|
|
297
|
+
# * {Types::ListRuleNamesByTargetResponse#rule_names #rule_names} => Array<String>
|
|
298
|
+
# * {Types::ListRuleNamesByTargetResponse#next_token #next_token} => String
|
|
299
|
+
#
|
|
300
|
+
# @example Request syntax with placeholder values
|
|
301
|
+
#
|
|
302
|
+
# resp = client.list_rule_names_by_target({
|
|
303
|
+
# target_arn: "TargetArn", # required
|
|
304
|
+
# next_token: "NextToken",
|
|
305
|
+
# limit: 1,
|
|
306
|
+
# })
|
|
307
|
+
#
|
|
308
|
+
# @example Response structure
|
|
309
|
+
#
|
|
310
|
+
# resp.rule_names #=> Array
|
|
311
|
+
# resp.rule_names[0] #=> String
|
|
312
|
+
# resp.next_token #=> String
|
|
313
|
+
#
|
|
314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRuleNamesByTarget AWS API Documentation
|
|
315
|
+
#
|
|
316
|
+
# @overload list_rule_names_by_target(params = {})
|
|
317
|
+
# @param [Hash] params ({})
|
|
318
|
+
def list_rule_names_by_target(params = {}, options = {})
|
|
319
|
+
req = build_request(:list_rule_names_by_target, params)
|
|
320
|
+
req.send_request(options)
|
|
321
|
+
end
|
|
316
322
|
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
323
|
+
# Lists your Amazon CloudWatch Events rules. You can either list all the
|
|
324
|
+
# rules or you can provide a prefix to match to the rule names.
|
|
325
|
+
#
|
|
326
|
+
# @option params [String] :name_prefix
|
|
327
|
+
# The prefix matching the rule name.
|
|
328
|
+
#
|
|
329
|
+
# @option params [String] :next_token
|
|
330
|
+
# The token returned by a previous call to retrieve the next set of
|
|
331
|
+
# results.
|
|
332
|
+
#
|
|
333
|
+
# @option params [Integer] :limit
|
|
334
|
+
# The maximum number of results to return.
|
|
335
|
+
#
|
|
336
|
+
# @return [Types::ListRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
337
|
+
#
|
|
338
|
+
# * {Types::ListRulesResponse#rules #rules} => Array<Types::Rule>
|
|
339
|
+
# * {Types::ListRulesResponse#next_token #next_token} => String
|
|
340
|
+
#
|
|
341
|
+
# @example Request syntax with placeholder values
|
|
342
|
+
#
|
|
343
|
+
# resp = client.list_rules({
|
|
344
|
+
# name_prefix: "RuleName",
|
|
345
|
+
# next_token: "NextToken",
|
|
346
|
+
# limit: 1,
|
|
347
|
+
# })
|
|
348
|
+
#
|
|
349
|
+
# @example Response structure
|
|
350
|
+
#
|
|
351
|
+
# resp.rules #=> Array
|
|
352
|
+
# resp.rules[0].name #=> String
|
|
353
|
+
# resp.rules[0].arn #=> String
|
|
354
|
+
# resp.rules[0].event_pattern #=> String
|
|
355
|
+
# resp.rules[0].state #=> String, one of "ENABLED", "DISABLED"
|
|
356
|
+
# resp.rules[0].description #=> String
|
|
357
|
+
# resp.rules[0].schedule_expression #=> String
|
|
358
|
+
# resp.rules[0].role_arn #=> String
|
|
359
|
+
# resp.next_token #=> String
|
|
360
|
+
#
|
|
361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRules AWS API Documentation
|
|
362
|
+
#
|
|
363
|
+
# @overload list_rules(params = {})
|
|
364
|
+
# @param [Hash] params ({})
|
|
365
|
+
def list_rules(params = {}, options = {})
|
|
366
|
+
req = build_request(:list_rules, params)
|
|
367
|
+
req.send_request(options)
|
|
368
|
+
end
|
|
350
369
|
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
370
|
+
# Lists the targets assigned to the specified rule.
|
|
371
|
+
#
|
|
372
|
+
# @option params [required, String] :rule
|
|
373
|
+
# The name of the rule.
|
|
374
|
+
#
|
|
375
|
+
# @option params [String] :next_token
|
|
376
|
+
# The token returned by a previous call to retrieve the next set of
|
|
377
|
+
# results.
|
|
378
|
+
#
|
|
379
|
+
# @option params [Integer] :limit
|
|
380
|
+
# The maximum number of results to return.
|
|
381
|
+
#
|
|
382
|
+
# @return [Types::ListTargetsByRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
383
|
+
#
|
|
384
|
+
# * {Types::ListTargetsByRuleResponse#targets #targets} => Array<Types::Target>
|
|
385
|
+
# * {Types::ListTargetsByRuleResponse#next_token #next_token} => String
|
|
386
|
+
#
|
|
387
|
+
# @example Request syntax with placeholder values
|
|
388
|
+
#
|
|
389
|
+
# resp = client.list_targets_by_rule({
|
|
390
|
+
# rule: "RuleName", # required
|
|
391
|
+
# next_token: "NextToken",
|
|
392
|
+
# limit: 1,
|
|
393
|
+
# })
|
|
394
|
+
#
|
|
395
|
+
# @example Response structure
|
|
396
|
+
#
|
|
397
|
+
# resp.targets #=> Array
|
|
398
|
+
# resp.targets[0].id #=> String
|
|
399
|
+
# resp.targets[0].arn #=> String
|
|
400
|
+
# resp.targets[0].role_arn #=> String
|
|
401
|
+
# resp.targets[0].input #=> String
|
|
402
|
+
# resp.targets[0].input_path #=> String
|
|
403
|
+
# resp.targets[0].input_transformer.input_paths_map #=> Hash
|
|
404
|
+
# resp.targets[0].input_transformer.input_paths_map["InputTransformerPathKey"] #=> String
|
|
405
|
+
# resp.targets[0].input_transformer.input_template #=> String
|
|
406
|
+
# resp.targets[0].kinesis_parameters.partition_key_path #=> String
|
|
407
|
+
# resp.targets[0].run_command_parameters.run_command_targets #=> Array
|
|
408
|
+
# resp.targets[0].run_command_parameters.run_command_targets[0].key #=> String
|
|
409
|
+
# resp.targets[0].run_command_parameters.run_command_targets[0].values #=> Array
|
|
410
|
+
# resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
|
|
411
|
+
# resp.targets[0].ecs_parameters.task_definition_arn #=> String
|
|
412
|
+
# resp.targets[0].ecs_parameters.task_count #=> Integer
|
|
413
|
+
# resp.next_token #=> String
|
|
414
|
+
#
|
|
415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule AWS API Documentation
|
|
416
|
+
#
|
|
417
|
+
# @overload list_targets_by_rule(params = {})
|
|
418
|
+
# @param [Hash] params ({})
|
|
419
|
+
def list_targets_by_rule(params = {}, options = {})
|
|
420
|
+
req = build_request(:list_targets_by_rule, params)
|
|
421
|
+
req.send_request(options)
|
|
422
|
+
end
|
|
387
423
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
# state: "ENABLED", # accepts ENABLED, DISABLED
|
|
432
|
-
# description: "RuleDescription",
|
|
433
|
-
# role_arn: "RoleArn",
|
|
434
|
-
# })
|
|
435
|
-
#
|
|
436
|
-
# @example Response structure
|
|
437
|
-
# resp.rule_arn #=> String
|
|
438
|
-
# @overload put_rule(params = {})
|
|
439
|
-
# @param [Hash] params ({})
|
|
440
|
-
def put_rule(params = {}, options = {})
|
|
441
|
-
req = build_request(:put_rule, params)
|
|
442
|
-
req.send_request(options)
|
|
443
|
-
end
|
|
424
|
+
# Sends custom events to Amazon CloudWatch Events so that they can be
|
|
425
|
+
# matched to rules.
|
|
426
|
+
#
|
|
427
|
+
# @option params [required, Array<Types::PutEventsRequestEntry>] :entries
|
|
428
|
+
# The entry that defines an event in your system. You can specify
|
|
429
|
+
# several parameters for the entry such as the source and type of the
|
|
430
|
+
# event, resources associated with the event, and so on.
|
|
431
|
+
#
|
|
432
|
+
# @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
433
|
+
#
|
|
434
|
+
# * {Types::PutEventsResponse#failed_entry_count #failed_entry_count} => Integer
|
|
435
|
+
# * {Types::PutEventsResponse#entries #entries} => Array<Types::PutEventsResultEntry>
|
|
436
|
+
#
|
|
437
|
+
# @example Request syntax with placeholder values
|
|
438
|
+
#
|
|
439
|
+
# resp = client.put_events({
|
|
440
|
+
# entries: [ # required
|
|
441
|
+
# {
|
|
442
|
+
# time: Time.now,
|
|
443
|
+
# source: "String",
|
|
444
|
+
# resources: ["EventResource"],
|
|
445
|
+
# detail_type: "String",
|
|
446
|
+
# detail: "String",
|
|
447
|
+
# },
|
|
448
|
+
# ],
|
|
449
|
+
# })
|
|
450
|
+
#
|
|
451
|
+
# @example Response structure
|
|
452
|
+
#
|
|
453
|
+
# resp.failed_entry_count #=> Integer
|
|
454
|
+
# resp.entries #=> Array
|
|
455
|
+
# resp.entries[0].event_id #=> String
|
|
456
|
+
# resp.entries[0].error_code #=> String
|
|
457
|
+
# resp.entries[0].error_message #=> String
|
|
458
|
+
#
|
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEvents AWS API Documentation
|
|
460
|
+
#
|
|
461
|
+
# @overload put_events(params = {})
|
|
462
|
+
# @param [Hash] params ({})
|
|
463
|
+
def put_events(params = {}, options = {})
|
|
464
|
+
req = build_request(:put_events, params)
|
|
465
|
+
req.send_request(options)
|
|
466
|
+
end
|
|
444
467
|
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
end
|
|
468
|
+
# Creates or updates the specified rule. Rules are enabled by default,
|
|
469
|
+
# or based on value of the state. You can disable a rule using
|
|
470
|
+
# DisableRule.
|
|
471
|
+
#
|
|
472
|
+
# When you create or update a rule, incoming events might not
|
|
473
|
+
# immediately start matching to new or updated rules. Please allow a
|
|
474
|
+
# short period of time for changes to take effect.
|
|
475
|
+
#
|
|
476
|
+
# A rule must contain at least an EventPattern or ScheduleExpression.
|
|
477
|
+
# Rules with EventPatterns are triggered when a matching event is
|
|
478
|
+
# observed. Rules with ScheduleExpressions self-trigger based on the
|
|
479
|
+
# given schedule. A rule can have both an EventPattern and a
|
|
480
|
+
# ScheduleExpression, in which case the rule triggers on matching events
|
|
481
|
+
# as well as on a schedule.
|
|
482
|
+
#
|
|
483
|
+
# Most services in AWS treat : or / as the same character in Amazon
|
|
484
|
+
# Resource Names (ARNs). However, CloudWatch Events uses an exact match
|
|
485
|
+
# in event patterns and rules. Be sure to use the correct ARN characters
|
|
486
|
+
# when creating event patterns so that they match the ARN syntax in the
|
|
487
|
+
# event you want to match.
|
|
488
|
+
#
|
|
489
|
+
# @option params [required, String] :name
|
|
490
|
+
# The name of the rule that you are creating or updating.
|
|
491
|
+
#
|
|
492
|
+
# @option params [String] :schedule_expression
|
|
493
|
+
# The scheduling expression. For example, "cron(0 20 * * ? *)",
|
|
494
|
+
# "rate(5 minutes)".
|
|
495
|
+
#
|
|
496
|
+
# @option params [String] :event_pattern
|
|
497
|
+
# The event pattern.
|
|
498
|
+
#
|
|
499
|
+
# @option params [String] :state
|
|
500
|
+
# Indicates whether the rule is enabled or disabled.
|
|
501
|
+
#
|
|
502
|
+
# @option params [String] :description
|
|
503
|
+
# A description of the rule.
|
|
504
|
+
#
|
|
505
|
+
# @option params [String] :role_arn
|
|
506
|
+
# The Amazon Resource Name (ARN) of the IAM role associated with the
|
|
507
|
+
# rule.
|
|
508
|
+
#
|
|
509
|
+
# @return [Types::PutRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
510
|
+
#
|
|
511
|
+
# * {Types::PutRuleResponse#rule_arn #rule_arn} => String
|
|
512
|
+
#
|
|
513
|
+
# @example Request syntax with placeholder values
|
|
514
|
+
#
|
|
515
|
+
# resp = client.put_rule({
|
|
516
|
+
# name: "RuleName", # required
|
|
517
|
+
# schedule_expression: "ScheduleExpression",
|
|
518
|
+
# event_pattern: "EventPattern",
|
|
519
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
|
520
|
+
# description: "RuleDescription",
|
|
521
|
+
# role_arn: "RoleArn",
|
|
522
|
+
# })
|
|
523
|
+
#
|
|
524
|
+
# @example Response structure
|
|
525
|
+
#
|
|
526
|
+
# resp.rule_arn #=> String
|
|
527
|
+
#
|
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRule AWS API Documentation
|
|
529
|
+
#
|
|
530
|
+
# @overload put_rule(params = {})
|
|
531
|
+
# @param [Hash] params ({})
|
|
532
|
+
def put_rule(params = {}, options = {})
|
|
533
|
+
req = build_request(:put_rule, params)
|
|
534
|
+
req.send_request(options)
|
|
535
|
+
end
|
|
514
536
|
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
537
|
+
# Adds the specified targets to the specified rule, or updates the
|
|
538
|
+
# targets if they are already associated with the rule.
|
|
539
|
+
#
|
|
540
|
+
# Targets are the resources that are invoked when a rule is triggered.
|
|
541
|
+
# Example targets include EC2 instances, AWS Lambda functions, Amazon
|
|
542
|
+
# Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines,
|
|
543
|
+
# and built-in targets. Note that creating rules with built-in targets
|
|
544
|
+
# is supported only in the AWS Management Console.
|
|
545
|
+
#
|
|
546
|
+
# For some target types, `PutTargets` provides target-specific
|
|
547
|
+
# parameters. If the target is an Amazon Kinesis stream, you can
|
|
548
|
+
# optionally specify which shard the event goes to by using the
|
|
549
|
+
# `KinesisParameters` argument. To invoke a command on multiple EC2
|
|
550
|
+
# instances with one rule, you can use the `RunCommandParameters` field.
|
|
551
|
+
#
|
|
552
|
+
# To be able to make API calls against the resources that you own,
|
|
553
|
+
# Amazon CloudWatch Events needs the appropriate permissions. For AWS
|
|
554
|
+
# Lambda and Amazon SNS resources, CloudWatch Events relies on
|
|
555
|
+
# resource-based policies. For EC2 instances, Amazon Kinesis streams,
|
|
556
|
+
# and AWS Step Functions state machines, CloudWatch Events relies on IAM
|
|
557
|
+
# roles that you specify in the `RoleARN` argument in `PutTarget`. For
|
|
558
|
+
# more information, see [Authentication and Access Control][1] in the
|
|
559
|
+
# *Amazon CloudWatch Events User Guide*.
|
|
560
|
+
#
|
|
561
|
+
# **Input**, **InputPath** and **InputTransformer** are mutually
|
|
562
|
+
# exclusive and optional parameters of a target. When a rule is
|
|
563
|
+
# triggered due to a matched event:
|
|
564
|
+
#
|
|
565
|
+
# * If none of the following arguments are specified for a target, then
|
|
566
|
+
# the entire event is passed to the target in JSON form (unless the
|
|
567
|
+
# target is Amazon EC2 Run Command or Amazon ECS task, in which case
|
|
568
|
+
# nothing from the event is passed to the target).
|
|
569
|
+
#
|
|
570
|
+
# * If **Input** is specified in the form of valid JSON, then the
|
|
571
|
+
# matched event is overridden with this constant.
|
|
572
|
+
#
|
|
573
|
+
# * If **InputPath** is specified in the form of JSONPath (for example,
|
|
574
|
+
# `$.detail`), then only the part of the event specified in the path
|
|
575
|
+
# is passed to the target (for example, only the detail part of the
|
|
576
|
+
# event is passed).
|
|
577
|
+
#
|
|
578
|
+
# * If **InputTransformer** is specified, then one or more specified
|
|
579
|
+
# JSONPaths are extracted from the event and used as values in a
|
|
580
|
+
# template that you specify as the input to the target.
|
|
581
|
+
#
|
|
582
|
+
# When you add targets to a rule and the associated rule triggers soon
|
|
583
|
+
# after, new or updated targets might not be immediately invoked. Please
|
|
584
|
+
# allow a short period of time for changes to take effect.
|
|
585
|
+
#
|
|
586
|
+
#
|
|
587
|
+
#
|
|
588
|
+
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html
|
|
589
|
+
#
|
|
590
|
+
# @option params [required, String] :rule
|
|
591
|
+
# The name of the rule.
|
|
592
|
+
#
|
|
593
|
+
# @option params [required, Array<Types::Target>] :targets
|
|
594
|
+
# The targets to update or add to the rule.
|
|
595
|
+
#
|
|
596
|
+
# @return [Types::PutTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
597
|
+
#
|
|
598
|
+
# * {Types::PutTargetsResponse#failed_entry_count #failed_entry_count} => Integer
|
|
599
|
+
# * {Types::PutTargetsResponse#failed_entries #failed_entries} => Array<Types::PutTargetsResultEntry>
|
|
600
|
+
#
|
|
601
|
+
# @example Request syntax with placeholder values
|
|
602
|
+
#
|
|
603
|
+
# resp = client.put_targets({
|
|
604
|
+
# rule: "RuleName", # required
|
|
605
|
+
# targets: [ # required
|
|
606
|
+
# {
|
|
607
|
+
# id: "TargetId", # required
|
|
608
|
+
# arn: "TargetArn", # required
|
|
609
|
+
# role_arn: "RoleArn",
|
|
610
|
+
# input: "TargetInput",
|
|
611
|
+
# input_path: "TargetInputPath",
|
|
612
|
+
# input_transformer: {
|
|
613
|
+
# input_paths_map: {
|
|
614
|
+
# "InputTransformerPathKey" => "TargetInputPath",
|
|
615
|
+
# },
|
|
616
|
+
# input_template: "TransformerInput", # required
|
|
617
|
+
# },
|
|
618
|
+
# kinesis_parameters: {
|
|
619
|
+
# partition_key_path: "TargetPartitionKeyPath", # required
|
|
620
|
+
# },
|
|
621
|
+
# run_command_parameters: {
|
|
622
|
+
# run_command_targets: [ # required
|
|
623
|
+
# {
|
|
624
|
+
# key: "RunCommandTargetKey", # required
|
|
625
|
+
# values: ["RunCommandTargetValue"], # required
|
|
626
|
+
# },
|
|
627
|
+
# ],
|
|
628
|
+
# },
|
|
629
|
+
# ecs_parameters: {
|
|
630
|
+
# task_definition_arn: "Arn", # required
|
|
631
|
+
# task_count: 1,
|
|
632
|
+
# },
|
|
633
|
+
# },
|
|
634
|
+
# ],
|
|
635
|
+
# })
|
|
636
|
+
#
|
|
637
|
+
# @example Response structure
|
|
638
|
+
#
|
|
639
|
+
# resp.failed_entry_count #=> Integer
|
|
640
|
+
# resp.failed_entries #=> Array
|
|
641
|
+
# resp.failed_entries[0].target_id #=> String
|
|
642
|
+
# resp.failed_entries[0].error_code #=> String
|
|
643
|
+
# resp.failed_entries[0].error_message #=> String
|
|
644
|
+
#
|
|
645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutTargets AWS API Documentation
|
|
646
|
+
#
|
|
647
|
+
# @overload put_targets(params = {})
|
|
648
|
+
# @param [Hash] params ({})
|
|
649
|
+
def put_targets(params = {}, options = {})
|
|
650
|
+
req = build_request(:put_targets, params)
|
|
651
|
+
req.send_request(options)
|
|
652
|
+
end
|
|
548
653
|
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
654
|
+
# Removes the specified targets from the specified rule. When the rule
|
|
655
|
+
# is triggered, those targets are no longer be invoked.
|
|
656
|
+
#
|
|
657
|
+
# When you remove a target, when the associated rule triggers, removed
|
|
658
|
+
# targets might continue to be invoked. Please allow a short period of
|
|
659
|
+
# time for changes to take effect.
|
|
660
|
+
#
|
|
661
|
+
# @option params [required, String] :rule
|
|
662
|
+
# The name of the rule.
|
|
663
|
+
#
|
|
664
|
+
# @option params [required, Array<String>] :ids
|
|
665
|
+
# The IDs of the targets to remove from the rule.
|
|
666
|
+
#
|
|
667
|
+
# @return [Types::RemoveTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
668
|
+
#
|
|
669
|
+
# * {Types::RemoveTargetsResponse#failed_entry_count #failed_entry_count} => Integer
|
|
670
|
+
# * {Types::RemoveTargetsResponse#failed_entries #failed_entries} => Array<Types::RemoveTargetsResultEntry>
|
|
671
|
+
#
|
|
672
|
+
# @example Request syntax with placeholder values
|
|
673
|
+
#
|
|
674
|
+
# resp = client.remove_targets({
|
|
675
|
+
# rule: "RuleName", # required
|
|
676
|
+
# ids: ["TargetId"], # required
|
|
677
|
+
# })
|
|
678
|
+
#
|
|
679
|
+
# @example Response structure
|
|
680
|
+
#
|
|
681
|
+
# resp.failed_entry_count #=> Integer
|
|
682
|
+
# resp.failed_entries #=> Array
|
|
683
|
+
# resp.failed_entries[0].target_id #=> String
|
|
684
|
+
# resp.failed_entries[0].error_code #=> String
|
|
685
|
+
# resp.failed_entries[0].error_message #=> String
|
|
686
|
+
#
|
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargets AWS API Documentation
|
|
688
|
+
#
|
|
689
|
+
# @overload remove_targets(params = {})
|
|
690
|
+
# @param [Hash] params ({})
|
|
691
|
+
def remove_targets(params = {}, options = {})
|
|
692
|
+
req = build_request(:remove_targets, params)
|
|
693
|
+
req.send_request(options)
|
|
694
|
+
end
|
|
578
695
|
|
|
579
|
-
|
|
696
|
+
# Tests whether the specified event pattern matches the provided event.
|
|
697
|
+
#
|
|
698
|
+
# Most services in AWS treat : or / as the same character in Amazon
|
|
699
|
+
# Resource Names (ARNs). However, CloudWatch Events uses an exact match
|
|
700
|
+
# in event patterns and rules. Be sure to use the correct ARN characters
|
|
701
|
+
# when creating event patterns so that they match the ARN syntax in the
|
|
702
|
+
# event you want to match.
|
|
703
|
+
#
|
|
704
|
+
# @option params [required, String] :event_pattern
|
|
705
|
+
# The event pattern.
|
|
706
|
+
#
|
|
707
|
+
# @option params [required, String] :event
|
|
708
|
+
# The event, in JSON format, to test against the event pattern.
|
|
709
|
+
#
|
|
710
|
+
# @return [Types::TestEventPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
711
|
+
#
|
|
712
|
+
# * {Types::TestEventPatternResponse#result #result} => Boolean
|
|
713
|
+
#
|
|
714
|
+
# @example Request syntax with placeholder values
|
|
715
|
+
#
|
|
716
|
+
# resp = client.test_event_pattern({
|
|
717
|
+
# event_pattern: "EventPattern", # required
|
|
718
|
+
# event: "String", # required
|
|
719
|
+
# })
|
|
720
|
+
#
|
|
721
|
+
# @example Response structure
|
|
722
|
+
#
|
|
723
|
+
# resp.result #=> Boolean
|
|
724
|
+
#
|
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPattern AWS API Documentation
|
|
726
|
+
#
|
|
727
|
+
# @overload test_event_pattern(params = {})
|
|
728
|
+
# @param [Hash] params ({})
|
|
729
|
+
def test_event_pattern(params = {}, options = {})
|
|
730
|
+
req = build_request(:test_event_pattern, params)
|
|
731
|
+
req.send_request(options)
|
|
732
|
+
end
|
|
580
733
|
|
|
581
|
-
|
|
582
|
-
# @api private
|
|
583
|
-
def build_request(operation_name, params = {})
|
|
584
|
-
handlers = @handlers.for(operation_name)
|
|
585
|
-
context = Seahorse::Client::RequestContext.new(
|
|
586
|
-
operation_name: operation_name,
|
|
587
|
-
operation: config.api.operation(operation_name),
|
|
588
|
-
client: self,
|
|
589
|
-
params: params,
|
|
590
|
-
config: config)
|
|
591
|
-
context[:gem_name] = 'aws-sdk-cloudwatchevents'
|
|
592
|
-
context[:gem_version] = '1.0.0.rc1'
|
|
593
|
-
Seahorse::Client::Request.new(handlers, context)
|
|
594
|
-
end
|
|
734
|
+
# @!endgroup
|
|
595
735
|
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
736
|
+
# @param params ({})
|
|
737
|
+
# @api private
|
|
738
|
+
def build_request(operation_name, params = {})
|
|
739
|
+
handlers = @handlers.for(operation_name)
|
|
740
|
+
context = Seahorse::Client::RequestContext.new(
|
|
741
|
+
operation_name: operation_name,
|
|
742
|
+
operation: config.api.operation(operation_name),
|
|
743
|
+
client: self,
|
|
744
|
+
params: params,
|
|
745
|
+
config: config)
|
|
746
|
+
context[:gem_name] = 'aws-sdk-cloudwatchevents'
|
|
747
|
+
context[:gem_version] = '1.0.0.rc2'
|
|
748
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
749
|
+
end
|
|
601
750
|
|
|
602
|
-
|
|
751
|
+
# @api private
|
|
752
|
+
# @deprecated
|
|
753
|
+
def waiter_names
|
|
754
|
+
[]
|
|
755
|
+
end
|
|
603
756
|
|
|
604
|
-
|
|
605
|
-
attr_reader :identifier
|
|
757
|
+
class << self
|
|
606
758
|
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
Errors
|
|
610
|
-
end
|
|
759
|
+
# @api private
|
|
760
|
+
attr_reader :identifier
|
|
611
761
|
|
|
762
|
+
# @api private
|
|
763
|
+
def errors_module
|
|
764
|
+
Errors
|
|
612
765
|
end
|
|
766
|
+
|
|
613
767
|
end
|
|
614
768
|
end
|
|
615
769
|
end
|