aws-sdk-cloudwatchlogs 1.0.0.rc1 → 1.0.0.rc2

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7e234d9dc793b6738513fe119cf93f14b7f61ac6
4
- data.tar.gz: b8483e4bacccc4046112694f9b831f81de46eacf
3
+ metadata.gz: d6ea055813dec8c86469926029cf59fa064f632f
4
+ data.tar.gz: 4966ded72fc7235f1230542d9544f7ebfb8b6440
5
5
  SHA512:
6
- metadata.gz: 5f202c57949838355e5352bb1ab8b33f484968728291c77fc2c8364716cd0204b285f1561c8851eb2b165731e122c9767b5294691c95ac7df8bc8cc509c43f82
7
- data.tar.gz: 36881ede05f7cd013d3320c59004e02b883a4892bf34061caa75f8fff929f976eed22895d1953a11e734e169f819f614846d98763d676229af0d6d94245a0466
6
+ metadata.gz: 039df7e3c965e6b431160a417c89b07422aac923ba714401e8a6b06f1f1ec3b1f7973b5f129b82b7f2648b73defc70d5b68c2ae1b6b002ad51ddc6b0d9c41dc1
7
+ data.tar.gz: 208d433abf93067d1610fd8096f1cc88e4e0c08b9112bbb8364bc292d3122d7e3d18e0fa84b7060f4b82da1e86324ba3e3b049ee406be9e7236d92eedad382c0
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
@@ -23,1106 +23,1400 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
23
 
24
24
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchlogs)
25
25
 
26
- module Aws
27
- module CloudWatchLogs
28
- class Client < Seahorse::Client::Base
26
+ module Aws::CloudWatchLogs
27
+ class Client < Seahorse::Client::Base
29
28
 
30
- include Aws::ClientStubs
29
+ include Aws::ClientStubs
31
30
 
32
- @identifier = :cloudwatchlogs
31
+ @identifier = :cloudwatchlogs
33
32
 
34
- set_api(ClientApi::API)
33
+ set_api(ClientApi::API)
35
34
 
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::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::JsonRpc)
35
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
36
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
37
+ add_plugin(Aws::Plugins::Logging)
38
+ add_plugin(Aws::Plugins::ParamConverter)
39
+ add_plugin(Aws::Plugins::ParamValidator)
40
+ add_plugin(Aws::Plugins::UserAgent)
41
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
42
+ add_plugin(Aws::Plugins::RetryErrors)
43
+ add_plugin(Aws::Plugins::GlobalConfiguration)
44
+ add_plugin(Aws::Plugins::RegionalEndpoint)
45
+ add_plugin(Aws::Plugins::ResponsePaging)
46
+ add_plugin(Aws::Plugins::StubResponses)
47
+ add_plugin(Aws::Plugins::IdempotencyToken)
48
+ add_plugin(Aws::Plugins::SignatureV4)
49
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
50
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :simple_json (false)
117
- # Disables request parameter conversion, validation, and formatting.
118
- # Also disable response data type conversions. This option is useful
119
- # when you want to ensure the highest level of performance by
120
- # avoiding overhead of walking request parameters and response data
121
- # structures.
122
- #
123
- # When `:simple_json` is enabled, the request parameters hash must
124
- # be formatted exactly as the DynamoDB API expects.
125
- # @option options [Boolean] :stub_responses (false)
126
- # Causes the client to return stubbed responses. By default
127
- # fake responses are generated and returned. You can specify
128
- # the response data to return or errors to raise by calling
129
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
130
- #
131
- # ** Please note ** When response stubbing is enabled, no HTTP
132
- # requests are made, and retries are disabled.
133
- # @option options [Boolean] :validate_params (true)
134
- # When `true`, request parameters are validated before
135
- # sending the request.
136
- def initialize(*args)
137
- super
138
- end
51
+ # @option options [required, Aws::CredentialProvider] :credentials
52
+ # Your AWS credentials. This can be an instance of any one of the
53
+ # following classes:
54
+ #
55
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
56
+ # credentials.
57
+ #
58
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
59
+ # from an EC2 IMDS on an EC2 instance.
60
+ #
61
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
62
+ # shared file, such as `~/.aws/config`.
63
+ #
64
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
65
+ #
66
+ # When `:credentials` are not configured directly, the following
67
+ # locations will be searched for credentials:
68
+ #
69
+ # * `Aws.config[:credentials]`
70
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
71
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
72
+ # * `~/.aws/credentials`
73
+ # * `~/.aws/config`
74
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
75
+ # very aggressive. Construct and pass an instance of
76
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
77
+ # timeouts.
78
+ #
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ #
91
+ # @option options [String] :access_key_id
92
+ #
93
+ # @option options [Boolean] :convert_params (true)
94
+ # When `true`, an attempt is made to coerce request parameters into
95
+ # the required types.
96
+ #
97
+ # @option options [String] :endpoint
98
+ # The client endpoint is normally constructed from the `:region`
99
+ # option. You should only configure an `:endpoint` when connecting
100
+ # to test endpoints. This should be avalid HTTP(S) URI.
101
+ #
102
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
103
+ # The log formatter.
104
+ #
105
+ # @option options [Symbol] :log_level (:info)
106
+ # The log level to send messages to the `:logger` at.
107
+ #
108
+ # @option options [Logger] :logger
109
+ # The Logger instance to send log messages to. If this option
110
+ # is not set, logging will be disabled.
111
+ #
112
+ # @option options [String] :profile ("default")
113
+ # Used when loading credentials from the shared credentials file
114
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
115
+ #
116
+ # @option options [Integer] :retry_limit (3)
117
+ # The maximum number of times to retry failed requests. Only
118
+ # ~ 500 level server errors and certain ~ 400 level client errors
119
+ # are retried. Generally, these are throttling errors, data
120
+ # checksum errors, networking errors, timeout errors and auth
121
+ # errors from expired credentials.
122
+ #
123
+ # @option options [String] :secret_access_key
124
+ #
125
+ # @option options [String] :session_token
126
+ #
127
+ # @option options [Boolean] :simple_json (false)
128
+ # Disables request parameter conversion, validation, and formatting.
129
+ # Also disable response data type conversions. This option is useful
130
+ # when you want to ensure the highest level of performance by
131
+ # avoiding overhead of walking request parameters and response data
132
+ # structures.
133
+ #
134
+ # When `:simple_json` is enabled, the request parameters hash must
135
+ # be formatted exactly as the DynamoDB API expects.
136
+ #
137
+ # @option options [Boolean] :stub_responses (false)
138
+ # Causes the client to return stubbed responses. By default
139
+ # fake responses are generated and returned. You can specify
140
+ # the response data to return or errors to raise by calling
141
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
142
+ #
143
+ # ** Please note ** When response stubbing is enabled, no HTTP
144
+ # requests are made, and retries are disabled.
145
+ #
146
+ # @option options [Boolean] :validate_params (true)
147
+ # When `true`, request parameters are validated before
148
+ # sending the request.
149
+ #
150
+ def initialize(*args)
151
+ super
152
+ end
139
153
 
140
- # @!group API Operations
154
+ # @!group API Operations
141
155
 
142
- # Cancels the specified export task.
143
- #
144
- # The task must be in the `PENDING` or `RUNNING` state.
145
- # @option params [required, String] :task_id
146
- # The ID of the export task.
147
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
148
- #
149
- # @example Request syntax with placeholder values
150
- # resp = client.cancel_export_task({
151
- # task_id: "ExportTaskId", # required
152
- # })
153
- # @overload cancel_export_task(params = {})
154
- # @param [Hash] params ({})
155
- def cancel_export_task(params = {}, options = {})
156
- req = build_request(:cancel_export_task, params)
157
- req.send_request(options)
158
- end
156
+ # Cancels the specified export task.
157
+ #
158
+ # The task must be in the `PENDING` or `RUNNING` state.
159
+ #
160
+ # @option params [required, String] :task_id
161
+ # The ID of the export task.
162
+ #
163
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
164
+ #
165
+ # @example Request syntax with placeholder values
166
+ #
167
+ # resp = client.cancel_export_task({
168
+ # task_id: "ExportTaskId", # required
169
+ # })
170
+ #
171
+ # @overload cancel_export_task(params = {})
172
+ # @param [Hash] params ({})
173
+ def cancel_export_task(params = {}, options = {})
174
+ req = build_request(:cancel_export_task, params)
175
+ req.send_request(options)
176
+ end
159
177
 
160
- # Creates an export task, which allows you to efficiently export data
161
- # from a log group to an Amazon S3 bucket.
162
- #
163
- # This is an asynchronous call. If all the required information is
164
- # provided, this operation initiates an export task and responds with
165
- # the ID of the task. After the task has started, you can use
166
- # DescribeExportTasks to get the status of the export task. Each account
167
- # can only have one active (`RUNNING` or `PENDING`) export task at a
168
- # time. To cancel an export task, use CancelExportTask.
169
- #
170
- # You can export logs from multiple log groups or multiple time ranges
171
- # to the same S3 bucket. To separate out log data for each export task,
172
- # you can specify a prefix that will be used as the Amazon S3 key prefix
173
- # for all exported objects.
174
- # @option params [String] :task_name
175
- # The name of the export task.
176
- # @option params [required, String] :log_group_name
177
- # The name of the log group.
178
- # @option params [String] :log_stream_name_prefix
179
- # Export only log streams that match the provided prefix. If you don't
180
- # specify a value, no prefix filter is applied.
181
- # @option params [required, Integer] :from
182
- # The start time of the range for the request, expressed as the number
183
- # of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a
184
- # timestamp earlier than this time are not exported.
185
- # @option params [required, Integer] :to
186
- # The end time of the range for the request, expressed as the number of
187
- # milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp
188
- # later than this time are not exported.
189
- # @option params [required, String] :destination
190
- # The name of S3 bucket for the exported log data. The bucket must be in
191
- # the same AWS region.
192
- # @option params [String] :destination_prefix
193
- # The prefix used as the start of the key for every object exported. If
194
- # you don't specify a value, the default is `exportedlogs`.
195
- # @return [Types::CreateExportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
196
- #
197
- # * {Types::CreateExportTaskResponse#task_id #taskId} => String
198
- #
199
- # @example Request syntax with placeholder values
200
- # resp = client.create_export_task({
201
- # task_name: "ExportTaskName",
202
- # log_group_name: "LogGroupName", # required
203
- # log_stream_name_prefix: "LogStreamName",
204
- # from: 1, # required
205
- # to: 1, # required
206
- # destination: "ExportDestinationBucket", # required
207
- # destination_prefix: "ExportDestinationPrefix",
208
- # })
209
- #
210
- # @example Response structure
211
- # resp.task_id #=> String
212
- # @overload create_export_task(params = {})
213
- # @param [Hash] params ({})
214
- def create_export_task(params = {}, options = {})
215
- req = build_request(:create_export_task, params)
216
- req.send_request(options)
217
- end
178
+ # Creates an export task, which allows you to efficiently export data
179
+ # from a log group to an Amazon S3 bucket.
180
+ #
181
+ # This is an asynchronous call. If all the required information is
182
+ # provided, this operation initiates an export task and responds with
183
+ # the ID of the task. After the task has started, you can use
184
+ # DescribeExportTasks to get the status of the export task. Each account
185
+ # can only have one active (`RUNNING` or `PENDING`) export task at a
186
+ # time. To cancel an export task, use CancelExportTask.
187
+ #
188
+ # You can export logs from multiple log groups or multiple time ranges
189
+ # to the same S3 bucket. To separate out log data for each export task,
190
+ # you can specify a prefix that will be used as the Amazon S3 key prefix
191
+ # for all exported objects.
192
+ #
193
+ # @option params [String] :task_name
194
+ # The name of the export task.
195
+ #
196
+ # @option params [required, String] :log_group_name
197
+ # The name of the log group.
198
+ #
199
+ # @option params [String] :log_stream_name_prefix
200
+ # Export only log streams that match the provided prefix. If you don't
201
+ # specify a value, no prefix filter is applied.
202
+ #
203
+ # @option params [required, Integer] :from
204
+ # The start time of the range for the request, expressed as the number
205
+ # of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a
206
+ # timestamp earlier than this time are not exported.
207
+ #
208
+ # @option params [required, Integer] :to
209
+ # The end time of the range for the request, expressed as the number of
210
+ # milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp
211
+ # later than this time are not exported.
212
+ #
213
+ # @option params [required, String] :destination
214
+ # The name of S3 bucket for the exported log data. The bucket must be in
215
+ # the same AWS region.
216
+ #
217
+ # @option params [String] :destination_prefix
218
+ # The prefix used as the start of the key for every object exported. If
219
+ # you don't specify a value, the default is `exportedlogs`.
220
+ #
221
+ # @return [Types::CreateExportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
222
+ #
223
+ # * {Types::CreateExportTaskResponse#task_id #task_id} => String
224
+ #
225
+ # @example Request syntax with placeholder values
226
+ #
227
+ # resp = client.create_export_task({
228
+ # task_name: "ExportTaskName",
229
+ # log_group_name: "LogGroupName", # required
230
+ # log_stream_name_prefix: "LogStreamName",
231
+ # from: 1, # required
232
+ # to: 1, # required
233
+ # destination: "ExportDestinationBucket", # required
234
+ # destination_prefix: "ExportDestinationPrefix",
235
+ # })
236
+ #
237
+ # @example Response structure
238
+ #
239
+ # resp.task_id #=> String
240
+ #
241
+ # @overload create_export_task(params = {})
242
+ # @param [Hash] params ({})
243
+ def create_export_task(params = {}, options = {})
244
+ req = build_request(:create_export_task, params)
245
+ req.send_request(options)
246
+ end
218
247
 
