aws-sdk-lambdacore 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,884 @@
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'
11
+ require 'aws-sdk-core/plugins/credentials_configuration'
12
+ require 'aws-sdk-core/plugins/logging'
13
+ require 'aws-sdk-core/plugins/param_converter'
14
+ require 'aws-sdk-core/plugins/param_validator'
15
+ require 'aws-sdk-core/plugins/user_agent'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors'
17
+ require 'aws-sdk-core/plugins/retry_errors'
18
+ require 'aws-sdk-core/plugins/global_configuration'
19
+ require 'aws-sdk-core/plugins/regional_endpoint'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern'
22
+ require 'aws-sdk-core/plugins/response_paging'
23
+ require 'aws-sdk-core/plugins/stub_responses'
24
+ require 'aws-sdk-core/plugins/idempotency_token'
25
+ require 'aws-sdk-core/plugins/invocation_id'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin'
29
+ require 'aws-sdk-core/plugins/transfer_encoding'
30
+ require 'aws-sdk-core/plugins/http_checksum'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm'
32
+ require 'aws-sdk-core/plugins/request_compression'
33
+ require 'aws-sdk-core/plugins/defaults_mode'
34
+ require 'aws-sdk-core/plugins/recursion_detection'
35
+ require 'aws-sdk-core/plugins/telemetry'
36
+ require 'aws-sdk-core/plugins/sign'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json'
38
+
39
+ module Aws::LambdaCore
40
+ # An API client for LambdaCore. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::LambdaCore::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :lambdacore
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::LambdaCore::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials used for authentication. This can be any class that includes and implements
99
+ # `Aws::CredentialProvider`, or instance of any one of the following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following locations will be searched for credentials:
128
+ #
129
+ # * `Aws.config[:credentials]`
130
+ #
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ #
134
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
135
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
136
+ #
137
+ # * `~/.aws/credentials`
138
+ #
139
+ # * `~/.aws/config`
140
+ #
141
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
142
+ # Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
143
+ # enable retries and extended timeouts. Instance profile credential fetching can be disabled by
144
+ # setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
145
+ #
146
+ # @option options [required, String] :region
147
+ # The AWS region to connect to. The configured `:region` is
148
+ # used to determine the service `:endpoint`. When not passed,
149
+ # a default `:region` is searched for in the following locations:
150
+ #
151
+ # * `Aws.config[:region]`
152
+ # * `ENV['AWS_REGION']`
153
+ # * `ENV['AMAZON_REGION']`
154
+ # * `ENV['AWS_DEFAULT_REGION']`
155
+ # * `~/.aws/credentials`
156
+ # * `~/.aws/config`
157
+ #
158
+ # @option options [String] :access_key_id
159
+ #
160
+ # @option options [String] :account_id
161
+ #
162
+ # @option options [Boolean] :active_endpoint_cache (false)
163
+ # When set to `true`, a thread polling for endpoints will be running in
164
+ # the background every 60 secs (default). Defaults to `false`.
165
+ #
166
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
167
+ # Used only in `adaptive` retry mode. When true, the request will sleep
168
+ # until there is sufficent client side capacity to retry the request.
169
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
170
+ # not retry instead of sleeping.
171
+ #
172
+ # @option options [Array<String>] :auth_scheme_preference
173
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
174
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
175
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
176
+ #
177
+ # @option options [Boolean] :client_side_monitoring (false)
178
+ # When `true`, client-side metrics will be collected for all API requests from
179
+ # this client.
180
+ #
181
+ # @option options [String] :client_side_monitoring_client_id ("")
182
+ # Allows you to provide an identifier for this client which will be attached to
183
+ # all generated client side metrics. Defaults to an empty string.
184
+ #
185
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
186
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
187
+ # side monitoring agent is running on, where client metrics will be published via UDP.
188
+ #
189
+ # @option options [Integer] :client_side_monitoring_port (31000)
190
+ # Required for publishing client metrics. The port that the client side monitoring
191
+ # agent is running on, where client metrics will be published via UDP.
192
+ #
193
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
194
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
195
+ # will use the Client Side Monitoring Agent Publisher.
196
+ #
197
+ # @option options [Boolean] :convert_params (true)
198
+ # When `true`, an attempt is made to coerce request parameters into
199
+ # the required types.
200
+ #
201
+ # @option options [Boolean] :correct_clock_skew (true)
202
+ # Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
203
+ # a clock skew correction and retry requests with skewed client clocks.
204
+ #
205
+ # @option options [String] :defaults_mode ("legacy")
206
+ # See {Aws::DefaultsModeConfiguration} for a list of the
207
+ # accepted modes and the configuration defaults that are included.
208
+ #
209
+ # @option options [Boolean] :disable_host_prefix_injection (false)
210
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
211
+ #
212
+ # @option options [Boolean] :disable_request_compression (false)
213
+ # When set to 'true' the request body will not be compressed
214
+ # for supported operations.
215
+ #
216
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
217
+ # Normally you should not configure the `:endpoint` option
218
+ # directly. This is normally constructed from the `:region`
219
+ # option. Configuring `:endpoint` is normally reserved for
220
+ # connecting to test or custom endpoints. The endpoint should
221
+ # be a URI formatted like:
222
+ #
223
+ # 'http://example.com'
224
+ # 'https://example.com'
225
+ # 'http://example.com:123'
226
+ #
227
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
228
+ # Used for the maximum size limit of the LRU cache storing endpoints data
229
+ # for endpoint discovery enabled operations. Defaults to 1000.
230
+ #
231
+ # @option options [Integer] :endpoint_cache_max_threads (10)
232
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
233
+ #
234
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
235
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
236
+ # Use this option to config the time interval in seconds for making
237
+ # requests fetching endpoints information. Defaults to 60 sec.
238
+ #
239
+ # @option options [Boolean] :endpoint_discovery (false)
240
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
241
+ #
242
+ # @option options [Boolean] :ignore_configured_endpoint_urls
243
+ # Setting to true disables use of endpoint URLs provided via environment
244
+ # variables and the shared configuration file.
245
+ #
246
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
247
+ # The log formatter.
248
+ #
249
+ # @option options [Symbol] :log_level (:info)
250
+ # The log level to send messages to the `:logger` at.
251
+ #
252
+ # @option options [Logger] :logger
253
+ # The Logger instance to send log messages to. If this option
254
+ # is not set, logging will be disabled.
255
+ #
256
+ # @option options [Integer] :max_attempts (3)
257
+ # An integer representing the maximum number attempts that will be made for
258
+ # a single request, including the initial attempt. For example,
259
+ # setting this value to 5 will result in a request being retried up to
260
+ # 4 times. Used in `standard` and `adaptive` retry modes.
261
+ #
262
+ # @option options [String] :profile ("default")
263
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
264
+ # When not specified, 'default' is used.
265
+ #
266
+ # @option options [String] :request_checksum_calculation ("when_supported")
267
+ # Determines when a checksum will be calculated for request payloads. Values are:
268
+ #
269
+ # * `when_supported` - (default) When set, a checksum will be
270
+ # calculated for all request payloads of operations modeled with the
271
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
272
+ # `requestAlgorithmMember` is modeled.
273
+ # * `when_required` - When set, a checksum will only be calculated for
274
+ # request payloads of operations modeled with the `httpChecksum` trait where
275
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
276
+ # is modeled and supplied.
277
+ #
278
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
279
+ # The minimum size in bytes that triggers compression for request
280
+ # bodies. The value must be non-negative integer value between 0
281
+ # and 10485780 bytes inclusive.
282
+ #
283
+ # @option options [String] :response_checksum_validation ("when_supported")
284
+ # Determines when checksum validation will be performed on response payloads. Values are:
285
+ #
286
+ # * `when_supported` - (default) When set, checksum validation is performed on all
287
+ # response payloads of operations modeled with the `httpChecksum` trait where
288
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
289
+ # are supported.
290
+ # * `when_required` - When set, checksum validation is not performed on
291
+ # response payloads of operations unless the checksum algorithm is supported and
292
+ # the `requestValidationModeMember` member is set to `ENABLED`.
293
+ #
294
+ # @option options [Proc] :retry_backoff
295
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
296
+ # This option is only used in the `legacy` retry mode.
297
+ #
298
+ # @option options [Float] :retry_base_delay (0.3)
299
+ # The base delay in seconds used by the default backoff function. This option
300
+ # is only used in the `legacy` retry mode.
301
+ #
302
+ # @option options [Symbol] :retry_jitter (:none)
303
+ # A delay randomiser function used by the default backoff function.
304
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
305
+ # otherwise a Proc that takes and returns a number. This option is only used
306
+ # in the `legacy` retry mode.
307
+ #
308
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
309
+ #
310
+ # @option options [Integer] :retry_limit (3)
311
+ # The maximum number of times to retry failed requests. Only
312
+ # ~ 500 level server errors and certain ~ 400 level client errors
313
+ # are retried. Generally, these are throttling errors, data
314
+ # checksum errors, networking errors, timeout errors, auth errors,
315
+ # endpoint discovery, and errors from expired credentials.
316
+ # This option is only used in the `legacy` retry mode.
317
+ #
318
+ # @option options [Integer] :retry_max_delay (0)
319
+ # The maximum number of seconds to delay between retries (0 for no limit)
320
+ # used by the default backoff function. This option is only used in the
321
+ # `legacy` retry mode.
322
+ #
323
+ # @option options [String] :retry_mode ("legacy")
324
+ # Specifies which retry algorithm to use. Values are:
325
+ #
326
+ # * `legacy` - The pre-existing retry behavior. This is the default
327
+ # value if no retry mode is provided.
328
+ #
329
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
330
+ # This includes support for retry quotas, which limit the number of
331
+ # unsuccessful retries a client can make.
332
+ #
333
+ # * `adaptive` - A retry mode that includes all the functionality of
334
+ # `standard` mode along with automatic client side throttling.
335
+ #
336
+ # @option options [String] :sdk_ua_app_id
337
+ # A unique and opaque application ID that is appended to the
338
+ # User-Agent header as app/sdk_ua_app_id. It should have a
339
+ # maximum length of 50. This variable is sourced from environment
340
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
341
+ #
342
+ # @option options [String] :secret_access_key
343
+ #
344
+ # @option options [String] :session_token
345
+ #
346
+ # @option options [Array] :sigv4a_signing_region_set
347
+ # A list of regions that should be signed with SigV4a signing. When
348
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
349
+ # in the following locations:
350
+ #
351
+ # * `Aws.config[:sigv4a_signing_region_set]`
352
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
353
+ # * `~/.aws/config`
354
+ #
355
+ # @option options [Boolean] :stub_responses (false)
356
+ # Causes the client to return stubbed responses. By default
357
+ # fake responses are generated and returned. You can specify
358
+ # the response data to return or errors to raise by calling
359
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
360
+ #
361
+ # ** Please note ** When response stubbing is enabled, no HTTP
362
+ # requests are made, and retries are disabled.
363
+ #
364
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
365
+ # Allows you to provide a telemetry provider, which is used to
366
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
367
+ # will not record or emit any telemetry data. The SDK supports the
368
+ # following telemetry providers:
369
+ #
370
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
371
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
372
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
373
+ #
374
+ # @option options [Aws::TokenProvider] :token_provider
375
+ # Your Bearer token used for authentication. This can be any class that includes and implements
376
+ # `Aws::TokenProvider`, or instance of any one of the following classes:
377
+ #
378
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
379
+ # tokens.
380
+ #
381
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
382
+ # access token generated from `aws login`.
383
+ #
384
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
385
+ # will be used to search for tokens configured for your profile in shared configuration files.
386
+ #
387
+ # @option options [Boolean] :use_dualstack_endpoint
388
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
389
+ # will be used if available.
390
+ #
391
+ # @option options [Boolean] :use_fips_endpoint
392
+ # When set to `true`, fips compatible endpoints will be used if available.
393
+ # When a `fips` region is used, the region is normalized and this config
394
+ # is set to `true`.
395
+ #
396
+ # @option options [Boolean] :validate_params (true)
397
+ # When `true`, request parameters are validated before
398
+ # sending the request.
399
+ #
400
+ # @option options [Aws::LambdaCore::EndpointProvider] :endpoint_provider
401
+ # The endpoint provider used to resolve endpoints. Any object that responds to
402
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
403
+ # `Aws::LambdaCore::EndpointParameters`.
404
+ #
405
+ # @option options [Float] :http_continue_timeout (1)
406
+ # The number of seconds to wait for a 100-continue response before sending the
407
+ # request body. This option has no effect unless the request has "Expect"
408
+ # header set to "100-continue". Defaults to `nil` which disables this
409
+ # behaviour. This value can safely be set per request on the session.
410
+ #
411
+ # @option options [Float] :http_idle_timeout (5)
412
+ # The number of seconds a connection is allowed to sit idle before it
413
+ # is considered stale. Stale connections are closed and removed from the
414
+ # pool before making a request.
415
+ #
416
+ # @option options [Float] :http_open_timeout (15)
417
+ # The default number of seconds to wait for response data.
418
+ # This value can safely be set per-request on the session.
419
+ #
420
+ # @option options [URI::HTTP,String] :http_proxy
421
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
422
+ #
423
+ # @option options [Float] :http_read_timeout (60)
424
+ # The default number of seconds to wait for response data.
425
+ # This value can safely be set per-request on the session.
426
+ #
427
+ # @option options [Boolean] :http_wire_trace (false)
428
+ # When `true`, HTTP debug output will be sent to the `:logger`.
429
+ #
430
+ # @option options [Proc] :on_chunk_received
431
+ # When a Proc object is provided, it will be used as callback when each chunk
432
+ # of the response body is received. It provides three arguments: the chunk,
433
+ # the number of bytes received, and the total number of
434
+ # bytes in the response (or nil if the server did not send a `content-length`).
435
+ #
436
+ # @option options [Proc] :on_chunk_sent
437
+ # When a Proc object is provided, it will be used as callback when each chunk
438
+ # of the request body is sent. It provides three arguments: the chunk,
439
+ # the number of bytes read from the body, and the total number of
440
+ # bytes in the body.
441
+ #
442
+ # @option options [Boolean] :raise_response_errors (true)
443
+ # When `true`, response errors are raised.
444
+ #
445
+ # @option options [String] :ssl_ca_bundle
446
+ # Full path to the SSL certificate authority bundle file that should be used when
447
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
448
+ # `:ssl_ca_directory` the the system default will be used if available.
449
+ #
450
+ # @option options [String] :ssl_ca_directory
451
+ # Full path of the directory that contains the unbundled SSL certificate
452
+ # authority files for verifying peer certificates. If you do
453
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
454
+ # default will be used if available.
455
+ #
456
+ # @option options [String] :ssl_ca_store
457
+ # Sets the X509::Store to verify peer certificate.
458
+ #
459
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
460
+ # Sets a client certificate when creating http connections.
461
+ #
462
+ # @option options [OpenSSL::PKey] :ssl_key
463
+ # Sets a client key when creating http connections.
464
+ #
465
+ # @option options [Float] :ssl_timeout
466
+ # Sets the SSL timeout in seconds
467
+ #
468
+ # @option options [Boolean] :ssl_verify_peer (true)
469
+ # When `true`, SSL peer certificates are verified when establishing a connection.
470
+ #
471
+ def initialize(*args)
472
+ super
473
+ end
474
+
475
+ # @!group API Operations
476
+
477
+ # Creates a network connector that enables Lambda compute resources to
478
+ # route outbound traffic through your Amazon VPC. The network connector
479
+ # provisions elastic network interfaces (ENIs) in the subnets you
480
+ # specify, providing a managed network path to private resources such as
481
+ # databases, caches, and internal APIs.
482
+ #
483
+ # This operation is asynchronous. The network connector starts in
484
+ # `PENDING` state while ENIs are provisioned in your VPC (provisioning
485
+ # typically takes up to 10 minutes). Use `GetNetworkConnector` to poll
486
+ # the connector state until it reaches `ACTIVE`. Once active, you can
487
+ # attach the connector to Lambda MicroVMs at run time using the
488
+ # `egressNetworkConnectors` parameter on `RunMicroVm`.
489
+ #
490
+ # This operation is idempotent when you provide a `ClientToken` — if you
491
+ # retry a request that completed successfully using the same client
492
+ # token, the operation returns the existing connector without creating a
493
+ # duplicate.
494
+ #
495
+ # @option params [required, String] :name
496
+ # A unique name for the network connector within your account and
497
+ # Region. You can use the name to identify the connector in subsequent
498
+ # API calls.
499
+ #
500
+ # @option params [required, Types::NetworkConnectorConfiguration] :configuration
501
+ # The network configuration for the connector. Specify a
502
+ # `VpcEgressConfiguration` to enable outbound traffic routing through
503
+ # your VPC.
504
+ #
505
+ # @option params [String] :operator_role
506
+ # The ARN of the IAM role that Lambda assumes to manage elastic network
507
+ # interfaces in your VPC. This role must have permissions for
508
+ # `ec2:CreateNetworkInterface`, `ec2:DeleteNetworkInterface`, and
509
+ # related describe operations.
510
+ #
511
+ # @option params [String] :client_token
512
+ # A unique, case-sensitive identifier that you provide to ensure the
513
+ # idempotency of the request. If you retry a request with the same
514
+ # client token, the API returns the existing connector without creating
515
+ # a duplicate.
516
+ #
517
+ # **A suitable default value is auto-generated.** You should normally
518
+ # not need to pass this option.**
519
+ #
520
+ # @option params [Hash<String,String>] :tags
521
+ # A map of key-value pairs to associate with the network connector for
522
+ # organization, cost allocation, or access control.
523
+ #
524
+ # @return [Types::CreateNetworkConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
525
+ #
526
+ # * {Types::CreateNetworkConnectorResponse#arn #arn} => String
527
+ # * {Types::CreateNetworkConnectorResponse#name #name} => String
528
+ # * {Types::CreateNetworkConnectorResponse#id #id} => String
529
+ # * {Types::CreateNetworkConnectorResponse#configuration #configuration} => Types::NetworkConnectorConfiguration
530
+ # * {Types::CreateNetworkConnectorResponse#operator_role #operator_role} => String
531
+ # * {Types::CreateNetworkConnectorResponse#state #state} => String
532
+ #
533
+ # @example Request syntax with placeholder values
534
+ #
535
+ # resp = client.create_network_connector({
536
+ # name: "NetworkConnectorName", # required
537
+ # configuration: { # required
538
+ # vpc_egress_configuration: {
539
+ # subnet_ids: ["NetworkConnectorSubnetId"],
540
+ # security_group_ids: ["NetworkConnectorSecurityGroupId"],
541
+ # network_protocol: "IPv4", # accepts IPv4, DualStack
542
+ # associated_compute_resource_types: ["MicroVm"], # accepts MicroVm
543
+ # },
544
+ # },
545
+ # operator_role: "NetworkConnectorRoleArn",
546
+ # client_token: "ClientTokenString",
547
+ # tags: {
548
+ # "NetworkConnectorTagKey" => "NetworkConnectorTagValue",
549
+ # },
550
+ # })
551
+ #
552
+ # @example Response structure
553
+ #
554
+ # resp.arn #=> String
555
+ # resp.name #=> String
556
+ # resp.id #=> String
557
+ # resp.configuration.vpc_egress_configuration.subnet_ids #=> Array
558
+ # resp.configuration.vpc_egress_configuration.subnet_ids[0] #=> String
559
+ # resp.configuration.vpc_egress_configuration.security_group_ids #=> Array
560
+ # resp.configuration.vpc_egress_configuration.security_group_ids[0] #=> String
561
+ # resp.configuration.vpc_egress_configuration.network_protocol #=> String, one of "IPv4", "DualStack"
562
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types #=> Array
563
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types[0] #=> String, one of "MicroVm"
564
+ # resp.operator_role #=> String
565
+ # resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "FAILED", "DELETING", "DELETE_FAILED"
566
+ #
567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lambda-core-2026-04-30/CreateNetworkConnector AWS API Documentation
568
+ #
569
+ # @overload create_network_connector(params = {})
570
+ # @param [Hash] params ({})
571
+ def create_network_connector(params = {}, options = {})
572
+ req = build_request(:create_network_connector, params)
573
+ req.send_request(options)
574
+ end
575
+
576
+ # Initiates deletion of a network connector. The connector transitions
577
+ # to `DELETING` state while elastic network interfaces are cleaned up
578
+ # asynchronously. After deletion completes, subsequent calls to
579
+ # `GetNetworkConnector` return `ResourceNotFoundException`.
580
+ #
581
+ # This operation is idempotent — calling delete on a connector that is
582
+ # already deleting or has been deleted succeeds without error. You can
583
+ # delete connectors in `ACTIVE` or `FAILED` states. Before deleting a
584
+ # connector, ensure that no Lambda MicroVMs are using it, as they will
585
+ # lose VPC egress connectivity immediately.
586
+ #
587
+ # @option params [required, String] :identifier
588
+ # A flexible identifier that accepts a network connector ID, name, or
589
+ # ARN
590
+ #
591
+ # @return [Types::DeleteNetworkConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
592
+ #
593
+ # * {Types::DeleteNetworkConnectorResponse#arn #arn} => String
594
+ # * {Types::DeleteNetworkConnectorResponse#name #name} => String
595
+ # * {Types::DeleteNetworkConnectorResponse#id #id} => String
596
+ # * {Types::DeleteNetworkConnectorResponse#configuration #configuration} => Types::NetworkConnectorConfiguration
597
+ # * {Types::DeleteNetworkConnectorResponse#operator_role #operator_role} => String
598
+ # * {Types::DeleteNetworkConnectorResponse#state #state} => String
599
+ #
600
+ # @example Request syntax with placeholder values
601
+ #
602
+ # resp = client.delete_network_connector({
603
+ # identifier: "NetworkConnectorIdentifier", # required
604
+ # })
605
+ #
606
+ # @example Response structure
607
+ #
608
+ # resp.arn #=> String
609
+ # resp.name #=> String
610
+ # resp.id #=> String
611
+ # resp.configuration.vpc_egress_configuration.subnet_ids #=> Array
612
+ # resp.configuration.vpc_egress_configuration.subnet_ids[0] #=> String
613
+ # resp.configuration.vpc_egress_configuration.security_group_ids #=> Array
614
+ # resp.configuration.vpc_egress_configuration.security_group_ids[0] #=> String
615
+ # resp.configuration.vpc_egress_configuration.network_protocol #=> String, one of "IPv4", "DualStack"
616
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types #=> Array
617
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types[0] #=> String, one of "MicroVm"
618
+ # resp.operator_role #=> String
619
+ # resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "FAILED", "DELETING", "DELETE_FAILED"
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lambda-core-2026-04-30/DeleteNetworkConnector AWS API Documentation
622
+ #
623
+ # @overload delete_network_connector(params = {})
624
+ # @param [Hash] params ({})
625
+ def delete_network_connector(params = {}, options = {})
626
+ req = build_request(:delete_network_connector, params)
627
+ req.send_request(options)
628
+ end
629
+
630
+ # Retrieves the current configuration, state, and metadata of a network
631
+ # connector. The `Identifier` parameter accepts the connector ID, name,
632
+ # or full ARN. Use this operation to poll connector state after creation
633
+ # or update, or to inspect the current VPC configuration and any failure
634
+ # reasons.
635
+ #
636
+ # The response includes the full connector configuration, current state,
637
+ # and — if the connector has been updated — the `LastUpdateStatus` and
638
+ # `LastUpdateStatusReasonCode` fields that indicate whether the most
639
+ # recent update succeeded or failed.
640
+ #
641
+ # @option params [required, String] :identifier
642
+ # A flexible identifier that accepts a network connector ID, name, or
643
+ # ARN
644
+ #
645
+ # @return [Types::GetNetworkConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
646
+ #
647
+ # * {Types::GetNetworkConnectorResponse#arn #arn} => String
648
+ # * {Types::GetNetworkConnectorResponse#name #name} => String
649
+ # * {Types::GetNetworkConnectorResponse#id #id} => String
650
+ # * {Types::GetNetworkConnectorResponse#version #version} => Integer
651
+ # * {Types::GetNetworkConnectorResponse#configuration #configuration} => Types::NetworkConnectorConfiguration
652
+ # * {Types::GetNetworkConnectorResponse#operator_role #operator_role} => String
653
+ # * {Types::GetNetworkConnectorResponse#state #state} => String
654
+ # * {Types::GetNetworkConnectorResponse#state_reason #state_reason} => String
655
+ # * {Types::GetNetworkConnectorResponse#state_reason_code #state_reason_code} => String
656
+ # * {Types::GetNetworkConnectorResponse#last_update_status #last_update_status} => String
657
+ # * {Types::GetNetworkConnectorResponse#last_update_status_reason #last_update_status_reason} => String
658
+ # * {Types::GetNetworkConnectorResponse#last_update_status_reason_code #last_update_status_reason_code} => String
659
+ # * {Types::GetNetworkConnectorResponse#last_modified #last_modified} => Time
660
+ #
661
+ # @example Request syntax with placeholder values
662
+ #
663
+ # resp = client.get_network_connector({
664
+ # identifier: "NetworkConnectorIdentifier", # required
665
+ # })
666
+ #
667
+ # @example Response structure
668
+ #
669
+ # resp.arn #=> String
670
+ # resp.name #=> String
671
+ # resp.id #=> String
672
+ # resp.version #=> Integer
673
+ # resp.configuration.vpc_egress_configuration.subnet_ids #=> Array
674
+ # resp.configuration.vpc_egress_configuration.subnet_ids[0] #=> String
675
+ # resp.configuration.vpc_egress_configuration.security_group_ids #=> Array
676
+ # resp.configuration.vpc_egress_configuration.security_group_ids[0] #=> String
677
+ # resp.configuration.vpc_egress_configuration.network_protocol #=> String, one of "IPv4", "DualStack"
678
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types #=> Array
679
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types[0] #=> String, one of "MicroVm"
680
+ # resp.operator_role #=> String
681
+ # resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "FAILED", "DELETING", "DELETE_FAILED"
682
+ # resp.state_reason #=> String
683
+ # resp.state_reason_code #=> String, one of "DisallowedByVpcEncryptionControl", "Ec2RequestLimitExceeded", "InsufficientRolePermissions", "InternalError", "InvalidSecurityGroup", "InvalidSubnet", "SubnetOutOfIPAddresses"
684
+ # resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
685
+ # resp.last_update_status_reason #=> String
686
+ # resp.last_update_status_reason_code #=> String, one of "DisallowedByVpcEncryptionControl", "Ec2RequestLimitExceeded", "InsufficientRolePermissions", "InternalError", "InvalidSecurityGroup", "InvalidSubnet", "SubnetOutOfIPAddresses"
687
+ # resp.last_modified #=> Time
688
+ #
689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lambda-core-2026-04-30/GetNetworkConnector AWS API Documentation
690
+ #
691
+ # @overload get_network_connector(params = {})
692
+ # @param [Hash] params ({})
693
+ def get_network_connector(params = {}, options = {})
694
+ req = build_request(:get_network_connector, params)
695
+ req.send_request(options)
696
+ end
697
+
698
+ # Returns a paginated list of network connectors in your account for the
699
+ # current Region. You can optionally filter results by connector state.
700
+ # Use the `Marker` parameter from a previous response to retrieve the
701
+ # next page of results.
702
+ #
703
+ # Each item in the response includes the connector ARN, name, ID, type,
704
+ # current state, and last modified timestamp. To retrieve full
705
+ # configuration details for a specific connector, use
706
+ # `GetNetworkConnector`.
707
+ #
708
+ # @option params [String] :state
709
+ # Optional filter to return only connectors in the specified state (for
710
+ # example, `ACTIVE` or `FAILED`).
711
+ #
712
+ # @option params [String] :marker
713
+ # The pagination token from a previous `ListNetworkConnectors` response.
714
+ # Use this value to retrieve the next page of results.
715
+ #
716
+ # @option params [Integer] :max_items
717
+ # The maximum number of connectors to return per page. Valid range: 1 to
718
+ # 100.
719
+ #
720
+ # @return [Types::ListNetworkConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
721
+ #
722
+ # * {Types::ListNetworkConnectorsResponse#network_connectors #network_connectors} => Array&lt;Types::NetworkConnectorSummary&gt;
723
+ # * {Types::ListNetworkConnectorsResponse#next_marker #next_marker} => String
724
+ #
725
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
726
+ #
727
+ # @example Request syntax with placeholder values
728
+ #
729
+ # resp = client.list_network_connectors({
730
+ # state: "PENDING", # accepts PENDING, ACTIVE, INACTIVE, FAILED, DELETING, DELETE_FAILED
731
+ # marker: "String",
732
+ # max_items: 1,
733
+ # })
734
+ #
735
+ # @example Response structure
736
+ #
737
+ # resp.network_connectors #=> Array
738
+ # resp.network_connectors[0].arn #=> String
739
+ # resp.network_connectors[0].name #=> String
740
+ # resp.network_connectors[0].id #=> String
741
+ # resp.network_connectors[0].type #=> String, one of "VPC_EGRESS"
742
+ # resp.network_connectors[0].state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "FAILED", "DELETING", "DELETE_FAILED"
743
+ # resp.network_connectors[0].last_modified #=> Time
744
+ # resp.next_marker #=> String
745
+ #
746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lambda-core-2026-04-30/ListNetworkConnectors AWS API Documentation
747
+ #
748
+ # @overload list_network_connectors(params = {})
749
+ # @param [Hash] params ({})
750
+ def list_network_connectors(params = {}, options = {})
751
+ req = build_request(:list_network_connectors, params)
752
+ req.send_request(options)
753
+ end
754
+
755
+ # Updates the VPC configuration or operator role of an existing network
756
+ # connector. You can modify the subnet IDs, security group IDs, network
757
+ # protocol, or operator role. The connector must be in `ACTIVE` state to
758
+ # accept updates.
759
+ #
760
+ # This operation is asynchronous. The connector remains in `ACTIVE`
761
+ # state during the update — existing workloads that reference this
762
+ # connector are not disrupted. Use `GetNetworkConnector` to monitor the
763
+ # `LastUpdateStatus` field, which transitions through `InProgress` to
764
+ # `Successful` or `Failed`. If the update fails, the
765
+ # `LastUpdateStatusReasonCode` field provides a specific error code for
766
+ # troubleshooting. This operation is idempotent when you provide a
767
+ # `ClientToken`.
768
+ #
769
+ # @option params [required, String] :identifier
770
+ # A flexible identifier that accepts a network connector ID, name, or
771
+ # ARN
772
+ #
773
+ # @option params [Types::NetworkConnectorConfiguration] :configuration
774
+ # The updated network configuration for the connector. Provide the full
775
+ # `VpcEgressConfiguration` including all subnet IDs and security group
776
+ # IDs — this replaces the existing configuration.
777
+ #
778
+ # @option params [String] :operator_role
779
+ # The updated ARN of the IAM role that Lambda assumes to manage ENIs.
780
+ # Use this to change the operator role without recreating the connector.
781
+ #
782
+ # @option params [String] :client_token
783
+ # A unique, case-sensitive identifier to ensure idempotency of the
784
+ # update request.
785
+ #
786
+ # **A suitable default value is auto-generated.** You should normally
787
+ # not need to pass this option.**
788
+ #
789
+ # @return [Types::UpdateNetworkConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
790
+ #
791
+ # * {Types::UpdateNetworkConnectorResponse#arn #arn} => String
792
+ # * {Types::UpdateNetworkConnectorResponse#name #name} => String
793
+ # * {Types::UpdateNetworkConnectorResponse#id #id} => String
794
+ # * {Types::UpdateNetworkConnectorResponse#operator_role #operator_role} => String
795
+ # * {Types::UpdateNetworkConnectorResponse#configuration #configuration} => Types::NetworkConnectorConfiguration
796
+ # * {Types::UpdateNetworkConnectorResponse#state #state} => String
797
+ # * {Types::UpdateNetworkConnectorResponse#last_update_status #last_update_status} => String
798
+ # * {Types::UpdateNetworkConnectorResponse#last_update_status_reason #last_update_status_reason} => String
799
+ # * {Types::UpdateNetworkConnectorResponse#last_modified #last_modified} => Time
800
+ #
801
+ # @example Request syntax with placeholder values
802
+ #
803
+ # resp = client.update_network_connector({
804
+ # identifier: "NetworkConnectorIdentifier", # required
805
+ # configuration: {
806
+ # vpc_egress_configuration: {
807
+ # subnet_ids: ["NetworkConnectorSubnetId"],
808
+ # security_group_ids: ["NetworkConnectorSecurityGroupId"],
809
+ # network_protocol: "IPv4", # accepts IPv4, DualStack
810
+ # associated_compute_resource_types: ["MicroVm"], # accepts MicroVm
811
+ # },
812
+ # },
813
+ # operator_role: "NetworkConnectorRoleArn",
814
+ # client_token: "ClientTokenString",
815
+ # })
816
+ #
817
+ # @example Response structure
818
+ #
819
+ # resp.arn #=> String
820
+ # resp.name #=> String
821
+ # resp.id #=> String
822
+ # resp.operator_role #=> String
823
+ # resp.configuration.vpc_egress_configuration.subnet_ids #=> Array
824
+ # resp.configuration.vpc_egress_configuration.subnet_ids[0] #=> String
825
+ # resp.configuration.vpc_egress_configuration.security_group_ids #=> Array
826
+ # resp.configuration.vpc_egress_configuration.security_group_ids[0] #=> String
827
+ # resp.configuration.vpc_egress_configuration.network_protocol #=> String, one of "IPv4", "DualStack"
828
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types #=> Array
829
+ # resp.configuration.vpc_egress_configuration.associated_compute_resource_types[0] #=> String, one of "MicroVm"
830
+ # resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "FAILED", "DELETING", "DELETE_FAILED"
831
+ # resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
832
+ # resp.last_update_status_reason #=> String
833
+ # resp.last_modified #=> Time
834
+ #
835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lambda-core-2026-04-30/UpdateNetworkConnector AWS API Documentation
836
+ #
837
+ # @overload update_network_connector(params = {})
838
+ # @param [Hash] params ({})
839
+ def update_network_connector(params = {}, options = {})
840
+ req = build_request(:update_network_connector, params)
841
+ req.send_request(options)
842
+ end
843
+
844
+ # @!endgroup
845
+
846
+ # @param params ({})
847
+ # @api private
848
+ def build_request(operation_name, params = {})
849
+ handlers = @handlers.for(operation_name)
850
+ tracer = config.telemetry_provider.tracer_provider.tracer(
851
+ Aws::Telemetry.module_to_tracer_name('Aws::LambdaCore')
852
+ )
853
+ context = Seahorse::Client::RequestContext.new(
854
+ operation_name: operation_name,
855
+ operation: config.api.operation(operation_name),
856
+ client: self,
857
+ params: params,
858
+ config: config,
859
+ tracer: tracer
860
+ )
861
+ context[:gem_name] = 'aws-sdk-lambdacore'
862
+ context[:gem_version] = '1.0.0'
863
+ Seahorse::Client::Request.new(handlers, context)
864
+ end
865
+
866
+ # @api private
867
+ # @deprecated
868
+ def waiter_names
869
+ []
870
+ end
871
+
872
+ class << self
873
+
874
+ # @api private
875
+ attr_reader :identifier
876
+
877
+ # @api private
878
+ def errors_module
879
+ Errors
880
+ end
881
+
882
+ end
883
+ end
884
+ end