aws-sdk-kinesisanalytics 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kinesisanalytics.rb +2 -2
- data/lib/aws-sdk-kinesisanalytics/client.rb +1118 -1000
- data/lib/aws-sdk-kinesisanalytics/client_api.rb +572 -574
- data/lib/aws-sdk-kinesisanalytics/errors.rb +4 -13
- data/lib/aws-sdk-kinesisanalytics/resource.rb +12 -14
- data/lib/aws-sdk-kinesisanalytics/types.rb +2472 -2205
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3a7d6835d04c26e5a5a8b514e34312450857d112
|
4
|
+
data.tar.gz: 544ad03fa7496bf8f9f19d6547a2a1c21d4c3b6b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7bde0843b2dfe9315631017f491e186d72967d9a7e86e38fdadbf2b9ccd2d863b37bcf04c4fd7b0ba1cc6ed3bff20ee130053a2c739b1737863ae8ff56997e95
|
7
|
+
data.tar.gz: aff6c102cd426ad93bb41620c0cde08e187931bf5c98f92648e73de3d9ccad65767b0abcf36979dd93a5dc5b7cc0178970da01bcaa5f8958530859195cf0f943
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-kinesisanalytics/customizations'
|
|
42
42
|
# @service
|
43
43
|
module Aws::KinesisAnalytics
|
44
44
|
|
45
|
-
GEM_VERSION = '1.0.0.
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
46
46
|
|
47
47
|
end
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
@@ -18,1036 +18,1154 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
23
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
24
|
|
24
25
|
Aws::Plugins::GlobalConfiguration.add_identifier(:kinesisanalytics)
|
25
26
|
|
26
|
-
module Aws
|
27
|
-
|
28
|
-
class Client < Seahorse::Client::Base
|
27
|
+
module Aws::KinesisAnalytics
|
28
|
+
class Client < Seahorse::Client::Base
|
29
29
|
|
30
|
-
|
30
|
+
include Aws::ClientStubs
|
31
31
|
|
32
|
-
|
32
|
+
@identifier = :kinesisanalytics
|
33
33
|
|
34
|
-
|
34
|
+
set_api(ClientApi::API)
|
35
35
|
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
52
|
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
55
|
+
# following classes:
|
56
|
+
#
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
58
|
+
# credentials.
|
59
|
+
#
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
62
|
+
#
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
64
|
+
# shared file, such as `~/.aws/config`.
|
65
|
+
#
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
67
|
+
#
|
68
|
+
# When `:credentials` are not configured directly, the following
|
69
|
+
# locations will be searched for credentials:
|
70
|
+
#
|
71
|
+
# * `Aws.config[:credentials]`
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
74
|
+
# * `~/.aws/credentials`
|
75
|
+
# * `~/.aws/config`
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
77
|
+
# very aggressive. Construct and pass an instance of
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
79
|
+
# timeouts.
|
80
|
+
#
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
#
|
93
|
+
# @option options [String] :access_key_id
|
94
|
+
#
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
97
|
+
# the required types.
|
98
|
+
#
|
99
|
+
# @option options [String] :endpoint
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
|
+
#
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
105
|
+
# The log formatter.
|
106
|
+
#
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
108
|
+
# The log level to send messages to the `:logger` at.
|
109
|
+
#
|
110
|
+
# @option options [Logger] :logger
|
111
|
+
# The Logger instance to send log messages to. If this option
|
112
|
+
# is not set, logging will be disabled.
|
113
|
+
#
|
114
|
+
# @option options [String] :profile ("default")
|
115
|
+
# Used when loading credentials from the shared credentials file
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
117
|
+
#
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
123
|
+
# errors from expired credentials.
|
124
|
+
#
|
125
|
+
# @option options [String] :secret_access_key
|
126
|
+
#
|
127
|
+
# @option options [String] :session_token
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
131
|
+
# Also disable response data type conversions. This option is useful
|
132
|
+
# when you want to ensure the highest level of performance by
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
134
|
+
# structures.
|
135
|
+
#
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
138
|
+
#
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
140
|
+
# Causes the client to return stubbed responses. By default
|
141
|
+
# fake responses are generated and returned. You can specify
|
142
|
+
# the response data to return or errors to raise by calling
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
144
|
+
#
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
146
|
+
# requests are made, and retries are disabled.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
149
|
+
# When `true`, request parameters are validated before
|
150
|
+
# sending the request.
|
151
|
+
#
|
152
|
+
def initialize(*args)
|
153
|
+
super
|
154
|
+
end
|
139
155
|
|
140
|
-
|
156
|
+
# @!group API Operations
|
141
157
|
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
# this operation. You can configure one or more outputs for your
|
234
|
-
# application. Each output configuration maps an in-application stream
|
235
|
-
# and an external destination.
|
236
|
-
#
|
237
|
-
# You can use one of the output configurations to deliver data from your
|
238
|
-
# in-application error stream to an external destination so that you can
|
239
|
-
# analyze the errors. For conceptual information, see [Understanding
|
240
|
-
# Application Output (Destination)][1].
|
241
|
-
#
|
242
|
-
# Note that any configuration update, including adding a streaming
|
243
|
-
# source using this operation, results in a new version of the
|
244
|
-
# application. You can use the DescribeApplication operation to find the
|
245
|
-
# current application version.
|
246
|
-
#
|
247
|
-
# For the limits on the number of application inputs and outputs you can
|
248
|
-
# configure, see [Limits][2].
|
249
|
-
#
|
250
|
-
# This operation requires permissions to perform the
|
251
|
-
# `kinesisanalytics:AddApplicationOutput` action.
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
|
256
|
-
# [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
|
257
|
-
# @option params [required, String] :application_name
|
258
|
-
# Name of the application to which you want to add the output
|
259
|
-
# configuration.
|
260
|
-
# @option params [required, Integer] :current_application_version_id
|
261
|
-
# Version of the application to which you want add the output
|
262
|
-
# configuration. You can use the DescribeApplication operation to get
|
263
|
-
# the current application version. If the version specified is not the
|
264
|
-
# current version, the `ConcurrentModificationException` is returned.
|
265
|
-
# @option params [required, Types::Output] :output
|
266
|
-
# An array of objects, each describing one output configuration. In the
|
267
|
-
# output configuration, you specify the name of an in-application
|
268
|
-
# stream, a destination (that is, an Amazon Kinesis stream or an Amazon
|
269
|
-
# Kinesis Firehose delivery stream), and record the formation to use
|
270
|
-
# when writing to the destination.
|
271
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
272
|
-
#
|
273
|
-
# @example Request syntax with placeholder values
|
274
|
-
# resp = client.add_application_output({
|
275
|
-
# application_name: "ApplicationName", # required
|
276
|
-
# current_application_version_id: 1, # required
|
277
|
-
# output: { # required
|
278
|
-
# name: "InAppStreamName", # required
|
279
|
-
# kinesis_streams_output: {
|
280
|
-
# resource_arn: "ResourceARN", # required
|
281
|
-
# role_arn: "RoleARN", # required
|
282
|
-
# },
|
283
|
-
# kinesis_firehose_output: {
|
284
|
-
# resource_arn: "ResourceARN", # required
|
285
|
-
# role_arn: "RoleARN", # required
|
286
|
-
# },
|
287
|
-
# destination_schema: { # required
|
288
|
-
# record_format_type: "JSON", # accepts JSON, CSV
|
289
|
-
# },
|
290
|
-
# },
|
291
|
-
# })
|
292
|
-
# @overload add_application_output(params = {})
|
293
|
-
# @param [Hash] params ({})
|
294
|
-
def add_application_output(params = {}, options = {})
|
295
|
-
req = build_request(:add_application_output, params)
|
296
|
-
req.send_request(options)
|
297
|
-
end
|
158
|
+
# Adds a streaming source to your Amazon Kinesis application. For
|
159
|
+
# conceptual information, see [Configuring Application Input][1].
|
160
|
+
#
|
161
|
+
# You can add a streaming source either when you create an application
|
162
|
+
# or you can use this operation to add a streaming source after you
|
163
|
+
# create an application. For more information, see CreateApplication.
|
164
|
+
#
|
165
|
+
# Any configuration update, including adding a streaming source using
|
166
|
+
# this operation, results in a new version of the application. You can
|
167
|
+
# use the DescribeApplication operation to find the current application
|
168
|
+
# version.
|
169
|
+
#
|
170
|
+
# This operation requires permissions to perform the
|
171
|
+
# `kinesisanalytics:AddApplicationInput` action.
|
172
|
+
#
|
173
|
+
#
|
174
|
+
#
|
175
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
|
176
|
+
#
|
177
|
+
# @option params [required, String] :application_name
|
178
|
+
# Name of your existing Amazon Kinesis Analytics application to which
|
179
|
+
# you want to add the streaming source.
|
180
|
+
#
|
181
|
+
# @option params [required, Integer] :current_application_version_id
|
182
|
+
# Current version of your Amazon Kinesis Analytics application. You can
|
183
|
+
# use the DescribeApplication operation to find the current application
|
184
|
+
# version.
|
185
|
+
#
|
186
|
+
# @option params [required, Types::Input] :input
|
187
|
+
# When you configure the application input, you specify the streaming
|
188
|
+
# source, the in-application stream name that is created, and the
|
189
|
+
# mapping between the two. For more information, see [Configuring
|
190
|
+
# Application Input][1].
|
191
|
+
#
|
192
|
+
#
|
193
|
+
#
|
194
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
|
195
|
+
#
|
196
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
197
|
+
#
|
198
|
+
# @example Request syntax with placeholder values
|
199
|
+
#
|
200
|
+
# resp = client.add_application_input({
|
201
|
+
# application_name: "ApplicationName", # required
|
202
|
+
# current_application_version_id: 1, # required
|
203
|
+
# input: { # required
|
204
|
+
# name_prefix: "InAppStreamName", # required
|
205
|
+
# kinesis_streams_input: {
|
206
|
+
# resource_arn: "ResourceARN", # required
|
207
|
+
# role_arn: "RoleARN", # required
|
208
|
+
# },
|
209
|
+
# kinesis_firehose_input: {
|
210
|
+
# resource_arn: "ResourceARN", # required
|
211
|
+
# role_arn: "RoleARN", # required
|
212
|
+
# },
|
213
|
+
# input_parallelism: {
|
214
|
+
# count: 1,
|
215
|
+
# },
|
216
|
+
# input_schema: { # required
|
217
|
+
# record_format: { # required
|
218
|
+
# record_format_type: "JSON", # required, accepts JSON, CSV
|
219
|
+
# mapping_parameters: {
|
220
|
+
# json_mapping_parameters: {
|
221
|
+
# record_row_path: "RecordRowPath", # required
|
222
|
+
# },
|
223
|
+
# csv_mapping_parameters: {
|
224
|
+
# record_row_delimiter: "RecordRowDelimiter", # required
|
225
|
+
# record_column_delimiter: "RecordColumnDelimiter", # required
|
226
|
+
# },
|
227
|
+
# },
|
228
|
+
# },
|
229
|
+
# record_encoding: "RecordEncoding",
|
230
|
+
# record_columns: [ # required
|
231
|
+
# {
|
232
|
+
# name: "RecordColumnName", # required
|
233
|
+
# mapping: "RecordColumnMapping",
|
234
|
+
# sql_type: "RecordColumnSqlType", # required
|
235
|
+
# },
|
236
|
+
# ],
|
237
|
+
# },
|
238
|
+
# },
|
239
|
+
# })
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationInput AWS API Documentation
|
242
|
+
#
|
243
|
+
# @overload add_application_input(params = {})
|
244
|
+
# @param [Hash] params ({})
|
245
|
+
def add_application_input(params = {}, options = {})
|
246
|
+
req = build_request(:add_application_input, params)
|
247
|
+
req.send_request(options)
|
248
|
+
end
|
298
249
|
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
250
|
+
# Adds an external destination to your Amazon Kinesis Analytics
|
251
|
+
# application.
|
252
|
+
#
|
253
|
+
# If you want Amazon Kinesis Analytics to deliver data from an
|
254
|
+
# in-application stream within your application to an external
|
255
|
+
# destination (such as an Amazon Kinesis stream or a Firehose delivery
|
256
|
+
# stream), you add the relevant configuration to your application using
|
257
|
+
# this operation. You can configure one or more outputs for your
|
258
|
+
# application. Each output configuration maps an in-application stream
|
259
|
+
# and an external destination.
|
260
|
+
#
|
261
|
+
# You can use one of the output configurations to deliver data from your
|
262
|
+
# in-application error stream to an external destination so that you can
|
263
|
+
# analyze the errors. For conceptual information, see [Understanding
|
264
|
+
# Application Output (Destination)][1].
|
265
|
+
#
|
266
|
+
# Note that any configuration update, including adding a streaming
|
267
|
+
# source using this operation, results in a new version of the
|
268
|
+
# application. You can use the DescribeApplication operation to find the
|
269
|
+
# current application version.
|
270
|
+
#
|
271
|
+
# For the limits on the number of application inputs and outputs you can
|
272
|
+
# configure, see [Limits][2].
|
273
|
+
#
|
274
|
+
# This operation requires permissions to perform the
|
275
|
+
# `kinesisanalytics:AddApplicationOutput` action.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
#
|
279
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
|
280
|
+
# [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
|
281
|
+
#
|
282
|
+
# @option params [required, String] :application_name
|
283
|
+
# Name of the application to which you want to add the output
|
284
|
+
# configuration.
|
285
|
+
#
|
286
|
+
# @option params [required, Integer] :current_application_version_id
|
287
|
+
# Version of the application to which you want add the output
|
288
|
+
# configuration. You can use the DescribeApplication operation to get
|
289
|
+
# the current application version. If the version specified is not the
|
290
|
+
# current version, the `ConcurrentModificationException` is returned.
|
291
|
+
#
|
292
|
+
# @option params [required, Types::Output] :output
|
293
|
+
# An array of objects, each describing one output configuration. In the
|
294
|
+
# output configuration, you specify the name of an in-application
|
295
|
+
# stream, a destination (that is, an Amazon Kinesis stream or an Amazon
|
296
|
+
# Kinesis Firehose delivery stream), and record the formation to use
|
297
|
+
# when writing to the destination.
|
298
|
+
#
|
299
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
300
|
+
#
|
301
|
+
# @example Request syntax with placeholder values
|
302
|
+
#
|
303
|
+
# resp = client.add_application_output({
|
304
|
+
# application_name: "ApplicationName", # required
|
305
|
+
# current_application_version_id: 1, # required
|
306
|
+
# output: { # required
|
307
|
+
# name: "InAppStreamName", # required
|
308
|
+
# kinesis_streams_output: {
|
309
|
+
# resource_arn: "ResourceARN", # required
|
310
|
+
# role_arn: "RoleARN", # required
|
311
|
+
# },
|
312
|
+
# kinesis_firehose_output: {
|
313
|
+
# resource_arn: "ResourceARN", # required
|
314
|
+
# role_arn: "RoleARN", # required
|
315
|
+
# },
|
316
|
+
# destination_schema: { # required
|
317
|
+
# record_format_type: "JSON", # accepts JSON, CSV
|
318
|
+
# },
|
319
|
+
# },
|
320
|
+
# })
|
321
|
+
#
|
322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationOutput AWS API Documentation
|
323
|
+
#
|
324
|
+
# @overload add_application_output(params = {})
|
325
|
+
# @param [Hash] params ({})
|
326
|
+
def add_application_output(params = {}, options = {})
|
327
|
+
req = build_request(:add_application_output, params)
|
328
|
+
req.send_request(options)
|
329
|
+
end
|
377
330
|
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
# `ExampleOutputStream2`, then your application code must create these
|
465
|
-
# streams.
|
466
|
-
# @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
467
|
-
#
|
468
|
-
# * {Types::CreateApplicationResponse#application_summary #ApplicationSummary} => Types::ApplicationSummary
|
469
|
-
#
|
470
|
-
# @example Request syntax with placeholder values
|
471
|
-
# resp = client.create_application({
|
472
|
-
# application_name: "ApplicationName", # required
|
473
|
-
# application_description: "ApplicationDescription",
|
474
|
-
# inputs: [
|
475
|
-
# {
|
476
|
-
# name_prefix: "InAppStreamName", # required
|
477
|
-
# kinesis_streams_input: {
|
478
|
-
# resource_arn: "ResourceARN", # required
|
479
|
-
# role_arn: "RoleARN", # required
|
480
|
-
# },
|
481
|
-
# kinesis_firehose_input: {
|
482
|
-
# resource_arn: "ResourceARN", # required
|
483
|
-
# role_arn: "RoleARN", # required
|
484
|
-
# },
|
485
|
-
# input_parallelism: {
|
486
|
-
# count: 1,
|
487
|
-
# },
|
488
|
-
# input_schema: { # required
|
489
|
-
# record_format: { # required
|
490
|
-
# record_format_type: "JSON", # required, accepts JSON, CSV
|
491
|
-
# mapping_parameters: {
|
492
|
-
# json_mapping_parameters: {
|
493
|
-
# record_row_path: "RecordRowPath", # required
|
494
|
-
# },
|
495
|
-
# csv_mapping_parameters: {
|
496
|
-
# record_row_delimiter: "RecordRowDelimiter", # required
|
497
|
-
# record_column_delimiter: "RecordColumnDelimiter", # required
|
498
|
-
# },
|
499
|
-
# },
|
500
|
-
# },
|
501
|
-
# record_encoding: "RecordEncoding",
|
502
|
-
# record_columns: [ # required
|
503
|
-
# {
|
504
|
-
# name: "RecordColumnName", # required
|
505
|
-
# mapping: "RecordColumnMapping",
|
506
|
-
# sql_type: "RecordColumnSqlType", # required
|
507
|
-
# },
|
508
|
-
# ],
|
509
|
-
# },
|
510
|
-
# },
|
511
|
-
# ],
|
512
|
-
# outputs: [
|
513
|
-
# {
|
514
|
-
# name: "InAppStreamName", # required
|
515
|
-
# kinesis_streams_output: {
|
516
|
-
# resource_arn: "ResourceARN", # required
|
517
|
-
# role_arn: "RoleARN", # required
|
518
|
-
# },
|
519
|
-
# kinesis_firehose_output: {
|
520
|
-
# resource_arn: "ResourceARN", # required
|
521
|
-
# role_arn: "RoleARN", # required
|
522
|
-
# },
|
523
|
-
# destination_schema: { # required
|
524
|
-
# record_format_type: "JSON", # accepts JSON, CSV
|
525
|
-
# },
|
526
|
-
# },
|
527
|
-
# ],
|
528
|
-
# application_code: "ApplicationCode",
|
529
|
-
# })
|
530
|
-
#
|
531
|
-
# @example Response structure
|
532
|
-
# resp.application_summary.application_name #=> String
|
533
|
-
# resp.application_summary.application_arn #=> String
|
534
|
-
# resp.application_summary.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
|
535
|
-
# @overload create_application(params = {})
|
536
|
-
# @param [Hash] params ({})
|
537
|
-
def create_application(params = {}, options = {})
|
538
|
-
req = build_request(:create_application, params)
|
539
|
-
req.send_request(options)
|
540
|
-
end
|
331
|
+
# Adds a reference data source to an existing application.
|
332
|
+
#
|
333
|
+
# Amazon Kinesis Analytics reads reference data (that is, an Amazon S3
|
334
|
+
# object) and creates an in-application table within your application.
|
335
|
+
# In the request, you provide the source (S3 bucket name and object key
|
336
|
+
# name), name of the in-application table to create, and the necessary
|
337
|
+
# mapping information that describes how data in Amazon S3 object maps
|
338
|
+
# to columns in the resulting in-application table.
|
339
|
+
#
|
340
|
+
# For conceptual information, see [Configuring Application Input][1].
|
341
|
+
# For the limits on data sources you can add to your application, see
|
342
|
+
# [Limits][2].
|
343
|
+
#
|
344
|
+
# This operation requires permissions to perform the
|
345
|
+
# `kinesisanalytics:AddApplicationOutput` action.
|
346
|
+
#
|
347
|
+
#
|
348
|
+
#
|
349
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
|
350
|
+
# [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
|
351
|
+
#
|
352
|
+
# @option params [required, String] :application_name
|
353
|
+
# Name of an existing application.
|
354
|
+
#
|
355
|
+
# @option params [required, Integer] :current_application_version_id
|
356
|
+
# Version of the application for which you are adding the reference data
|
357
|
+
# source. You can use the DescribeApplication operation to get the
|
358
|
+
# current application version. If the version specified is not the
|
359
|
+
# current version, the `ConcurrentModificationException` is returned.
|
360
|
+
#
|
361
|
+
# @option params [required, Types::ReferenceDataSource] :reference_data_source
|
362
|
+
# The reference data source can be an object in your Amazon S3 bucket.
|
363
|
+
# Amazon Kinesis Analytics reads the object and copies the data into the
|
364
|
+
# in-application table that is created. You provide an S3 bucket, object
|
365
|
+
# key name, and the resulting in-application table that is created. You
|
366
|
+
# must also provide an IAM role with the necessary permissions that
|
367
|
+
# Amazon Kinesis Analytics can assume to read the object from your S3
|
368
|
+
# bucket on your behalf.
|
369
|
+
#
|
370
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
371
|
+
#
|
372
|
+
# @example Request syntax with placeholder values
|
373
|
+
#
|
374
|
+
# resp = client.add_application_reference_data_source({
|
375
|
+
# application_name: "ApplicationName", # required
|
376
|
+
# current_application_version_id: 1, # required
|
377
|
+
# reference_data_source: { # required
|
378
|
+
# table_name: "InAppTableName", # required
|
379
|
+
# s3_reference_data_source: {
|
380
|
+
# bucket_arn: "BucketARN", # required
|
381
|
+
# file_key: "FileKey", # required
|
382
|
+
# reference_role_arn: "RoleARN", # required
|
383
|
+
# },
|
384
|
+
# reference_schema: { # required
|
385
|
+
# record_format: { # required
|
386
|
+
# record_format_type: "JSON", # required, accepts JSON, CSV
|
387
|
+
# mapping_parameters: {
|
388
|
+
# json_mapping_parameters: {
|
389
|
+
# record_row_path: "RecordRowPath", # required
|
390
|
+
# },
|
391
|
+
# csv_mapping_parameters: {
|
392
|
+
# record_row_delimiter: "RecordRowDelimiter", # required
|
393
|
+
# record_column_delimiter: "RecordColumnDelimiter", # required
|
394
|
+
# },
|
395
|
+
# },
|
396
|
+
# },
|
397
|
+
# record_encoding: "RecordEncoding",
|
398
|
+
# record_columns: [ # required
|
399
|
+
# {
|
400
|
+
# name: "RecordColumnName", # required
|
401
|
+
# mapping: "RecordColumnMapping",
|
402
|
+
# sql_type: "RecordColumnSqlType", # required
|
403
|
+
# },
|
404
|
+
# ],
|
405
|
+
# },
|
406
|
+
# },
|
407
|
+
# })
|
408
|
+
#
|
409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource AWS API Documentation
|
410
|
+
#
|
411
|
+
# @overload add_application_reference_data_source(params = {})
|
412
|
+
# @param [Hash] params ({})
|
413
|
+
def add_application_reference_data_source(params = {}, options = {})
|
414
|
+
req = build_request(:add_application_reference_data_source, params)
|
415
|
+
req.send_request(options)
|
416
|
+
end
|
541
417
|
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
418
|
+
# Creates an Amazon Kinesis Analytics application. You can configure
|
419
|
+
# each application with one streaming source as input, application code
|
420
|
+
# to process the input, and up to five streaming destinations where you
|
421
|
+
# want Amazon Kinesis Analytics to write the output data from your
|
422
|
+
# application. For an overview, see [How it Works][1].
|
423
|
+
#
|
424
|
+
# In the input configuration, you map the streaming source to an
|
425
|
+
# in-application stream, which you can think of as a constantly updating
|
426
|
+
# table. In the mapping, you must provide a schema for the
|
427
|
+
# in-application stream and map each data column in the in-application
|
428
|
+
# stream to a data element in the streaming source, with the option of
|
429
|
+
# renaming, casting and dropping columns as desired.
|
430
|
+
#
|
431
|
+
# Your application code is one or more SQL statements that read input
|
432
|
+
# data, transform it, and generate output. Your application code can
|
433
|
+
# create one or more SQL artifacts like SQL streams or pumps.
|
434
|
+
#
|
435
|
+
# In the output configuration, you can configure the application to
|
436
|
+
# write data from in-application streams created in your applications to
|
437
|
+
# up to five streaming destinations.
|
438
|
+
#
|
439
|
+
# To read data from your source stream or write data to destination
|
440
|
+
# streams, Amazon Kinesis Analytics needs your permissions. You grant
|
441
|
+
# these permissions by creating IAM roles. This operation requires
|
442
|
+
# permissions to perform the `kinesisanalytics:CreateApplication`
|
443
|
+
# action.
|
444
|
+
#
|
445
|
+
# For introductory exercises to create an Amazon Kinesis Analytics
|
446
|
+
# application, see [Getting Started][2].
|
447
|
+
#
|
448
|
+
#
|
449
|
+
#
|
450
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html
|
451
|
+
# [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html
|
452
|
+
#
|
453
|
+
# @option params [required, String] :application_name
|
454
|
+
# Name of your Amazon Kinesis Analytics application (for example,
|
455
|
+
# `sample-app`).
|
456
|
+
#
|
457
|
+
# @option params [String] :application_description
|
458
|
+
# Summary description of the application.
|
459
|
+
#
|
460
|
+
# @option params [Array<Types::Input>] :inputs
|
461
|
+
# Use this parameter to configure the application input.
|
462
|
+
#
|
463
|
+
# You can configure your application to receive input from a single
|
464
|
+
# streaming source. In this configuration, you map this streaming source
|
465
|
+
# to an in-application stream that is created. Your application code can
|
466
|
+
# then query the in-application stream like a table (you can think of it
|
467
|
+
# as a constantly updating table).
|
468
|
+
#
|
469
|
+
# For the streaming source, you provide its Amazon Resource Name (ARN)
|
470
|
+
# and format of data on the stream (for example, JSON, CSV, etc). You
|
471
|
+
# also must provide an IAM role that Amazon Kinesis Analytics can assume
|
472
|
+
# to read this stream on your behalf.
|
473
|
+
#
|
474
|
+
# To create the in-application stream, you need to specify a schema to
|
475
|
+
# transform your data into a schematized version used in SQL. In the
|
476
|
+
# schema, you provide the necessary mapping of the data elements in the
|
477
|
+
# streaming source to record columns in the in-app stream.
|
478
|
+
#
|
479
|
+
# @option params [Array<Types::Output>] :outputs
|
480
|
+
# You can configure application output to write data from any of the
|
481
|
+
# in-application streams to up to five destinations.
|
482
|
+
#
|
483
|
+
# These destinations can be Amazon Kinesis streams, Amazon Kinesis
|
484
|
+
# Firehose delivery streams, or both.
|
485
|
+
#
|
486
|
+
# In the configuration, you specify the in-application stream name, the
|
487
|
+
# destination stream Amazon Resource Name (ARN), and the format to use
|
488
|
+
# when writing data. You must also provide an IAM role that Amazon
|
489
|
+
# Kinesis Analytics can assume to write to the destination stream on
|
490
|
+
# your behalf.
|
491
|
+
#
|
492
|
+
# In the output configuration, you also provide the output stream Amazon
|
493
|
+
# Resource Name (ARN) and the format of data in the stream (for example,
|
494
|
+
# JSON, CSV). You also must provide an IAM role that Amazon Kinesis
|
495
|
+
# Analytics can assume to write to this stream on your behalf.
|
496
|
+
#
|
497
|
+
# @option params [String] :application_code
|
498
|
+
# One or more SQL statements that read input data, transform it, and
|
499
|
+
# generate output. For example, you can write a SQL statement that reads
|
500
|
+
# input data and generates a running average of the number of
|
501
|
+
# advertisement clicks by vendor.
|
502
|
+
#
|
503
|
+
# You can also provide a series of SQL statements, where output of one
|
504
|
+
# statement can be used as the input for the next statement.
|
505
|
+
#
|
506
|
+
# Note that the application code must create the streams with names
|
507
|
+
# specified in the `Outputs`. For example, if your `Outputs` defines
|
508
|
+
# output streams named `ExampleOutputStream1` and
|
509
|
+
# `ExampleOutputStream2`, then your application code must create these
|
510
|
+
# streams.
|
511
|
+
#
|
512
|
+
# @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
513
|
+
#
|
514
|
+
# * {Types::CreateApplicationResponse#application_summary #application_summary} => Types::ApplicationSummary
|
515
|
+
#
|
516
|
+
# @example Request syntax with placeholder values
|
517
|
+
#
|
518
|
+
# resp = client.create_application({
|
519
|
+
# application_name: "ApplicationName", # required
|
520
|
+
# application_description: "ApplicationDescription",
|
521
|
+
# inputs: [
|
522
|
+
# {
|
523
|
+
# name_prefix: "InAppStreamName", # required
|
524
|
+
# kinesis_streams_input: {
|
525
|
+
# resource_arn: "ResourceARN", # required
|
526
|
+
# role_arn: "RoleARN", # required
|
527
|
+
# },
|
528
|
+
# kinesis_firehose_input: {
|
529
|
+
# resource_arn: "ResourceARN", # required
|
530
|
+
# role_arn: "RoleARN", # required
|
531
|
+
# },
|
532
|
+
# input_parallelism: {
|
533
|
+
# count: 1,
|
534
|
+
# },
|
535
|
+
# input_schema: { # required
|
536
|
+
# record_format: { # required
|
537
|
+
# record_format_type: "JSON", # required, accepts JSON, CSV
|
538
|
+
# mapping_parameters: {
|
539
|
+
# json_mapping_parameters: {
|
540
|
+
# record_row_path: "RecordRowPath", # required
|
541
|
+
# },
|
542
|
+
# csv_mapping_parameters: {
|
543
|
+
# record_row_delimiter: "RecordRowDelimiter", # required
|
544
|
+
# record_column_delimiter: "RecordColumnDelimiter", # required
|
545
|
+
# },
|
546
|
+
# },
|
547
|
+
# },
|
548
|
+
# record_encoding: "RecordEncoding",
|
549
|
+
# record_columns: [ # required
|
550
|
+
# {
|
551
|
+
# name: "RecordColumnName", # required
|
552
|
+
# mapping: "RecordColumnMapping",
|
553
|
+
# sql_type: "RecordColumnSqlType", # required
|
554
|
+
# },
|
555
|
+
# ],
|
556
|
+
# },
|
557
|
+
# },
|
558
|
+
# ],
|
559
|
+
# outputs: [
|
560
|
+
# {
|
561
|
+
# name: "InAppStreamName", # required
|
562
|
+
# kinesis_streams_output: {
|
563
|
+
# resource_arn: "ResourceARN", # required
|
564
|
+
# role_arn: "RoleARN", # required
|
565
|
+
# },
|
566
|
+
# kinesis_firehose_output: {
|
567
|
+
# resource_arn: "ResourceARN", # required
|
568
|
+
# role_arn: "RoleARN", # required
|
569
|
+
# },
|
570
|
+
# destination_schema: { # required
|
571
|
+
# record_format_type: "JSON", # accepts JSON, CSV
|
572
|
+
# },
|
573
|
+
# },
|
574
|
+
# ],
|
575
|
+
# application_code: "ApplicationCode",
|
576
|
+
# })
|
577
|
+
#
|
578
|
+
# @example Response structure
|
579
|
+
#
|
580
|
+
# resp.application_summary.application_name #=> String
|
581
|
+
# resp.application_summary.application_arn #=> String
|
582
|
+
# resp.application_summary.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/CreateApplication AWS API Documentation
|
585
|
+
#
|
586
|
+
# @overload create_application(params = {})
|
587
|
+
# @param [Hash] params ({})
|
588
|
+
def create_application(params = {}, options = {})
|
589
|
+
req = build_request(:create_application, params)
|
590
|
+
req.send_request(options)
|
591
|
+
end
|
566
592
|
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
def delete_application_output(params = {}, options = {})
|
599
|
-
req = build_request(:delete_application_output, params)
|
600
|
-
req.send_request(options)
|
601
|
-
end
|
593
|
+
# Deletes the specified application. Amazon Kinesis Analytics halts
|
594
|
+
# application execution and deletes the application, including any
|
595
|
+
# application artifacts (such as in-application streams, reference
|
596
|
+
# table, and application code).
|
597
|
+
#
|
598
|
+
# This operation requires permissions to perform the
|
599
|
+
# `kinesisanalytics:DeleteApplication` action.
|
600
|
+
#
|
601
|
+
# @option params [required, String] :application_name
|
602
|
+
# Name of the Amazon Kinesis Analytics application to delete.
|
603
|
+
#
|
604
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :create_timestamp
|
605
|
+
# You can use the `DescribeApplication` operation to get this value.
|
606
|
+
#
|
607
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
608
|
+
#
|
609
|
+
# @example Request syntax with placeholder values
|
610
|
+
#
|
611
|
+
# resp = client.delete_application({
|
612
|
+
# application_name: "ApplicationName", # required
|
613
|
+
# create_timestamp: Time.now, # required
|
614
|
+
# })
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplication AWS API Documentation
|
617
|
+
#
|
618
|
+
# @overload delete_application(params = {})
|
619
|
+
# @param [Hash] params ({})
|
620
|
+
def delete_application(params = {}, options = {})
|
621
|
+
req = build_request(:delete_application, params)
|
622
|
+
req.send_request(options)
|
623
|
+
end
|
602
624
|
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
625
|
+
# Deletes output destination configuration from your application
|
626
|
+
# configuration. Amazon Kinesis Analytics will no longer write data from
|
627
|
+
# the corresponding in-application stream to the external output
|
628
|
+
# destination.
|
629
|
+
#
|
630
|
+
# This operation requires permissions to perform the
|
631
|
+
# `kinesisanalytics:DeleteApplicationOutput` action.
|
632
|
+
#
|
633
|
+
# @option params [required, String] :application_name
|
634
|
+
# Amazon Kinesis Analytics application name.
|
635
|
+
#
|
636
|
+
# @option params [required, Integer] :current_application_version_id
|
637
|
+
# Amazon Kinesis Analytics application version. You can use the
|
638
|
+
# DescribeApplication operation to get the current application version.
|
639
|
+
# If the version specified is not the current version, the
|
640
|
+
# `ConcurrentModificationException` is returned.
|
641
|
+
#
|
642
|
+
# @option params [required, String] :output_id
|
643
|
+
# The ID of the configuration to delete. Each output configuration that
|
644
|
+
# is added to the application, either when the application is created or
|
645
|
+
# later using the AddApplicationOutput operation, has a unique ID. You
|
646
|
+
# need to provide the ID to uniquely identify the output configuration
|
647
|
+
# that you want to delete from the application configuration. You can
|
648
|
+
# use the DescribeApplication operation to get the specific `OutputId`.
|
649
|
+
#
|
650
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
651
|
+
#
|
652
|
+
# @example Request syntax with placeholder values
|
653
|
+
#
|
654
|
+
# resp = client.delete_application_output({
|
655
|
+
# application_name: "ApplicationName", # required
|
656
|
+
# current_application_version_id: 1, # required
|
657
|
+
# output_id: "Id", # required
|
658
|
+
# })
|
659
|
+
#
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationOutput AWS API Documentation
|
661
|
+
#
|
662
|
+
# @overload delete_application_output(params = {})
|
663
|
+
# @param [Hash] params ({})
|
664
|
+
def delete_application_output(params = {}, options = {})
|
665
|
+
req = build_request(:delete_application_output, params)
|
666
|
+
req.send_request(options)
|
667
|
+
end
|
638
668
|
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].name #=> String
|
683
|
-
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
|
684
|
-
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
|
685
|
-
# resp.application_detail.input_descriptions[0].input_parallelism.count #=> Integer
|
686
|
-
# resp.application_detail.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
|
687
|
-
# resp.application_detail.output_descriptions #=> Array
|
688
|
-
# resp.application_detail.output_descriptions[0].output_id #=> String
|
689
|
-
# resp.application_detail.output_descriptions[0].name #=> String
|
690
|
-
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
|
691
|
-
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
|
692
|
-
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
|
693
|
-
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
|
694
|
-
# resp.application_detail.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
|
695
|
-
# resp.application_detail.reference_data_source_descriptions #=> Array
|
696
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_id #=> String
|
697
|
-
# resp.application_detail.reference_data_source_descriptions[0].table_name #=> String
|
698
|
-
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
|
699
|
-
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
|
700
|
-
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
|
701
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
|
702
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
|
703
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
|
704
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
|
705
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
|
706
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
|
707
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
|
708
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
|
709
|
-
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
|
710
|
-
# resp.application_detail.application_code #=> String
|
711
|
-
# resp.application_detail.application_version_id #=> Integer
|
712
|
-
# @overload describe_application(params = {})
|
713
|
-
# @param [Hash] params ({})
|
714
|
-
def describe_application(params = {}, options = {})
|
715
|
-
req = build_request(:describe_application, params)
|
716
|
-
req.send_request(options)
|
717
|
-
end
|
669
|
+
# Deletes a reference data source configuration from the specified
|
670
|
+
# application configuration.
|
671
|
+
#
|
672
|
+
# If the application is running, Amazon Kinesis Analytics immediately
|
673
|
+
# removes the in-application table that you created using the
|
674
|
+
# AddApplicationReferenceDataSource operation.
|
675
|
+
#
|
676
|
+
# This operation requires permissions to perform the
|
677
|
+
# `kinesisanalytics.DeleteApplicationReferenceDataSource` action.
|
678
|
+
#
|
679
|
+
# @option params [required, String] :application_name
|
680
|
+
# Name of an existing application.
|
681
|
+
#
|
682
|
+
# @option params [required, Integer] :current_application_version_id
|
683
|
+
# Version of the application. You can use the DescribeApplication
|
684
|
+
# operation to get the current application version. If the version
|
685
|
+
# specified is not the current version, the
|
686
|
+
# `ConcurrentModificationException` is returned.
|
687
|
+
#
|
688
|
+
# @option params [required, String] :reference_id
|
689
|
+
# ID of the reference data source. When you add a reference data source
|
690
|
+
# to your application using the AddApplicationReferenceDataSource,
|
691
|
+
# Amazon Kinesis Analytics assigns an ID. You can use the
|
692
|
+
# DescribeApplication operation to get the reference ID.
|
693
|
+
#
|
694
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
695
|
+
#
|
696
|
+
# @example Request syntax with placeholder values
|
697
|
+
#
|
698
|
+
# resp = client.delete_application_reference_data_source({
|
699
|
+
# application_name: "ApplicationName", # required
|
700
|
+
# current_application_version_id: 1, # required
|
701
|
+
# reference_id: "Id", # required
|
702
|
+
# })
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource AWS API Documentation
|
705
|
+
#
|
706
|
+
# @overload delete_application_reference_data_source(params = {})
|
707
|
+
# @param [Hash] params ({})
|
708
|
+
def delete_application_reference_data_source(params = {}, options = {})
|
709
|
+
req = build_request(:delete_application_reference_data_source, params)
|
710
|
+
req.send_request(options)
|
711
|
+
end
|
718
712
|
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
713
|
+
# Returns information about a specific Amazon Kinesis Analytics
|
714
|
+
# application.
|
715
|
+
#
|
716
|
+
# If you want to retrieve a list of all applications in your account,
|
717
|
+
# use the ListApplications operation.
|
718
|
+
#
|
719
|
+
# This operation requires permissions to perform the
|
720
|
+
# `kinesisanalytics:DescribeApplication` action. You can use
|
721
|
+
# `DescribeApplication` to get the current application versionId, which
|
722
|
+
# you need to call other operations such as `Update`.
|
723
|
+
#
|
724
|
+
# @option params [required, String] :application_name
|
725
|
+
# Name of the application.
|
726
|
+
#
|
727
|
+
# @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
728
|
+
#
|
729
|
+
# * {Types::DescribeApplicationResponse#application_detail #application_detail} => Types::ApplicationDetail
|
730
|
+
#
|
731
|
+
# @example Request syntax with placeholder values
|
732
|
+
#
|
733
|
+
# resp = client.describe_application({
|
734
|
+
# application_name: "ApplicationName", # required
|
735
|
+
# })
|
736
|
+
#
|
737
|
+
# @example Response structure
|
738
|
+
#
|
739
|
+
# resp.application_detail.application_name #=> String
|
740
|
+
# resp.application_detail.application_description #=> String
|
741
|
+
# resp.application_detail.application_arn #=> String
|
742
|
+
# resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
|
743
|
+
# resp.application_detail.create_timestamp #=> Time
|
744
|
+
# resp.application_detail.last_update_timestamp #=> Time
|
745
|
+
# resp.application_detail.input_descriptions #=> Array
|
746
|
+
# resp.application_detail.input_descriptions[0].input_id #=> String
|
747
|
+
# resp.application_detail.input_descriptions[0].name_prefix #=> String
|
748
|
+
# resp.application_detail.input_descriptions[0].in_app_stream_names #=> Array
|
749
|
+
# resp.application_detail.input_descriptions[0].in_app_stream_names[0] #=> String
|
750
|
+
# resp.application_detail.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
|
751
|
+
# resp.application_detail.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
|
752
|
+
# resp.application_detail.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
|
753
|
+
# resp.application_detail.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
|
754
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
|
755
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
|
756
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
|
757
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
|
758
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_encoding #=> String
|
759
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_columns #=> Array
|
760
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].name #=> String
|
761
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
|
762
|
+
# resp.application_detail.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
|
763
|
+
# resp.application_detail.input_descriptions[0].input_parallelism.count #=> Integer
|
764
|
+
# resp.application_detail.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
|
765
|
+
# resp.application_detail.output_descriptions #=> Array
|
766
|
+
# resp.application_detail.output_descriptions[0].output_id #=> String
|
767
|
+
# resp.application_detail.output_descriptions[0].name #=> String
|
768
|
+
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
|
769
|
+
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
|
770
|
+
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
|
771
|
+
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
|
772
|
+
# resp.application_detail.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
|
773
|
+
# resp.application_detail.reference_data_source_descriptions #=> Array
|
774
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_id #=> String
|
775
|
+
# resp.application_detail.reference_data_source_descriptions[0].table_name #=> String
|
776
|
+
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
|
777
|
+
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
|
778
|
+
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
|
779
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
|
780
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
|
781
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
|
782
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
|
783
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
|
784
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
|
785
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
|
786
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
|
787
|
+
# resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
|
788
|
+
# resp.application_detail.application_code #=> String
|
789
|
+
# resp.application_detail.application_version_id #=> Integer
|
790
|
+
#
|
791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DescribeApplication AWS API Documentation
|
792
|
+
#
|
793
|
+
# @overload describe_application(params = {})
|
794
|
+
# @param [Hash] params ({})
|
795
|
+
def describe_application(params = {}, options = {})
|
796
|
+
req = build_request(:describe_application, params)
|
797
|
+
req.send_request(options)
|
798
|
+
end
|
781
799
|
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
800
|
+
# Infers a schema by evaluating sample records on the specified
|
801
|
+
# streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose
|
802
|
+
# delivery stream). In the response, the operation returns the inferred
|
803
|
+
# schema and also the sample records that the operation used to infer
|
804
|
+
# the schema.
|
805
|
+
#
|
806
|
+
# You can use the inferred schema when configuring a streaming source
|
807
|
+
# for your application. For conceptual information, see [Configuring
|
808
|
+
# Application Input][1]. Note that when you create an application using
|
809
|
+
# the Amazon Kinesis Analytics console, the console uses this operation
|
810
|
+
# to infer a schema and show it in the console user interface.
|
811
|
+
#
|
812
|
+
# This operation requires permissions to perform the
|
813
|
+
# `kinesisanalytics:DiscoverInputSchema` action.
|
814
|
+
#
|
815
|
+
#
|
816
|
+
#
|
817
|
+
# [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
|
818
|
+
#
|
819
|
+
# @option params [required, String] :resource_arn
|
820
|
+
# Amazon Resource Name (ARN) of the streaming source.
|
821
|
+
#
|
822
|
+
# @option params [required, String] :role_arn
|
823
|
+
# ARN of the IAM role that Amazon Kinesis Analytics can assume to access
|
824
|
+
# the stream on your behalf.
|
825
|
+
#
|
826
|
+
# @option params [required, Types::InputStartingPositionConfiguration] :input_starting_position_configuration
|
827
|
+
# Point at which you want Amazon Kinesis Analytics to start reading
|
828
|
+
# records from the specified streaming source discovery purposes.
|
829
|
+
#
|
830
|
+
# @return [Types::DiscoverInputSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
831
|
+
#
|
832
|
+
# * {Types::DiscoverInputSchemaResponse#input_schema #input_schema} => Types::SourceSchema
|
833
|
+
# * {Types::DiscoverInputSchemaResponse#parsed_input_records #parsed_input_records} => Array<Array<String>>
|
834
|
+
# * {Types::DiscoverInputSchemaResponse#raw_input_records #raw_input_records} => Array<String>
|
835
|
+
#
|
836
|
+
# @example Request syntax with placeholder values
|
837
|
+
#
|
838
|
+
# resp = client.discover_input_schema({
|
839
|
+
# resource_arn: "ResourceARN", # required
|
840
|
+
# role_arn: "RoleARN", # required
|
841
|
+
# input_starting_position_configuration: { # required
|
842
|
+
# input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
|
843
|
+
# },
|
844
|
+
# })
|
845
|
+
#
|
846
|
+
# @example Response structure
|
847
|
+
#
|
848
|
+
# resp.input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
|
849
|
+
# resp.input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
|
850
|
+
# resp.input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
|
851
|
+
# resp.input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
|
852
|
+
# resp.input_schema.record_encoding #=> String
|
853
|
+
# resp.input_schema.record_columns #=> Array
|
854
|
+
# resp.input_schema.record_columns[0].name #=> String
|
855
|
+
# resp.input_schema.record_columns[0].mapping #=> String
|
856
|
+
# resp.input_schema.record_columns[0].sql_type #=> String
|
857
|
+
# resp.parsed_input_records #=> Array
|
858
|
+
# resp.parsed_input_records[0] #=> Array
|
859
|
+
# resp.parsed_input_records[0][0] #=> String
|
860
|
+
# resp.raw_input_records #=> Array
|
861
|
+
# resp.raw_input_records[0] #=> String
|
862
|
+
#
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DiscoverInputSchema AWS API Documentation
|
864
|
+
#
|
865
|
+
# @overload discover_input_schema(params = {})
|
866
|
+
# @param [Hash] params ({})
|
867
|
+
def discover_input_schema(params = {}, options = {})
|
868
|
+
req = build_request(:discover_input_schema, params)
|
869
|
+
req.send_request(options)
|
870
|
+
end
|
826
871
|
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
872
|
+
# Returns a list of Amazon Kinesis Analytics applications in your
|
873
|
+
# account. For each application, the response includes the application
|
874
|
+
# name, Amazon Resource Name (ARN), and status. If the response returns
|
875
|
+
# the `HasMoreApplications` value as true, you can send another request
|
876
|
+
# by adding the `ExclusiveStartApplicationName` in the request body, and
|
877
|
+
# set the value of this to the last application name from the previous
|
878
|
+
# response.
|
879
|
+
#
|
880
|
+
# If you want detailed information about a specific application, use
|
881
|
+
# DescribeApplication.
|
882
|
+
#
|
883
|
+
# This operation requires permissions to perform the
|
884
|
+
# `kinesisanalytics:ListApplications` action.
|
885
|
+
#
|
886
|
+
# @option params [Integer] :limit
|
887
|
+
# Maximum number of applications to list.
|
888
|
+
#
|
889
|
+
# @option params [String] :exclusive_start_application_name
|
890
|
+
# Name of the application to start the list with. When using pagination
|
891
|
+
# to retrieve the list, you don't need to specify this parameter in the
|
892
|
+
# first request. However, in subsequent requests, you add the last
|
893
|
+
# application name from the previous response to get the next page of
|
894
|
+
# applications.
|
895
|
+
#
|
896
|
+
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
897
|
+
#
|
898
|
+
# * {Types::ListApplicationsResponse#application_summaries #application_summaries} => Array<Types::ApplicationSummary>
|
899
|
+
# * {Types::ListApplicationsResponse#has_more_applications #has_more_applications} => Boolean
|
900
|
+
#
|
901
|
+
# @example Request syntax with placeholder values
|
902
|
+
#
|
903
|
+
# resp = client.list_applications({
|
904
|
+
# limit: 1,
|
905
|
+
# exclusive_start_application_name: "ApplicationName",
|
906
|
+
# })
|
907
|
+
#
|
908
|
+
# @example Response structure
|
909
|
+
#
|
910
|
+
# resp.application_summaries #=> Array
|
911
|
+
# resp.application_summaries[0].application_name #=> String
|
912
|
+
# resp.application_summaries[0].application_arn #=> String
|
913
|
+
# resp.application_summaries[0].application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
|
914
|
+
# resp.has_more_applications #=> Boolean
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListApplications AWS API Documentation
|
917
|
+
#
|
918
|
+
# @overload list_applications(params = {})
|
919
|
+
# @param [Hash] params ({})
|
920
|
+
def list_applications(params = {}, options = {})
|
921
|
+
req = build_request(:list_applications, params)
|
922
|
+
req.send_request(options)
|
923
|
+
end
|
870
924
|
|
871
|
-
|
872
|
-
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
|
925
|
+
# Starts the specified Amazon Kinesis Analytics application. After
|
926
|
+
# creating an application, you must exclusively call this operation to
|
927
|
+
# start your application.
|
928
|
+
#
|
929
|
+
# After the application starts, it begins consuming the input data,
|
930
|
+
# processes it, and writes the output to the configured destination.
|
931
|
+
#
|
932
|
+
# The application status must be `READY` for you to start an
|
933
|
+
# application. You can get the application status in the console or
|
934
|
+
# using the DescribeApplication operation.
|
935
|
+
#
|
936
|
+
# After you start the application, you can stop the application from
|
937
|
+
# processing the input by calling the StopApplication operation.
|
938
|
+
#
|
939
|
+
# This operation requires permissions to perform the
|
940
|
+
# `kinesisanalytics:StartApplication` action.
|
941
|
+
#
|
942
|
+
# @option params [required, String] :application_name
|
943
|
+
# Name of the application.
|
944
|
+
#
|
945
|
+
# @option params [required, Array<Types::InputConfiguration>] :input_configurations
|
946
|
+
# Identifies the specific input, by ID, that the application starts
|
947
|
+
# consuming. Amazon Kinesis Analytics starts reading the streaming
|
948
|
+
# source associated with the input. You can also specify where in the
|
949
|
+
# streaming source you want Amazon Kinesis Analytics to start reading.
|
950
|
+
#
|
951
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
952
|
+
#
|
953
|
+
# @example Request syntax with placeholder values
|
954
|
+
#
|
955
|
+
# resp = client.start_application({
|
956
|
+
# application_name: "ApplicationName", # required
|
957
|
+
# input_configurations: [ # required
|
958
|
+
# {
|
959
|
+
# id: "Id", # required
|
960
|
+
# input_starting_position_configuration: { # required
|
961
|
+
# input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
|
962
|
+
# },
|
963
|
+
# },
|
964
|
+
# ],
|
965
|
+
# })
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/StartApplication AWS API Documentation
|
968
|
+
#
|
969
|
+
# @overload start_application(params = {})
|
970
|
+
# @param [Hash] params ({})
|
971
|
+
def start_application(params = {}, options = {})
|
972
|
+
req = build_request(:start_application, params)
|
973
|
+
req.send_request(options)
|
974
|
+
end
|
894
975
|
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
# role_arn_update: "RoleARN",
|
925
|
-
# },
|
926
|
-
# kinesis_firehose_input_update: {
|
927
|
-
# resource_arn_update: "ResourceARN",
|
928
|
-
# role_arn_update: "RoleARN",
|
929
|
-
# },
|
930
|
-
# input_schema_update: {
|
931
|
-
# record_format_update: {
|
932
|
-
# record_format_type: "JSON", # required, accepts JSON, CSV
|
933
|
-
# mapping_parameters: {
|
934
|
-
# json_mapping_parameters: {
|
935
|
-
# record_row_path: "RecordRowPath", # required
|
936
|
-
# },
|
937
|
-
# csv_mapping_parameters: {
|
938
|
-
# record_row_delimiter: "RecordRowDelimiter", # required
|
939
|
-
# record_column_delimiter: "RecordColumnDelimiter", # required
|
940
|
-
# },
|
941
|
-
# },
|
942
|
-
# },
|
943
|
-
# record_encoding_update: "RecordEncoding",
|
944
|
-
# record_column_updates: [
|
945
|
-
# {
|
946
|
-
# name: "RecordColumnName", # required
|
947
|
-
# mapping: "RecordColumnMapping",
|
948
|
-
# sql_type: "RecordColumnSqlType", # required
|
949
|
-
# },
|
950
|
-
# ],
|
951
|
-
# },
|
952
|
-
# input_parallelism_update: {
|
953
|
-
# count_update: 1,
|
954
|
-
# },
|
955
|
-
# },
|
956
|
-
# ],
|
957
|
-
# application_code_update: "ApplicationCode",
|
958
|
-
# output_updates: [
|
959
|
-
# {
|
960
|
-
# output_id: "Id", # required
|
961
|
-
# name_update: "InAppStreamName",
|
962
|
-
# kinesis_streams_output_update: {
|
963
|
-
# resource_arn_update: "ResourceARN",
|
964
|
-
# role_arn_update: "RoleARN",
|
965
|
-
# },
|
966
|
-
# kinesis_firehose_output_update: {
|
967
|
-
# resource_arn_update: "ResourceARN",
|
968
|
-
# role_arn_update: "RoleARN",
|
969
|
-
# },
|
970
|
-
# destination_schema_update: {
|
971
|
-
# record_format_type: "JSON", # accepts JSON, CSV
|
972
|
-
# },
|
973
|
-
# },
|
974
|
-
# ],
|
975
|
-
# reference_data_source_updates: [
|
976
|
-
# {
|
977
|
-
# reference_id: "Id", # required
|
978
|
-
# table_name_update: "InAppTableName",
|
979
|
-
# s3_reference_data_source_update: {
|
980
|
-
# bucket_arn_update: "BucketARN",
|
981
|
-
# file_key_update: "FileKey",
|
982
|
-
# reference_role_arn_update: "RoleARN",
|
983
|
-
# },
|
984
|
-
# reference_schema_update: {
|
985
|
-
# record_format: { # required
|
986
|
-
# record_format_type: "JSON", # required, accepts JSON, CSV
|
987
|
-
# mapping_parameters: {
|
988
|
-
# json_mapping_parameters: {
|
989
|
-
# record_row_path: "RecordRowPath", # required
|
990
|
-
# },
|
991
|
-
# csv_mapping_parameters: {
|
992
|
-
# record_row_delimiter: "RecordRowDelimiter", # required
|
993
|
-
# record_column_delimiter: "RecordColumnDelimiter", # required
|
994
|
-
# },
|
995
|
-
# },
|
996
|
-
# },
|
997
|
-
# record_encoding: "RecordEncoding",
|
998
|
-
# record_columns: [ # required
|
999
|
-
# {
|
1000
|
-
# name: "RecordColumnName", # required
|
1001
|
-
# mapping: "RecordColumnMapping",
|
1002
|
-
# sql_type: "RecordColumnSqlType", # required
|
1003
|
-
# },
|
1004
|
-
# ],
|
1005
|
-
# },
|
1006
|
-
# },
|
1007
|
-
# ],
|
1008
|
-
# },
|
1009
|
-
# })
|
1010
|
-
# @overload update_application(params = {})
|
1011
|
-
# @param [Hash] params ({})
|
1012
|
-
def update_application(params = {}, options = {})
|
1013
|
-
req = build_request(:update_application, params)
|
1014
|
-
req.send_request(options)
|
1015
|
-
end
|
976
|
+
# Stops the application from processing input data. You can stop an
|
977
|
+
# application only if it is in the running state. You can use the
|
978
|
+
# DescribeApplication operation to find the application state. After the
|
979
|
+
# application is stopped, Amazon Kinesis Analytics stops reading data
|
980
|
+
# from the input, the application stops processing data, and there is no
|
981
|
+
# output written to the destination.
|
982
|
+
#
|
983
|
+
# This operation requires permissions to perform the
|
984
|
+
# `kinesisanalytics:StopApplication` action.
|
985
|
+
#
|
986
|
+
# @option params [required, String] :application_name
|
987
|
+
# Name of the running application to stop.
|
988
|
+
#
|
989
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
990
|
+
#
|
991
|
+
# @example Request syntax with placeholder values
|
992
|
+
#
|
993
|
+
# resp = client.stop_application({
|
994
|
+
# application_name: "ApplicationName", # required
|
995
|
+
# })
|
996
|
+
#
|
997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/StopApplication AWS API Documentation
|
998
|
+
#
|
999
|
+
# @overload stop_application(params = {})
|
1000
|
+
# @param [Hash] params ({})
|
1001
|
+
def stop_application(params = {}, options = {})
|
1002
|
+
req = build_request(:stop_application, params)
|
1003
|
+
req.send_request(options)
|
1004
|
+
end
|
1016
1005
|
|
1017
|
-
|
1006
|
+
# Updates an existing Kinesis Analytics application. Using this API, you
|
1007
|
+
# can update application code, input configuration, and output
|
1008
|
+
# configuration.
|
1009
|
+
#
|
1010
|
+
# Note that Kinesis Analytics updates the `CurrentApplicationVersionId`
|
1011
|
+
# each time you update your application.
|
1012
|
+
#
|
1013
|
+
# This opeation requires permission for the
|
1014
|
+
# `kinesisanalytics:UpdateApplication` action.
|
1015
|
+
#
|
1016
|
+
# @option params [required, String] :application_name
|
1017
|
+
# Name of the Kinesis Analytics application to update.
|
1018
|
+
#
|
1019
|
+
# @option params [required, Integer] :current_application_version_id
|
1020
|
+
# The current application version ID. You can use the
|
1021
|
+
# DescribeApplication operation to get this value.
|
1022
|
+
#
|
1023
|
+
# @option params [required, Types::ApplicationUpdate] :application_update
|
1024
|
+
# Describes application updates.
|
1025
|
+
#
|
1026
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1027
|
+
#
|
1028
|
+
# @example Request syntax with placeholder values
|
1029
|
+
#
|
1030
|
+
# resp = client.update_application({
|
1031
|
+
# application_name: "ApplicationName", # required
|
1032
|
+
# current_application_version_id: 1, # required
|
1033
|
+
# application_update: { # required
|
1034
|
+
# input_updates: [
|
1035
|
+
# {
|
1036
|
+
# input_id: "Id", # required
|
1037
|
+
# name_prefix_update: "InAppStreamName",
|
1038
|
+
# kinesis_streams_input_update: {
|
1039
|
+
# resource_arn_update: "ResourceARN",
|
1040
|
+
# role_arn_update: "RoleARN",
|
1041
|
+
# },
|
1042
|
+
# kinesis_firehose_input_update: {
|
1043
|
+
# resource_arn_update: "ResourceARN",
|
1044
|
+
# role_arn_update: "RoleARN",
|
1045
|
+
# },
|
1046
|
+
# input_schema_update: {
|
1047
|
+
# record_format_update: {
|
1048
|
+
# record_format_type: "JSON", # required, accepts JSON, CSV
|
1049
|
+
# mapping_parameters: {
|
1050
|
+
# json_mapping_parameters: {
|
1051
|
+
# record_row_path: "RecordRowPath", # required
|
1052
|
+
# },
|
1053
|
+
# csv_mapping_parameters: {
|
1054
|
+
# record_row_delimiter: "RecordRowDelimiter", # required
|
1055
|
+
# record_column_delimiter: "RecordColumnDelimiter", # required
|
1056
|
+
# },
|
1057
|
+
# },
|
1058
|
+
# },
|
1059
|
+
# record_encoding_update: "RecordEncoding",
|
1060
|
+
# record_column_updates: [
|
1061
|
+
# {
|
1062
|
+
# name: "RecordColumnName", # required
|
1063
|
+
# mapping: "RecordColumnMapping",
|
1064
|
+
# sql_type: "RecordColumnSqlType", # required
|
1065
|
+
# },
|
1066
|
+
# ],
|
1067
|
+
# },
|
1068
|
+
# input_parallelism_update: {
|
1069
|
+
# count_update: 1,
|
1070
|
+
# },
|
1071
|
+
# },
|
1072
|
+
# ],
|
1073
|
+
# application_code_update: "ApplicationCode",
|
1074
|
+
# output_updates: [
|
1075
|
+
# {
|
1076
|
+
# output_id: "Id", # required
|
1077
|
+
# name_update: "InAppStreamName",
|
1078
|
+
# kinesis_streams_output_update: {
|
1079
|
+
# resource_arn_update: "ResourceARN",
|
1080
|
+
# role_arn_update: "RoleARN",
|
1081
|
+
# },
|
1082
|
+
# kinesis_firehose_output_update: {
|
1083
|
+
# resource_arn_update: "ResourceARN",
|
1084
|
+
# role_arn_update: "RoleARN",
|
1085
|
+
# },
|
1086
|
+
# destination_schema_update: {
|
1087
|
+
# record_format_type: "JSON", # accepts JSON, CSV
|
1088
|
+
# },
|
1089
|
+
# },
|
1090
|
+
# ],
|
1091
|
+
# reference_data_source_updates: [
|
1092
|
+
# {
|
1093
|
+
# reference_id: "Id", # required
|
1094
|
+
# table_name_update: "InAppTableName",
|
1095
|
+
# s3_reference_data_source_update: {
|
1096
|
+
# bucket_arn_update: "BucketARN",
|
1097
|
+
# file_key_update: "FileKey",
|
1098
|
+
# reference_role_arn_update: "RoleARN",
|
1099
|
+
# },
|
1100
|
+
# reference_schema_update: {
|
1101
|
+
# record_format: { # required
|
1102
|
+
# record_format_type: "JSON", # required, accepts JSON, CSV
|
1103
|
+
# mapping_parameters: {
|
1104
|
+
# json_mapping_parameters: {
|
1105
|
+
# record_row_path: "RecordRowPath", # required
|
1106
|
+
# },
|
1107
|
+
# csv_mapping_parameters: {
|
1108
|
+
# record_row_delimiter: "RecordRowDelimiter", # required
|
1109
|
+
# record_column_delimiter: "RecordColumnDelimiter", # required
|
1110
|
+
# },
|
1111
|
+
# },
|
1112
|
+
# },
|
1113
|
+
# record_encoding: "RecordEncoding",
|
1114
|
+
# record_columns: [ # required
|
1115
|
+
# {
|
1116
|
+
# name: "RecordColumnName", # required
|
1117
|
+
# mapping: "RecordColumnMapping",
|
1118
|
+
# sql_type: "RecordColumnSqlType", # required
|
1119
|
+
# },
|
1120
|
+
# ],
|
1121
|
+
# },
|
1122
|
+
# },
|
1123
|
+
# ],
|
1124
|
+
# },
|
1125
|
+
# })
|
1126
|
+
#
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/UpdateApplication AWS API Documentation
|
1128
|
+
#
|
1129
|
+
# @overload update_application(params = {})
|
1130
|
+
# @param [Hash] params ({})
|
1131
|
+
def update_application(params = {}, options = {})
|
1132
|
+
req = build_request(:update_application, params)
|
1133
|
+
req.send_request(options)
|
1134
|
+
end
|
1018
1135
|
|
1019
|
-
|
1020
|
-
# @api private
|
1021
|
-
def build_request(operation_name, params = {})
|
1022
|
-
handlers = @handlers.for(operation_name)
|
1023
|
-
context = Seahorse::Client::RequestContext.new(
|
1024
|
-
operation_name: operation_name,
|
1025
|
-
operation: config.api.operation(operation_name),
|
1026
|
-
client: self,
|
1027
|
-
params: params,
|
1028
|
-
config: config)
|
1029
|
-
context[:gem_name] = 'aws-sdk-kinesisanalytics'
|
1030
|
-
context[:gem_version] = '1.0.0.rc1'
|
1031
|
-
Seahorse::Client::Request.new(handlers, context)
|
1032
|
-
end
|
1136
|
+
# @!endgroup
|
1033
1137
|
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1138
|
+
# @param params ({})
|
1139
|
+
# @api private
|
1140
|
+
def build_request(operation_name, params = {})
|
1141
|
+
handlers = @handlers.for(operation_name)
|
1142
|
+
context = Seahorse::Client::RequestContext.new(
|
1143
|
+
operation_name: operation_name,
|
1144
|
+
operation: config.api.operation(operation_name),
|
1145
|
+
client: self,
|
1146
|
+
params: params,
|
1147
|
+
config: config)
|
1148
|
+
context[:gem_name] = 'aws-sdk-kinesisanalytics'
|
1149
|
+
context[:gem_version] = '1.0.0.rc2'
|
1150
|
+
Seahorse::Client::Request.new(handlers, context)
|
1151
|
+
end
|
1039
1152
|
|
1040
|
-
|
1153
|
+
# @api private
|
1154
|
+
# @deprecated
|
1155
|
+
def waiter_names
|
1156
|
+
[]
|
1157
|
+
end
|
1041
1158
|
|
1042
|
-
|
1043
|
-
attr_reader :identifier
|
1159
|
+
class << self
|
1044
1160
|
|
1045
|
-
|
1046
|
-
|
1047
|
-
Errors
|
1048
|
-
end
|
1161
|
+
# @api private
|
1162
|
+
attr_reader :identifier
|
1049
1163
|
|
1164
|
+
# @api private
|
1165
|
+
def errors_module
|
1166
|
+
Errors
|
1050
1167
|
end
|
1168
|
+
|
1051
1169
|
end
|
1052
1170
|
end
|
1053
1171
|
end
|