219
- # Creates a log group with the specified name.
220
- #
221
- # You can create up to 5000 log groups per account.
222
- #
223
- # You must use the following guidelines when naming a log group:
224
- #
225
- # * Log group names must be unique within a region for an AWS account.
226
- #
227
- # * Log group names can be between 1 and 512 characters long.
228
- #
229
- # * Log group names consist of the following characters: a-z, A-Z, 0-9,
230
- # '\_' (underscore), '-' (hyphen), '/' (forward slash), and
231
- # '.' (period).
232
- # @option params [required, String] :log_group_name
233
- # The name of the log group.
234
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
235
- #
236
- # @example Request syntax with placeholder values
237
- # resp = client.create_log_group({
238
- # log_group_name: "LogGroupName", # required
239
- # })
240
- # @overload create_log_group(params = {})
241
- # @param [Hash] params ({})
242
- def create_log_group(params = {}, options = {})
243
- req = build_request(:create_log_group, params)
244
- req.send_request(options)
245
- end
248
+ # Creates a log group with the specified name.
249
+ #
250
+ # You can create up to 5000 log groups per account.
251
+ #
252
+ # You must use the following guidelines when naming a log group:
253
+ #
254
+ # * Log group names must be unique within a region for an AWS account.
255
+ #
256
+ # * Log group names can be between 1 and 512 characters long.
257
+ #
258
+ # * Log group names consist of the following characters: a-z, A-Z, 0-9,
259
+ # '\_' (underscore), '-' (hyphen), '/' (forward slash), and
260
+ # '.' (period).
261
+ #
262
+ # @option params [required, String] :log_group_name
263
+ # The name of the log group.
264
+ #
265
+ # @option params [Hash<String,String>] :tags
266
+ # The key-value pairs to use for the tags.
267
+ #
268
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
269
+ #
270
+ # @example Request syntax with placeholder values
271
+ #
272
+ # resp = client.create_log_group({
273
+ # log_group_name: "LogGroupName", # required
274
+ # tags: {
275
+ # "TagKey" => "TagValue",
276
+ # },
277
+ # })
278
+ #
279
+ # @overload create_log_group(params = {})
280
+ # @param [Hash] params ({})
281
+ def create_log_group(params = {}, options = {})
282
+ req = build_request(:create_log_group, params)
283
+ req.send_request(options)
284
+ end
246
285
 
247
- # Creates a log stream for the specified log group.
248
- #
249
- # There is no limit on the number of log streams that you can create for
250
- # a log group.
251
- #
252
- # You must use the following guidelines when naming a log stream:
253
- #
254
- # * Log stream names must be unique within the log group.
255
- #
256
- # * Log stream names can be between 1 and 512 characters long.
257
- #
258
- # * The ':' (colon) and '*' (asterisk) characters are not allowed.
259
- # @option params [required, String] :log_group_name
260
- # The name of the log group.
261
- # @option params [required, String] :log_stream_name
262
- # The name of the log stream.
263
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
264
- #
265
- # @example Request syntax with placeholder values
266
- # resp = client.create_log_stream({
267
- # log_group_name: "LogGroupName", # required
268
- # log_stream_name: "LogStreamName", # required
269
- # })
270
- # @overload create_log_stream(params = {})
271
- # @param [Hash] params ({})
272
- def create_log_stream(params = {}, options = {})
273
- req = build_request(:create_log_stream, params)
274
- req.send_request(options)
275
- end
286
+ # Creates a log stream for the specified log group.
287
+ #
288
+ # There is no limit on the number of log streams that you can create for
289
+ # a log group.
290
+ #
291
+ # You must use the following guidelines when naming a log stream:
292
+ #
293
+ # * Log stream names must be unique within the log group.
294
+ #
295
+ # * Log stream names can be between 1 and 512 characters long.
296
+ #
297
+ # * The ':' (colon) and '*' (asterisk) characters are not allowed.
298
+ #
299
+ # @option params [required, String] :log_group_name
300
+ # The name of the log group.
301
+ #
302
+ # @option params [required, String] :log_stream_name
303
+ # The name of the log stream.
304
+ #
305
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
306
+ #
307
+ # @example Request syntax with placeholder values
308
+ #
309
+ # resp = client.create_log_stream({
310
+ # log_group_name: "LogGroupName", # required
311
+ # log_stream_name: "LogStreamName", # required
312
+ # })
313
+ #
314
+ # @overload create_log_stream(params = {})
315
+ # @param [Hash] params ({})
316
+ def create_log_stream(params = {}, options = {})
317
+ req = build_request(:create_log_stream, params)
318
+ req.send_request(options)
319
+ end
276
320
 
277
- # Deletes the specified destination, and eventually disables all the
278
- # subscription filters that publish to it. This operation does not
279
- # delete the physical resource encapsulated by the destination.
280
- # @option params [required, String] :destination_name
281
- # The name of the destination.
282
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
283
- #
284
- # @example Request syntax with placeholder values
285
- # resp = client.delete_destination({
286
- # destination_name: "DestinationName", # required
287
- # })
288
- # @overload delete_destination(params = {})
289
- # @param [Hash] params ({})
290
- def delete_destination(params = {}, options = {})
291
- req = build_request(:delete_destination, params)
292
- req.send_request(options)
293
- end
321
+ # Deletes the specified destination, and eventually disables all the
322
+ # subscription filters that publish to it. This operation does not
323
+ # delete the physical resource encapsulated by the destination.
324
+ #
325
+ # @option params [required, String] :destination_name
326
+ # The name of the destination.
327
+ #
328
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
329
+ #
330
+ # @example Request syntax with placeholder values
331
+ #
332
+ # resp = client.delete_destination({
333
+ # destination_name: "DestinationName", # required
334
+ # })
335
+ #
336
+ # @overload delete_destination(params = {})
337
+ # @param [Hash] params ({})
338
+ def delete_destination(params = {}, options = {})
339
+ req = build_request(:delete_destination, params)
340
+ req.send_request(options)
341
+ end
294
342
 
295
- # Deletes the specified log group and permanently deletes all the
296
- # archived log events associated with the log group.
297
- # @option params [required, String] :log_group_name
298
- # The name of the log group.
299
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
300
- #
301
- # @example Request syntax with placeholder values
302
- # resp = client.delete_log_group({
303
- # log_group_name: "LogGroupName", # required
304
- # })
305
- # @overload delete_log_group(params = {})
306
- # @param [Hash] params ({})
307
- def delete_log_group(params = {}, options = {})
308
- req = build_request(:delete_log_group, params)
309
- req.send_request(options)
310
- end
343
+ # Deletes the specified log group and permanently deletes all the
344
+ # archived log events associated with the log group.
345
+ #
346
+ # @option params [required, String] :log_group_name
347
+ # The name of the log group.
348
+ #
349
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
350
+ #
351
+ # @example Request syntax with placeholder values
352
+ #
353
+ # resp = client.delete_log_group({
354
+ # log_group_name: "LogGroupName", # required
355
+ # })
356
+ #
357
+ # @overload delete_log_group(params = {})
358
+ # @param [Hash] params ({})
359
+ def delete_log_group(params = {}, options = {})
360
+ req = build_request(:delete_log_group, params)
361
+ req.send_request(options)
362
+ end
311
363
 
312
- # Deletes the specified log stream and permanently deletes all the
313
- # archived log events associated with the log stream.
314
- # @option params [required, String] :log_group_name
315
- # The name of the log group.
316
- # @option params [required, String] :log_stream_name
317
- # The name of the log stream.
318
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
319
- #
320
- # @example Request syntax with placeholder values
321
- # resp = client.delete_log_stream({
322
- # log_group_name: "LogGroupName", # required
323
- # log_stream_name: "LogStreamName", # required
324
- # })
325
- # @overload delete_log_stream(params = {})
326
- # @param [Hash] params ({})
327
- def delete_log_stream(params = {}, options = {})
328
- req = build_request(:delete_log_stream, params)
329
- req.send_request(options)
330
- end
364
+ # Deletes the specified log stream and permanently deletes all the
365
+ # archived log events associated with the log stream.
366
+ #
367
+ # @option params [required, String] :log_group_name
368
+ # The name of the log group.
369
+ #
370
+ # @option params [required, String] :log_stream_name
371
+ # The name of the log stream.
372
+ #
373
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
374
+ #
375
+ # @example Request syntax with placeholder values
376
+ #
377
+ # resp = client.delete_log_stream({
378
+ # log_group_name: "LogGroupName", # required
379
+ # log_stream_name: "LogStreamName", # required
380
+ # })
381
+ #
382
+ # @overload delete_log_stream(params = {})
383
+ # @param [Hash] params ({})
384
+ def delete_log_stream(params = {}, options = {})
385
+ req = build_request(:delete_log_stream, params)
386
+ req.send_request(options)
387
+ end
331
388
 
332
- # Deletes the specified metric filter.
333
- # @option params [required, String] :log_group_name
334
- # The name of the log group.
335
- # @option params [required, String] :filter_name
336
- # The name of the metric filter.
337
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
338
- #
339
- # @example Request syntax with placeholder values
340
- # resp = client.delete_metric_filter({
341
- # log_group_name: "LogGroupName", # required
342
- # filter_name: "FilterName", # required
343
- # })
344
- # @overload delete_metric_filter(params = {})
345
- # @param [Hash] params ({})
346
- def delete_metric_filter(params = {}, options = {})
347
- req = build_request(:delete_metric_filter, params)
348
- req.send_request(options)
349
- end
389
+ # Deletes the specified metric filter.
390
+ #
391
+ # @option params [required, String] :log_group_name
392
+ # The name of the log group.
393
+ #
394
+ # @option params [required, String] :filter_name
395
+ # The name of the metric filter.
396
+ #
397
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
398
+ #
399
+ # @example Request syntax with placeholder values
400
+ #
401
+ # resp = client.delete_metric_filter({
402
+ # log_group_name: "LogGroupName", # required
403
+ # filter_name: "FilterName", # required
404
+ # })
405
+ #
406
+ # @overload delete_metric_filter(params = {})
407
+ # @param [Hash] params ({})
408
+ def delete_metric_filter(params = {}, options = {})
409
+ req = build_request(:delete_metric_filter, params)
410
+ req.send_request(options)
411
+ end
350
412
 
