aws-sdk-appfabric 1.0.0
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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-appfabric/client.rb +1753 -0
- data/lib/aws-sdk-appfabric/client_api.rb +929 -0
- data/lib/aws-sdk-appfabric/customizations.rb +0 -0
- data/lib/aws-sdk-appfabric/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-appfabric/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-appfabric/endpoints.rb +380 -0
- data/lib/aws-sdk-appfabric/errors.rb +232 -0
- data/lib/aws-sdk-appfabric/plugins/endpoints.rb +120 -0
- data/lib/aws-sdk-appfabric/resource.rb +26 -0
- data/lib/aws-sdk-appfabric/types.rb +1987 -0
- data/lib/aws-sdk-appfabric/waiters.rb +15 -0
- data/lib/aws-sdk-appfabric.rb +58 -0
- metadata +95 -0
@@ -0,0 +1,1753 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:appfabric)
|
37
|
+
|
38
|
+
module Aws::AppFabric
|
39
|
+
# An API client for AppFabric. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::AppFabric::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :appfabric
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::AppFabric::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :sdk_ua_app_id
|
279
|
+
# A unique and opaque application ID that is appended to the
|
280
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
281
|
+
# maximum length of 50.
|
282
|
+
#
|
283
|
+
# @option options [String] :secret_access_key
|
284
|
+
#
|
285
|
+
# @option options [String] :session_token
|
286
|
+
#
|
287
|
+
# @option options [Boolean] :stub_responses (false)
|
288
|
+
# Causes the client to return stubbed responses. By default
|
289
|
+
# fake responses are generated and returned. You can specify
|
290
|
+
# the response data to return or errors to raise by calling
|
291
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
292
|
+
#
|
293
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
294
|
+
# requests are made, and retries are disabled.
|
295
|
+
#
|
296
|
+
# @option options [Aws::TokenProvider] :token_provider
|
297
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
298
|
+
# following classes:
|
299
|
+
#
|
300
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
301
|
+
# tokens.
|
302
|
+
#
|
303
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
304
|
+
# access token generated from `aws login`.
|
305
|
+
#
|
306
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
307
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
308
|
+
#
|
309
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
310
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
311
|
+
# will be used if available.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :use_fips_endpoint
|
314
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
315
|
+
# When a `fips` region is used, the region is normalized and this config
|
316
|
+
# is set to `true`.
|
317
|
+
#
|
318
|
+
# @option options [Boolean] :validate_params (true)
|
319
|
+
# When `true`, request parameters are validated before
|
320
|
+
# sending the request.
|
321
|
+
#
|
322
|
+
# @option options [Aws::AppFabric::EndpointProvider] :endpoint_provider
|
323
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::AppFabric::EndpointParameters`
|
324
|
+
#
|
325
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
326
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
327
|
+
#
|
328
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
329
|
+
# seconds to wait when opening a HTTP session before raising a
|
330
|
+
# `Timeout::Error`.
|
331
|
+
#
|
332
|
+
# @option options [Float] :http_read_timeout (60) The default
|
333
|
+
# number of seconds to wait for response data. This value can
|
334
|
+
# safely be set per-request on the session.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
337
|
+
# seconds a connection is allowed to sit idle before it is
|
338
|
+
# considered stale. Stale connections are closed and removed
|
339
|
+
# from the pool before making a request.
|
340
|
+
#
|
341
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
342
|
+
# seconds to wait for a 100-continue response before sending the
|
343
|
+
# request body. This option has no effect unless the request has
|
344
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
345
|
+
# disables this behaviour. This value can safely be set per
|
346
|
+
# request on the session.
|
347
|
+
#
|
348
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
349
|
+
# in seconds.
|
350
|
+
#
|
351
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
352
|
+
# HTTP debug output will be sent to the `:logger`.
|
353
|
+
#
|
354
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
355
|
+
# SSL peer certificates are verified when establishing a
|
356
|
+
# connection.
|
357
|
+
#
|
358
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
359
|
+
# certificate authority bundle file that should be used when
|
360
|
+
# verifying peer certificates. If you do not pass
|
361
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
362
|
+
# will be used if available.
|
363
|
+
#
|
364
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
365
|
+
# directory that contains the unbundled SSL certificate
|
366
|
+
# authority files for verifying peer certificates. If you do
|
367
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
368
|
+
# system default will be used if available.
|
369
|
+
#
|
370
|
+
def initialize(*args)
|
371
|
+
super
|
372
|
+
end
|
373
|
+
|
374
|
+
# @!group API Operations
|
375
|
+
|
376
|
+
# Gets user access details in a batch request.
|
377
|
+
#
|
378
|
+
# This action polls data from the tasks that are kicked off by the
|
379
|
+
# `StartUserAccessTasks` action.
|
380
|
+
#
|
381
|
+
# @option params [required, String] :app_bundle_identifier
|
382
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
383
|
+
# of the app bundle to use for the request.
|
384
|
+
#
|
385
|
+
# @option params [required, Array<String>] :task_id_list
|
386
|
+
# The tasks IDs to use for the request.
|
387
|
+
#
|
388
|
+
# @return [Types::BatchGetUserAccessTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
389
|
+
#
|
390
|
+
# * {Types::BatchGetUserAccessTasksResponse#user_access_results_list #user_access_results_list} => Array<Types::UserAccessResultItem>
|
391
|
+
#
|
392
|
+
# @example Request syntax with placeholder values
|
393
|
+
#
|
394
|
+
# resp = client.batch_get_user_access_tasks({
|
395
|
+
# app_bundle_identifier: "Identifier", # required
|
396
|
+
# task_id_list: ["UUID"], # required
|
397
|
+
# })
|
398
|
+
#
|
399
|
+
# @example Response structure
|
400
|
+
#
|
401
|
+
# resp.user_access_results_list #=> Array
|
402
|
+
# resp.user_access_results_list[0].app #=> String
|
403
|
+
# resp.user_access_results_list[0].tenant_id #=> String
|
404
|
+
# resp.user_access_results_list[0].tenant_display_name #=> String
|
405
|
+
# resp.user_access_results_list[0].task_id #=> String
|
406
|
+
# resp.user_access_results_list[0].result_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "EXPIRED"
|
407
|
+
# resp.user_access_results_list[0].email #=> String
|
408
|
+
# resp.user_access_results_list[0].user_id #=> String
|
409
|
+
# resp.user_access_results_list[0].user_full_name #=> String
|
410
|
+
# resp.user_access_results_list[0].user_first_name #=> String
|
411
|
+
# resp.user_access_results_list[0].user_last_name #=> String
|
412
|
+
# resp.user_access_results_list[0].user_status #=> String
|
413
|
+
# resp.user_access_results_list[0].task_error.error_code #=> String
|
414
|
+
# resp.user_access_results_list[0].task_error.error_message #=> String
|
415
|
+
#
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/BatchGetUserAccessTasks AWS API Documentation
|
417
|
+
#
|
418
|
+
# @overload batch_get_user_access_tasks(params = {})
|
419
|
+
# @param [Hash] params ({})
|
420
|
+
def batch_get_user_access_tasks(params = {}, options = {})
|
421
|
+
req = build_request(:batch_get_user_access_tasks, params)
|
422
|
+
req.send_request(options)
|
423
|
+
end
|
424
|
+
|
425
|
+
# Establishes a connection between Amazon Web Services AppFabric and an
|
426
|
+
# application, which allows AppFabric to call the APIs of the
|
427
|
+
# application.
|
428
|
+
#
|
429
|
+
# @option params [required, String] :app_bundle_identifier
|
430
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
431
|
+
# of the app bundle that contains the app authorization to use for the
|
432
|
+
# request.
|
433
|
+
#
|
434
|
+
# @option params [required, String] :app_authorization_identifier
|
435
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
436
|
+
# of the app authorization to use for the request.
|
437
|
+
#
|
438
|
+
# @option params [Types::AuthRequest] :auth_request
|
439
|
+
# Contains OAuth2 authorization information.
|
440
|
+
#
|
441
|
+
# This is required if the app authorization for the request is
|
442
|
+
# configured with an OAuth2 (`oauth2`) authorization type.
|
443
|
+
#
|
444
|
+
# @return [Types::ConnectAppAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
445
|
+
#
|
446
|
+
# * {Types::ConnectAppAuthorizationResponse#app_authorization_summary #app_authorization_summary} => Types::AppAuthorizationSummary
|
447
|
+
#
|
448
|
+
# @example Request syntax with placeholder values
|
449
|
+
#
|
450
|
+
# resp = client.connect_app_authorization({
|
451
|
+
# app_bundle_identifier: "Identifier", # required
|
452
|
+
# app_authorization_identifier: "Identifier", # required
|
453
|
+
# auth_request: {
|
454
|
+
# redirect_uri: "RedirectUri", # required
|
455
|
+
# code: "SensitiveString2048", # required
|
456
|
+
# },
|
457
|
+
# })
|
458
|
+
#
|
459
|
+
# @example Response structure
|
460
|
+
#
|
461
|
+
# resp.app_authorization_summary.app_authorization_arn #=> String
|
462
|
+
# resp.app_authorization_summary.app_bundle_arn #=> String
|
463
|
+
# resp.app_authorization_summary.app #=> String
|
464
|
+
# resp.app_authorization_summary.tenant.tenant_identifier #=> String
|
465
|
+
# resp.app_authorization_summary.tenant.tenant_display_name #=> String
|
466
|
+
# resp.app_authorization_summary.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
|
467
|
+
# resp.app_authorization_summary.updated_at #=> Time
|
468
|
+
#
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ConnectAppAuthorization AWS API Documentation
|
470
|
+
#
|
471
|
+
# @overload connect_app_authorization(params = {})
|
472
|
+
# @param [Hash] params ({})
|
473
|
+
def connect_app_authorization(params = {}, options = {})
|
474
|
+
req = build_request(:connect_app_authorization, params)
|
475
|
+
req.send_request(options)
|
476
|
+
end
|
477
|
+
|
478
|
+
# Creates an app authorization within an app bundle, which allows
|
479
|
+
# AppFabric to connect to an application.
|
480
|
+
#
|
481
|
+
# @option params [required, String] :app_bundle_identifier
|
482
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
483
|
+
# of the app bundle to use for the request.
|
484
|
+
#
|
485
|
+
# @option params [required, String] :app
|
486
|
+
# The name of the application.
|
487
|
+
#
|
488
|
+
# Valid values are:
|
489
|
+
#
|
490
|
+
# * `SLACK`
|
491
|
+
#
|
492
|
+
# * `ASANA`
|
493
|
+
#
|
494
|
+
# * `JIRA`
|
495
|
+
#
|
496
|
+
# * `M365`
|
497
|
+
#
|
498
|
+
# * `M365AUDITLOGS`
|
499
|
+
#
|
500
|
+
# * `ZOOM`
|
501
|
+
#
|
502
|
+
# * `ZENDESK`
|
503
|
+
#
|
504
|
+
# * `OKTA`
|
505
|
+
#
|
506
|
+
# * `GOOGLE`
|
507
|
+
#
|
508
|
+
# * `DROPBOX`
|
509
|
+
#
|
510
|
+
# * `SMARTSHEET`
|
511
|
+
#
|
512
|
+
# * `CISCO`
|
513
|
+
#
|
514
|
+
# @option params [required, Types::Credential] :credential
|
515
|
+
# Contains credentials for the application, such as an API key or OAuth2
|
516
|
+
# client ID and secret.
|
517
|
+
#
|
518
|
+
# Specify credentials that match the authorization type for your
|
519
|
+
# request. For example, if the authorization type for your request is
|
520
|
+
# OAuth2 (`oauth2`), then you should provide only the OAuth2
|
521
|
+
# credentials.
|
522
|
+
#
|
523
|
+
# @option params [required, Types::Tenant] :tenant
|
524
|
+
# Contains information about an application tenant, such as the
|
525
|
+
# application display name and identifier.
|
526
|
+
#
|
527
|
+
# @option params [required, String] :auth_type
|
528
|
+
# The authorization type for the app authorization.
|
529
|
+
#
|
530
|
+
# @option params [String] :client_token
|
531
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
532
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
533
|
+
# request without accidentally performing the same operation a second
|
534
|
+
# time. Passing the same value to a later call to an operation requires
|
535
|
+
# that you also pass the same value for all other parameters. We
|
536
|
+
# recommend that you use a [UUID type of value][1].
|
537
|
+
#
|
538
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
539
|
+
# random one for you.
|
540
|
+
#
|
541
|
+
# If you retry the operation with the same `ClientToken`, but with
|
542
|
+
# different parameters, the retry fails with an
|
543
|
+
# `IdempotentParameterMismatch` error.
|
544
|
+
#
|
545
|
+
# **A suitable default value is auto-generated.** You should normally
|
546
|
+
# not need to pass this option.**
|
547
|
+
#
|
548
|
+
#
|
549
|
+
#
|
550
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
551
|
+
#
|
552
|
+
# @option params [Array<Types::Tag>] :tags
|
553
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
554
|
+
# resource.
|
555
|
+
#
|
556
|
+
# @return [Types::CreateAppAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
557
|
+
#
|
558
|
+
# * {Types::CreateAppAuthorizationResponse#app_authorization #app_authorization} => Types::AppAuthorization
|
559
|
+
#
|
560
|
+
# @example Request syntax with placeholder values
|
561
|
+
#
|
562
|
+
# resp = client.create_app_authorization({
|
563
|
+
# app_bundle_identifier: "Identifier", # required
|
564
|
+
# app: "String255", # required
|
565
|
+
# credential: { # required
|
566
|
+
# oauth2_credential: {
|
567
|
+
# client_id: "String2048", # required
|
568
|
+
# client_secret: "SensitiveString2048", # required
|
569
|
+
# },
|
570
|
+
# api_key_credential: {
|
571
|
+
# api_key: "SensitiveString2048", # required
|
572
|
+
# },
|
573
|
+
# },
|
574
|
+
# tenant: { # required
|
575
|
+
# tenant_identifier: "TenantIdentifier", # required
|
576
|
+
# tenant_display_name: "String2048", # required
|
577
|
+
# },
|
578
|
+
# auth_type: "oauth2", # required, accepts oauth2, apiKey
|
579
|
+
# client_token: "UUID",
|
580
|
+
# tags: [
|
581
|
+
# {
|
582
|
+
# key: "TagKey", # required
|
583
|
+
# value: "TagValue", # required
|
584
|
+
# },
|
585
|
+
# ],
|
586
|
+
# })
|
587
|
+
#
|
588
|
+
# @example Response structure
|
589
|
+
#
|
590
|
+
# resp.app_authorization.app_authorization_arn #=> String
|
591
|
+
# resp.app_authorization.app_bundle_arn #=> String
|
592
|
+
# resp.app_authorization.app #=> String
|
593
|
+
# resp.app_authorization.tenant.tenant_identifier #=> String
|
594
|
+
# resp.app_authorization.tenant.tenant_display_name #=> String
|
595
|
+
# resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
|
596
|
+
# resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
|
597
|
+
# resp.app_authorization.created_at #=> Time
|
598
|
+
# resp.app_authorization.updated_at #=> Time
|
599
|
+
# resp.app_authorization.persona #=> String, one of "admin", "endUser"
|
600
|
+
# resp.app_authorization.auth_url #=> String
|
601
|
+
#
|
602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/CreateAppAuthorization AWS API Documentation
|
603
|
+
#
|
604
|
+
# @overload create_app_authorization(params = {})
|
605
|
+
# @param [Hash] params ({})
|
606
|
+
def create_app_authorization(params = {}, options = {})
|
607
|
+
req = build_request(:create_app_authorization, params)
|
608
|
+
req.send_request(options)
|
609
|
+
end
|
610
|
+
|
611
|
+
# Creates an app bundle to collect data from an application using
|
612
|
+
# AppFabric.
|
613
|
+
#
|
614
|
+
# @option params [String] :client_token
|
615
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
616
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
617
|
+
# request without accidentally performing the same operation a second
|
618
|
+
# time. Passing the same value to a later call to an operation requires
|
619
|
+
# that you also pass the same value for all other parameters. We
|
620
|
+
# recommend that you use a [UUID type of value][1].
|
621
|
+
#
|
622
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
623
|
+
# random one for you.
|
624
|
+
#
|
625
|
+
# If you retry the operation with the same `ClientToken`, but with
|
626
|
+
# different parameters, the retry fails with an
|
627
|
+
# `IdempotentParameterMismatch` error.
|
628
|
+
#
|
629
|
+
# **A suitable default value is auto-generated.** You should normally
|
630
|
+
# not need to pass this option.**
|
631
|
+
#
|
632
|
+
#
|
633
|
+
#
|
634
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
635
|
+
#
|
636
|
+
# @option params [String] :customer_managed_key_identifier
|
637
|
+
# The Amazon Resource Name (ARN) of the Key Management Service (KMS) key
|
638
|
+
# to use to encrypt the application data. If this is not specified, an
|
639
|
+
# Amazon Web Services owned key is used for encryption.
|
640
|
+
#
|
641
|
+
# @option params [Array<Types::Tag>] :tags
|
642
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
643
|
+
# resource.
|
644
|
+
#
|
645
|
+
# @return [Types::CreateAppBundleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
646
|
+
#
|
647
|
+
# * {Types::CreateAppBundleResponse#app_bundle #app_bundle} => Types::AppBundle
|
648
|
+
#
|
649
|
+
# @example Request syntax with placeholder values
|
650
|
+
#
|
651
|
+
# resp = client.create_app_bundle({
|
652
|
+
# client_token: "UUID",
|
653
|
+
# customer_managed_key_identifier: "Identifier",
|
654
|
+
# tags: [
|
655
|
+
# {
|
656
|
+
# key: "TagKey", # required
|
657
|
+
# value: "TagValue", # required
|
658
|
+
# },
|
659
|
+
# ],
|
660
|
+
# })
|
661
|
+
#
|
662
|
+
# @example Response structure
|
663
|
+
#
|
664
|
+
# resp.app_bundle.arn #=> String
|
665
|
+
# resp.app_bundle.customer_managed_key_arn #=> String
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/CreateAppBundle AWS API Documentation
|
668
|
+
#
|
669
|
+
# @overload create_app_bundle(params = {})
|
670
|
+
# @param [Hash] params ({})
|
671
|
+
def create_app_bundle(params = {}, options = {})
|
672
|
+
req = build_request(:create_app_bundle, params)
|
673
|
+
req.send_request(options)
|
674
|
+
end
|
675
|
+
|
676
|
+
# Creates a data ingestion for an application.
|
677
|
+
#
|
678
|
+
# @option params [required, String] :app_bundle_identifier
|
679
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
680
|
+
# of the app bundle to use for the request.
|
681
|
+
#
|
682
|
+
# @option params [required, String] :app
|
683
|
+
# The name of the application.
|
684
|
+
#
|
685
|
+
# Valid values are:
|
686
|
+
#
|
687
|
+
# * `SLACK`
|
688
|
+
#
|
689
|
+
# * `ASANA`
|
690
|
+
#
|
691
|
+
# * `JIRA`
|
692
|
+
#
|
693
|
+
# * `M365`
|
694
|
+
#
|
695
|
+
# * `M365AUDITLOGS`
|
696
|
+
#
|
697
|
+
# * `ZOOM`
|
698
|
+
#
|
699
|
+
# * `ZENDESK`
|
700
|
+
#
|
701
|
+
# * `OKTA`
|
702
|
+
#
|
703
|
+
# * `GOOGLE`
|
704
|
+
#
|
705
|
+
# * `DROPBOX`
|
706
|
+
#
|
707
|
+
# * `SMARTSHEET`
|
708
|
+
#
|
709
|
+
# * `CISCO`
|
710
|
+
#
|
711
|
+
# @option params [required, String] :tenant_id
|
712
|
+
# The ID of the application tenant.
|
713
|
+
#
|
714
|
+
# @option params [required, String] :ingestion_type
|
715
|
+
# The ingestion type.
|
716
|
+
#
|
717
|
+
# @option params [String] :client_token
|
718
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
719
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
720
|
+
# request without accidentally performing the same operation a second
|
721
|
+
# time. Passing the same value to a later call to an operation requires
|
722
|
+
# that you also pass the same value for all other parameters. We
|
723
|
+
# recommend that you use a [UUID type of value][1].
|
724
|
+
#
|
725
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
726
|
+
# random one for you.
|
727
|
+
#
|
728
|
+
# If you retry the operation with the same `ClientToken`, but with
|
729
|
+
# different parameters, the retry fails with an
|
730
|
+
# `IdempotentParameterMismatch` error.
|
731
|
+
#
|
732
|
+
# **A suitable default value is auto-generated.** You should normally
|
733
|
+
# not need to pass this option.**
|
734
|
+
#
|
735
|
+
#
|
736
|
+
#
|
737
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
738
|
+
#
|
739
|
+
# @option params [Array<Types::Tag>] :tags
|
740
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
741
|
+
# resource.
|
742
|
+
#
|
743
|
+
# @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
744
|
+
#
|
745
|
+
# * {Types::CreateIngestionResponse#ingestion #ingestion} => Types::Ingestion
|
746
|
+
#
|
747
|
+
# @example Request syntax with placeholder values
|
748
|
+
#
|
749
|
+
# resp = client.create_ingestion({
|
750
|
+
# app_bundle_identifier: "Identifier", # required
|
751
|
+
# app: "String255", # required
|
752
|
+
# tenant_id: "TenantIdentifier", # required
|
753
|
+
# ingestion_type: "auditLog", # required, accepts auditLog
|
754
|
+
# client_token: "UUID",
|
755
|
+
# tags: [
|
756
|
+
# {
|
757
|
+
# key: "TagKey", # required
|
758
|
+
# value: "TagValue", # required
|
759
|
+
# },
|
760
|
+
# ],
|
761
|
+
# })
|
762
|
+
#
|
763
|
+
# @example Response structure
|
764
|
+
#
|
765
|
+
# resp.ingestion.arn #=> String
|
766
|
+
# resp.ingestion.app_bundle_arn #=> String
|
767
|
+
# resp.ingestion.app #=> String
|
768
|
+
# resp.ingestion.tenant_id #=> String
|
769
|
+
# resp.ingestion.created_at #=> Time
|
770
|
+
# resp.ingestion.updated_at #=> Time
|
771
|
+
# resp.ingestion.state #=> String, one of "enabled", "disabled"
|
772
|
+
# resp.ingestion.ingestion_type #=> String, one of "auditLog"
|
773
|
+
#
|
774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/CreateIngestion AWS API Documentation
|
775
|
+
#
|
776
|
+
# @overload create_ingestion(params = {})
|
777
|
+
# @param [Hash] params ({})
|
778
|
+
def create_ingestion(params = {}, options = {})
|
779
|
+
req = build_request(:create_ingestion, params)
|
780
|
+
req.send_request(options)
|
781
|
+
end
|
782
|
+
|
783
|
+
# Creates an ingestion destination, which specifies how an
|
784
|
+
# application's ingested data is processed by Amazon Web Services
|
785
|
+
# AppFabric and where it's delivered.
|
786
|
+
#
|
787
|
+
# @option params [required, String] :app_bundle_identifier
|
788
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
789
|
+
# of the app bundle to use for the request.
|
790
|
+
#
|
791
|
+
# @option params [required, String] :ingestion_identifier
|
792
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
793
|
+
# of the ingestion to use for the request.
|
794
|
+
#
|
795
|
+
# @option params [required, Types::ProcessingConfiguration] :processing_configuration
|
796
|
+
# Contains information about how ingested data is processed.
|
797
|
+
#
|
798
|
+
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
799
|
+
# Contains information about the destination of ingested data.
|
800
|
+
#
|
801
|
+
# @option params [String] :client_token
|
802
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
803
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
804
|
+
# request without accidentally performing the same operation a second
|
805
|
+
# time. Passing the same value to a later call to an operation requires
|
806
|
+
# that you also pass the same value for all other parameters. We
|
807
|
+
# recommend that you use a [UUID type of value][1].
|
808
|
+
#
|
809
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
810
|
+
# random one for you.
|
811
|
+
#
|
812
|
+
# If you retry the operation with the same `ClientToken`, but with
|
813
|
+
# different parameters, the retry fails with an
|
814
|
+
# `IdempotentParameterMismatch` error.
|
815
|
+
#
|
816
|
+
# **A suitable default value is auto-generated.** You should normally
|
817
|
+
# not need to pass this option.**
|
818
|
+
#
|
819
|
+
#
|
820
|
+
#
|
821
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
822
|
+
#
|
823
|
+
# @option params [Array<Types::Tag>] :tags
|
824
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
825
|
+
# resource.
|
826
|
+
#
|
827
|
+
# @return [Types::CreateIngestionDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
828
|
+
#
|
829
|
+
# * {Types::CreateIngestionDestinationResponse#ingestion_destination #ingestion_destination} => Types::IngestionDestination
|
830
|
+
#
|
831
|
+
# @example Request syntax with placeholder values
|
832
|
+
#
|
833
|
+
# resp = client.create_ingestion_destination({
|
834
|
+
# app_bundle_identifier: "Identifier", # required
|
835
|
+
# ingestion_identifier: "Identifier", # required
|
836
|
+
# processing_configuration: { # required
|
837
|
+
# audit_log: {
|
838
|
+
# schema: "ocsf", # required, accepts ocsf, raw
|
839
|
+
# format: "json", # required, accepts json, parquet
|
840
|
+
# },
|
841
|
+
# },
|
842
|
+
# destination_configuration: { # required
|
843
|
+
# audit_log: {
|
844
|
+
# destination: { # required
|
845
|
+
# s3_bucket: {
|
846
|
+
# bucket_name: "String63", # required
|
847
|
+
# prefix: "String120",
|
848
|
+
# },
|
849
|
+
# firehose_stream: {
|
850
|
+
# stream_name: "String64", # required
|
851
|
+
# },
|
852
|
+
# },
|
853
|
+
# },
|
854
|
+
# },
|
855
|
+
# client_token: "UUID",
|
856
|
+
# tags: [
|
857
|
+
# {
|
858
|
+
# key: "TagKey", # required
|
859
|
+
# value: "TagValue", # required
|
860
|
+
# },
|
861
|
+
# ],
|
862
|
+
# })
|
863
|
+
#
|
864
|
+
# @example Response structure
|
865
|
+
#
|
866
|
+
# resp.ingestion_destination.arn #=> String
|
867
|
+
# resp.ingestion_destination.ingestion_arn #=> String
|
868
|
+
# resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
|
869
|
+
# resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
|
870
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
|
871
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
|
872
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
|
873
|
+
# resp.ingestion_destination.status #=> String, one of "Active", "Failed"
|
874
|
+
# resp.ingestion_destination.status_reason #=> String
|
875
|
+
# resp.ingestion_destination.created_at #=> Time
|
876
|
+
# resp.ingestion_destination.updated_at #=> Time
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/CreateIngestionDestination AWS API Documentation
|
879
|
+
#
|
880
|
+
# @overload create_ingestion_destination(params = {})
|
881
|
+
# @param [Hash] params ({})
|
882
|
+
def create_ingestion_destination(params = {}, options = {})
|
883
|
+
req = build_request(:create_ingestion_destination, params)
|
884
|
+
req.send_request(options)
|
885
|
+
end
|
886
|
+
|
887
|
+
# Deletes an app authorization. You must delete the associated ingestion
|
888
|
+
# before you can delete an app authorization.
|
889
|
+
#
|
890
|
+
# @option params [required, String] :app_bundle_identifier
|
891
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
892
|
+
# of the app bundle to use for the request.
|
893
|
+
#
|
894
|
+
# @option params [required, String] :app_authorization_identifier
|
895
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
896
|
+
# of the app authorization to use for the request.
|
897
|
+
#
|
898
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
899
|
+
#
|
900
|
+
# @example Request syntax with placeholder values
|
901
|
+
#
|
902
|
+
# resp = client.delete_app_authorization({
|
903
|
+
# app_bundle_identifier: "Identifier", # required
|
904
|
+
# app_authorization_identifier: "Identifier", # required
|
905
|
+
# })
|
906
|
+
#
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/DeleteAppAuthorization AWS API Documentation
|
908
|
+
#
|
909
|
+
# @overload delete_app_authorization(params = {})
|
910
|
+
# @param [Hash] params ({})
|
911
|
+
def delete_app_authorization(params = {}, options = {})
|
912
|
+
req = build_request(:delete_app_authorization, params)
|
913
|
+
req.send_request(options)
|
914
|
+
end
|
915
|
+
|
916
|
+
# Deletes an app bundle. You must delete all associated app
|
917
|
+
# authorizations before you can delete an app bundle.
|
918
|
+
#
|
919
|
+
# @option params [required, String] :app_bundle_identifier
|
920
|
+
# The ID or Amazon Resource Name (ARN) of the app bundle that needs to
|
921
|
+
# be deleted.
|
922
|
+
#
|
923
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
|
+
#
|
925
|
+
# @example Request syntax with placeholder values
|
926
|
+
#
|
927
|
+
# resp = client.delete_app_bundle({
|
928
|
+
# app_bundle_identifier: "Identifier", # required
|
929
|
+
# })
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/DeleteAppBundle AWS API Documentation
|
932
|
+
#
|
933
|
+
# @overload delete_app_bundle(params = {})
|
934
|
+
# @param [Hash] params ({})
|
935
|
+
def delete_app_bundle(params = {}, options = {})
|
936
|
+
req = build_request(:delete_app_bundle, params)
|
937
|
+
req.send_request(options)
|
938
|
+
end
|
939
|
+
|
940
|
+
# Deletes an ingestion. You must stop (disable) the ingestion and you
|
941
|
+
# must delete all associated ingestion destinations before you can
|
942
|
+
# delete an app ingestion.
|
943
|
+
#
|
944
|
+
# @option params [required, String] :app_bundle_identifier
|
945
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
946
|
+
# of the app bundle to use for the request.
|
947
|
+
#
|
948
|
+
# @option params [required, String] :ingestion_identifier
|
949
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
950
|
+
# of the ingestion to use for the request.
|
951
|
+
#
|
952
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
953
|
+
#
|
954
|
+
# @example Request syntax with placeholder values
|
955
|
+
#
|
956
|
+
# resp = client.delete_ingestion({
|
957
|
+
# app_bundle_identifier: "Identifier", # required
|
958
|
+
# ingestion_identifier: "Identifier", # required
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/DeleteIngestion AWS API Documentation
|
962
|
+
#
|
963
|
+
# @overload delete_ingestion(params = {})
|
964
|
+
# @param [Hash] params ({})
|
965
|
+
def delete_ingestion(params = {}, options = {})
|
966
|
+
req = build_request(:delete_ingestion, params)
|
967
|
+
req.send_request(options)
|
968
|
+
end
|
969
|
+
|
970
|
+
# Deletes an ingestion destination.
|
971
|
+
#
|
972
|
+
# This deletes the association between an ingestion and it's
|
973
|
+
# destination. It doesn't delete previously ingested data or the
|
974
|
+
# storage destination, such as the Amazon S3 bucket where the data is
|
975
|
+
# delivered. If the ingestion destination is deleted while the
|
976
|
+
# associated ingestion is enabled, the ingestion will fail and is
|
977
|
+
# eventually disabled.
|
978
|
+
#
|
979
|
+
# @option params [required, String] :app_bundle_identifier
|
980
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
981
|
+
# of the app bundle to use for the request.
|
982
|
+
#
|
983
|
+
# @option params [required, String] :ingestion_identifier
|
984
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
985
|
+
# of the ingestion to use for the request.
|
986
|
+
#
|
987
|
+
# @option params [required, String] :ingestion_destination_identifier
|
988
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
989
|
+
# of the ingestion destination to use for the request.
|
990
|
+
#
|
991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
992
|
+
#
|
993
|
+
# @example Request syntax with placeholder values
|
994
|
+
#
|
995
|
+
# resp = client.delete_ingestion_destination({
|
996
|
+
# app_bundle_identifier: "Identifier", # required
|
997
|
+
# ingestion_identifier: "Identifier", # required
|
998
|
+
# ingestion_destination_identifier: "Identifier", # required
|
999
|
+
# })
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/DeleteIngestionDestination AWS API Documentation
|
1002
|
+
#
|
1003
|
+
# @overload delete_ingestion_destination(params = {})
|
1004
|
+
# @param [Hash] params ({})
|
1005
|
+
def delete_ingestion_destination(params = {}, options = {})
|
1006
|
+
req = build_request(:delete_ingestion_destination, params)
|
1007
|
+
req.send_request(options)
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# Returns information about an app authorization.
|
1011
|
+
#
|
1012
|
+
# @option params [required, String] :app_bundle_identifier
|
1013
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1014
|
+
# of the app bundle to use for the request.
|
1015
|
+
#
|
1016
|
+
# @option params [required, String] :app_authorization_identifier
|
1017
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1018
|
+
# of the app authorization to use for the request.
|
1019
|
+
#
|
1020
|
+
# @return [Types::GetAppAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1021
|
+
#
|
1022
|
+
# * {Types::GetAppAuthorizationResponse#app_authorization #app_authorization} => Types::AppAuthorization
|
1023
|
+
#
|
1024
|
+
# @example Request syntax with placeholder values
|
1025
|
+
#
|
1026
|
+
# resp = client.get_app_authorization({
|
1027
|
+
# app_bundle_identifier: "Identifier", # required
|
1028
|
+
# app_authorization_identifier: "Identifier", # required
|
1029
|
+
# })
|
1030
|
+
#
|
1031
|
+
# @example Response structure
|
1032
|
+
#
|
1033
|
+
# resp.app_authorization.app_authorization_arn #=> String
|
1034
|
+
# resp.app_authorization.app_bundle_arn #=> String
|
1035
|
+
# resp.app_authorization.app #=> String
|
1036
|
+
# resp.app_authorization.tenant.tenant_identifier #=> String
|
1037
|
+
# resp.app_authorization.tenant.tenant_display_name #=> String
|
1038
|
+
# resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
|
1039
|
+
# resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
|
1040
|
+
# resp.app_authorization.created_at #=> Time
|
1041
|
+
# resp.app_authorization.updated_at #=> Time
|
1042
|
+
# resp.app_authorization.persona #=> String, one of "admin", "endUser"
|
1043
|
+
# resp.app_authorization.auth_url #=> String
|
1044
|
+
#
|
1045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/GetAppAuthorization AWS API Documentation
|
1046
|
+
#
|
1047
|
+
# @overload get_app_authorization(params = {})
|
1048
|
+
# @param [Hash] params ({})
|
1049
|
+
def get_app_authorization(params = {}, options = {})
|
1050
|
+
req = build_request(:get_app_authorization, params)
|
1051
|
+
req.send_request(options)
|
1052
|
+
end
|
1053
|
+
|
1054
|
+
# Returns information about an app bundle.
|
1055
|
+
#
|
1056
|
+
# @option params [required, String] :app_bundle_identifier
|
1057
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1058
|
+
# of the app bundle to use for the request.
|
1059
|
+
#
|
1060
|
+
# @return [Types::GetAppBundleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1061
|
+
#
|
1062
|
+
# * {Types::GetAppBundleResponse#app_bundle #app_bundle} => Types::AppBundle
|
1063
|
+
#
|
1064
|
+
# @example Request syntax with placeholder values
|
1065
|
+
#
|
1066
|
+
# resp = client.get_app_bundle({
|
1067
|
+
# app_bundle_identifier: "Identifier", # required
|
1068
|
+
# })
|
1069
|
+
#
|
1070
|
+
# @example Response structure
|
1071
|
+
#
|
1072
|
+
# resp.app_bundle.arn #=> String
|
1073
|
+
# resp.app_bundle.customer_managed_key_arn #=> String
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/GetAppBundle AWS API Documentation
|
1076
|
+
#
|
1077
|
+
# @overload get_app_bundle(params = {})
|
1078
|
+
# @param [Hash] params ({})
|
1079
|
+
def get_app_bundle(params = {}, options = {})
|
1080
|
+
req = build_request(:get_app_bundle, params)
|
1081
|
+
req.send_request(options)
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
# Returns information about an ingestion.
|
1085
|
+
#
|
1086
|
+
# @option params [required, String] :app_bundle_identifier
|
1087
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1088
|
+
# of the app bundle to use for the request.
|
1089
|
+
#
|
1090
|
+
# @option params [required, String] :ingestion_identifier
|
1091
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1092
|
+
# of the ingestion to use for the request.
|
1093
|
+
#
|
1094
|
+
# @return [Types::GetIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1095
|
+
#
|
1096
|
+
# * {Types::GetIngestionResponse#ingestion #ingestion} => Types::Ingestion
|
1097
|
+
#
|
1098
|
+
# @example Request syntax with placeholder values
|
1099
|
+
#
|
1100
|
+
# resp = client.get_ingestion({
|
1101
|
+
# app_bundle_identifier: "Identifier", # required
|
1102
|
+
# ingestion_identifier: "Identifier", # required
|
1103
|
+
# })
|
1104
|
+
#
|
1105
|
+
# @example Response structure
|
1106
|
+
#
|
1107
|
+
# resp.ingestion.arn #=> String
|
1108
|
+
# resp.ingestion.app_bundle_arn #=> String
|
1109
|
+
# resp.ingestion.app #=> String
|
1110
|
+
# resp.ingestion.tenant_id #=> String
|
1111
|
+
# resp.ingestion.created_at #=> Time
|
1112
|
+
# resp.ingestion.updated_at #=> Time
|
1113
|
+
# resp.ingestion.state #=> String, one of "enabled", "disabled"
|
1114
|
+
# resp.ingestion.ingestion_type #=> String, one of "auditLog"
|
1115
|
+
#
|
1116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/GetIngestion AWS API Documentation
|
1117
|
+
#
|
1118
|
+
# @overload get_ingestion(params = {})
|
1119
|
+
# @param [Hash] params ({})
|
1120
|
+
def get_ingestion(params = {}, options = {})
|
1121
|
+
req = build_request(:get_ingestion, params)
|
1122
|
+
req.send_request(options)
|
1123
|
+
end
|
1124
|
+
|
1125
|
+
# Returns information about an ingestion destination.
|
1126
|
+
#
|
1127
|
+
# @option params [required, String] :app_bundle_identifier
|
1128
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1129
|
+
# of the app bundle to use for the request.
|
1130
|
+
#
|
1131
|
+
# @option params [required, String] :ingestion_identifier
|
1132
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1133
|
+
# of the ingestion to use for the request.
|
1134
|
+
#
|
1135
|
+
# @option params [required, String] :ingestion_destination_identifier
|
1136
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1137
|
+
# of the ingestion destination to use for the request.
|
1138
|
+
#
|
1139
|
+
# @return [Types::GetIngestionDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1140
|
+
#
|
1141
|
+
# * {Types::GetIngestionDestinationResponse#ingestion_destination #ingestion_destination} => Types::IngestionDestination
|
1142
|
+
#
|
1143
|
+
# @example Request syntax with placeholder values
|
1144
|
+
#
|
1145
|
+
# resp = client.get_ingestion_destination({
|
1146
|
+
# app_bundle_identifier: "Identifier", # required
|
1147
|
+
# ingestion_identifier: "Identifier", # required
|
1148
|
+
# ingestion_destination_identifier: "Identifier", # required
|
1149
|
+
# })
|
1150
|
+
#
|
1151
|
+
# @example Response structure
|
1152
|
+
#
|
1153
|
+
# resp.ingestion_destination.arn #=> String
|
1154
|
+
# resp.ingestion_destination.ingestion_arn #=> String
|
1155
|
+
# resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
|
1156
|
+
# resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
|
1157
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
|
1158
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
|
1159
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
|
1160
|
+
# resp.ingestion_destination.status #=> String, one of "Active", "Failed"
|
1161
|
+
# resp.ingestion_destination.status_reason #=> String
|
1162
|
+
# resp.ingestion_destination.created_at #=> Time
|
1163
|
+
# resp.ingestion_destination.updated_at #=> Time
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/GetIngestionDestination AWS API Documentation
|
1166
|
+
#
|
1167
|
+
# @overload get_ingestion_destination(params = {})
|
1168
|
+
# @param [Hash] params ({})
|
1169
|
+
def get_ingestion_destination(params = {}, options = {})
|
1170
|
+
req = build_request(:get_ingestion_destination, params)
|
1171
|
+
req.send_request(options)
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# Returns a list of all app authorizations configured for an app bundle.
|
1175
|
+
#
|
1176
|
+
# @option params [required, String] :app_bundle_identifier
|
1177
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1178
|
+
# of the app bundle to use for the request.
|
1179
|
+
#
|
1180
|
+
# @option params [Integer] :max_results
|
1181
|
+
# The maximum number of results that are returned per call. You can use
|
1182
|
+
# `nextToken` to obtain further pages of results.
|
1183
|
+
#
|
1184
|
+
# This is only an upper limit. The actual number of results returned per
|
1185
|
+
# call might be fewer than the specified maximum.
|
1186
|
+
#
|
1187
|
+
# @option params [String] :next_token
|
1188
|
+
# If `nextToken` is returned, there are more results available. The
|
1189
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1190
|
+
# the call again using the returned token to retrieve the next page.
|
1191
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1192
|
+
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1193
|
+
# 400 InvalidToken error*.
|
1194
|
+
#
|
1195
|
+
# @return [Types::ListAppAuthorizationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1196
|
+
#
|
1197
|
+
# * {Types::ListAppAuthorizationsResponse#app_authorization_summary_list #app_authorization_summary_list} => Array<Types::AppAuthorizationSummary>
|
1198
|
+
# * {Types::ListAppAuthorizationsResponse#next_token #next_token} => String
|
1199
|
+
#
|
1200
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1201
|
+
#
|
1202
|
+
# @example Request syntax with placeholder values
|
1203
|
+
#
|
1204
|
+
# resp = client.list_app_authorizations({
|
1205
|
+
# app_bundle_identifier: "Identifier", # required
|
1206
|
+
# max_results: 1,
|
1207
|
+
# next_token: "String2048",
|
1208
|
+
# })
|
1209
|
+
#
|
1210
|
+
# @example Response structure
|
1211
|
+
#
|
1212
|
+
# resp.app_authorization_summary_list #=> Array
|
1213
|
+
# resp.app_authorization_summary_list[0].app_authorization_arn #=> String
|
1214
|
+
# resp.app_authorization_summary_list[0].app_bundle_arn #=> String
|
1215
|
+
# resp.app_authorization_summary_list[0].app #=> String
|
1216
|
+
# resp.app_authorization_summary_list[0].tenant.tenant_identifier #=> String
|
1217
|
+
# resp.app_authorization_summary_list[0].tenant.tenant_display_name #=> String
|
1218
|
+
# resp.app_authorization_summary_list[0].status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
|
1219
|
+
# resp.app_authorization_summary_list[0].updated_at #=> Time
|
1220
|
+
# resp.next_token #=> String
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ListAppAuthorizations AWS API Documentation
|
1223
|
+
#
|
1224
|
+
# @overload list_app_authorizations(params = {})
|
1225
|
+
# @param [Hash] params ({})
|
1226
|
+
def list_app_authorizations(params = {}, options = {})
|
1227
|
+
req = build_request(:list_app_authorizations, params)
|
1228
|
+
req.send_request(options)
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# Returns a list of app bundles.
|
1232
|
+
#
|
1233
|
+
# @option params [Integer] :max_results
|
1234
|
+
# The maximum number of results that are returned per call. You can use
|
1235
|
+
# `nextToken` to obtain further pages of results.
|
1236
|
+
#
|
1237
|
+
# This is only an upper limit. The actual number of results returned per
|
1238
|
+
# call might be fewer than the specified maximum.
|
1239
|
+
#
|
1240
|
+
# @option params [String] :next_token
|
1241
|
+
# If `nextToken` is returned, there are more results available. The
|
1242
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1243
|
+
# the call again using the returned token to retrieve the next page.
|
1244
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1245
|
+
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1246
|
+
# 400 InvalidToken error*.
|
1247
|
+
#
|
1248
|
+
# @return [Types::ListAppBundlesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1249
|
+
#
|
1250
|
+
# * {Types::ListAppBundlesResponse#app_bundle_summary_list #app_bundle_summary_list} => Array<Types::AppBundleSummary>
|
1251
|
+
# * {Types::ListAppBundlesResponse#next_token #next_token} => String
|
1252
|
+
#
|
1253
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1254
|
+
#
|
1255
|
+
# @example Request syntax with placeholder values
|
1256
|
+
#
|
1257
|
+
# resp = client.list_app_bundles({
|
1258
|
+
# max_results: 1,
|
1259
|
+
# next_token: "String2048",
|
1260
|
+
# })
|
1261
|
+
#
|
1262
|
+
# @example Response structure
|
1263
|
+
#
|
1264
|
+
# resp.app_bundle_summary_list #=> Array
|
1265
|
+
# resp.app_bundle_summary_list[0].arn #=> String
|
1266
|
+
# resp.next_token #=> String
|
1267
|
+
#
|
1268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ListAppBundles AWS API Documentation
|
1269
|
+
#
|
1270
|
+
# @overload list_app_bundles(params = {})
|
1271
|
+
# @param [Hash] params ({})
|
1272
|
+
def list_app_bundles(params = {}, options = {})
|
1273
|
+
req = build_request(:list_app_bundles, params)
|
1274
|
+
req.send_request(options)
|
1275
|
+
end
|
1276
|
+
|
1277
|
+
# Returns a list of all ingestion destinations configured for an
|
1278
|
+
# ingestion.
|
1279
|
+
#
|
1280
|
+
# @option params [required, String] :app_bundle_identifier
|
1281
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1282
|
+
# of the app bundle to use for the request.
|
1283
|
+
#
|
1284
|
+
# @option params [required, String] :ingestion_identifier
|
1285
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1286
|
+
# of the ingestion to use for the request.
|
1287
|
+
#
|
1288
|
+
# @option params [Integer] :max_results
|
1289
|
+
# The maximum number of results that are returned per call. You can use
|
1290
|
+
# `nextToken` to obtain further pages of results.
|
1291
|
+
#
|
1292
|
+
# This is only an upper limit. The actual number of results returned per
|
1293
|
+
# call might be fewer than the specified maximum.
|
1294
|
+
#
|
1295
|
+
# @option params [String] :next_token
|
1296
|
+
# If `nextToken` is returned, there are more results available. The
|
1297
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1298
|
+
# the call again using the returned token to retrieve the next page.
|
1299
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1300
|
+
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1301
|
+
# 400 InvalidToken error*.
|
1302
|
+
#
|
1303
|
+
# @return [Types::ListIngestionDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1304
|
+
#
|
1305
|
+
# * {Types::ListIngestionDestinationsResponse#ingestion_destinations #ingestion_destinations} => Array<Types::IngestionDestinationSummary>
|
1306
|
+
# * {Types::ListIngestionDestinationsResponse#next_token #next_token} => String
|
1307
|
+
#
|
1308
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1309
|
+
#
|
1310
|
+
# @example Request syntax with placeholder values
|
1311
|
+
#
|
1312
|
+
# resp = client.list_ingestion_destinations({
|
1313
|
+
# app_bundle_identifier: "Identifier", # required
|
1314
|
+
# ingestion_identifier: "Identifier", # required
|
1315
|
+
# max_results: 1,
|
1316
|
+
# next_token: "String",
|
1317
|
+
# })
|
1318
|
+
#
|
1319
|
+
# @example Response structure
|
1320
|
+
#
|
1321
|
+
# resp.ingestion_destinations #=> Array
|
1322
|
+
# resp.ingestion_destinations[0].arn #=> String
|
1323
|
+
# resp.next_token #=> String
|
1324
|
+
#
|
1325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ListIngestionDestinations AWS API Documentation
|
1326
|
+
#
|
1327
|
+
# @overload list_ingestion_destinations(params = {})
|
1328
|
+
# @param [Hash] params ({})
|
1329
|
+
def list_ingestion_destinations(params = {}, options = {})
|
1330
|
+
req = build_request(:list_ingestion_destinations, params)
|
1331
|
+
req.send_request(options)
|
1332
|
+
end
|
1333
|
+
|
1334
|
+
# Returns a list of all ingestions configured for an app bundle.
|
1335
|
+
#
|
1336
|
+
# @option params [required, String] :app_bundle_identifier
|
1337
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1338
|
+
# of the app bundle to use for the request.
|
1339
|
+
#
|
1340
|
+
# @option params [Integer] :max_results
|
1341
|
+
# The maximum number of results that are returned per call. You can use
|
1342
|
+
# `nextToken` to obtain further pages of results.
|
1343
|
+
#
|
1344
|
+
# This is only an upper limit. The actual number of results returned per
|
1345
|
+
# call might be fewer than the specified maximum.
|
1346
|
+
#
|
1347
|
+
# @option params [String] :next_token
|
1348
|
+
# If `nextToken` is returned, there are more results available. The
|
1349
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1350
|
+
# the call again using the returned token to retrieve the next page.
|
1351
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1352
|
+
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1353
|
+
# 400 InvalidToken error*.
|
1354
|
+
#
|
1355
|
+
# @return [Types::ListIngestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
|
+
#
|
1357
|
+
# * {Types::ListIngestionsResponse#ingestions #ingestions} => Array<Types::IngestionSummary>
|
1358
|
+
# * {Types::ListIngestionsResponse#next_token #next_token} => String
|
1359
|
+
#
|
1360
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1361
|
+
#
|
1362
|
+
# @example Request syntax with placeholder values
|
1363
|
+
#
|
1364
|
+
# resp = client.list_ingestions({
|
1365
|
+
# app_bundle_identifier: "Identifier", # required
|
1366
|
+
# max_results: 1,
|
1367
|
+
# next_token: "String",
|
1368
|
+
# })
|
1369
|
+
#
|
1370
|
+
# @example Response structure
|
1371
|
+
#
|
1372
|
+
# resp.ingestions #=> Array
|
1373
|
+
# resp.ingestions[0].arn #=> String
|
1374
|
+
# resp.ingestions[0].app #=> String
|
1375
|
+
# resp.ingestions[0].tenant_id #=> String
|
1376
|
+
# resp.ingestions[0].state #=> String, one of "enabled", "disabled"
|
1377
|
+
# resp.next_token #=> String
|
1378
|
+
#
|
1379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ListIngestions AWS API Documentation
|
1380
|
+
#
|
1381
|
+
# @overload list_ingestions(params = {})
|
1382
|
+
# @param [Hash] params ({})
|
1383
|
+
def list_ingestions(params = {}, options = {})
|
1384
|
+
req = build_request(:list_ingestions, params)
|
1385
|
+
req.send_request(options)
|
1386
|
+
end
|
1387
|
+
|
1388
|
+
# Returns a list of tags for a resource.
|
1389
|
+
#
|
1390
|
+
# @option params [required, String] :resource_arn
|
1391
|
+
# The Amazon Resource Name (ARN) of the resource for which you want to
|
1392
|
+
# retrieve tags.
|
1393
|
+
#
|
1394
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1395
|
+
#
|
1396
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1397
|
+
#
|
1398
|
+
# @example Request syntax with placeholder values
|
1399
|
+
#
|
1400
|
+
# resp = client.list_tags_for_resource({
|
1401
|
+
# resource_arn: "Arn", # required
|
1402
|
+
# })
|
1403
|
+
#
|
1404
|
+
# @example Response structure
|
1405
|
+
#
|
1406
|
+
# resp.tags #=> Array
|
1407
|
+
# resp.tags[0].key #=> String
|
1408
|
+
# resp.tags[0].value #=> String
|
1409
|
+
#
|
1410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/ListTagsForResource AWS API Documentation
|
1411
|
+
#
|
1412
|
+
# @overload list_tags_for_resource(params = {})
|
1413
|
+
# @param [Hash] params ({})
|
1414
|
+
def list_tags_for_resource(params = {}, options = {})
|
1415
|
+
req = build_request(:list_tags_for_resource, params)
|
1416
|
+
req.send_request(options)
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# Starts (enables) an ingestion, which collects data from an
|
1420
|
+
# application.
|
1421
|
+
#
|
1422
|
+
# @option params [required, String] :ingestion_identifier
|
1423
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1424
|
+
# of the ingestion to use for the request.
|
1425
|
+
#
|
1426
|
+
# @option params [required, String] :app_bundle_identifier
|
1427
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1428
|
+
# of the app bundle to use for the request.
|
1429
|
+
#
|
1430
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1431
|
+
#
|
1432
|
+
# @example Request syntax with placeholder values
|
1433
|
+
#
|
1434
|
+
# resp = client.start_ingestion({
|
1435
|
+
# ingestion_identifier: "Identifier", # required
|
1436
|
+
# app_bundle_identifier: "Identifier", # required
|
1437
|
+
# })
|
1438
|
+
#
|
1439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/StartIngestion AWS API Documentation
|
1440
|
+
#
|
1441
|
+
# @overload start_ingestion(params = {})
|
1442
|
+
# @param [Hash] params ({})
|
1443
|
+
def start_ingestion(params = {}, options = {})
|
1444
|
+
req = build_request(:start_ingestion, params)
|
1445
|
+
req.send_request(options)
|
1446
|
+
end
|
1447
|
+
|
1448
|
+
# Starts the tasks to search user access status for a specific email
|
1449
|
+
# address.
|
1450
|
+
#
|
1451
|
+
# The tasks are stopped when the user access status data is found. The
|
1452
|
+
# tasks are terminated when the API calls to the application time out.
|
1453
|
+
#
|
1454
|
+
# @option params [required, String] :app_bundle_identifier
|
1455
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1456
|
+
# of the app bundle to use for the request.
|
1457
|
+
#
|
1458
|
+
# @option params [required, String] :email
|
1459
|
+
# The email address of the target user.
|
1460
|
+
#
|
1461
|
+
# @return [Types::StartUserAccessTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1462
|
+
#
|
1463
|
+
# * {Types::StartUserAccessTasksResponse#user_access_tasks_list #user_access_tasks_list} => Array<Types::UserAccessTaskItem>
|
1464
|
+
#
|
1465
|
+
# @example Request syntax with placeholder values
|
1466
|
+
#
|
1467
|
+
# resp = client.start_user_access_tasks({
|
1468
|
+
# app_bundle_identifier: "Identifier", # required
|
1469
|
+
# email: "Email", # required
|
1470
|
+
# })
|
1471
|
+
#
|
1472
|
+
# @example Response structure
|
1473
|
+
#
|
1474
|
+
# resp.user_access_tasks_list #=> Array
|
1475
|
+
# resp.user_access_tasks_list[0].app #=> String
|
1476
|
+
# resp.user_access_tasks_list[0].tenant_id #=> String
|
1477
|
+
# resp.user_access_tasks_list[0].task_id #=> String
|
1478
|
+
# resp.user_access_tasks_list[0].error.error_code #=> String
|
1479
|
+
# resp.user_access_tasks_list[0].error.error_message #=> String
|
1480
|
+
#
|
1481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/StartUserAccessTasks AWS API Documentation
|
1482
|
+
#
|
1483
|
+
# @overload start_user_access_tasks(params = {})
|
1484
|
+
# @param [Hash] params ({})
|
1485
|
+
def start_user_access_tasks(params = {}, options = {})
|
1486
|
+
req = build_request(:start_user_access_tasks, params)
|
1487
|
+
req.send_request(options)
|
1488
|
+
end
|
1489
|
+
|
1490
|
+
# Stops (disables) an ingestion.
|
1491
|
+
#
|
1492
|
+
# @option params [required, String] :ingestion_identifier
|
1493
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1494
|
+
# of the ingestion to use for the request.
|
1495
|
+
#
|
1496
|
+
# @option params [required, String] :app_bundle_identifier
|
1497
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1498
|
+
# of the app bundle to use for the request.
|
1499
|
+
#
|
1500
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1501
|
+
#
|
1502
|
+
# @example Request syntax with placeholder values
|
1503
|
+
#
|
1504
|
+
# resp = client.stop_ingestion({
|
1505
|
+
# ingestion_identifier: "Identifier", # required
|
1506
|
+
# app_bundle_identifier: "Identifier", # required
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/StopIngestion AWS API Documentation
|
1510
|
+
#
|
1511
|
+
# @overload stop_ingestion(params = {})
|
1512
|
+
# @param [Hash] params ({})
|
1513
|
+
def stop_ingestion(params = {}, options = {})
|
1514
|
+
req = build_request(:stop_ingestion, params)
|
1515
|
+
req.send_request(options)
|
1516
|
+
end
|
1517
|
+
|
1518
|
+
# Assigns one or more tags (key-value pairs) to the specified resource.
|
1519
|
+
#
|
1520
|
+
# @option params [required, String] :resource_arn
|
1521
|
+
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
1522
|
+
#
|
1523
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1524
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
1525
|
+
# resource.
|
1526
|
+
#
|
1527
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1528
|
+
#
|
1529
|
+
# @example Request syntax with placeholder values
|
1530
|
+
#
|
1531
|
+
# resp = client.tag_resource({
|
1532
|
+
# resource_arn: "Arn", # required
|
1533
|
+
# tags: [ # required
|
1534
|
+
# {
|
1535
|
+
# key: "TagKey", # required
|
1536
|
+
# value: "TagValue", # required
|
1537
|
+
# },
|
1538
|
+
# ],
|
1539
|
+
# })
|
1540
|
+
#
|
1541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/TagResource AWS API Documentation
|
1542
|
+
#
|
1543
|
+
# @overload tag_resource(params = {})
|
1544
|
+
# @param [Hash] params ({})
|
1545
|
+
def tag_resource(params = {}, options = {})
|
1546
|
+
req = build_request(:tag_resource, params)
|
1547
|
+
req.send_request(options)
|
1548
|
+
end
|
1549
|
+
|
1550
|
+
# Removes a tag or tags from a resource.
|
1551
|
+
#
|
1552
|
+
# @option params [required, String] :resource_arn
|
1553
|
+
# The Amazon Resource Name (ARN) of the resource that you want to untag.
|
1554
|
+
#
|
1555
|
+
# @option params [required, Array<String>] :tag_keys
|
1556
|
+
# The keys of the key-value pairs for the tag or tags you want to remove
|
1557
|
+
# from the specified resource.
|
1558
|
+
#
|
1559
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1560
|
+
#
|
1561
|
+
# @example Request syntax with placeholder values
|
1562
|
+
#
|
1563
|
+
# resp = client.untag_resource({
|
1564
|
+
# resource_arn: "Arn", # required
|
1565
|
+
# tag_keys: ["TagKey"], # required
|
1566
|
+
# })
|
1567
|
+
#
|
1568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/UntagResource AWS API Documentation
|
1569
|
+
#
|
1570
|
+
# @overload untag_resource(params = {})
|
1571
|
+
# @param [Hash] params ({})
|
1572
|
+
def untag_resource(params = {}, options = {})
|
1573
|
+
req = build_request(:untag_resource, params)
|
1574
|
+
req.send_request(options)
|
1575
|
+
end
|
1576
|
+
|
1577
|
+
# Updates an app authorization within an app bundle, which allows
|
1578
|
+
# AppFabric to connect to an application.
|
1579
|
+
#
|
1580
|
+
# If the app authorization was in a `connected` state, updating the app
|
1581
|
+
# authorization will set it back to a `PendingConnect` state.
|
1582
|
+
#
|
1583
|
+
# @option params [required, String] :app_bundle_identifier
|
1584
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1585
|
+
# of the app bundle to use for the request.
|
1586
|
+
#
|
1587
|
+
# @option params [required, String] :app_authorization_identifier
|
1588
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1589
|
+
# of the app authorization to use for the request.
|
1590
|
+
#
|
1591
|
+
# @option params [Types::Credential] :credential
|
1592
|
+
# Contains credentials for the application, such as an API key or OAuth2
|
1593
|
+
# client ID and secret.
|
1594
|
+
#
|
1595
|
+
# Specify credentials that match the authorization type of the app
|
1596
|
+
# authorization to update. For example, if the authorization type of the
|
1597
|
+
# app authorization is OAuth2 (`oauth2`), then you should provide only
|
1598
|
+
# the OAuth2 credentials.
|
1599
|
+
#
|
1600
|
+
# @option params [Types::Tenant] :tenant
|
1601
|
+
# Contains information about an application tenant, such as the
|
1602
|
+
# application display name and identifier.
|
1603
|
+
#
|
1604
|
+
# @return [Types::UpdateAppAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1605
|
+
#
|
1606
|
+
# * {Types::UpdateAppAuthorizationResponse#app_authorization #app_authorization} => Types::AppAuthorization
|
1607
|
+
#
|
1608
|
+
# @example Request syntax with placeholder values
|
1609
|
+
#
|
1610
|
+
# resp = client.update_app_authorization({
|
1611
|
+
# app_bundle_identifier: "Identifier", # required
|
1612
|
+
# app_authorization_identifier: "Identifier", # required
|
1613
|
+
# credential: {
|
1614
|
+
# oauth2_credential: {
|
1615
|
+
# client_id: "String2048", # required
|
1616
|
+
# client_secret: "SensitiveString2048", # required
|
1617
|
+
# },
|
1618
|
+
# api_key_credential: {
|
1619
|
+
# api_key: "SensitiveString2048", # required
|
1620
|
+
# },
|
1621
|
+
# },
|
1622
|
+
# tenant: {
|
1623
|
+
# tenant_identifier: "TenantIdentifier", # required
|
1624
|
+
# tenant_display_name: "String2048", # required
|
1625
|
+
# },
|
1626
|
+
# })
|
1627
|
+
#
|
1628
|
+
# @example Response structure
|
1629
|
+
#
|
1630
|
+
# resp.app_authorization.app_authorization_arn #=> String
|
1631
|
+
# resp.app_authorization.app_bundle_arn #=> String
|
1632
|
+
# resp.app_authorization.app #=> String
|
1633
|
+
# resp.app_authorization.tenant.tenant_identifier #=> String
|
1634
|
+
# resp.app_authorization.tenant.tenant_display_name #=> String
|
1635
|
+
# resp.app_authorization.auth_type #=> String, one of "oauth2", "apiKey"
|
1636
|
+
# resp.app_authorization.status #=> String, one of "PendingConnect", "Connected", "ConnectionValidationFailed", "TokenAutoRotationFailed"
|
1637
|
+
# resp.app_authorization.created_at #=> Time
|
1638
|
+
# resp.app_authorization.updated_at #=> Time
|
1639
|
+
# resp.app_authorization.persona #=> String, one of "admin", "endUser"
|
1640
|
+
# resp.app_authorization.auth_url #=> String
|
1641
|
+
#
|
1642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/UpdateAppAuthorization AWS API Documentation
|
1643
|
+
#
|
1644
|
+
# @overload update_app_authorization(params = {})
|
1645
|
+
# @param [Hash] params ({})
|
1646
|
+
def update_app_authorization(params = {}, options = {})
|
1647
|
+
req = build_request(:update_app_authorization, params)
|
1648
|
+
req.send_request(options)
|
1649
|
+
end
|
1650
|
+
|
1651
|
+
# Updates an ingestion destination, which specifies how an
|
1652
|
+
# application's ingested data is processed by Amazon Web Services
|
1653
|
+
# AppFabric and where it's delivered.
|
1654
|
+
#
|
1655
|
+
# @option params [required, String] :app_bundle_identifier
|
1656
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1657
|
+
# of the app bundle to use for the request.
|
1658
|
+
#
|
1659
|
+
# @option params [required, String] :ingestion_identifier
|
1660
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1661
|
+
# of the ingestion to use for the request.
|
1662
|
+
#
|
1663
|
+
# @option params [required, String] :ingestion_destination_identifier
|
1664
|
+
# The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID)
|
1665
|
+
# of the ingestion destination to use for the request.
|
1666
|
+
#
|
1667
|
+
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
1668
|
+
# Contains information about the destination of ingested data.
|
1669
|
+
#
|
1670
|
+
# @return [Types::UpdateIngestionDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1671
|
+
#
|
1672
|
+
# * {Types::UpdateIngestionDestinationResponse#ingestion_destination #ingestion_destination} => Types::IngestionDestination
|
1673
|
+
#
|
1674
|
+
# @example Request syntax with placeholder values
|
1675
|
+
#
|
1676
|
+
# resp = client.update_ingestion_destination({
|
1677
|
+
# app_bundle_identifier: "Identifier", # required
|
1678
|
+
# ingestion_identifier: "Identifier", # required
|
1679
|
+
# ingestion_destination_identifier: "Identifier", # required
|
1680
|
+
# destination_configuration: { # required
|
1681
|
+
# audit_log: {
|
1682
|
+
# destination: { # required
|
1683
|
+
# s3_bucket: {
|
1684
|
+
# bucket_name: "String63", # required
|
1685
|
+
# prefix: "String120",
|
1686
|
+
# },
|
1687
|
+
# firehose_stream: {
|
1688
|
+
# stream_name: "String64", # required
|
1689
|
+
# },
|
1690
|
+
# },
|
1691
|
+
# },
|
1692
|
+
# },
|
1693
|
+
# })
|
1694
|
+
#
|
1695
|
+
# @example Response structure
|
1696
|
+
#
|
1697
|
+
# resp.ingestion_destination.arn #=> String
|
1698
|
+
# resp.ingestion_destination.ingestion_arn #=> String
|
1699
|
+
# resp.ingestion_destination.processing_configuration.audit_log.schema #=> String, one of "ocsf", "raw"
|
1700
|
+
# resp.ingestion_destination.processing_configuration.audit_log.format #=> String, one of "json", "parquet"
|
1701
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.bucket_name #=> String
|
1702
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.s3_bucket.prefix #=> String
|
1703
|
+
# resp.ingestion_destination.destination_configuration.audit_log.destination.firehose_stream.stream_name #=> String
|
1704
|
+
# resp.ingestion_destination.status #=> String, one of "Active", "Failed"
|
1705
|
+
# resp.ingestion_destination.status_reason #=> String
|
1706
|
+
# resp.ingestion_destination.created_at #=> Time
|
1707
|
+
# resp.ingestion_destination.updated_at #=> Time
|
1708
|
+
#
|
1709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appfabric-2023-05-19/UpdateIngestionDestination AWS API Documentation
|
1710
|
+
#
|
1711
|
+
# @overload update_ingestion_destination(params = {})
|
1712
|
+
# @param [Hash] params ({})
|
1713
|
+
def update_ingestion_destination(params = {}, options = {})
|
1714
|
+
req = build_request(:update_ingestion_destination, params)
|
1715
|
+
req.send_request(options)
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# @!endgroup
|
1719
|
+
|
1720
|
+
# @param params ({})
|
1721
|
+
# @api private
|
1722
|
+
def build_request(operation_name, params = {})
|
1723
|
+
handlers = @handlers.for(operation_name)
|
1724
|
+
context = Seahorse::Client::RequestContext.new(
|
1725
|
+
operation_name: operation_name,
|
1726
|
+
operation: config.api.operation(operation_name),
|
1727
|
+
client: self,
|
1728
|
+
params: params,
|
1729
|
+
config: config)
|
1730
|
+
context[:gem_name] = 'aws-sdk-appfabric'
|
1731
|
+
context[:gem_version] = '1.0.0'
|
1732
|
+
Seahorse::Client::Request.new(handlers, context)
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# @api private
|
1736
|
+
# @deprecated
|
1737
|
+
def waiter_names
|
1738
|
+
[]
|
1739
|
+
end
|
1740
|
+
|
1741
|
+
class << self
|
1742
|
+
|
1743
|
+
# @api private
|
1744
|
+
attr_reader :identifier
|
1745
|
+
|
1746
|
+
# @api private
|
1747
|
+
def errors_module
|
1748
|
+
Errors
|
1749
|
+
end
|
1750
|
+
|
1751
|
+
end
|
1752
|
+
end
|
1753
|
+
end
|