aws-sdk-appintegrationsservice 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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 41fbb10c519449d66ec97b884543287f2a78fd92fbb8c159cf5f2dcb66294f52
4
+ data.tar.gz: 540b9b3a96b26b58e3f26c5c34b2b456f40f28f4d74fbcfd2786d6e4eef64542
5
+ SHA512:
6
+ metadata.gz: d6bf0d44b6dc4527bb5259f8039f958600fd293216eedfc94fdc44b07b8e5a069e7b757f7dbe2158039b3caf29f94d0fa30ff09a2108a44cb01358692c691f4e
7
+ data.tar.gz: 3a8497122f3708e4b8a1e0cddf6e31c53ab33ff1ff6ca45c266aa80563c988670a7317f712ffe1719b0e0d228f5bb934b3937afd1b2909832114a80d9aff2c8b
@@ -0,0 +1,53 @@
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/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-appintegrationsservice/types'
15
+ require_relative 'aws-sdk-appintegrationsservice/client_api'
16
+ require_relative 'aws-sdk-appintegrationsservice/client'
17
+ require_relative 'aws-sdk-appintegrationsservice/errors'
18
+ require_relative 'aws-sdk-appintegrationsservice/resource'
19
+ require_relative 'aws-sdk-appintegrationsservice/customizations'
20
+
21
+ # This module provides support for Amazon AppIntegrations Service. This module is available in the
22
+ # `aws-sdk-appintegrationsservice` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # app_integrations_service = Aws::AppIntegrationsService::Client.new
31
+ # resp = app_integrations_service.create_event_integration(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon AppIntegrations Service are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::AppIntegrationsService::Errors::ServiceError
43
+ # # rescues all Amazon AppIntegrations Service API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::AppIntegrationsService
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,714 @@
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/master/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/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:appintegrationsservice)
34
+
35
+ module Aws::AppIntegrationsService
36
+ # An API client for AppIntegrationsService. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::AppIntegrationsService::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :appintegrationsservice
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # The Amazon AppIntegrations APIs are in preview release and are subject
331
+ # to change.
332
+ #
333
+ # Creates an EventIntegration, given a specified name, description, and
334
+ # a reference to an Amazon Eventbridge bus in your account and a partner
335
+ # event source that will push events to that bus. No objects are created
336
+ # in the your account, only metadata that is persisted on the
337
+ # EventIntegration control plane.
338
+ #
339
+ # @option params [required, String] :name
340
+ # The name of the event integration.
341
+ #
342
+ # @option params [String] :description
343
+ # The description of the event integration.
344
+ #
345
+ # @option params [required, Types::EventFilter] :event_filter
346
+ # The event filter.
347
+ #
348
+ # @option params [required, String] :event_bridge_bus
349
+ # The Eventbridge bus.
350
+ #
351
+ # @option params [String] :client_token
352
+ # A unique, case-sensitive identifier that you provide to ensure the
353
+ # idempotency of the request.
354
+ #
355
+ # **A suitable default value is auto-generated.** You should normally
356
+ # not need to pass this option.**
357
+ #
358
+ # @option params [Hash<String,String>] :tags
359
+ # One or more tags.
360
+ #
361
+ # @return [Types::CreateEventIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
362
+ #
363
+ # * {Types::CreateEventIntegrationResponse#event_integration_arn #event_integration_arn} => String
364
+ #
365
+ # @example Request syntax with placeholder values
366
+ #
367
+ # resp = client.create_event_integration({
368
+ # name: "Name", # required
369
+ # description: "Description",
370
+ # event_filter: { # required
371
+ # source: "Source", # required
372
+ # },
373
+ # event_bridge_bus: "EventBridgeBus", # required
374
+ # client_token: "IdempotencyToken",
375
+ # tags: {
376
+ # "TagKey" => "TagValue",
377
+ # },
378
+ # })
379
+ #
380
+ # @example Response structure
381
+ #
382
+ # resp.event_integration_arn #=> String
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/CreateEventIntegration AWS API Documentation
385
+ #
386
+ # @overload create_event_integration(params = {})
387
+ # @param [Hash] params ({})
388
+ def create_event_integration(params = {}, options = {})
389
+ req = build_request(:create_event_integration, params)
390
+ req.send_request(options)
391
+ end
392
+
393
+ # The Amazon AppIntegrations APIs are in preview release and are subject
394
+ # to change.
395
+ #
396
+ # Deletes the specified existing event integration. If the event
397
+ # integration is associated with clients, the request is rejected.
398
+ #
399
+ # @option params [required, String] :name
400
+ # The name of the event integration.
401
+ #
402
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
403
+ #
404
+ # @example Request syntax with placeholder values
405
+ #
406
+ # resp = client.delete_event_integration({
407
+ # name: "Name", # required
408
+ # })
409
+ #
410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/DeleteEventIntegration AWS API Documentation
411
+ #
412
+ # @overload delete_event_integration(params = {})
413
+ # @param [Hash] params ({})
414
+ def delete_event_integration(params = {}, options = {})
415
+ req = build_request(:delete_event_integration, params)
416
+ req.send_request(options)
417
+ end
418
+
419
+ # The Amazon AppIntegrations APIs are in preview release and are subject
420
+ # to change.
421
+ #
422
+ # Return information about the event integration.
423
+ #
424
+ # @option params [required, String] :name
425
+ # The name of the event integration.
426
+ #
427
+ # @return [Types::GetEventIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
+ #
429
+ # * {Types::GetEventIntegrationResponse#name #name} => String
430
+ # * {Types::GetEventIntegrationResponse#description #description} => String
431
+ # * {Types::GetEventIntegrationResponse#event_integration_arn #event_integration_arn} => String
432
+ # * {Types::GetEventIntegrationResponse#event_bridge_bus #event_bridge_bus} => String
433
+ # * {Types::GetEventIntegrationResponse#event_filter #event_filter} => Types::EventFilter
434
+ # * {Types::GetEventIntegrationResponse#tags #tags} => Hash&lt;String,String&gt;
435
+ #
436
+ # @example Request syntax with placeholder values
437
+ #
438
+ # resp = client.get_event_integration({
439
+ # name: "Name", # required
440
+ # })
441
+ #
442
+ # @example Response structure
443
+ #
444
+ # resp.name #=> String
445
+ # resp.description #=> String
446
+ # resp.event_integration_arn #=> String
447
+ # resp.event_bridge_bus #=> String
448
+ # resp.event_filter.source #=> String
449
+ # resp.tags #=> Hash
450
+ # resp.tags["TagKey"] #=> String
451
+ #
452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/GetEventIntegration AWS API Documentation
453
+ #
454
+ # @overload get_event_integration(params = {})
455
+ # @param [Hash] params ({})
456
+ def get_event_integration(params = {}, options = {})
457
+ req = build_request(:get_event_integration, params)
458
+ req.send_request(options)
459
+ end
460
+
461
+ # The Amazon AppIntegrations APIs are in preview release and are subject
462
+ # to change.
463
+ #
464
+ # Returns a paginated list of event integration associations in the
465
+ # account.
466
+ #
467
+ # @option params [required, String] :event_integration_name
468
+ # The name of the event integration.
469
+ #
470
+ # @option params [String] :next_token
471
+ # The token for the next set of results. Use the value returned in the
472
+ # previous response in the next request to retrieve the next set of
473
+ # results.
474
+ #
475
+ # @option params [Integer] :max_results
476
+ # The maximum number of results to return per page.
477
+ #
478
+ # @return [Types::ListEventIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
+ #
480
+ # * {Types::ListEventIntegrationAssociationsResponse#event_integration_associations #event_integration_associations} => Array&lt;Types::EventIntegrationAssociation&gt;
481
+ # * {Types::ListEventIntegrationAssociationsResponse#next_token #next_token} => String
482
+ #
483
+ # @example Request syntax with placeholder values
484
+ #
485
+ # resp = client.list_event_integration_associations({
486
+ # event_integration_name: "Name", # required
487
+ # next_token: "NextToken",
488
+ # max_results: 1,
489
+ # })
490
+ #
491
+ # @example Response structure
492
+ #
493
+ # resp.event_integration_associations #=> Array
494
+ # resp.event_integration_associations[0].event_integration_association_arn #=> String
495
+ # resp.event_integration_associations[0].event_integration_association_id #=> String
496
+ # resp.event_integration_associations[0].event_integration_name #=> String
497
+ # resp.event_integration_associations[0].client_id #=> String
498
+ # resp.event_integration_associations[0].event_bridge_rule_name #=> String
499
+ # resp.event_integration_associations[0].client_association_metadata #=> Hash
500
+ # resp.event_integration_associations[0].client_association_metadata["NonBlankString"] #=> String
501
+ # resp.next_token #=> String
502
+ #
503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/ListEventIntegrationAssociations AWS API Documentation
504
+ #
505
+ # @overload list_event_integration_associations(params = {})
506
+ # @param [Hash] params ({})
507
+ def list_event_integration_associations(params = {}, options = {})
508
+ req = build_request(:list_event_integration_associations, params)
509
+ req.send_request(options)
510
+ end
511
+
512
+ # The Amazon AppIntegrations APIs are in preview release and are subject
513
+ # to change.
514
+ #
515
+ # Returns a paginated list of event integrations in the account.
516
+ #
517
+ # @option params [String] :next_token
518
+ # The token for the next set of results. Use the value returned in the
519
+ # previous response in the next request to retrieve the next set of
520
+ # results.
521
+ #
522
+ # @option params [Integer] :max_results
523
+ # The maximum number of results to return per page.
524
+ #
525
+ # @return [Types::ListEventIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
526
+ #
527
+ # * {Types::ListEventIntegrationsResponse#event_integrations #event_integrations} => Array&lt;Types::EventIntegration&gt;
528
+ # * {Types::ListEventIntegrationsResponse#next_token #next_token} => String
529
+ #
530
+ # @example Request syntax with placeholder values
531
+ #
532
+ # resp = client.list_event_integrations({
533
+ # next_token: "NextToken",
534
+ # max_results: 1,
535
+ # })
536
+ #
537
+ # @example Response structure
538
+ #
539
+ # resp.event_integrations #=> Array
540
+ # resp.event_integrations[0].event_integration_arn #=> String
541
+ # resp.event_integrations[0].name #=> String
542
+ # resp.event_integrations[0].description #=> String
543
+ # resp.event_integrations[0].event_filter.source #=> String
544
+ # resp.event_integrations[0].event_bridge_bus #=> String
545
+ # resp.event_integrations[0].tags #=> Hash
546
+ # resp.event_integrations[0].tags["TagKey"] #=> String
547
+ # resp.next_token #=> String
548
+ #
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/ListEventIntegrations AWS API Documentation
550
+ #
551
+ # @overload list_event_integrations(params = {})
552
+ # @param [Hash] params ({})
553
+ def list_event_integrations(params = {}, options = {})
554
+ req = build_request(:list_event_integrations, params)
555
+ req.send_request(options)
556
+ end
557
+
558
+ # The Amazon AppIntegrations APIs are in preview release and are subject
559
+ # to change.
560
+ #
561
+ # Lists the tags for the specified resource.
562
+ #
563
+ # @option params [required, String] :resource_arn
564
+ # The Amazon Resource Name (ARN) of the resource.
565
+ #
566
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
567
+ #
568
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
569
+ #
570
+ # @example Request syntax with placeholder values
571
+ #
572
+ # resp = client.list_tags_for_resource({
573
+ # resource_arn: "Arn", # required
574
+ # })
575
+ #
576
+ # @example Response structure
577
+ #
578
+ # resp.tags #=> Hash
579
+ # resp.tags["TagKey"] #=> String
580
+ #
581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/ListTagsForResource AWS API Documentation
582
+ #
583
+ # @overload list_tags_for_resource(params = {})
584
+ # @param [Hash] params ({})
585
+ def list_tags_for_resource(params = {}, options = {})
586
+ req = build_request(:list_tags_for_resource, params)
587
+ req.send_request(options)
588
+ end
589
+
590
+ # The Amazon AppIntegrations APIs are in preview release and are subject
591
+ # to change.
592
+ #
593
+ # Adds the specified tags to the specified resource.
594
+ #
595
+ # @option params [required, String] :resource_arn
596
+ # The Amazon Resource Name (ARN) of the resource.
597
+ #
598
+ # @option params [required, Hash<String,String>] :tags
599
+ # One or more tags.
600
+ #
601
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
602
+ #
603
+ # @example Request syntax with placeholder values
604
+ #
605
+ # resp = client.tag_resource({
606
+ # resource_arn: "Arn", # required
607
+ # tags: { # required
608
+ # "TagKey" => "TagValue",
609
+ # },
610
+ # })
611
+ #
612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/TagResource AWS API Documentation
613
+ #
614
+ # @overload tag_resource(params = {})
615
+ # @param [Hash] params ({})
616
+ def tag_resource(params = {}, options = {})
617
+ req = build_request(:tag_resource, params)
618
+ req.send_request(options)
619
+ end
620
+
621
+ # The Amazon AppIntegrations APIs are in preview release and are subject
622
+ # to change.
623
+ #
624
+ # Removes the specified tags from the specified resource.
625
+ #
626
+ # @option params [required, String] :resource_arn
627
+ # The Amazon Resource Name (ARN) of the resource.
628
+ #
629
+ # @option params [required, Array<String>] :tag_keys
630
+ # The tag keys.
631
+ #
632
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
633
+ #
634
+ # @example Request syntax with placeholder values
635
+ #
636
+ # resp = client.untag_resource({
637
+ # resource_arn: "Arn", # required
638
+ # tag_keys: ["TagKey"], # required
639
+ # })
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/UntagResource AWS API Documentation
642
+ #
643
+ # @overload untag_resource(params = {})
644
+ # @param [Hash] params ({})
645
+ def untag_resource(params = {}, options = {})
646
+ req = build_request(:untag_resource, params)
647
+ req.send_request(options)
648
+ end
649
+
650
+ # The Amazon AppIntegrations APIs are in preview release and are subject
651
+ # to change.
652
+ #
653
+ # Updates the description of an event integration.
654
+ #
655
+ # @option params [required, String] :name
656
+ # The name of the event integration.
657
+ #
658
+ # @option params [String] :description
659
+ # The description of the event inegration.
660
+ #
661
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
662
+ #
663
+ # @example Request syntax with placeholder values
664
+ #
665
+ # resp = client.update_event_integration({
666
+ # name: "Name", # required
667
+ # description: "Description",
668
+ # })
669
+ #
670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appintegrations-2020-07-29/UpdateEventIntegration AWS API Documentation
671
+ #
672
+ # @overload update_event_integration(params = {})
673
+ # @param [Hash] params ({})
674
+ def update_event_integration(params = {}, options = {})
675
+ req = build_request(:update_event_integration, params)
676
+ req.send_request(options)
677
+ end
678
+
679
+ # @!endgroup
680
+
681
+ # @param params ({})
682
+ # @api private
683
+ def build_request(operation_name, params = {})
684
+ handlers = @handlers.for(operation_name)
685
+ context = Seahorse::Client::RequestContext.new(
686
+ operation_name: operation_name,
687
+ operation: config.api.operation(operation_name),
688
+ client: self,
689
+ params: params,
690
+ config: config)
691
+ context[:gem_name] = 'aws-sdk-appintegrationsservice'
692
+ context[:gem_version] = '1.0.0'
693
+ Seahorse::Client::Request.new(handlers, context)
694
+ end
695
+
696
+ # @api private
697
+ # @deprecated
698
+ def waiter_names
699
+ []
700
+ end
701
+
702
+ class << self
703
+
704
+ # @api private
705
+ attr_reader :identifier
706
+
707
+ # @api private
708
+ def errors_module
709
+ Errors
710
+ end
711
+
712
+ end
713
+ end
714
+ end