351
- # Deletes the specified retention policy.
352
- #
353
- # Log events do not expire if they belong to log groups without a
354
- # retention policy.
355
- # @option params [required, String] :log_group_name
356
- # The name of the log group.
357
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
358
- #
359
- # @example Request syntax with placeholder values
360
- # resp = client.delete_retention_policy({
361
- # log_group_name: "LogGroupName", # required
362
- # })
363
- # @overload delete_retention_policy(params = {})
364
- # @param [Hash] params ({})
365
- def delete_retention_policy(params = {}, options = {})
366
- req = build_request(:delete_retention_policy, params)
367
- req.send_request(options)
368
- end
413
+ # Deletes the specified retention policy.
414
+ #
415
+ # Log events do not expire if they belong to log groups without a
416
+ # retention policy.
417
+ #
418
+ # @option params [required, String] :log_group_name
419
+ # The name of the log group.
420
+ #
421
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
422
+ #
423
+ # @example Request syntax with placeholder values
424
+ #
425
+ # resp = client.delete_retention_policy({
426
+ # log_group_name: "LogGroupName", # required
427
+ # })
428
+ #
429
+ # @overload delete_retention_policy(params = {})
430
+ # @param [Hash] params ({})
431
+ def delete_retention_policy(params = {}, options = {})
432
+ req = build_request(:delete_retention_policy, params)
433
+ req.send_request(options)
434
+ end
369
435
 
370
- # Deletes the specified subscription filter.
371
- # @option params [required, String] :log_group_name
372
- # The name of the log group.
373
- # @option params [required, String] :filter_name
374
- # The name of the subscription filter.
375
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
376
- #
377
- # @example Request syntax with placeholder values
378
- # resp = client.delete_subscription_filter({
379
- # log_group_name: "LogGroupName", # required
380
- # filter_name: "FilterName", # required
381
- # })
382
- # @overload delete_subscription_filter(params = {})
383
- # @param [Hash] params ({})
384
- def delete_subscription_filter(params = {}, options = {})
385
- req = build_request(:delete_subscription_filter, params)
386
- req.send_request(options)
387
- end
436
+ # Deletes the specified subscription filter.
437
+ #
438
+ # @option params [required, String] :log_group_name
439
+ # The name of the log group.
440
+ #
441
+ # @option params [required, String] :filter_name
442
+ # The name of the subscription filter.
443
+ #
444
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
445
+ #
446
+ # @example Request syntax with placeholder values
447
+ #
448
+ # resp = client.delete_subscription_filter({
449
+ # log_group_name: "LogGroupName", # required
450
+ # filter_name: "FilterName", # required
451
+ # })
452
+ #
453
+ # @overload delete_subscription_filter(params = {})
454
+ # @param [Hash] params ({})
455
+ def delete_subscription_filter(params = {}, options = {})
456
+ req = build_request(:delete_subscription_filter, params)
457
+ req.send_request(options)
458
+ end
388
459
 
389
- # Lists all your destinations. The results are ASCII-sorted by
390
- # destination name.
391
- # @option params [String] :destination_name_prefix
392
- # The prefix to match. If you don't specify a value, no prefix filter
393
- # is applied.
394
- # @option params [String] :next_token
395
- # The token for the next set of items to return. (You received this
396
- # token from a previous call.)
397
- # @option params [Integer] :limit
398
- # The maximum number of items returned. If you don't specify a value,
399
- # the default is up to 50 items.
400
- # @return [Types::DescribeDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
401
- #
402
- # * {Types::DescribeDestinationsResponse#destinations #destinations} => Array&lt;Types::Destination&gt;
403
- # * {Types::DescribeDestinationsResponse#next_token #nextToken} => String
404
- #
405
- # @example Request syntax with placeholder values
406
- # resp = client.describe_destinations({
407
- # destination_name_prefix: "DestinationName",
408
- # next_token: "NextToken",
409
- # limit: 1,
410
- # })
411
- #
412
- # @example Response structure
413
- # resp.destinations #=> Array
414
- # resp.destinations[0].destination_name #=> String
415
- # resp.destinations[0].target_arn #=> String
416
- # resp.destinations[0].role_arn #=> String
417
- # resp.destinations[0].access_policy #=> String
418
- # resp.destinations[0].arn #=> String
419
- # resp.destinations[0].creation_time #=> Integer
420
- # resp.next_token #=> String
421
- # @overload describe_destinations(params = {})
422
- # @param [Hash] params ({})
423
- def describe_destinations(params = {}, options = {})
424
- req = build_request(:describe_destinations, params)
425
- req.send_request(options)
426
- end
460
+ # Lists all your destinations. The results are ASCII-sorted by
461
+ # destination name.
462
+ #
463
+ # @option params [String] :destination_name_prefix
464
+ # The prefix to match. If you don't specify a value, no prefix filter
465
+ # is applied.
466
+ #
467
+ # @option params [String] :next_token
468
+ # The token for the next set of items to return. (You received this
469
+ # token from a previous call.)
470
+ #
471
+ # @option params [Integer] :limit
472
+ # The maximum number of items returned. If you don't specify a value,
473
+ # the default is up to 50 items.
474
+ #
475
+ # @return [Types::DescribeDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
476
+ #
477
+ # * {Types::DescribeDestinationsResponse#destinations #destinations} => Array&lt;Types::Destination&gt;
478
+ # * {Types::DescribeDestinationsResponse#next_token #next_token} => String
479
+ #
480
+ # @example Request syntax with placeholder values
481
+ #
482
+ # resp = client.describe_destinations({
483
+ # destination_name_prefix: "DestinationName",
484
+ # next_token: "NextToken",
485
+ # limit: 1,
486
+ # })
487
+ #
488
+ # @example Response structure
489
+ #
490
+ # resp.destinations #=> Array
491
+ # resp.destinations[0].destination_name #=> String
492
+ # resp.destinations[0].target_arn #=> String
493
+ # resp.destinations[0].role_arn #=> String
494
+ # resp.destinations[0].access_policy #=> String
495
+ # resp.destinations[0].arn #=> String
496
+ # resp.destinations[0].creation_time #=> Integer
497
+ # resp.next_token #=> String
498
+ #
499
+ # @overload describe_destinations(params = {})
500
+ # @param [Hash] params ({})
501
+ def describe_destinations(params = {}, options = {})
502
+ req = build_request(:describe_destinations, params)
503
+ req.send_request(options)
504
+ end
427
505
 
428
- # Lists the specified export tasks. You can list all your export tasks
429
- # or filter the results based on task ID or task status.
430
- # @option params [String] :task_id
431
- # The ID of the export task. Specifying a task ID filters the results to
432
- # zero or one export tasks.
433
- # @option params [String] :status_code
434
- # The status code of the export task. Specifying a status code filters
435
- # the results to zero or more export tasks.
436
- # @option params [String] :next_token
437
- # The token for the next set of items to return. (You received this
438
- # token from a previous call.)
439
- # @option params [Integer] :limit
440
- # The maximum number of items returned. If you don't specify a value,
441
- # the default is up to 50 items.
442
- # @return [Types::DescribeExportTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
443
- #
444
- # * {Types::DescribeExportTasksResponse#export_tasks #exportTasks} => Array&lt;Types::ExportTask&gt;
445
- # * {Types::DescribeExportTasksResponse#next_token #nextToken} => String
446
- #
447
- # @example Request syntax with placeholder values
448
- # resp = client.describe_export_tasks({
449
- # task_id: "ExportTaskId",
450
- # status_code: "CANCELLED", # accepts CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING
451
- # next_token: "NextToken",
452
- # limit: 1,
453
- # })
454
- #
455
- # @example Response structure
456
- # resp.export_tasks #=> Array
457
- # resp.export_tasks[0].task_id #=> String
458
- # resp.export_tasks[0].task_name #=> String
459
- # resp.export_tasks[0].log_group_name #=> String
460
- # resp.export_tasks[0].from #=> Integer
461
- # resp.export_tasks[0].to #=> Integer
462
- # resp.export_tasks[0].destination #=> String
463
- # resp.export_tasks[0].destination_prefix #=> String
464
- # resp.export_tasks[0].status.code #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PENDING", "PENDING_CANCEL", "RUNNING"
465
- # resp.export_tasks[0].status.message #=> String
466
- # resp.export_tasks[0].execution_info.creation_time #=> Integer
467
- # resp.export_tasks[0].execution_info.completion_time #=> Integer
468
- # resp.next_token #=> String
469
- # @overload describe_export_tasks(params = {})
470
- # @param [Hash] params ({})
471
- def describe_export_tasks(params = {}, options = {})
472
- req = build_request(:describe_export_tasks, params)
473
- req.send_request(options)
474
- end
506
+ # Lists the specified export tasks. You can list all your export tasks
507
+ # or filter the results based on task ID or task status.
508
+ #
509
+ # @option params [String] :task_id
510
+ # The ID of the export task. Specifying a task ID filters the results to
511
+ # zero or one export tasks.
512
+ #
513
+ # @option params [String] :status_code
514
+ # The status code of the export task. Specifying a status code filters
515
+ # the results to zero or more export tasks.
516
+ #
517
+ # @option params [String] :next_token
518
+ # The token for the next set of items to return. (You received this
519
+ # token from a previous call.)
520
+ #
521
+ # @option params [Integer] :limit
522
+ # The maximum number of items returned. If you don't specify a value,
523
+ # the default is up to 50 items.
524
+ #
525
+ # @return [Types::DescribeExportTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
526
+ #
527
+ # * {Types::DescribeExportTasksResponse#export_tasks #export_tasks} => Array&lt;Types::ExportTask&gt;
528
+ # * {Types::DescribeExportTasksResponse#next_token #next_token} => String
529
+ #
530
+ # @example Request syntax with placeholder values
531
+ #
532
+ # resp = client.describe_export_tasks({
533
+ # task_id: "ExportTaskId",
534
+ # status_code: "CANCELLED", # accepts CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING
535
+ # next_token: "NextToken",
536
+ # limit: 1,
537
+ # })
538
+ #
539
+ # @example Response structure
540
+ #
541
+ # resp.export_tasks #=> Array
542
+ # resp.export_tasks[0].task_id #=> String
543
+ # resp.export_tasks[0].task_name #=> String
544
+ # resp.export_tasks[0].log_group_name #=> String
545
+ # resp.export_tasks[0].from #=> Integer
546
+ # resp.export_tasks[0].to #=> Integer
547
+ # resp.export_tasks[0].destination #=> String
548
+ # resp.export_tasks[0].destination_prefix #=> String
549
+ # resp.export_tasks[0].status.code #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PENDING", "PENDING_CANCEL", "RUNNING"
550
+ # resp.export_tasks[0].status.message #=> String
551
+ # resp.export_tasks[0].execution_info.creation_time #=> Integer
552
+ # resp.export_tasks[0].execution_info.completion_time #=> Integer
553
+ # resp.next_token #=> String
554
+ #
555
+ # @overload describe_export_tasks(params = {})
556
+ # @param [Hash] params ({})
557
+ def describe_export_tasks(params = {}, options = {})
558
+ req = build_request(:describe_export_tasks, params)
559
+ req.send_request(options)
560
+ end
475
561
 
