aws-sdk-agentregistry 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,725 @@
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::AgentRegistry
40
+ # An API client for AgentRegistry. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::AgentRegistry::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 = :agentregistry
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::AgentRegistry::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::AgentRegistry::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::AgentRegistry::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
+ # Retrieves multiple discoverable registry records by ID from a single
478
+ # registry. Records that cannot be retrieved are reported individually
479
+ # in the `errors` list rather than failing the entire request.
480
+ #
481
+ # @option params [required, Array<Types::RegistryRecordsEntry>] :entries
482
+ # The registry-scoped groups of record IDs to retrieve. Currently, you
483
+ # can specify exactly one entry.
484
+ #
485
+ # @return [Types::BatchGetDiscoverableRegistryRecordResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
486
+ #
487
+ # * {Types::BatchGetDiscoverableRegistryRecordResponse#registry_records #registry_records} => Array&lt;Types::RegistryRecordSummary&gt;
488
+ # * {Types::BatchGetDiscoverableRegistryRecordResponse#errors #errors} => Array&lt;Types::BatchGetDiscoverableRegistryRecordError&gt;
489
+ #
490
+ # @example Request syntax with placeholder values
491
+ #
492
+ # resp = client.batch_get_discoverable_registry_record({
493
+ # entries: [ # required
494
+ # {
495
+ # registry_id: "RegistryIdentifier", # required
496
+ # record_ids: ["RecordIdentifier"], # required
497
+ # },
498
+ # ],
499
+ # })
500
+ #
501
+ # @example Response structure
502
+ #
503
+ # resp.registry_records #=> Array
504
+ # resp.registry_records[0].registry_arn #=> String
505
+ # resp.registry_records[0].record_arn #=> String
506
+ # resp.registry_records[0].record_id #=> String
507
+ # resp.registry_records[0].name #=> String
508
+ # resp.registry_records[0].description #=> String
509
+ # resp.registry_records[0].display_name #=> String
510
+ # resp.registry_records[0].record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
511
+ # resp.registry_records[0].descriptors.mcp_server.data #=> String
512
+ # resp.registry_records[0].descriptors.mcp_server.data_schema_version #=> String
513
+ # resp.registry_records[0].descriptors.mcp_server.additional_data.tools.data #=> String
514
+ # resp.registry_records[0].descriptors.mcp_server.additional_data.tools.data_schema_version #=> String
515
+ # resp.registry_records[0].descriptors.mcp_server.source.from_url.url #=> String
516
+ # resp.registry_records[0].descriptors.a2a_agent_card.data #=> String
517
+ # resp.registry_records[0].descriptors.a2a_agent_card.data_schema_version #=> String
518
+ # resp.registry_records[0].descriptors.a2a_agent_card.source.from_url.url #=> String
519
+ # resp.registry_records[0].descriptors.agent_skills_definition.data #=> String
520
+ # resp.registry_records[0].descriptors.agent_skills_definition.data_schema_version #=> String
521
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.data #=> String
522
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.data_schema_version #=> String
523
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.url #=> String
524
+ # resp.registry_records[0].descriptors.custom.data #=> String
525
+ # resp.registry_records[0].record_version #=> String
526
+ # resp.registry_records[0].status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
527
+ # resp.registry_records[0].created_at #=> Time
528
+ # resp.registry_records[0].updated_at #=> Time
529
+ # resp.errors #=> Array
530
+ # resp.errors[0].registry_id #=> String
531
+ # resp.errors[0].record_id #=> String
532
+ # resp.errors[0].error_code #=> String, one of "RESOURCE_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_ERROR"
533
+ # resp.errors[0].message #=> String
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/agent-registry-2025-12-01/BatchGetDiscoverableRegistryRecord AWS API Documentation
536
+ #
537
+ # @overload batch_get_discoverable_registry_record(params = {})
538
+ # @param [Hash] params ({})
539
+ def batch_get_discoverable_registry_record(params = {}, options = {})
540
+ req = build_request(:batch_get_discoverable_registry_record, params)
541
+ req.send_request(options)
542
+ end
543
+
544
+ # Lists the discoverable registry records in a registry. You can
545
+ # optionally filter and paginate the results.
546
+ #
547
+ # @option params [required, String] :registry_id
548
+ # Registry identifier that accepts either ARN or ID format
549
+ #
550
+ # @option params [Integer] :max_results
551
+ # The maximum number of records to return in a single page. Valid values
552
+ # are 1 through 100.
553
+ #
554
+ # @option params [String] :next_token
555
+ # The pagination token returned by a previous request. Use this value to
556
+ # retrieve the next page of results.
557
+ #
558
+ # @option params [Array<Types::RegistryRecordFilter>] :filters
559
+ # The filters to apply to the discoverable registry record list.
560
+ #
561
+ # @return [Types::ListDiscoverableRegistryRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
562
+ #
563
+ # * {Types::ListDiscoverableRegistryRecordsResponse#registry_records #registry_records} => Array&lt;Types::DiscoverableRegistryRecordSummary&gt;
564
+ # * {Types::ListDiscoverableRegistryRecordsResponse#next_token #next_token} => String
565
+ #
566
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
567
+ #
568
+ # @example Request syntax with placeholder values
569
+ #
570
+ # resp = client.list_discoverable_registry_records({
571
+ # registry_id: "RegistryIdentifier", # required
572
+ # max_results: 1,
573
+ # next_token: "ListDiscoverableRegistryRecordsRequestNextTokenString",
574
+ # filters: [
575
+ # {
576
+ # name: "recordType", # required, accepts recordType, descriptorType
577
+ # values: ["FilterValue"], # required
578
+ # },
579
+ # ],
580
+ # })
581
+ #
582
+ # @example Response structure
583
+ #
584
+ # resp.registry_records #=> Array
585
+ # resp.registry_records[0].registry_arn #=> String
586
+ # resp.registry_records[0].record_arn #=> String
587
+ # resp.registry_records[0].record_id #=> String
588
+ # resp.registry_records[0].name #=> String
589
+ # resp.registry_records[0].description #=> String
590
+ # resp.registry_records[0].display_name #=> String
591
+ # resp.registry_records[0].record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
592
+ # resp.registry_records[0].record_version #=> String
593
+ # resp.registry_records[0].status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
594
+ # resp.registry_records[0].created_at #=> Time
595
+ # resp.registry_records[0].updated_at #=> Time
596
+ # resp.next_token #=> String
597
+ #
598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/agent-registry-2025-12-01/ListDiscoverableRegistryRecords AWS API Documentation
599
+ #
600
+ # @overload list_discoverable_registry_records(params = {})
601
+ # @param [Hash] params ({})
602
+ def list_discoverable_registry_records(params = {}, options = {})
603
+ req = build_request(:list_discoverable_registry_records, params)
604
+ req.send_request(options)
605
+ end
606
+
607
+ # Searches the discoverable registry records in a registry using a
608
+ # natural language query. Returns metadata for the matching records
609
+ # ordered by relevance.
610
+ #
611
+ # @option params [required, String] :search_query
612
+ # The natural language query to search for matching registry records.
613
+ #
614
+ # @option params [required, Array<String>] :registry_ids
615
+ # The registry identifiers to search within. Currently, you must specify
616
+ # exactly one registry identifier. You can provide either the full
617
+ # Amazon Web Services Resource Name (ARN) or the registry ID.
618
+ #
619
+ # @option params [Integer] :max_results
620
+ # The maximum number of results to return. Valid values are 1 through
621
+ # 20. The default value is 10.
622
+ #
623
+ # @option params [Hash,Array,String,Numeric,Boolean] :filters
624
+ # An optional structured JSON metadata filter that narrows the search
625
+ # results. Supports the field-level operators `$eq`, `$ne`, and `$in`,
626
+ # and the logical operators `$and` and `$or` on filterable fields.
627
+ #
628
+ # Document type used to carry open content
629
+ # (Hash,Array,String,Numeric,Boolean). A document type value is
630
+ # serialized using the same format as its surroundings and requires no
631
+ # additional encoding or escaping.
632
+ #
633
+ # @return [Types::SearchDiscoverableRegistryRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
634
+ #
635
+ # * {Types::SearchDiscoverableRegistryRecordsResponse#registry_records #registry_records} => Array&lt;Types::RegistryRecordSummary&gt;
636
+ #
637
+ # @example Request syntax with placeholder values
638
+ #
639
+ # resp = client.search_discoverable_registry_records({
640
+ # search_query: "SearchQuery", # required
641
+ # registry_ids: ["RegistryIdentifier"], # required
642
+ # max_results: 1,
643
+ # filters: {
644
+ # },
645
+ # })
646
+ #
647
+ # @example Response structure
648
+ #
649
+ # resp.registry_records #=> Array
650
+ # resp.registry_records[0].registry_arn #=> String
651
+ # resp.registry_records[0].record_arn #=> String
652
+ # resp.registry_records[0].record_id #=> String
653
+ # resp.registry_records[0].name #=> String
654
+ # resp.registry_records[0].description #=> String
655
+ # resp.registry_records[0].display_name #=> String
656
+ # resp.registry_records[0].record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
657
+ # resp.registry_records[0].descriptors.mcp_server.data #=> String
658
+ # resp.registry_records[0].descriptors.mcp_server.data_schema_version #=> String
659
+ # resp.registry_records[0].descriptors.mcp_server.additional_data.tools.data #=> String
660
+ # resp.registry_records[0].descriptors.mcp_server.additional_data.tools.data_schema_version #=> String
661
+ # resp.registry_records[0].descriptors.mcp_server.source.from_url.url #=> String
662
+ # resp.registry_records[0].descriptors.a2a_agent_card.data #=> String
663
+ # resp.registry_records[0].descriptors.a2a_agent_card.data_schema_version #=> String
664
+ # resp.registry_records[0].descriptors.a2a_agent_card.source.from_url.url #=> String
665
+ # resp.registry_records[0].descriptors.agent_skills_definition.data #=> String
666
+ # resp.registry_records[0].descriptors.agent_skills_definition.data_schema_version #=> String
667
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.data #=> String
668
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.data_schema_version #=> String
669
+ # resp.registry_records[0].descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.url #=> String
670
+ # resp.registry_records[0].descriptors.custom.data #=> String
671
+ # resp.registry_records[0].record_version #=> String
672
+ # resp.registry_records[0].status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
673
+ # resp.registry_records[0].created_at #=> Time
674
+ # resp.registry_records[0].updated_at #=> Time
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/agent-registry-2025-12-01/SearchDiscoverableRegistryRecords AWS API Documentation
677
+ #
678
+ # @overload search_discoverable_registry_records(params = {})
679
+ # @param [Hash] params ({})
680
+ def search_discoverable_registry_records(params = {}, options = {})
681
+ req = build_request(:search_discoverable_registry_records, params)
682
+ req.send_request(options)
683
+ end
684
+
685
+ # @!endgroup
686
+
687
+ # @param params ({})
688
+ # @api private
689
+ def build_request(operation_name, params = {})
690
+ handlers = @handlers.for(operation_name)
691
+ tracer = config.telemetry_provider.tracer_provider.tracer(
692
+ Aws::Telemetry.module_to_tracer_name('Aws::AgentRegistry')
693
+ )
694
+ context = Seahorse::Client::RequestContext.new(
695
+ operation_name: operation_name,
696
+ operation: config.api.operation(operation_name),
697
+ client: self,
698
+ params: params,
699
+ config: config,
700
+ tracer: tracer
701
+ )
702
+ context[:gem_name] = 'aws-sdk-agentregistry'
703
+ context[:gem_version] = '1.0.0'
704
+ Seahorse::Client::Request.new(handlers, context)
705
+ end
706
+
707
+ # @api private
708
+ # @deprecated
709
+ def waiter_names
710
+ []
711
+ end
712
+
713
+ class << self
714
+
715
+ # @api private
716
+ attr_reader :identifier
717
+
718
+ # @api private
719
+ def errors_module
720
+ Errors
721
+ end
722
+
723
+ end
724
+ end
725
+ end