476
- # Lists the specified log groups. You can list all your log groups or
477
- # filter the results by prefix. The results are ASCII-sorted by log
478
- # group name.
479
- # @option params [String] :log_group_name_prefix
480
- # The prefix to match.
481
- # @option params [String] :next_token
482
- # The token for the next set of items to return. (You received this
483
- # token from a previous call.)
484
- # @option params [Integer] :limit
485
- # The maximum number of items returned. If you don't specify a value,
486
- # the default is up to 50 items.
487
- # @return [Types::DescribeLogGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
488
- #
489
- # * {Types::DescribeLogGroupsResponse#log_groups #logGroups} => Array&lt;Types::LogGroup&gt;
490
- # * {Types::DescribeLogGroupsResponse#next_token #nextToken} => String
491
- #
492
- # @example Request syntax with placeholder values
493
- # resp = client.describe_log_groups({
494
- # log_group_name_prefix: "LogGroupName",
495
- # next_token: "NextToken",
496
- # limit: 1,
497
- # })
498
- #
499
- # @example Response structure
500
- # resp.log_groups #=> Array
501
- # resp.log_groups[0].log_group_name #=> String
502
- # resp.log_groups[0].creation_time #=> Integer
503
- # resp.log_groups[0].retention_in_days #=> Integer
504
- # resp.log_groups[0].metric_filter_count #=> Integer
505
- # resp.log_groups[0].arn #=> String
506
- # resp.log_groups[0].stored_bytes #=> Integer
507
- # resp.next_token #=> String
508
- # @overload describe_log_groups(params = {})
509
- # @param [Hash] params ({})
510
- def describe_log_groups(params = {}, options = {})
511
- req = build_request(:describe_log_groups, params)
512
- req.send_request(options)
513
- end
562
+ # Lists the specified log groups. You can list all your log groups or
563
+ # filter the results by prefix. The results are ASCII-sorted by log
564
+ # group name.
565
+ #
566
+ # @option params [String] :log_group_name_prefix
567
+ # The prefix to match.
568
+ #
569
+ # @option params [String] :next_token
570
+ # The token for the next set of items to return. (You received this
571
+ # token from a previous call.)
572
+ #
573
+ # @option params [Integer] :limit
574
+ # The maximum number of items returned. If you don't specify a value,
575
+ # the default is up to 50 items.
576
+ #
577
+ # @return [Types::DescribeLogGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
578
+ #
579
+ # * {Types::DescribeLogGroupsResponse#log_groups #log_groups} => Array&lt;Types::LogGroup&gt;
580
+ # * {Types::DescribeLogGroupsResponse#next_token #next_token} => String
581
+ #
582
+ # @example Request syntax with placeholder values
583
+ #
584
+ # resp = client.describe_log_groups({
585
+ # log_group_name_prefix: "LogGroupName",
586
+ # next_token: "NextToken",
587
+ # limit: 1,
588
+ # })
589
+ #
590
+ # @example Response structure
591
+ #
592
+ # resp.log_groups #=> Array
593
+ # resp.log_groups[0].log_group_name #=> String
594
+ # resp.log_groups[0].creation_time #=> Integer
595
+ # resp.log_groups[0].retention_in_days #=> Integer
596
+ # resp.log_groups[0].metric_filter_count #=> Integer
597
+ # resp.log_groups[0].arn #=> String
598
+ # resp.log_groups[0].stored_bytes #=> Integer
599
+ # resp.next_token #=> String
600
+ #
601
+ # @overload describe_log_groups(params = {})
602
+ # @param [Hash] params ({})
603
+ def describe_log_groups(params = {}, options = {})
604
+ req = build_request(:describe_log_groups, params)
605
+ req.send_request(options)
606
+ end
514
607
 
515
- # Lists the log streams for the specified log group. You can list all
516
- # the log streams or filter the results by prefix. You can also control
517
- # how the results are ordered.
518
- #
519
- # This operation has a limit of five transactions per second, after
520
- # which transactions are throttled.
521
- # @option params [required, String] :log_group_name
522
- # The name of the log group.
523
- # @option params [String] :log_stream_name_prefix
524
- # The prefix to match.
525
- #
526
- # You cannot specify this parameter if `orderBy` is `LastEventTime`.
527
- # @option params [String] :order_by
528
- # If the value is `LogStreamName`, the results are ordered by log stream
529
- # name. If the value is `LastEventTime`, the results are ordered by the
530
- # event time. The default value is `LogStreamName`.
531
- #
532
- # If you order the results by event time, you cannot specify the
533
- # `logStreamNamePrefix` parameter.
534
- # @option params [Boolean] :descending
535
- # If the value is true, results are returned in descending order. If the
536
- # value is to false, results are returned in ascending order. The
537
- # default value is false.
538
- # @option params [String] :next_token
539
- # The token for the next set of items to return. (You received this
540
- # token from a previous call.)
541
- # @option params [Integer] :limit
542
- # The maximum number of items returned. If you don't specify a value,
543
- # the default is up to 50 items.
544
- # @return [Types::DescribeLogStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
545
- #
546
- # * {Types::DescribeLogStreamsResponse#log_streams #logStreams} => Array&lt;Types::LogStream&gt;
547
- # * {Types::DescribeLogStreamsResponse#next_token #nextToken} => String
548
- #
549
- # @example Request syntax with placeholder values
550
- # resp = client.describe_log_streams({
551
- # log_group_name: "LogGroupName", # required
552
- # log_stream_name_prefix: "LogStreamName",
553
- # order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
554
- # descending: false,
555
- # next_token: "NextToken",
556
- # limit: 1,
557
- # })
558
- #
559
- # @example Response structure
560
- # resp.log_streams #=> Array
561
- # resp.log_streams[0].log_stream_name #=> String
562
- # resp.log_streams[0].creation_time #=> Integer
563
- # resp.log_streams[0].first_event_timestamp #=> Integer
564
- # resp.log_streams[0].last_event_timestamp #=> Integer
565
- # resp.log_streams[0].last_ingestion_time #=> Integer
566
- # resp.log_streams[0].upload_sequence_token #=> String
567
- # resp.log_streams[0].arn #=> String
568
- # resp.log_streams[0].stored_bytes #=> Integer
569
- # resp.next_token #=> String
570
- # @overload describe_log_streams(params = {})
571
- # @param [Hash] params ({})
572
- def describe_log_streams(params = {}, options = {})
573
- req = build_request(:describe_log_streams, params)
574
- req.send_request(options)
575
- end
608
+ # Lists the log streams for the specified log group. You can list all
609
+ # the log streams or filter the results by prefix. You can also control
610
+ # how the results are ordered.
611
+ #
612
+ # This operation has a limit of five transactions per second, after
613
+ # which transactions are throttled.
614
+ #
615
+ # @option params [required, String] :log_group_name
616
+ # The name of the log group.
617
+ #
618
+ # @option params [String] :log_stream_name_prefix
619
+ # The prefix to match.
620
+ #
621
+ # You cannot specify this parameter if `orderBy` is `LastEventTime`.
622
+ #
623
+ # @option params [String] :order_by
624
+ # If the value is `LogStreamName`, the results are ordered by log stream
625
+ # name. If the value is `LastEventTime`, the results are ordered by the
626
+ # event time. The default value is `LogStreamName`.
627
+ #
628
+ # If you order the results by event time, you cannot specify the
629
+ # `logStreamNamePrefix` parameter.
630
+ #
631
+ # @option params [Boolean] :descending
632
+ # If the value is true, results are returned in descending order. If the
633
+ # value is to false, results are returned in ascending order. The
634
+ # default value is false.
635
+ #
636
+ # @option params [String] :next_token
637
+ # The token for the next set of items to return. (You received this
638
+ # token from a previous call.)
639
+ #
640
+ # @option params [Integer] :limit
641
+ # The maximum number of items returned. If you don't specify a value,
642
+ # the default is up to 50 items.
643
+ #
644
+ # @return [Types::DescribeLogStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
645
+ #
646
+ # * {Types::DescribeLogStreamsResponse#log_streams #log_streams} => Array&lt;Types::LogStream&gt;
647
+ # * {Types::DescribeLogStreamsResponse#next_token #next_token} => String
648
+ #
649
+ # @example Request syntax with placeholder values
650
+ #
651
+ # resp = client.describe_log_streams({
652
+ # log_group_name: "LogGroupName", # required
653
+ # log_stream_name_prefix: "LogStreamName",
654
+ # order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
655
+ # descending: false,
656
+ # next_token: "NextToken",
657
+ # limit: 1,
658
+ # })
659
+ #
660
+ # @example Response structure
661
+ #
662
+ # resp.log_streams #=> Array
663
+ # resp.log_streams[0].log_stream_name #=> String
664
+ # resp.log_streams[0].creation_time #=> Integer
665
+ # resp.log_streams[0].first_event_timestamp #=> Integer
666
+ # resp.log_streams[0].last_event_timestamp #=> Integer
667
+ # resp.log_streams[0].last_ingestion_time #=> Integer
668
+ # resp.log_streams[0].upload_sequence_token #=> String
669
+ # resp.log_streams[0].arn #=> String
670
+ # resp.log_streams[0].stored_bytes #=> Integer
671
+ # resp.next_token #=> String
672
+ #
673
+ # @overload describe_log_streams(params = {})
674
+ # @param [Hash] params ({})
675
+ def describe_log_streams(params = {}, options = {})
676
+ req = build_request(:describe_log_streams, params)
677
+ req.send_request(options)
678
+ end
576
679
 
577
- # Lists the specified metric filters. You can list all the metric
578
- # filters or filter the results by log name, prefix, metric name, or
579
- # metric namespace. The results are ASCII-sorted by filter name.
580
- # @option params [String] :log_group_name
581
- # The name of the log group.
582
- # @option params [String] :filter_name_prefix
583
- # The prefix to match.
584
- # @option params [String] :next_token
585
- # The token for the next set of items to return. (You received this
586
- # token from a previous call.)
587
- # @option params [Integer] :limit
588
- # The maximum number of items returned. If you don't specify a value,
589
- # the default is up to 50 items.
590
- # @option params [String] :metric_name
591
- # The name of the CloudWatch metric.
592
- # @option params [String] :metric_namespace
593
- # The namespace of the CloudWatch metric.
594
- # @return [Types::DescribeMetricFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
595
- #
596
- # * {Types::DescribeMetricFiltersResponse#metric_filters #metricFilters} => Array&lt;Types::MetricFilter&gt;
597
- # * {Types::DescribeMetricFiltersResponse#next_token #nextToken} => String
598
- #
599
- # @example Request syntax with placeholder values
600
- # resp = client.describe_metric_filters({
601
- # log_group_name: "LogGroupName",
602
- # filter_name_prefix: "FilterName",
603
- # next_token: "NextToken",
604
- # limit: 1,
605
- # metric_name: "MetricName",
606
- # metric_namespace: "MetricNamespace",
607
- # })
608
- #
609
- # @example Response structure
610
- # resp.metric_filters #=> Array
611
- # resp.metric_filters[0].filter_name #=> String
612
- # resp.metric_filters[0].filter_pattern #=> String
613
- # resp.metric_filters[0].metric_transformations #=> Array
614
- # resp.metric_filters[0].metric_transformations[0].metric_name #=> String
615
- # resp.metric_filters[0].metric_transformations[0].metric_namespace #=> String
616
- # resp.metric_filters[0].metric_transformations[0].metric_value #=> String
617
- # resp.metric_filters[0].metric_transformations[0].default_value #=> Float
618
- # resp.metric_filters[0].creation_time #=> Integer
619
- # resp.metric_filters[0].log_group_name #=> String
620
- # resp.next_token #=> String
621
- # @overload describe_metric_filters(params = {})
622
- # @param [Hash] params ({})
623
- def describe_metric_filters(params = {}, options = {})
624
- req = build_request(:describe_metric_filters, params)
625
- req.send_request(options)
626
- end
680
+ # Lists the specified metric filters. You can list all the metric
681
+ # filters or filter the results by log name, prefix, metric name, and
682
+ # metric namespace. The results are ASCII-sorted by filter name.
683
+ #
684
+ # @option params [String] :log_group_name
685
+ # The name of the log group.
686
+ #
687
+ # @option params [String] :filter_name_prefix
688
+ # The prefix to match.
689
+ #
690
+ # @option params [String] :next_token
691
+ # The token for the next set of items to return. (You received this
692
+ # token from a previous call.)
693
+ #
694
+ # @option params [Integer] :limit
695
+ # The maximum number of items returned. If you don't specify a value,
696
+ # the default is up to 50 items.
697
+ #
698
+ # @option params [String] :metric_name
699
+ # The name of the CloudWatch metric.
700
+ #
701
+ # @option params [String] :metric_namespace
702
+ # The namespace of the CloudWatch metric.
703
+ #
704
+ # @return [Types::DescribeMetricFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
705
+ #
706
+ # * {Types::DescribeMetricFiltersResponse#metric_filters #metric_filters} => Array&lt;Types::MetricFilter&gt;
707
+ # * {Types::DescribeMetricFiltersResponse#next_token #next_token} => String
708
+ #
709
+ # @example Request syntax with placeholder values
710
+ #
711
+ # resp = client.describe_metric_filters({
712
+ # log_group_name: "LogGroupName",
713
+ # filter_name_prefix: "FilterName",
714
+ # next_token: "NextToken",
715
+ # limit: 1,
716
+ # metric_name: "MetricName",
717
+ # metric_namespace: "MetricNamespace",
718
+ # })
719
+ #
720
+ # @example Response structure
721
+ #
722
+ # resp.metric_filters #=> Array
723
+ # resp.metric_filters[0].filter_name #=> String
724
+ # resp.metric_filters[0].filter_pattern #=> String
725
+ # resp.metric_filters[0].metric_transformations #=> Array
726
+ # resp.metric_filters[0].metric_transformations[0].metric_name #=> String
727
+ # resp.metric_filters[0].metric_transformations[0].metric_namespace #=> String
728
+ # resp.metric_filters[0].metric_transformations[0].metric_value #=> String
729
+ # resp.metric_filters[0].metric_transformations[0].default_value #=> Float
730
+ # resp.metric_filters[0].creation_time #=> Integer
731
+ # resp.metric_filters[0].log_group_name #=> String
732
+ # resp.next_token #=> String
733
+ #
734
+ # @overload describe_metric_filters(params = {})
735
+ # @param [Hash] params ({})
736
+ def describe_metric_filters(params = {}, options = {})
737
+ req = build_request(:describe_metric_filters, params)
738
+ req.send_request(options)
739
+ end
627
740
 
628
- # Lists the subscription filters for the specified log group. You can
629
- # list all the subscription filters or filter the results by prefix. The
630
- # results are ASCII-sorted by filter name.
631
- # @option params [required, String] :log_group_name
632
- # The name of the log group.
633
- # @option params [String] :filter_name_prefix
634
- # The prefix to match. If you don't specify a value, no prefix filter
635
- # is applied.
636
- # @option params [String] :next_token
637
- # The token for the next set of items to return. (You received this
638
- # token from a previous call.)
639
- # @option params [Integer] :limit
640
- # The maximum number of items returned. If you don't specify a value,
641
- # the default is up to 50 items.
642
- # @return [Types::DescribeSubscriptionFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
643
- #
644
- # * {Types::DescribeSubscriptionFiltersResponse#subscription_filters #subscriptionFilters} => Array&lt;Types::SubscriptionFilter&gt;
645
- # * {Types::DescribeSubscriptionFiltersResponse#next_token #nextToken} => String
646
- #
647
- # @example Request syntax with placeholder values
648
- # resp = client.describe_subscription_filters({
649
- # log_group_name: "LogGroupName", # required
650
- # filter_name_prefix: "FilterName",
651
- # next_token: "NextToken",
652
- # limit: 1,
653
- # })
654
- #
655
- # @example Response structure
656
- # resp.subscription_filters #=> Array
657
- # resp.subscription_filters[0].filter_name #=> String
658
- # resp.subscription_filters[0].log_group_name #=> String
659
- # resp.subscription_filters[0].filter_pattern #=> String
660
- # resp.subscription_filters[0].destination_arn #=> String
661
- # resp.subscription_filters[0].role_arn #=> String
662
- # resp.subscription_filters[0].creation_time #=> Integer
663
- # resp.next_token #=> String
664
- # @overload describe_subscription_filters(params = {})
665
- # @param [Hash] params ({})
666
- def describe_subscription_filters(params = {}, options = {})
667
- req = build_request(:describe_subscription_filters, params)
668
- req.send_request(options)
669
- end
741
+ # Lists the subscription filters for the specified log group. You can
742
+ # list all the subscription filters or filter the results by prefix. The
743
+ # results are ASCII-sorted by filter name.
744
+ #
745
+ # @option params [required, String] :log_group_name
746
+ # The name of the log group.
747
+ #
748
+ # @option params [String] :filter_name_prefix
749
+ # The prefix to match. If you don't specify a value, no prefix filter
750
+ # is applied.
751
+ #
752
+ # @option params [String] :next_token
753
+ # The token for the next set of items to return. (You received this
754
+ # token from a previous call.)
755
+ #
756
+ # @option params [Integer] :limit
757
+ # The maximum number of items returned. If you don't specify a value,
758
+ # the default is up to 50 items.
759
+ #
760
+ # @return [Types::DescribeSubscriptionFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
761
+ #
762
+ # * {Types::DescribeSubscriptionFiltersResponse#subscription_filters #subscription_filters} => Array&lt;Types::SubscriptionFilter&gt;
763
+ # * {Types::DescribeSubscriptionFiltersResponse#next_token #next_token} => String
764
+ #
765
+ # @example Request syntax with placeholder values
766
+ #
767
+ # resp = client.describe_subscription_filters({
768
+ # log_group_name: "LogGroupName", # required
769
+ # filter_name_prefix: "FilterName",
770
+ # next_token: "NextToken",
771
+ # limit: 1,
772
+ # })
773
+ #
774
+ # @example Response structure
775
+ #
776
+ # resp.subscription_filters #=> Array
777
+ # resp.subscription_filters[0].filter_name #=> String
778
+ # resp.subscription_filters[0].log_group_name #=> String
779
+ # resp.subscription_filters[0].filter_pattern #=> String
780
+ # resp.subscription_filters[0].destination_arn #=> String
781
+ # resp.subscription_filters[0].role_arn #=> String
782
+ # resp.subscription_filters[0].distribution #=> String, one of "Random", "ByLogStream"
783
+ # resp.subscription_filters[0].creation_time #=> Integer
784
+ # resp.next_token #=> String
785
+ #
786
+ # @overload describe_subscription_filters(params = {})
787
+ # @param [Hash] params ({})
788
+ def describe_subscription_filters(params = {}, options = {})
789
+ req = build_request(:describe_subscription_filters, params)
790
+ req.send_request(options)
791
+ end
670
792
 
671
- # Lists log events from the specified log group. You can list all the
672
- # log events or filter the results using a filter pattern, a time range,
673
- # and the name of the log stream.
674
- #
675
- # By default, this operation returns as many log events as can fit in
676
- # 1MB (up to 10,000 log events), or all the events found within the time
677
- # range that you specify. If the results include a token, then there are
678
- # more log events available, and you can get additional results by
679
- # specifying the token in a subsequent call.
680
- # @option params [required, String] :log_group_name
681
- # The name of the log group.
682
- # @option params [Array<String>] :log_stream_names
683
- # Optional list of log stream names.
684
- # @option params [Integer] :start_time
685
- # The start of the time range. Events with a timestamp prior to this
686
- # time are not returned.
687
- # @option params [Integer] :end_time
688
- # The end of the time range. Events with a timestamp later than this
689
- # time are not returned.
690
- # @option params [String] :filter_pattern
691
- # The filter pattern to use. If not provided, all the events are
692
- # matched.
693
- # @option params [String] :next_token
694
- # The token for the next set of events to return. (You received this
695
- # token from a previous call.)
696
- # @option params [Integer] :limit
697
- # The maximum number of events to return. The default is 10,000 events.
698
- # @option params [Boolean] :interleaved
699
- # If the value is true, the operation makes a best effort to provide
700
- # responses that contain events from multiple log streams within the log
701
- # group interleaved in a single response. If the value is false all the
702
- # matched log events in the first log stream are searched first, then
703
- # those in the next log stream, and so on. The default is false.
704
- # @return [Types::FilterLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
705
- #
706
- # * {Types::FilterLogEventsResponse#events #events} => Array&lt;Types::FilteredLogEvent&gt;
707
- # * {Types::FilterLogEventsResponse#searched_log_streams #searchedLogStreams} => Array&lt;Types::SearchedLogStream&gt;
708
- # * {Types::FilterLogEventsResponse#next_token #nextToken} => String
709
- #
710
- # @example Request syntax with placeholder values
711
- # resp = client.filter_log_events({
712
- # log_group_name: "LogGroupName", # required
713
- # log_stream_names: ["LogStreamName"],
714
- # start_time: 1,
715
- # end_time: 1,
716
- # filter_pattern: "FilterPattern",
717
- # next_token: "NextToken",
718
- # limit: 1,
719
- # interleaved: false,
720
- # })
721
- #
722
- # @example Response structure
723
- # resp.events #=> Array
724
- # resp.events[0].log_stream_name #=> String
725
- # resp.events[0].timestamp #=> Integer
726
- # resp.events[0].message #=> String
727
- # resp.events[0].ingestion_time #=> Integer
728
- # resp.events[0].event_id #=> String
729
- # resp.searched_log_streams #=> Array
730
- # resp.searched_log_streams[0].log_stream_name #=> String
731
- # resp.searched_log_streams[0].searched_completely #=> Boolean
732
- # resp.next_token #=> String
733
- # @overload filter_log_events(params = {})
734
- # @param [Hash] params ({})
735
- def filter_log_events(params = {}, options = {})
736
- req = build_request(:filter_log_events, params)
737
- req.send_request(options)
738
- end
793
+ # Lists log events from the specified log group. You can list all the
794
+ # log events or filter the results using a filter pattern, a time range,
795
+ # and the name of the log stream.
796
+ #
797
+ # By default, this operation returns as many log events as can fit in
798
+ # 1MB (up to 10,000 log events), or all the events found within the time
799
+ # range that you specify. If the results include a token, then there are
800
+ # more log events available, and you can get additional results by
801
+ # specifying the token in a subsequent call.
802
+ #
803
+ # @option params [required, String] :log_group_name
804
+ # The name of the log group.
805
+ #
806
+ # @option params [Array<String>] :log_stream_names
807
+ # Optional list of log stream names.
808
+ #
809
+ # @option params [Integer] :start_time
810
+ # The start of the time range, expressed as the number of milliseconds
811
+ # since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this
812
+ # time are not returned.
813
+ #
814
+ # @option params [Integer] :end_time
815
+ # The end of the time range, expressed as the number of milliseconds
816
+ # since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than
817
+ # this time are not returned.
818
+ #
819
+ # @option params [String] :filter_pattern
820
+ # The filter pattern to use. If not provided, all the events are
821
+ # matched.
822
+ #
823
+ # @option params [String] :next_token
824
+ # The token for the next set of events to return. (You received this
825
+ # token from a previous call.)
826
+ #
827
+ # @option params [Integer] :limit
828
+ # The maximum number of events to return. The default is 10,000 events.
829
+ #
830
+ # @option params [Boolean] :interleaved
831
+ # If the value is true, the operation makes a best effort to provide
832
+ # responses that contain events from multiple log streams within the log
833
+ # group interleaved in a single response. If the value is false all the
834
+ # matched log events in the first log stream are searched first, then
835
+ # those in the next log stream, and so on. The default is false.
836
+ #
837
+ # @return [Types::FilterLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
838
+ #
839
+ # * {Types::FilterLogEventsResponse#events #events} => Array&lt;Types::FilteredLogEvent&gt;
840
+ # * {Types::FilterLogEventsResponse#searched_log_streams #searched_log_streams} => Array&lt;Types::SearchedLogStream&gt;
841
+ # * {Types::FilterLogEventsResponse#next_token #next_token} => String
842
+ #
843
+ # @example Request syntax with placeholder values
844
+ #
845
+ # resp = client.filter_log_events({
846
+ # log_group_name: "LogGroupName", # required
847
+ # log_stream_names: ["LogStreamName"],
848
+ # start_time: 1,
849
+ # end_time: 1,
850
+ # filter_pattern: "FilterPattern",
851
+ # next_token: "NextToken",
852
+ # limit: 1,
853
+ # interleaved: false,
854
+ # })
855
+ #
856
+ # @example Response structure
857
+ #
858
+ # resp.events #=> Array
859
+ # resp.events[0].log_stream_name #=> String
860
+ # resp.events[0].timestamp #=> Integer
861
+ # resp.events[0].message #=> String
862
+ # resp.events[0].ingestion_time #=> Integer
863
+ # resp.events[0].event_id #=> String
864
+ # resp.searched_log_streams #=> Array
865
+ # resp.searched_log_streams[0].log_stream_name #=> String
866
+ # resp.searched_log_streams[0].searched_completely #=> Boolean
867
+ # resp.next_token #=> String
868
+ #
869
+ # @overload filter_log_events(params = {})
870
+ # @param [Hash] params ({})
871
+ def filter_log_events(params = {}, options = {})
872
+ req = build_request(:filter_log_events, params)
873
+ req.send_request(options)
874
+ end
739
875
 
740
- # Lists log events from the specified log stream. You can list all the
741
- # log events or filter using a time range.
742
- #
743
- # By default, this operation returns as many log events as can fit in a
744
- # response size of 1MB (up to 10,000 log events). If the results include
745
- # tokens, there are more log events available. You can get additional
746
- # log events by specifying one of the tokens in a subsequent call.
747
- # @option params [required, String] :log_group_name
748
- # The name of the log group.
749
- # @option params [required, String] :log_stream_name
750
- # The name of the log stream.
751
- # @option params [Integer] :start_time
752
- # The start of the time range. Events with a timestamp earlier than this
753
- # time are not included.
754
- # @option params [Integer] :end_time
755
- # The end of the time range. Events with a timestamp later than this
756
- # time are not included.
757
- # @option params [String] :next_token
758
- # The token for the next set of items to return. (You received this
759
- # token from a previous call.)
760
- # @option params [Integer] :limit
761
- # The maximum number of log events returned. If you don't specify a
762
- # value, the maximum is as many log events as can fit in a response size
763
- # of 1MB, up to 10,000 log events.
764
- # @option params [Boolean] :start_from_head
765
- # If the value is true, the earliest log events are returned first. If
766
- # the value is false, the latest log events are returned first. The
767
- # default value is false.
768
- # @return [Types::GetLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
769
- #
770
- # * {Types::GetLogEventsResponse#events #events} => Array&lt;Types::OutputLogEvent&gt;
771
- # * {Types::GetLogEventsResponse#next_forward_token #nextForwardToken} => String
772
- # * {Types::GetLogEventsResponse#next_backward_token #nextBackwardToken} => String
773
- #
774
- # @example Request syntax with placeholder values
775
- # resp = client.get_log_events({
776
- # log_group_name: "LogGroupName", # required
777
- # log_stream_name: "LogStreamName", # required
778
- # start_time: 1,
779
- # end_time: 1,
780
- # next_token: "NextToken",
781
- # limit: 1,
782
- # start_from_head: false,
783
- # })
784
- #
785
- # @example Response structure
786
- # resp.events #=> Array
787
- # resp.events[0].timestamp #=> Integer
788
- # resp.events[0].message #=> String
789
- # resp.events[0].ingestion_time #=> Integer
790
- # resp.next_forward_token #=> String
791
- # resp.next_backward_token #=> String
792
- # @overload get_log_events(params = {})
793
- # @param [Hash] params ({})
794
- def get_log_events(params = {}, options = {})
795
- req = build_request(:get_log_events, params)
796
- req.send_request(options)
797
- end
876
+ # Lists log events from the specified log stream. You can list all the
877
+ # log events or filter using a time range.
878
+ #
879
+ # By default, this operation returns as many log events as can fit in a
880
+ # response size of 1MB (up to 10,000 log events). If the results include
881
+ # tokens, there are more log events available. You can get additional
882
+ # log events by specifying one of the tokens in a subsequent call.
883
+ #
884
+ # @option params [required, String] :log_group_name
885
+ # The name of the log group.
886
+ #
887
+ # @option params [required, String] :log_stream_name
888
+ # The name of the log stream.
889
+ #
890
+ # @option params [Integer] :start_time
891
+ # The start of the time range, expressed as the number of milliseconds
892
+ # since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than
893
+ # this time are not included.
894
+ #
895
+ # @option params [Integer] :end_time
896
+ # The end of the time range, expressed as the number of milliseconds
897
+ # since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than
898
+ # this time are not included.
899
+ #
900
+ # @option params [String] :next_token
901
+ # The token for the next set of items to return. (You received this
902
+ # token from a previous call.)
903
+ #
904
+ # @option params [Integer] :limit
905
+ # The maximum number of log events returned. If you don't specify a
906
+ # value, the maximum is as many log events as can fit in a response size
907
+ # of 1MB, up to 10,000 log events.
908
+ #
909
+ # @option params [Boolean] :start_from_head
910
+ # If the value is true, the earliest log events are returned first. If
911
+ # the value is false, the latest log events are returned first. The
912
+ # default value is false.
913
+ #
914
+ # @return [Types::GetLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
915
+ #
916
+ # * {Types::GetLogEventsResponse#events #events} => Array&lt;Types::OutputLogEvent&gt;
917
+ # * {Types::GetLogEventsResponse#next_forward_token #next_forward_token} => String
918
+ # * {Types::GetLogEventsResponse#next_backward_token #next_backward_token} => String
919
+ #
920
+ # @example Request syntax with placeholder values
921
+ #
922
+ # resp = client.get_log_events({
923
+ # log_group_name: "LogGroupName", # required
924
+ # log_stream_name: "LogStreamName", # required
925
+ # start_time: 1,
926
+ # end_time: 1,
927
+ # next_token: "NextToken",
928
+ # limit: 1,
929
+ # start_from_head: false,
930
+ # })
931
+ #
932
+ # @example Response structure
933
+ #
934
+ # resp.events #=> Array
935
+ # resp.events[0].timestamp #=> Integer
936
+ # resp.events[0].message #=> String
937
+ # resp.events[0].ingestion_time #=> Integer
938
+ # resp.next_forward_token #=> String
939
+ # resp.next_backward_token #=> String
940
+ #
941
+ # @overload get_log_events(params = {})
942
+ # @param [Hash] params ({})
943
+ def get_log_events(params = {}, options = {})
944
+ req = build_request(:get_log_events, params)
945
+ req.send_request(options)
946
+ end
798
947
 
799
- # Creates or updates a destination. A destination encapsulates a
800
- # physical resource (such as a Kinesis stream) and enables you to
801
- # subscribe to a real-time stream of log events of a different account,
802
- # ingested using PutLogEvents. Currently, the only supported physical
803
- # resource is a Amazon Kinesis stream belonging to the same account as
804
- # the destination.
805
- #
806
- # A destination controls what is written to its Amazon Kinesis stream
807
- # through an access policy. By default, `PutDestination` does not set
808
- # any access policy with the destination, which means a cross-account
809
- # user cannot call PutSubscriptionFilter against this destination. To
810
- # enable this, the destination owner must call PutDestinationPolicy
811
- # after `PutDestination`.
812
- # @option params [required, String] :destination_name
813
- # A name for the destination.
814
- # @option params [required, String] :target_arn
815
- # The ARN of an Amazon Kinesis stream to deliver matching log events to.
816
- # @option params [required, String] :role_arn
817
- # The ARN of an IAM role that grants CloudWatch Logs permissions to call
818
- # Amazon Kinesis PutRecord on the destination stream.
819
- # @return [Types::PutDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
- #
821
- # * {Types::PutDestinationResponse#destination #destination} => Types::Destination
822
- #
823
- # @example Request syntax with placeholder values
824
- # resp = client.put_destination({
825
- # destination_name: "DestinationName", # required
826
- # target_arn: "TargetArn", # required
827
- # role_arn: "RoleArn", # required
828
- # })
829
- #
830
- # @example Response structure
831
- # resp.destination.destination_name #=> String
832
- # resp.destination.target_arn #=> String
833
- # resp.destination.role_arn #=> String
834
- # resp.destination.access_policy #=> String
835
- # resp.destination.arn #=> String
836
- # resp.destination.creation_time #=> Integer
837
- # @overload put_destination(params = {})
838
- # @param [Hash] params ({})
839
- def put_destination(params = {}, options = {})
840
- req = build_request(:put_destination, params)
841
- req.send_request(options)
842
- end
948
+ # Lists the tags for the specified log group.
949
+ #
950
+ # To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.
951
+ #
952
+ # @option params [required, String] :log_group_name
953
+ # The name of the log group.
954
+ #
955
+ # @return [Types::ListTagsLogGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
956
+ #
957
+ # * {Types::ListTagsLogGroupResponse#tags #tags} => Hash&lt;String,String&gt;
958
+ #
959
+ # @example Request syntax with placeholder values
960
+ #
961
+ # resp = client.list_tags_log_group({
962
+ # log_group_name: "LogGroupName", # required
963
+ # })
964
+ #
965
+ # @example Response structure
966
+ #
967
+ # resp.tags #=> Hash
968
+ # resp.tags["TagKey"] #=> String
969
+ #
970
+ # @overload list_tags_log_group(params = {})
971
+ # @param [Hash] params ({})
972
+ def list_tags_log_group(params = {}, options = {})
973
+ req = build_request(:list_tags_log_group, params)
974
+ req.send_request(options)
975
+ end
843
976
 
844
- # Creates or updates an access policy associated with an existing
845
- # destination. An access policy is an [IAM policy document][1] that is
846
- # used to authorize claims to register a subscription filter against a
847
- # given destination.
848
- #
849
- #
850
- #
851
- # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html
852
- # @option params [required, String] :destination_name
853
- # A name for an existing destination.
854
- # @option params [required, String] :access_policy
855
- # An IAM policy document that authorizes cross-account users to deliver
856
- # their log events to the associated destination.
857
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
858
- #
859
- # @example Request syntax with placeholder values
860
- # resp = client.put_destination_policy({
861
- # destination_name: "DestinationName", # required
862
- # access_policy: "AccessPolicy", # required
863
- # })
864
- # @overload put_destination_policy(params = {})
865
- # @param [Hash] params ({})
866
- def put_destination_policy(params = {}, options = {})
867
- req = build_request(:put_destination_policy, params)
868
- req.send_request(options)
869
- end
977
+ # Creates or updates a destination. A destination encapsulates a
978
+ # physical resource (such as a Kinesis stream) and enables you to
979
+ # subscribe to a real-time stream of log events of a different account,
980
+ # ingested using PutLogEvents. Currently, the only supported physical
981
+ # resource is a Amazon Kinesis stream belonging to the same account as
982
+ # the destination.
983
+ #
984
+ # A destination controls what is written to its Amazon Kinesis stream
985
+ # through an access policy. By default, `PutDestination` does not set
986
+ # any access policy with the destination, which means a cross-account
987
+ # user cannot call PutSubscriptionFilter against this destination. To
988
+ # enable this, the destination owner must call PutDestinationPolicy
989
+ # after `PutDestination`.
990
+ #
991
+ # @option params [required, String] :destination_name
992
+ # A name for the destination.
993
+ #
994
+ # @option params [required, String] :target_arn
995
+ # The ARN of an Amazon Kinesis stream to deliver matching log events to.
996
+ #
997
+ # @option params [required, String] :role_arn
998
+ # The ARN of an IAM role that grants CloudWatch Logs permissions to call
999
+ # Amazon Kinesis PutRecord on the destination stream.
1000
+ #
1001
+ # @return [Types::PutDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1002
+ #
1003
+ # * {Types::PutDestinationResponse#destination #destination} => Types::Destination
1004
+ #
1005
+ # @example Request syntax with placeholder values
1006
+ #
1007
+ # resp = client.put_destination({
1008
+ # destination_name: "DestinationName", # required
1009
+ # target_arn: "TargetArn", # required
1010
+ # role_arn: "RoleArn", # required
1011
+ # })
1012
+ #
1013
+ # @example Response structure
1014
+ #
1015
+ # resp.destination.destination_name #=> String
1016
+ # resp.destination.target_arn #=> String
1017
+ # resp.destination.role_arn #=> String
1018
+ # resp.destination.access_policy #=> String
1019
+ # resp.destination.arn #=> String
1020
+ # resp.destination.creation_time #=> Integer
1021
+ #
1022
+ # @overload put_destination(params = {})
1023
+ # @param [Hash] params ({})
1024
+ def put_destination(params = {}, options = {})
1025
+ req = build_request(:put_destination, params)
1026
+ req.send_request(options)
1027
+ end
870
1028
 
871
- # Uploads a batch of log events to the specified log stream.
872
- #
873
- # You must include the sequence token obtained from the response of the
874
- # previous call. An upload in a newly created log stream does not
875
- # require a sequence token. You can also get the sequence token using
876
- # DescribeLogStreams.
877
- #
878
- # The batch of events must satisfy the following constraints:
879
- #
880
- # * The maximum batch size is 1,048,576 bytes, and this size is
881
- # calculated as the sum of all event messages in UTF-8, plus 26 bytes
882
- # for each log event.
883
- #
884
- # * None of the log events in the batch can be more than 2 hours in the
885
- # future.
886
- #
887
- # * None of the log events in the batch can be older than 14 days or the
888
- # retention period of the log group.
889
- #
890
- # * The log events in the batch must be in chronological ordered by
891
- # their timestamp.
892
- #
893
- # * The maximum number of log events in a batch is 10,000.
894
- #
895
- # * A batch of log events in a single PutLogEvents request cannot span
896
- # more than 24 hours. Otherwise, the PutLogEvents operation will fail.
897
- # @option params [required, String] :log_group_name
898
- # The name of the log group.
899
- # @option params [required, String] :log_stream_name
900
- # The name of the log stream.
901
- # @option params [required, Array<Types::InputLogEvent>] :log_events
902
- # The log events.
903
- # @option params [String] :sequence_token
904
- # The sequence token.
905
- # @return [Types::PutLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
906
- #
907
- # * {Types::PutLogEventsResponse#next_sequence_token #nextSequenceToken} => String
908
- # * {Types::PutLogEventsResponse#rejected_log_events_info #rejectedLogEventsInfo} => Types::RejectedLogEventsInfo
909
- #
910
- # @example Request syntax with placeholder values
911
- # resp = client.put_log_events({
912
- # log_group_name: "LogGroupName", # required
913
- # log_stream_name: "LogStreamName", # required
914
- # log_events: [ # required
915
- # {
916
- # timestamp: 1, # required
917
- # message: "EventMessage", # required
918
- # },
919
- # ],
920
- # sequence_token: "SequenceToken",
921
- # })
922
- #
923
- # @example Response structure
924
- # resp.next_sequence_token #=> String
925
- # resp.rejected_log_events_info.too_new_log_event_start_index #=> Integer
926
- # resp.rejected_log_events_info.too_old_log_event_end_index #=> Integer
927
- # resp.rejected_log_events_info.expired_log_event_end_index #=> Integer
928
- # @overload put_log_events(params = {})
929
- # @param [Hash] params ({})
930
- def put_log_events(params = {}, options = {})
931
- req = build_request(:put_log_events, params)
932
- req.send_request(options)
933
- end
1029
+ # Creates or updates an access policy associated with an existing
1030
+ # destination. An access policy is an [IAM policy document][1] that is
1031
+ # used to authorize claims to register a subscription filter against a
1032
+ # given destination.
1033
+ #
1034
+ #
1035
+ #
1036
+ # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html
1037
+ #
1038
+ # @option params [required, String] :destination_name
1039
+ # A name for an existing destination.
1040
+ #
1041
+ # @option params [required, String] :access_policy
1042
+ # An IAM policy document that authorizes cross-account users to deliver
1043
+ # their log events to the associated destination.
1044
+ #
1045
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1046
+ #
1047
+ # @example Request syntax with placeholder values
1048
+ #
1049
+ # resp = client.put_destination_policy({
1050
+ # destination_name: "DestinationName", # required
1051
+ # access_policy: "AccessPolicy", # required
1052
+ # })
1053
+ #
1054
+ # @overload put_destination_policy(params = {})
1055
+ # @param [Hash] params ({})
1056
+ def put_destination_policy(params = {}, options = {})
1057
+ req = build_request(:put_destination_policy, params)
1058
+ req.send_request(options)
1059
+ end
934
1060
 
935
- # Creates or updates a metric filter and associates it with the
936
- # specified log group. Metric filters allow you to configure rules to
937
- # extract metric data from log events ingested through PutLogEvents.
938
- #
939
- # The maximum number of metric filters that can be associated with a log
940
- # group is 100.
941
- # @option params [required, String] :log_group_name
942
- # The name of the log group.
943
- # @option params [required, String] :filter_name
944
- # A name for the metric filter.
945
- # @option params [required, String] :filter_pattern
946
- # A filter pattern for extracting metric data out of ingested log
947
- # events.
948
- # @option params [required, Array<Types::MetricTransformation>] :metric_transformations
949
- # A collection of information needed to define how metric data gets
950
- # emitted.
951
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
952
- #
953
- # @example Request syntax with placeholder values
954
- # resp = client.put_metric_filter({
955
- # log_group_name: "LogGroupName", # required
956
- # filter_name: "FilterName", # required
957
- # filter_pattern: "FilterPattern", # required
958
- # metric_transformations: [ # required
959
- # {
960
- # metric_name: "MetricName", # required
961
- # metric_namespace: "MetricNamespace", # required
962
- # metric_value: "MetricValue", # required
963
- # default_value: 1.0,
964
- # },
965
- # ],
966
- # })
967
- # @overload put_metric_filter(params = {})
968
- # @param [Hash] params ({})
969
- def put_metric_filter(params = {}, options = {})
970
- req = build_request(:put_metric_filter, params)
971
- req.send_request(options)
972
- end
1061
+ # Uploads a batch of log events to the specified log stream.
1062
+ #
1063
+ # You must include the sequence token obtained from the response of the
1064
+ # previous call. An upload in a newly created log stream does not
1065
+ # require a sequence token. You can also get the sequence token using
1066
+ # DescribeLogStreams.
1067
+ #
1068
+ # The batch of events must satisfy the following constraints:
1069
+ #
1070
+ # * The maximum batch size is 1,048,576 bytes, and this size is
1071
+ # calculated as the sum of all event messages in UTF-8, plus 26 bytes
1072
+ # for each log event.
1073
+ #
1074
+ # * None of the log events in the batch can be more than 2 hours in the
1075
+ # future.
1076
+ #
1077
+ # * None of the log events in the batch can be older than 14 days or the
1078
+ # retention period of the log group.
1079
+ #
1080
+ # * The log events in the batch must be in chronological ordered by
1081
+ # their timestamp (the time the event occurred, expressed as the
1082
+ # number of milliseconds since Jan 1, 1970 00:00:00 UTC).
1083
+ #
1084
+ # * The maximum number of log events in a batch is 10,000.
1085
+ #
1086
+ # * A batch of log events in a single request cannot span more than 24
1087
+ # hours. Otherwise, the operation fails.
1088
+ #
1089
+ # @option params [required, String] :log_group_name
1090
+ # The name of the log group.
1091
+ #
1092
+ # @option params [required, String] :log_stream_name
1093
+ # The name of the log stream.
1094
+ #
1095
+ # @option params [required, Array<Types::InputLogEvent>] :log_events
1096
+ # The log events.
1097
+ #
1098
+ # @option params [String] :sequence_token
1099
+ # The sequence token.
1100
+ #
1101
+ # @return [Types::PutLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1102
+ #
1103
+ # * {Types::PutLogEventsResponse#next_sequence_token #next_sequence_token} => String
1104
+ # * {Types::PutLogEventsResponse#rejected_log_events_info #rejected_log_events_info} => Types::RejectedLogEventsInfo
1105
+ #
1106
+ # @example Request syntax with placeholder values
1107
+ #
1108
+ # resp = client.put_log_events({
1109
+ # log_group_name: "LogGroupName", # required
1110
+ # log_stream_name: "LogStreamName", # required
1111
+ # log_events: [ # required
1112
+ # {
1113
+ # timestamp: 1, # required
1114
+ # message: "EventMessage", # required
1115
+ # },
1116
+ # ],
1117
+ # sequence_token: "SequenceToken",
1118
+ # })
1119
+ #
1120
+ # @example Response structure
1121
+ #
1122
+ # resp.next_sequence_token #=> String
1123
+ # resp.rejected_log_events_info.too_new_log_event_start_index #=> Integer
1124
+ # resp.rejected_log_events_info.too_old_log_event_end_index #=> Integer
1125
+ # resp.rejected_log_events_info.expired_log_event_end_index #=> Integer
1126
+ #
1127
+ # @overload put_log_events(params = {})
1128
+ # @param [Hash] params ({})
1129
+ def put_log_events(params = {}, options = {})
1130
+ req = build_request(:put_log_events, params)
1131
+ req.send_request(options)
1132
+ end
973
1133
 
974
- # Sets the retention of the specified log group. A retention policy
975
- # allows you to configure the number of days you want to retain log
976
- # events in the specified log group.
977
- # @option params [required, String] :log_group_name
978
- # The name of the log group.
979
- # @option params [required, Integer] :retention_in_days
980
- # The number of days to retain the log events in the specified log
981
- # group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180,
982
- # 365, 400, 545, 731, 1827, and 3653.
983
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
984
- #
985
- # @example Request syntax with placeholder values
986
- # resp = client.put_retention_policy({
987
- # log_group_name: "LogGroupName", # required
988
- # retention_in_days: 1, # required
989
- # })
990
- # @overload put_retention_policy(params = {})
991
- # @param [Hash] params ({})
992
- def put_retention_policy(params = {}, options = {})
993
- req = build_request(:put_retention_policy, params)
994
- req.send_request(options)
995
- end
1134
+ # Creates or updates a metric filter and associates it with the
1135
+ # specified log group. Metric filters allow you to configure rules to
1136
+ # extract metric data from log events ingested through PutLogEvents.
1137
+ #
1138
+ # The maximum number of metric filters that can be associated with a log
1139
+ # group is 100.
1140
+ #
1141
+ # @option params [required, String] :log_group_name
1142
+ # The name of the log group.
1143
+ #
1144
+ # @option params [required, String] :filter_name
1145
+ # A name for the metric filter.
1146
+ #
1147
+ # @option params [required, String] :filter_pattern
1148
+ # A filter pattern for extracting metric data out of ingested log
1149
+ # events.
1150
+ #
1151
+ # @option params [required, Array<Types::MetricTransformation>] :metric_transformations
1152
+ # A collection of information needed to define how metric data gets
1153
+ # emitted.
1154
+ #
1155
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1156
+ #
1157
+ # @example Request syntax with placeholder values
1158
+ #
1159
+ # resp = client.put_metric_filter({
1160
+ # log_group_name: "LogGroupName", # required
1161
+ # filter_name: "FilterName", # required
1162
+ # filter_pattern: "FilterPattern", # required
1163
+ # metric_transformations: [ # required
1164
+ # {
1165
+ # metric_name: "MetricName", # required
1166
+ # metric_namespace: "MetricNamespace", # required
1167
+ # metric_value: "MetricValue", # required
1168
+ # default_value: 1.0,
1169
+ # },
1170
+ # ],
1171
+ # })
1172
+ #
1173
+ # @overload put_metric_filter(params = {})
1174
+ # @param [Hash] params ({})
1175
+ def put_metric_filter(params = {}, options = {})
1176
+ req = build_request(:put_metric_filter, params)
1177
+ req.send_request(options)
1178
+ end
996
1179
 
997
- # Creates or updates a subscription filter and associates it with the
998
- # specified log group. Subscription filters allow you to subscribe to a
999
- # real-time stream of log events ingested through PutLogEvents and have
1000
- # them delivered to a specific destination. Currently, the supported
1001
- # destinations are:
1002
- #
1003
- # * An Amazon Kinesis stream belonging to the same account as the
1004
- # subscription filter, for same-account delivery.
1005
- #
1006
- # * A logical destination that belongs to a different account, for
1007
- # cross-account delivery.
1008
- #
1009
- # * An Amazon Kinesis Firehose stream that belongs to the same account
1010
- # as the subscription filter, for same-account delivery.
1011
- #
1012
- # * An AWS Lambda function that belongs to the same account as the
1013
- # subscription filter, for same-account delivery.
1014
- #
1015
- # There can only be one subscription filter associated with a log group.
1016
- # @option params [required, String] :log_group_name
1017
- # The name of the log group.
1018
- # @option params [required, String] :filter_name
1019
- # A name for the subscription filter.
1020
- # @option params [required, String] :filter_pattern
1021
- # A filter pattern for subscribing to a filtered stream of log events.
1022
- # @option params [required, String] :destination_arn
1023
- # The ARN of the destination to deliver matching log events to.
1024
- # Currently, the supported destinations are:
1025
- #
1026
- # * An Amazon Kinesis stream belonging to the same account as the
1027
- # subscription filter, for same-account delivery.
1028
- #
1029
- # * A logical destination (specified using an ARN) belonging to a
1030
- # different account, for cross-account delivery.
1031
- #
1032
- # * An Amazon Kinesis Firehose stream belonging to the same account as
1033
- # the subscription filter, for same-account delivery.
1034
- #
1035
- # * An AWS Lambda function belonging to the same account as the
1036
- # subscription filter, for same-account delivery.
1037
- # @option params [String] :role_arn
1038
- # The ARN of an IAM role that grants CloudWatch Logs permissions to
1039
- # deliver ingested log events to the destination stream. You don't need
1040
- # to provide the ARN when you are working with a logical destination for
1041
- # cross-account delivery.
1042
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1043
- #
1044
- # @example Request syntax with placeholder values
1045
- # resp = client.put_subscription_filter({
1046
- # log_group_name: "LogGroupName", # required
1047
- # filter_name: "FilterName", # required
1048
- # filter_pattern: "FilterPattern", # required
1049
- # destination_arn: "DestinationArn", # required
1050
- # role_arn: "RoleArn",
1051
- # })
1052
- # @overload put_subscription_filter(params = {})
1053
- # @param [Hash] params ({})
1054
- def put_subscription_filter(params = {}, options = {})
1055
- req = build_request(:put_subscription_filter, params)
1056
- req.send_request(options)
1057
- end
1180
+ # Sets the retention of the specified log group. A retention policy
1181
+ # allows you to configure the number of days you want to retain log
1182
+ # events in the specified log group.
1183
+ #
1184
+ # @option params [required, String] :log_group_name
1185
+ # The name of the log group.
1186
+ #
1187
+ # @option params [required, Integer] :retention_in_days
1188
+ # The number of days to retain the log events in the specified log
1189
+ # group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180,
1190
+ # 365, 400, 545, 731, 1827, and 3653.
1191
+ #
1192
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1193
+ #
1194
+ # @example Request syntax with placeholder values
1195
+ #
1196
+ # resp = client.put_retention_policy({
1197
+ # log_group_name: "LogGroupName", # required
1198
+ # retention_in_days: 1, # required
1199
+ # })
1200
+ #
1201
+ # @overload put_retention_policy(params = {})
1202
+ # @param [Hash] params ({})
1203
+ def put_retention_policy(params = {}, options = {})
1204
+ req = build_request(:put_retention_policy, params)
1205
+ req.send_request(options)
1206
+ end
1058
1207
 
1059
- # Tests the filter pattern of a metric filter against a sample of log
1060
- # event messages. You can use this operation to validate the correctness
1061
- # of a metric filter pattern.
1062
- # @option params [required, String] :filter_pattern
1063
- # A symbolic description of how CloudWatch Logs should interpret the
1064
- # data in each log event. For example, a log event may contain
1065
- # timestamps, IP addresses, strings, and so on. You use the filter
1066
- # pattern to specify what to look for in the log event message.
1067
- # @option params [required, Array<String>] :log_event_messages
1068
- # The log event messages to test.
1069
- # @return [Types::TestMetricFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1070
- #
1071
- # * {Types::TestMetricFilterResponse#matches #matches} => Array&lt;Types::MetricFilterMatchRecord&gt;
1072
- #
1073
- # @example Request syntax with placeholder values
1074
- # resp = client.test_metric_filter({
1075
- # filter_pattern: "FilterPattern", # required
1076
- # log_event_messages: ["EventMessage"], # required
1077
- # })
1078
- #
1079
- # @example Response structure
1080
- # resp.matches #=> Array
1081
- # resp.matches[0].event_number #=> Integer
1082
- # resp.matches[0].event_message #=> String
1083
- # resp.matches[0].extracted_values #=> Hash
1084
- # resp.matches[0].extracted_values["Token"] #=> String
1085
- # @overload test_metric_filter(params = {})
1086
- # @param [Hash] params ({})
1087
- def test_metric_filter(params = {}, options = {})
1088
- req = build_request(:test_metric_filter, params)
1089
- req.send_request(options)
1090
- end
1208
+ # Creates or updates a subscription filter and associates it with the
1209
+ # specified log group. Subscription filters allow you to subscribe to a
1210
+ # real-time stream of log events ingested through PutLogEvents and have
1211
+ # them delivered to a specific destination. Currently, the supported
1212
+ # destinations are:
1213
+ #
1214
+ # * An Amazon Kinesis stream belonging to the same account as the
1215
+ # subscription filter, for same-account delivery.
1216
+ #
1217
+ # * A logical destination that belongs to a different account, for
1218
+ # cross-account delivery.
1219
+ #
1220
+ # * An Amazon Kinesis Firehose stream that belongs to the same account
1221
+ # as the subscription filter, for same-account delivery.
1222
+ #
1223
+ # * An AWS Lambda function that belongs to the same account as the
1224
+ # subscription filter, for same-account delivery.
1225
+ #
1226
+ # There can only be one subscription filter associated with a log group.
1227
+ #
1228
+ # @option params [required, String] :log_group_name
1229
+ # The name of the log group.
1230
+ #
1231
+ # @option params [required, String] :filter_name
1232
+ # A name for the subscription filter.
1233
+ #
1234
+ # @option params [required, String] :filter_pattern
1235
+ # A filter pattern for subscribing to a filtered stream of log events.
1236
+ #
1237
+ # @option params [required, String] :destination_arn
1238
+ # The ARN of the destination to deliver matching log events to.
1239
+ # Currently, the supported destinations are:
1240
+ #
1241
+ # * An Amazon Kinesis stream belonging to the same account as the
1242
+ # subscription filter, for same-account delivery.
1243
+ #
1244
+ # * A logical destination (specified using an ARN) belonging to a
1245
+ # different account, for cross-account delivery.
1246
+ #
1247
+ # * An Amazon Kinesis Firehose stream belonging to the same account as
1248
+ # the subscription filter, for same-account delivery.
1249
+ #
1250
+ # * An AWS Lambda function belonging to the same account as the
1251
+ # subscription filter, for same-account delivery.
1252
+ #
1253
+ # @option params [String] :role_arn
1254
+ # The ARN of an IAM role that grants CloudWatch Logs permissions to
1255
+ # deliver ingested log events to the destination stream. You don't need
1256
+ # to provide the ARN when you are working with a logical destination for
1257
+ # cross-account delivery.
1258
+ #
1259
+ # @option params [String] :distribution
1260
+ # The method used to distribute log data to the destination, when the
1261
+ # destination is an Amazon Kinesis stream. By default, log data is
1262
+ # grouped by log stream. For a more even distribution, you can group log
1263
+ # data randomly.
1264
+ #
1265
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1266
+ #
1267
+ # @example Request syntax with placeholder values
1268
+ #
1269
+ # resp = client.put_subscription_filter({
1270
+ # log_group_name: "LogGroupName", # required
1271
+ # filter_name: "FilterName", # required
1272
+ # filter_pattern: "FilterPattern", # required
1273
+ # destination_arn: "DestinationArn", # required
1274
+ # role_arn: "RoleArn",
1275
+ # distribution: "Random", # accepts Random, ByLogStream
1276
+ # })
1277
+ #
1278
+ # @overload put_subscription_filter(params = {})
1279
+ # @param [Hash] params ({})
1280
+ def put_subscription_filter(params = {}, options = {})
1281
+ req = build_request(:put_subscription_filter, params)
1282
+ req.send_request(options)
1283
+ end
1091
1284
 
1092
- # @!endgroup
1285
+ # Adds or updates the specified tags for the specified log group.
1286
+ #
1287
+ # To list the tags for a log group, use ListTagsLogGroup. To remove
1288
+ # tags, use UntagLogGroup.
1289
+ #
1290
+ # For more information about tags, see [Tag Log Groups in Amazon
1291
+ # CloudWatch Logs][1] in the *Amazon CloudWatch Logs User Guide*.
1292
+ #
1293
+ #
1294
+ #
1295
+ # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html
1296
+ #
1297
+ # @option params [required, String] :log_group_name
1298
+ # The name of the log group.
1299
+ #
1300
+ # @option params [required, Hash<String,String>] :tags
1301
+ # The key-value pairs to use for the tags.
1302
+ #
1303
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1304
+ #
1305
+ # @example Request syntax with placeholder values
1306
+ #
1307
+ # resp = client.tag_log_group({
1308
+ # log_group_name: "LogGroupName", # required
1309
+ # tags: { # required
1310
+ # "TagKey" => "TagValue",
1311
+ # },
1312
+ # })
1313
+ #
1314
+ # @overload tag_log_group(params = {})
1315
+ # @param [Hash] params ({})
1316
+ def tag_log_group(params = {}, options = {})
1317
+ req = build_request(:tag_log_group, params)
1318
+ req.send_request(options)
1319
+ end
1093
1320
 
1094
- # @param params ({})
1095
- # @api private
1096
- def build_request(operation_name, params = {})
1097
- handlers = @handlers.for(operation_name)
1098
- context = Seahorse::Client::RequestContext.new(
1099
- operation_name: operation_name,
1100
- operation: config.api.operation(operation_name),
1101
- client: self,
1102
- params: params,
1103
- config: config)
1104
- context[:gem_name] = 'aws-sdk-cloudwatchlogs'
1105
- context[:gem_version] = '1.0.0.rc1'
1106
- Seahorse::Client::Request.new(handlers, context)
1107
- end
1321
+ # Tests the filter pattern of a metric filter against a sample of log
1322
+ # event messages. You can use this operation to validate the correctness
1323
+ # of a metric filter pattern.
1324
+ #
1325
+ # @option params [required, String] :filter_pattern
1326
+ # A symbolic description of how CloudWatch Logs should interpret the
1327
+ # data in each log event. For example, a log event may contain
1328
+ # timestamps, IP addresses, strings, and so on. You use the filter
1329
+ # pattern to specify what to look for in the log event message.
1330
+ #
1331
+ # @option params [required, Array<String>] :log_event_messages
1332
+ # The log event messages to test.
1333
+ #
1334
+ # @return [Types::TestMetricFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1335
+ #
1336
+ # * {Types::TestMetricFilterResponse#matches #matches} => Array&lt;Types::MetricFilterMatchRecord&gt;
1337
+ #
1338
+ # @example Request syntax with placeholder values
1339
+ #
1340
+ # resp = client.test_metric_filter({
1341
+ # filter_pattern: "FilterPattern", # required
1342
+ # log_event_messages: ["EventMessage"], # required
1343
+ # })
1344
+ #
1345
+ # @example Response structure
1346
+ #
1347
+ # resp.matches #=> Array
1348
+ # resp.matches[0].event_number #=> Integer
1349
+ # resp.matches[0].event_message #=> String
1350
+ # resp.matches[0].extracted_values #=> Hash
1351
+ # resp.matches[0].extracted_values["Token"] #=> String
1352
+ #
1353
+ # @overload test_metric_filter(params = {})
1354
+ # @param [Hash] params ({})
1355
+ def test_metric_filter(params = {}, options = {})
1356
+ req = build_request(:test_metric_filter, params)
1357
+ req.send_request(options)
1358
+ end
1108
1359
 
1109
- # @api private
1110
- # @deprecated
1111
- def waiter_names
1112
- []
1113
- end
1360
+ # Removes the specified tags from the specified log group.
1361
+ #
1362
+ # To list the tags for a log group, use ListTagsLogGroup. To add tags,
1363
+ # use UntagLogGroup.
1364
+ #
1365
+ # @option params [required, String] :log_group_name
1366
+ # The name of the log group.
1367
+ #
1368
+ # @option params [required, Array<String>] :tags
1369
+ # The tag keys. The corresponding tags are removed from the log group.
1370
+ #
1371
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1372
+ #
1373
+ # @example Request syntax with placeholder values
1374
+ #
1375
+ # resp = client.untag_log_group({
1376
+ # log_group_name: "LogGroupName", # required
1377
+ # tags: ["TagKey"], # required
1378
+ # })
1379
+ #
1380
+ # @overload untag_log_group(params = {})
1381
+ # @param [Hash] params ({})
1382
+ def untag_log_group(params = {}, options = {})
1383
+ req = build_request(:untag_log_group, params)
1384
+ req.send_request(options)
1385
+ end
1386
+
1387
+ # @!endgroup
1388
+
1389
+ # @param params ({})
1390
+ # @api private
1391
+ def build_request(operation_name, params = {})
1392
+ handlers = @handlers.for(operation_name)
1393
+ context = Seahorse::Client::RequestContext.new(
1394
+ operation_name: operation_name,
1395
+ operation: config.api.operation(operation_name),
1396
+ client: self,
1397
+ params: params,
1398
+ config: config)
1399
+ context[:gem_name] = 'aws-sdk-cloudwatchlogs'
1400
+ context[:gem_version] = '1.0.0.rc1'
1401
+ Seahorse::Client::Request.new(handlers, context)
1402
+ end
1114
1403
 
1115
- class << self
1404
+ # @api private
1405
+ # @deprecated
1406
+ def waiter_names
1407
+ []
1408
+ end
1116
1409
 
1117
- # @api private
1118
- attr_reader :identifier
1410
+ class << self
1119
1411
 
1120
- # @api private
1121
- def errors_module
1122
- Errors
1123
- end
1412
+ # @api private
1413
+ attr_reader :identifier
1124
1414
 
1415
+ # @api private
1416
+ def errors_module
1417
+ Errors
1125
1418
  end
1419
+
1126
1420
  end
1127
1421
  end
1128
1422
  end