aws-sdk-apiportal 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,2860 @@
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::APIPortal
40
+ # An API client for APIPortal. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::APIPortal::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 = :apiportal
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::APIPortal::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
203
+ # to apply a clock skew correction and retry requests with skewed client
204
+ # clocks. Takes effect only when `disable_clock_skew_correction` is not set.
205
+ #
206
+ # @option options [String] :defaults_mode ("legacy")
207
+ # See {Aws::DefaultsModeConfiguration} for a list of the
208
+ # accepted modes and the configuration defaults that are included.
209
+ #
210
+ # @option options [Boolean] :disable_clock_skew_correction
211
+ # Used only in `standard` and `adaptive` retry modes. When `true`, the
212
+ # SDK does not apply a clock skew correction, does not update its stored
213
+ # skew from responses, and does not retry clock skew errors. Clock skew
214
+ # correction is enabled by default.
215
+ #
216
+ # @option options [Boolean] :disable_host_prefix_injection (false)
217
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
218
+ #
219
+ # @option options [Boolean] :disable_request_compression (false)
220
+ # When set to 'true' the request body will not be compressed
221
+ # for supported operations.
222
+ #
223
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
224
+ # Normally you should not configure the `:endpoint` option
225
+ # directly. This is normally constructed from the `:region`
226
+ # option. Configuring `:endpoint` is normally reserved for
227
+ # connecting to test or custom endpoints. The endpoint should
228
+ # be a URI formatted like:
229
+ #
230
+ # 'http://example.com'
231
+ # 'https://example.com'
232
+ # 'http://example.com:123'
233
+ #
234
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
235
+ # Used for the maximum size limit of the LRU cache storing endpoints data
236
+ # for endpoint discovery enabled operations. Defaults to 1000.
237
+ #
238
+ # @option options [Integer] :endpoint_cache_max_threads (10)
239
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
240
+ #
241
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
242
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
243
+ # Use this option to config the time interval in seconds for making
244
+ # requests fetching endpoints information. Defaults to 60 sec.
245
+ #
246
+ # @option options [Boolean] :endpoint_discovery (false)
247
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
248
+ #
249
+ # @option options [Boolean] :ignore_configured_endpoint_urls
250
+ # Setting to true disables use of endpoint URLs provided via environment
251
+ # variables and the shared configuration file.
252
+ #
253
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
254
+ # The log formatter.
255
+ #
256
+ # @option options [Symbol] :log_level (:info)
257
+ # The log level to send messages to the `:logger` at.
258
+ #
259
+ # @option options [Logger] :logger
260
+ # The Logger instance to send log messages to. If this option
261
+ # is not set, logging will be disabled.
262
+ #
263
+ # @option options [Integer] :max_attempts (3)
264
+ # An integer representing the maximum number attempts that will be made for
265
+ # a single request, including the initial attempt. For example,
266
+ # setting this value to 5 will result in a request being retried up to
267
+ # 4 times. Used in `standard` and `adaptive` retry modes. Defaults to 3,
268
+ # except for DynamoDB and DynamoDB Streams, which default to 4.
269
+ #
270
+ # @option options [String] :profile ("default")
271
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
272
+ # When not specified, 'default' is used.
273
+ #
274
+ # @option options [String] :request_checksum_calculation ("when_supported")
275
+ # Determines when a checksum will be calculated for request payloads. Values are:
276
+ #
277
+ # * `when_supported` - (default) When set, a checksum will be
278
+ # calculated for all request payloads of operations modeled with the
279
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
280
+ # `requestAlgorithmMember` is modeled.
281
+ # * `when_required` - When set, a checksum will only be calculated for
282
+ # request payloads of operations modeled with the `httpChecksum` trait where
283
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
284
+ # is modeled and supplied.
285
+ #
286
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
287
+ # The minimum size in bytes that triggers compression for request
288
+ # bodies. The value must be non-negative integer value between 0
289
+ # and 10485780 bytes inclusive.
290
+ #
291
+ # @option options [String] :response_checksum_validation ("when_supported")
292
+ # Determines when checksum validation will be performed on response payloads. Values are:
293
+ #
294
+ # * `when_supported` - (default) When set, checksum validation is performed on all
295
+ # response payloads of operations modeled with the `httpChecksum` trait where
296
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
297
+ # are supported.
298
+ # * `when_required` - When set, checksum validation is not performed on
299
+ # response payloads of operations unless the checksum algorithm is supported and
300
+ # the `requestValidationModeMember` member is set to `ENABLED`.
301
+ #
302
+ # @option options [Proc] :retry_backoff
303
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
304
+ # This option is only used in the `legacy` retry mode.
305
+ #
306
+ # @option options [Float] :retry_base_delay (0.3)
307
+ # The base delay in seconds used by the default backoff function. This option
308
+ # is only used in the `legacy` retry mode.
309
+ #
310
+ # @option options [Symbol] :retry_jitter (:none)
311
+ # A delay randomiser function used by the default backoff function.
312
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
313
+ # otherwise a Proc that takes and returns a number. This option is only used
314
+ # in the `legacy` retry mode.
315
+ #
316
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
317
+ #
318
+ # @option options [Integer] :retry_limit (3)
319
+ # The maximum number of times to retry failed requests. Only
320
+ # ~ 500 level server errors and certain ~ 400 level client errors
321
+ # are retried. Generally, these are throttling errors, data
322
+ # checksum errors, networking errors, timeout errors, auth errors,
323
+ # endpoint discovery, and errors from expired credentials.
324
+ # This option is only used in the `legacy` retry mode.
325
+ #
326
+ # @option options [Integer] :retry_max_delay (0)
327
+ # The maximum number of seconds to delay between retries (0 for no limit)
328
+ # used by the default backoff function. This option is only used in the
329
+ # `legacy` retry mode.
330
+ #
331
+ # @option options [String] :retry_mode ("standard")
332
+ # Specifies which retry algorithm to use. Values are:
333
+ #
334
+ # * `legacy` - The pre-existing retry behavior.
335
+ #
336
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
337
+ # This includes support for retry quotas, which limit the number of
338
+ # unsuccessful retries a client can make. This is the default value
339
+ # if no retry mode is provided.
340
+ #
341
+ # * `adaptive` - A retry mode that includes all the functionality of
342
+ # `standard` mode along with automatic client side throttling.
343
+ #
344
+ # @option options [String] :sdk_ua_app_id
345
+ # A unique and opaque application ID that is appended to the
346
+ # User-Agent header as app/sdk_ua_app_id. It should have a
347
+ # maximum length of 50. This variable is sourced from environment
348
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
349
+ #
350
+ # @option options [String] :secret_access_key
351
+ #
352
+ # @option options [String] :session_token
353
+ #
354
+ # @option options [Array] :sigv4a_signing_region_set
355
+ # A list of regions that should be signed with SigV4a signing. When
356
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
357
+ # in the following locations:
358
+ #
359
+ # * `Aws.config[:sigv4a_signing_region_set]`
360
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
361
+ # * `~/.aws/config`
362
+ #
363
+ # @option options [Boolean] :stub_responses (false)
364
+ # Causes the client to return stubbed responses. By default
365
+ # fake responses are generated and returned. You can specify
366
+ # the response data to return or errors to raise by calling
367
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
368
+ #
369
+ # ** Please note ** When response stubbing is enabled, no HTTP
370
+ # requests are made, and retries are disabled.
371
+ #
372
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
373
+ # Allows you to provide a telemetry provider, which is used to
374
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
375
+ # will not record or emit any telemetry data. The SDK supports the
376
+ # following telemetry providers:
377
+ #
378
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
379
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
380
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
381
+ #
382
+ # @option options [Aws::TokenProvider] :token_provider
383
+ # Your Bearer token used for authentication. This can be any class that includes and implements
384
+ # `Aws::TokenProvider`, or instance of any one of the following classes:
385
+ #
386
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
387
+ # tokens.
388
+ #
389
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
390
+ # access token generated from `aws login`.
391
+ #
392
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
393
+ # will be used to search for tokens configured for your profile in shared configuration files.
394
+ #
395
+ # @option options [Boolean] :use_dualstack_endpoint
396
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
397
+ # will be used if available.
398
+ #
399
+ # @option options [Boolean] :use_fips_endpoint
400
+ # When set to `true`, fips compatible endpoints will be used if available.
401
+ # When a `fips` region is used, the region is normalized and this config
402
+ # is set to `true`.
403
+ #
404
+ # @option options [Boolean] :validate_params (true)
405
+ # When `true`, request parameters are validated before
406
+ # sending the request.
407
+ #
408
+ # @option options [Aws::APIPortal::EndpointProvider] :endpoint_provider
409
+ # The endpoint provider used to resolve endpoints. Any object that responds to
410
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
411
+ # `Aws::APIPortal::EndpointParameters`.
412
+ #
413
+ # @option options [Float] :http_continue_timeout (1)
414
+ # The number of seconds to wait for a 100-continue response before sending the
415
+ # request body. This option has no effect unless the request has "Expect"
416
+ # header set to "100-continue". Defaults to `nil` which disables this
417
+ # behaviour. This value can safely be set per request on the session.
418
+ #
419
+ # @option options [Float] :http_idle_timeout (5)
420
+ # The number of seconds a connection is allowed to sit idle before it
421
+ # is considered stale. Stale connections are closed and removed from the
422
+ # pool before making a request.
423
+ #
424
+ # @option options [Float] :http_open_timeout (15)
425
+ # The default number of seconds to wait for response data.
426
+ # This value can safely be set per-request on the session.
427
+ #
428
+ # @option options [URI::HTTP,String] :http_proxy
429
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
430
+ #
431
+ # @option options [Float] :http_read_timeout (60)
432
+ # The default number of seconds to wait for response data.
433
+ # This value can safely be set per-request on the session.
434
+ #
435
+ # @option options [Boolean] :http_wire_trace (false)
436
+ # When `true`, HTTP debug output will be sent to the `:logger`.
437
+ #
438
+ # @option options [Proc] :on_chunk_received
439
+ # When a Proc object is provided, it will be used as callback when each chunk
440
+ # of the response body is received. It provides three arguments: the chunk,
441
+ # the number of bytes received, and the total number of
442
+ # bytes in the response (or nil if the server did not send a `content-length`).
443
+ #
444
+ # @option options [Proc] :on_chunk_sent
445
+ # When a Proc object is provided, it will be used as callback when each chunk
446
+ # of the request body is sent. It provides three arguments: the chunk,
447
+ # the number of bytes read from the body, and the total number of
448
+ # bytes in the body.
449
+ #
450
+ # @option options [Boolean] :raise_response_errors (true)
451
+ # When `true`, response errors are raised.
452
+ #
453
+ # @option options [String] :ssl_ca_bundle
454
+ # Full path to the SSL certificate authority bundle file that should be used when
455
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
456
+ # `:ssl_ca_directory` the the system default will be used if available.
457
+ #
458
+ # @option options [String] :ssl_ca_directory
459
+ # Full path of the directory that contains the unbundled SSL certificate
460
+ # authority files for verifying peer certificates. If you do
461
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
462
+ # default will be used if available.
463
+ #
464
+ # @option options [String] :ssl_ca_store
465
+ # Sets the X509::Store to verify peer certificate.
466
+ #
467
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
468
+ # Sets a client certificate when creating http connections.
469
+ #
470
+ # @option options [OpenSSL::PKey] :ssl_key
471
+ # Sets a client key when creating http connections.
472
+ #
473
+ # @option options [Float] :ssl_timeout
474
+ # Sets the SSL timeout in seconds
475
+ #
476
+ # @option options [Boolean] :ssl_verify_peer (true)
477
+ # When `true`, SSL peer certificates are verified when establishing a connection.
478
+ #
479
+ def initialize(*args)
480
+ super
481
+ end
482
+
483
+ # @!group API Operations
484
+
485
+ # Associate one or more Managed APIs with a product. Best-effort — IDs
486
+ # that fail are returned in \{@link
487
+ # AssociateManagedApisResponse#failedItems}; IDs that succeed are
488
+ # omitted. Associating an already-associated Managed API is a no-op (not
489
+ # reported as failure).
490
+ #
491
+ # @option params [required, String] :product_id
492
+ # The identifier of the product to associate the Managed APIs with.
493
+ #
494
+ # @option params [required, Array<String>] :managed_api_ids
495
+ # Bounded list of Managed API IDs, used as the request payload for batch
496
+ # associate/disassociate.
497
+ #
498
+ # @return [Types::AssociateManagedApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
499
+ #
500
+ # * {Types::AssociateManagedApisResponse#failed_items #failed_items} => Array&lt;Types::FailedManagedApiItem&gt;
501
+ #
502
+ # @example Request syntax with placeholder values
503
+ #
504
+ # resp = client.associate_managed_apis({
505
+ # product_id: "ProductId", # required
506
+ # managed_api_ids: ["ManagedApiId"], # required
507
+ # })
508
+ #
509
+ # @example Response structure
510
+ #
511
+ # resp.failed_items #=> Array
512
+ # resp.failed_items[0].managed_api_id #=> String
513
+ # resp.failed_items[0].error_code #=> String, one of "MANAGED_API_NOT_FOUND", "INTERNAL_ERROR"
514
+ # resp.failed_items[0].error_message #=> String
515
+ #
516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/AssociateManagedApis AWS API Documentation
517
+ #
518
+ # @overload associate_managed_apis(params = {})
519
+ # @param [Hash] params ({})
520
+ def associate_managed_apis(params = {}, options = {})
521
+ req = build_request(:associate_managed_apis, params)
522
+ req.send_request(options)
523
+ end
524
+
525
+ # Promote a discovered API in the API inventory into the managed API
526
+ # list.
527
+ #
528
+ # @option params [required, Types::ApiSignature] :api_signature
529
+ # The resource, method, host, port, and path that identify the API.
530
+ #
531
+ # @option params [Hash<String,String>] :tags
532
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
533
+ # per resource.
534
+ #
535
+ # @return [Types::CreateManagedApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
536
+ #
537
+ # * {Types::CreateManagedApiResponse#managed_api_id #managed_api_id} => String
538
+ # * {Types::CreateManagedApiResponse#managed_api_arn #managed_api_arn} => String
539
+ # * {Types::CreateManagedApiResponse#api_signature #api_signature} => Types::ApiSignature
540
+ # * {Types::CreateManagedApiResponse#created_at #created_at} => Time
541
+ # * {Types::CreateManagedApiResponse#updated_at #updated_at} => Time
542
+ # * {Types::CreateManagedApiResponse#tags #tags} => Hash&lt;String,String&gt;
543
+ #
544
+ # @example Request syntax with placeholder values
545
+ #
546
+ # resp = client.create_managed_api({
547
+ # api_signature: { # required
548
+ # resource_arn: "ResourceArn", # required
549
+ # method: "GET", # required, accepts GET, POST, PUT, DELETE, PATCH, ANY, HEAD, OPTIONS
550
+ # hostname: "ApiSignatureHostnameString", # required
551
+ # port: 1, # required
552
+ # path: "ApiSignaturePathString", # required
553
+ # },
554
+ # tags: {
555
+ # "TagKey" => "TagValue",
556
+ # },
557
+ # })
558
+ #
559
+ # @example Response structure
560
+ #
561
+ # resp.managed_api_id #=> String
562
+ # resp.managed_api_arn #=> String
563
+ # resp.api_signature.resource_arn #=> String
564
+ # resp.api_signature.method #=> String, one of "GET", "POST", "PUT", "DELETE", "PATCH", "ANY", "HEAD", "OPTIONS"
565
+ # resp.api_signature.hostname #=> String
566
+ # resp.api_signature.port #=> Integer
567
+ # resp.api_signature.path #=> String
568
+ # resp.created_at #=> Time
569
+ # resp.updated_at #=> Time
570
+ # resp.tags #=> Hash
571
+ # resp.tags["TagKey"] #=> String
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateManagedApi AWS API Documentation
574
+ #
575
+ # @overload create_managed_api(params = {})
576
+ # @param [Hash] params ({})
577
+ def create_managed_api(params = {}, options = {})
578
+ req = build_request(:create_managed_api, params)
579
+ req.send_request(options)
580
+ end
581
+
582
+ # Creates a portal that publishes documentation for the products it
583
+ # includes. Use UpdatePortalPublishStatus to publish it.
584
+ #
585
+ # @option params [required, Types::PortalContent] :portal_content
586
+ # The portal's display name, description, and theme.
587
+ #
588
+ # @option params [required, Types::EndpointConfigurationRequest] :endpoint_configuration
589
+ # Exactly one of the members is set: `none` for no custom domain, or
590
+ # `acmManaged` to bring a domain + ACM certificate. Modeled as a union
591
+ # so the "exactly one" choice is enforced by type.
592
+ #
593
+ # @option params [required, Types::Authorization] :authorization
594
+ # How readers sign in to the portal, and whether fine-grained access
595
+ # control is on.
596
+ #
597
+ # @option params [Array<String>] :included_product_arns
598
+ # The ARNs of the products the portal includes, up to 200.
599
+ #
600
+ # @option params [String] :logo_uri
601
+ # The S3 location of the portal logo, in the form `s3://bucket/key`.
602
+ #
603
+ # @option params [String] :rum_app_monitor_name
604
+ # The name of the CloudWatch RUM app monitor that collects reader
605
+ # telemetry for the portal.
606
+ #
607
+ # @option params [Hash<String,String>] :tags
608
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
609
+ # per resource.
610
+ #
611
+ # @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
612
+ #
613
+ # * {Types::CreatePortalResponse#portal_id #portal_id} => String
614
+ # * {Types::CreatePortalResponse#portal_arn #portal_arn} => String
615
+ # * {Types::CreatePortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
616
+ # * {Types::CreatePortalResponse#authorization #authorization} => Types::Authorization
617
+ # * {Types::CreatePortalResponse#portal_content #portal_content} => Types::PortalContent
618
+ # * {Types::CreatePortalResponse#included_product_arns #included_product_arns} => Array&lt;String&gt;
619
+ # * {Types::CreatePortalResponse#publish_status #publish_status} => String
620
+ # * {Types::CreatePortalResponse#status_exception #status_exception} => Types::PortalStatusException
621
+ # * {Types::CreatePortalResponse#updated_at #updated_at} => Time
622
+ # * {Types::CreatePortalResponse#published_at #published_at} => Time
623
+ # * {Types::CreatePortalResponse#publish_description #publish_description} => String
624
+ # * {Types::CreatePortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
625
+ # * {Types::CreatePortalResponse#tags #tags} => Hash&lt;String,String&gt;
626
+ #
627
+ # @example Request syntax with placeholder values
628
+ #
629
+ # resp = client.create_portal({
630
+ # portal_content: { # required
631
+ # display_name: "PortalName", # required
632
+ # description: "PortalDescription",
633
+ # theme: { # required
634
+ # custom_colors: { # required
635
+ # background_color: "Color", # required
636
+ # navigation_color: "Color", # required
637
+ # header_color: "Color", # required
638
+ # text_color: "Color", # required
639
+ # accent_color: "Color", # required
640
+ # error_validation_color: "Color", # required
641
+ # },
642
+ # logo_uploaded_at: Time.now,
643
+ # },
644
+ # },
645
+ # endpoint_configuration: { # required
646
+ # none: {
647
+ # },
648
+ # acm_managed: {
649
+ # domain_name: "PortalDomainName", # required
650
+ # certificate_arn: "CertificateArn", # required
651
+ # },
652
+ # },
653
+ # authorization: { # required
654
+ # authorization_config: { # required
655
+ # none: {
656
+ # },
657
+ # cognito_config: {
658
+ # user_pool_arn: "UserPoolArn", # required
659
+ # app_client_id: "AppClientId", # required
660
+ # user_pool_domain: "UserPoolDomain", # required
661
+ # identity_pool_id: "IdentityPoolId",
662
+ # },
663
+ # },
664
+ # fine_grained_access_control: "ENABLED", # required, accepts ENABLED, DISABLED
665
+ # },
666
+ # included_product_arns: ["ProductArn"],
667
+ # logo_uri: "LogoUri",
668
+ # rum_app_monitor_name: "RUMAppMonitorName",
669
+ # tags: {
670
+ # "TagKey" => "TagValue",
671
+ # },
672
+ # })
673
+ #
674
+ # @example Response structure
675
+ #
676
+ # resp.portal_id #=> String
677
+ # resp.portal_arn #=> String
678
+ # resp.endpoint_configuration.domain_name #=> String
679
+ # resp.endpoint_configuration.certificate_arn #=> String
680
+ # resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
681
+ # resp.endpoint_configuration.portal_default_domain_name #=> String
682
+ # resp.authorization.authorization_config.cognito_config.user_pool_arn #=> String
683
+ # resp.authorization.authorization_config.cognito_config.app_client_id #=> String
684
+ # resp.authorization.authorization_config.cognito_config.user_pool_domain #=> String
685
+ # resp.authorization.authorization_config.cognito_config.identity_pool_id #=> String
686
+ # resp.authorization.fine_grained_access_control #=> String, one of "ENABLED", "DISABLED"
687
+ # resp.portal_content.display_name #=> String
688
+ # resp.portal_content.description #=> String
689
+ # resp.portal_content.theme.custom_colors.background_color #=> String
690
+ # resp.portal_content.theme.custom_colors.navigation_color #=> String
691
+ # resp.portal_content.theme.custom_colors.header_color #=> String
692
+ # resp.portal_content.theme.custom_colors.text_color #=> String
693
+ # resp.portal_content.theme.custom_colors.accent_color #=> String
694
+ # resp.portal_content.theme.custom_colors.error_validation_color #=> String
695
+ # resp.portal_content.theme.logo_uploaded_at #=> Time
696
+ # resp.included_product_arns #=> Array
697
+ # resp.included_product_arns[0] #=> String
698
+ # resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
699
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
700
+ # resp.status_exception.message #=> String
701
+ # resp.updated_at #=> Time
702
+ # resp.published_at #=> Time
703
+ # resp.publish_description #=> String
704
+ # resp.rum_app_monitor_name #=> String
705
+ # resp.tags #=> Hash
706
+ # resp.tags["TagKey"] #=> String
707
+ #
708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreatePortal AWS API Documentation
709
+ #
710
+ # @overload create_portal(params = {})
711
+ # @param [Hash] params ({})
712
+ def create_portal(params = {}, options = {})
713
+ req = build_request(:create_portal, params)
714
+ req.send_request(options)
715
+ end
716
+
717
+ # Starts building a preview of the portal's current content. Use
718
+ # GetPortal to check the preview status and get the preview URL.
719
+ #
720
+ # @option params [required, String] :portal_id
721
+ # The identifier of the portal.
722
+ #
723
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
724
+ #
725
+ # @example Request syntax with placeholder values
726
+ #
727
+ # resp = client.create_portal_preview({
728
+ # portal_id: "PortalId", # required
729
+ # })
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreatePortalPreview AWS API Documentation
732
+ #
733
+ # @overload create_portal_preview(params = {})
734
+ # @param [Hash] params ({})
735
+ def create_portal_preview(params = {}, options = {})
736
+ req = build_request(:create_portal_preview, params)
737
+ req.send_request(options)
738
+ end
739
+
740
+ # Creates a product. A product groups Managed APIs with their API pages
741
+ # and product pages so a portal can publish them together.
742
+ #
743
+ # @option params [required, String] :display_name
744
+ # The name of the product, from 1 to 255 characters.
745
+ #
746
+ # @option params [String] :description
747
+ # A description of the product, up to 1024 characters.
748
+ #
749
+ # @option params [Hash<String,String>] :tags
750
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
751
+ # per resource.
752
+ #
753
+ # @option params [Types::ApiSelectionConfiguration] :api_selection_configuration
754
+ # How Managed APIs are selected for the product. The selection mode
755
+ # can't be changed after the product is created.
756
+ #
757
+ # @return [Types::CreateProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
758
+ #
759
+ # * {Types::CreateProductResponse#product_id #product_id} => String
760
+ # * {Types::CreateProductResponse#product_arn #product_arn} => String
761
+ # * {Types::CreateProductResponse#display_name #display_name} => String
762
+ # * {Types::CreateProductResponse#display_order #display_order} => Types::DisplayOrder
763
+ # * {Types::CreateProductResponse#description #description} => String
764
+ # * {Types::CreateProductResponse#updated_at #updated_at} => Time
765
+ # * {Types::CreateProductResponse#tags #tags} => Hash&lt;String,String&gt;
766
+ # * {Types::CreateProductResponse#api_selection_configuration #api_selection_configuration} => Types::ApiSelectionConfiguration
767
+ # * {Types::CreateProductResponse#status #status} => String
768
+ # * {Types::CreateProductResponse#failure_reason #failure_reason} => String
769
+ #
770
+ # @example Request syntax with placeholder values
771
+ #
772
+ # resp = client.create_product({
773
+ # display_name: "ProductName", # required
774
+ # description: "ProductDescription",
775
+ # tags: {
776
+ # "TagKey" => "TagValue",
777
+ # },
778
+ # api_selection_configuration: {
779
+ # api_selection_mode: "CUSTOM", # required, accepts CUSTOM, RULE_BASED
780
+ # rule_filters: [
781
+ # {
782
+ # key: "RESOURCE_ARN", # required, accepts RESOURCE_ARN, HOST, METHOD, PATH, PORT, ACCOUNT
783
+ # values: ["RuleFilterValue"], # required
784
+ # },
785
+ # ],
786
+ # },
787
+ # })
788
+ #
789
+ # @example Response structure
790
+ #
791
+ # resp.product_id #=> String
792
+ # resp.product_arn #=> String
793
+ # resp.display_name #=> String
794
+ # resp.display_order.overview_page_arn #=> String
795
+ # resp.display_order.product_page_arns #=> Array
796
+ # resp.display_order.product_page_arns[0] #=> String
797
+ # resp.display_order.contents #=> Array
798
+ # resp.display_order.contents[0].section_name #=> String
799
+ # resp.display_order.contents[0].product_api_page_arns #=> Array
800
+ # resp.display_order.contents[0].product_api_page_arns[0] #=> String
801
+ # resp.description #=> String
802
+ # resp.updated_at #=> Time
803
+ # resp.tags #=> Hash
804
+ # resp.tags["TagKey"] #=> String
805
+ # resp.api_selection_configuration.api_selection_mode #=> String, one of "CUSTOM", "RULE_BASED"
806
+ # resp.api_selection_configuration.rule_filters #=> Array
807
+ # resp.api_selection_configuration.rule_filters[0].key #=> String, one of "RESOURCE_ARN", "HOST", "METHOD", "PATH", "PORT", "ACCOUNT"
808
+ # resp.api_selection_configuration.rule_filters[0].values #=> Array
809
+ # resp.api_selection_configuration.rule_filters[0].values[0] #=> String
810
+ # resp.status #=> String, one of "ACTIVE", "IN_PROGRESS", "FAILED"
811
+ # resp.failure_reason #=> String, one of "API_PAGE_ATTACHED", "EVALUATION_ERROR"
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProduct AWS API Documentation
814
+ #
815
+ # @overload create_product(params = {})
816
+ # @param [Hash] params ({})
817
+ def create_product(params = {}, options = {})
818
+ req = build_request(:create_product, params)
819
+ req.send_request(options)
820
+ end
821
+
822
+ # Creates an API page that documents a Managed API in a product. The
823
+ # page content is generated asynchronously. Use `status` to track it.
824
+ #
825
+ # @option params [required, String] :product_id
826
+ # The identifier of the product.
827
+ #
828
+ # @option params [required, String] :managed_api_id
829
+ # The Managed API this page documents. It must already be associated
830
+ # with the product, and the page's API identifier is taken from the
831
+ # Managed API rather than supplied by the caller.
832
+ #
833
+ # @option params [Types::ApiPageDisplayContent] :display_content
834
+ # Exactly one of the members is set: `none` to use default display
835
+ # content, or `overrides` to customize it. Modeled as a union so the
836
+ # "exactly one" choice is enforced by type.
837
+ #
838
+ # @option params [String] :try_it_state
839
+ # Whether readers can call the API from the page with Try-It. Defaults
840
+ # to `DISABLED`. To enable it, the page's API URL must use HTTPS on a
841
+ # domain that supports Try-It.
842
+ #
843
+ # @option params [Hash<String,String>] :tags
844
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
845
+ # per resource.
846
+ #
847
+ # @return [Types::CreateProductApiPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
848
+ #
849
+ # * {Types::CreateProductApiPageResponse#product_api_page_id #product_api_page_id} => String
850
+ # * {Types::CreateProductApiPageResponse#product_api_page_arn #product_api_page_arn} => String
851
+ # * {Types::CreateProductApiPageResponse#api_id #api_id} => Types::ApiId
852
+ # * {Types::CreateProductApiPageResponse#display_content #display_content} => Types::ApiPageDisplayContentResponse
853
+ # * {Types::CreateProductApiPageResponse#try_it_state #try_it_state} => String
854
+ # * {Types::CreateProductApiPageResponse#updated_at #updated_at} => Time
855
+ # * {Types::CreateProductApiPageResponse#status #status} => String
856
+ # * {Types::CreateProductApiPageResponse#status_exception #status_exception} => Types::ProductApiPageStatusException
857
+ # * {Types::CreateProductApiPageResponse#tags #tags} => Hash&lt;String,String&gt;
858
+ #
859
+ # @example Request syntax with placeholder values
860
+ #
861
+ # resp = client.create_product_api_page({
862
+ # product_id: "ProductId", # required
863
+ # managed_api_id: "ManagedApiId", # required
864
+ # display_content: {
865
+ # none: {
866
+ # },
867
+ # overrides: {
868
+ # operation_name: "OperationName",
869
+ # api_url: "DisplayContentOverridesApiUrlString",
870
+ # body: "ApiPageBody",
871
+ # },
872
+ # },
873
+ # try_it_state: "ENABLED", # accepts ENABLED, DISABLED
874
+ # tags: {
875
+ # "TagKey" => "TagValue",
876
+ # },
877
+ # })
878
+ #
879
+ # @example Response structure
880
+ #
881
+ # resp.product_api_page_id #=> String
882
+ # resp.product_api_page_arn #=> String
883
+ # resp.api_id.identifier_parts.path #=> String
884
+ # resp.api_id.identifier_parts.method #=> String
885
+ # resp.api_id.identifier_parts.resource_arn #=> String
886
+ # resp.display_content.operation_name #=> String
887
+ # resp.display_content.api_url #=> String
888
+ # resp.display_content.body #=> String
889
+ # resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
890
+ # resp.updated_at #=> Time
891
+ # resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
892
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "RESOURCE_DELETED", "MEMBER_LEFT_ORG"
893
+ # resp.status_exception.message #=> String
894
+ # resp.tags #=> Hash
895
+ # resp.tags["TagKey"] #=> String
896
+ #
897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductApiPage AWS API Documentation
898
+ #
899
+ # @overload create_product_api_page(params = {})
900
+ # @param [Hash] params ({})
901
+ def create_product_api_page(params = {}, options = {})
902
+ req = build_request(:create_product_api_page, params)
903
+ req.send_request(options)
904
+ end
905
+
906
+ # Creates a product page with free-form documentation. A product can
907
+ # have up to 40 pages.
908
+ #
909
+ # @option params [required, String] :product_id
910
+ # The identifier of the product.
911
+ #
912
+ # @option params [required, Types::DisplayContent] :display_content
913
+ # The title and body of the page.
914
+ #
915
+ # @option params [Hash<String,String>] :tags
916
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
917
+ # per resource.
918
+ #
919
+ # @return [Types::CreateProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
920
+ #
921
+ # * {Types::CreateProductPageResponse#product_page_id #product_page_id} => String
922
+ # * {Types::CreateProductPageResponse#product_page_arn #product_page_arn} => String
923
+ # * {Types::CreateProductPageResponse#display_content #display_content} => Types::DisplayContent
924
+ # * {Types::CreateProductPageResponse#updated_at #updated_at} => Time
925
+ # * {Types::CreateProductPageResponse#tags #tags} => Hash&lt;String,String&gt;
926
+ #
927
+ # @example Request syntax with placeholder values
928
+ #
929
+ # resp = client.create_product_page({
930
+ # product_id: "ProductId", # required
931
+ # display_content: { # required
932
+ # title: "PageTitle", # required
933
+ # body: "PageBody", # required
934
+ # },
935
+ # tags: {
936
+ # "TagKey" => "TagValue",
937
+ # },
938
+ # })
939
+ #
940
+ # @example Response structure
941
+ #
942
+ # resp.product_page_id #=> String
943
+ # resp.product_page_arn #=> String
944
+ # resp.display_content.title #=> String
945
+ # resp.display_content.body #=> String
946
+ # resp.updated_at #=> Time
947
+ # resp.tags #=> Hash
948
+ # resp.tags["TagKey"] #=> String
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductPage AWS API Documentation
951
+ #
952
+ # @overload create_product_page(params = {})
953
+ # @param [Hash] params ({})
954
+ def create_product_page(params = {}, options = {})
955
+ req = build_request(:create_product_page, params)
956
+ req.send_request(options)
957
+ end
958
+
959
+ # Deletes the discovery configuration and stops any running discovery.
960
+ #
961
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteDiscoveryConfiguration AWS API Documentation
964
+ #
965
+ # @overload delete_discovery_configuration(params = {})
966
+ # @param [Hash] params ({})
967
+ def delete_discovery_configuration(params = {}, options = {})
968
+ req = build_request(:delete_discovery_configuration, params)
969
+ req.send_request(options)
970
+ end
971
+
972
+ # Deletes a Managed API.
973
+ #
974
+ # @option params [required, String] :managed_api_id
975
+ # The identifier of the Managed API.
976
+ #
977
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
978
+ #
979
+ # @example Request syntax with placeholder values
980
+ #
981
+ # resp = client.delete_managed_api({
982
+ # managed_api_id: "ManagedApiId", # required
983
+ # })
984
+ #
985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteManagedApi AWS API Documentation
986
+ #
987
+ # @overload delete_managed_api(params = {})
988
+ # @param [Hash] params ({})
989
+ def delete_managed_api(params = {}, options = {})
990
+ req = build_request(:delete_managed_api, params)
991
+ req.send_request(options)
992
+ end
993
+
994
+ # Deletes the organization-wide discovery configuration and stops any
995
+ # running discovery across the organization. Only the organization
996
+ # management account may call this operation.
997
+ #
998
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
999
+ #
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteOrganizationDiscoveryConfiguration AWS API Documentation
1001
+ #
1002
+ # @overload delete_organization_discovery_configuration(params = {})
1003
+ # @param [Hash] params ({})
1004
+ def delete_organization_discovery_configuration(params = {}, options = {})
1005
+ req = build_request(:delete_organization_discovery_configuration, params)
1006
+ req.send_request(options)
1007
+ end
1008
+
1009
+ # Deletes a portal.
1010
+ #
1011
+ # @option params [required, String] :portal_id
1012
+ # The identifier of the portal.
1013
+ #
1014
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1015
+ #
1016
+ # @example Request syntax with placeholder values
1017
+ #
1018
+ # resp = client.delete_portal({
1019
+ # portal_id: "PortalId", # required
1020
+ # })
1021
+ #
1022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeletePortal AWS API Documentation
1023
+ #
1024
+ # @overload delete_portal(params = {})
1025
+ # @param [Hash] params ({})
1026
+ def delete_portal(params = {}, options = {})
1027
+ req = build_request(:delete_portal, params)
1028
+ req.send_request(options)
1029
+ end
1030
+
1031
+ # Deletes a product.
1032
+ #
1033
+ # @option params [required, String] :product_id
1034
+ # The identifier of the product.
1035
+ #
1036
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1037
+ #
1038
+ # @example Request syntax with placeholder values
1039
+ #
1040
+ # resp = client.delete_product({
1041
+ # product_id: "ProductId", # required
1042
+ # })
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProduct AWS API Documentation
1045
+ #
1046
+ # @overload delete_product(params = {})
1047
+ # @param [Hash] params ({})
1048
+ def delete_product(params = {}, options = {})
1049
+ req = build_request(:delete_product, params)
1050
+ req.send_request(options)
1051
+ end
1052
+
1053
+ # Deletes an API page.
1054
+ #
1055
+ # @option params [required, String] :product_id
1056
+ # The identifier of the product.
1057
+ #
1058
+ # @option params [required, String] :product_api_page_id
1059
+ # The identifier of the API page.
1060
+ #
1061
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1062
+ #
1063
+ # @example Request syntax with placeholder values
1064
+ #
1065
+ # resp = client.delete_product_api_page({
1066
+ # product_id: "ProductId", # required
1067
+ # product_api_page_id: "ProductApiPageId", # required
1068
+ # })
1069
+ #
1070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductApiPage AWS API Documentation
1071
+ #
1072
+ # @overload delete_product_api_page(params = {})
1073
+ # @param [Hash] params ({})
1074
+ def delete_product_api_page(params = {}, options = {})
1075
+ req = build_request(:delete_product_api_page, params)
1076
+ req.send_request(options)
1077
+ end
1078
+
1079
+ # Deletes a product page.
1080
+ #
1081
+ # @option params [required, String] :product_id
1082
+ # The identifier of the product.
1083
+ #
1084
+ # @option params [required, String] :product_page_id
1085
+ # The identifier of the product page.
1086
+ #
1087
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1088
+ #
1089
+ # @example Request syntax with placeholder values
1090
+ #
1091
+ # resp = client.delete_product_page({
1092
+ # product_id: "ProductId", # required
1093
+ # product_page_id: "ProductPageId", # required
1094
+ # })
1095
+ #
1096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductPage AWS API Documentation
1097
+ #
1098
+ # @overload delete_product_page(params = {})
1099
+ # @param [Hash] params ({})
1100
+ def delete_product_page(params = {}, options = {})
1101
+ req = build_request(:delete_product_page, params)
1102
+ req.send_request(options)
1103
+ end
1104
+
1105
+ # Deletes the sharing policy of a product. The product is no longer
1106
+ # shared.
1107
+ #
1108
+ # @option params [required, String] :product_id
1109
+ # The identifier of the product.
1110
+ #
1111
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1112
+ #
1113
+ # @example Request syntax with placeholder values
1114
+ #
1115
+ # resp = client.delete_product_sharing_policy({
1116
+ # product_id: "ProductId", # required
1117
+ # })
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductSharingPolicy AWS API Documentation
1120
+ #
1121
+ # @overload delete_product_sharing_policy(params = {})
1122
+ # @param [Hash] params ({})
1123
+ def delete_product_sharing_policy(params = {}, options = {})
1124
+ req = build_request(:delete_product_sharing_policy, params)
1125
+ req.send_request(options)
1126
+ end
1127
+
1128
+ # Disassociate one or more Managed APIs from a product. Best-effort —
1129
+ # IDs that fail are returned in \{@link
1130
+ # DisassociateManagedApisResponse#failedItems}; IDs that succeed are
1131
+ # omitted. Disassociating an unmapped Managed API is a no-op (not
1132
+ # reported as failure).
1133
+ #
1134
+ # @option params [required, String] :product_id
1135
+ # The identifier of the product to disassociate the Managed APIs from.
1136
+ #
1137
+ # @option params [required, Array<String>] :managed_api_ids
1138
+ # Bounded list of Managed API IDs, used as the request payload for batch
1139
+ # associate/disassociate.
1140
+ #
1141
+ # @return [Types::DisassociateManagedApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1142
+ #
1143
+ # * {Types::DisassociateManagedApisResponse#failed_items #failed_items} => Array&lt;Types::FailedManagedApiItem&gt;
1144
+ #
1145
+ # @example Request syntax with placeholder values
1146
+ #
1147
+ # resp = client.disassociate_managed_apis({
1148
+ # product_id: "ProductId", # required
1149
+ # managed_api_ids: ["ManagedApiId"], # required
1150
+ # })
1151
+ #
1152
+ # @example Response structure
1153
+ #
1154
+ # resp.failed_items #=> Array
1155
+ # resp.failed_items[0].managed_api_id #=> String
1156
+ # resp.failed_items[0].error_code #=> String, one of "MANAGED_API_NOT_FOUND", "INTERNAL_ERROR"
1157
+ # resp.failed_items[0].error_message #=> String
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisassociateManagedApis AWS API Documentation
1160
+ #
1161
+ # @overload disassociate_managed_apis(params = {})
1162
+ # @param [Hash] params ({})
1163
+ def disassociate_managed_apis(params = {}, options = {})
1164
+ req = build_request(:disassociate_managed_apis, params)
1165
+ req.send_request(options)
1166
+ end
1167
+
1168
+ # Gets full details of a single API inventory item.
1169
+ #
1170
+ # @option params [required, String] :method
1171
+ # The HTTP method of the API.
1172
+ #
1173
+ # @option params [required, String] :host
1174
+ # A discovered API's front-door hostname (e.g. an ALB, CloudFront, or
1175
+ # API Gateway DNS name), bounded by the DNS name limit (RFC 1035).
1176
+ # Usually literal, but may contain placeholders: &lt;*&gt; - stands for
1177
+ # one dot-separated part of the hostname. When 10 or more hosts differ
1178
+ # only in that part, they fold into one, e.g. a.example.com,
1179
+ # b.example.com, ... become "&lt;*&gt;.example.com". Deeper levels fold
1180
+ # the same way ("&lt;*&gt;.&lt;*&gt;.example.com"). The registrable
1181
+ # domain never folds. <ip> - an IP-literal host.</p> </ip>
1182
+ #
1183
+ # @option params [required, Integer] :port
1184
+ # The port the API listens on, from 0 to 65535.
1185
+ #
1186
+ # @option params [required, String] :path
1187
+ # The request path of the API.
1188
+ #
1189
+ # @option params [required, String] :resource_arn
1190
+ # The ARN of the resource that serves the API, such as an API Gateway
1191
+ # stage or a load balancer.
1192
+ #
1193
+ # @return [Types::GetApiInventoryItemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1194
+ #
1195
+ # * {Types::GetApiInventoryItemResponse#item #item} => Types::ApiInventoryItemDetail
1196
+ #
1197
+ # @example Request syntax with placeholder values
1198
+ #
1199
+ # resp = client.get_api_inventory_item({
1200
+ # method: "GET", # required, accepts GET, POST, PUT, DELETE, PATCH, ANY, HEAD, OPTIONS
1201
+ # host: "Host", # required
1202
+ # port: 1, # required
1203
+ # path: "Path", # required
1204
+ # resource_arn: "ResourceArn", # required
1205
+ # })
1206
+ #
1207
+ # @example Response structure
1208
+ #
1209
+ # resp.item.method #=> String, one of "GET", "POST", "PUT", "DELETE", "PATCH", "ANY", "HEAD", "OPTIONS"
1210
+ # resp.item.host #=> String
1211
+ # resp.item.port #=> Integer
1212
+ # resp.item.path #=> String
1213
+ # resp.item.account_id #=> String
1214
+ # resp.item.resource_arn #=> String
1215
+ # resp.item.region #=> String
1216
+ # resp.item.discovery_source #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
1217
+ # resp.item.visibility #=> String, one of "PUBLIC", "PRIVATE"
1218
+ # resp.item.waf_status #=> String, one of "ENABLED", "DISABLED"
1219
+ # resp.item.classification #=> String, one of "SHADOW", "MANAGED", "MANAGED_ZOMBIE", "MANAGED_ORPHANED"
1220
+ # resp.item.managed_by #=> String, one of "SELF", "ORGANIZATION"
1221
+ # resp.item.workloads #=> Array
1222
+ # resp.item.workloads[0] #=> String, one of "MCP", "LLM", "A2A"
1223
+ # resp.item.managed_api_id #=> String
1224
+ #
1225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetApiInventoryItem AWS API Documentation
1226
+ #
1227
+ # @overload get_api_inventory_item(params = {})
1228
+ # @param [Hash] params ({})
1229
+ def get_api_inventory_item(params = {}, options = {})
1230
+ req = build_request(:get_api_inventory_item, params)
1231
+ req.send_request(options)
1232
+ end
1233
+
1234
+ # Retrieves the discovery configuration for the account and region.
1235
+ #
1236
+ # @return [Types::GetDiscoveryConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1237
+ #
1238
+ # * {Types::GetDiscoveryConfigurationResponse#discovery_configuration #discovery_configuration} => Types::DiscoveryConfigurationData
1239
+ # * {Types::GetDiscoveryConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;
1240
+ #
1241
+ # @example Response structure
1242
+ #
1243
+ # resp.discovery_configuration.arn #=> String
1244
+ # resp.discovery_configuration.status #=> String, one of "DISABLED", "ENABLED", "UPDATING"
1245
+ # resp.discovery_configuration.discovery_sources #=> Array
1246
+ # resp.discovery_configuration.discovery_sources[0] #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
1247
+ # resp.discovery_configuration.excluded_resources #=> Array
1248
+ # resp.discovery_configuration.excluded_resources[0] #=> String
1249
+ # resp.discovery_configuration.features #=> Array
1250
+ # resp.discovery_configuration.features[0] #=> String, one of "AI_DISCOVERY"
1251
+ # resp.discovery_configuration.created_at #=> Time
1252
+ # resp.discovery_configuration.updated_at #=> Time
1253
+ # resp.tags #=> Hash
1254
+ # resp.tags["TagKey"] #=> String
1255
+ #
1256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetDiscoveryConfiguration AWS API Documentation
1257
+ #
1258
+ # @overload get_discovery_configuration(params = {})
1259
+ # @param [Hash] params ({})
1260
+ def get_discovery_configuration(params = {}, options = {})
1261
+ req = build_request(:get_discovery_configuration, params)
1262
+ req.send_request(options)
1263
+ end
1264
+
1265
+ # Returns a Managed API, including its security posture findings.
1266
+ #
1267
+ # @option params [required, String] :managed_api_id
1268
+ # The identifier of the Managed API.
1269
+ #
1270
+ # @return [Types::GetManagedApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1271
+ #
1272
+ # * {Types::GetManagedApiResponse#managed_api_id #managed_api_id} => String
1273
+ # * {Types::GetManagedApiResponse#managed_api_arn #managed_api_arn} => String
1274
+ # * {Types::GetManagedApiResponse#api_signature #api_signature} => Types::ApiSignature
1275
+ # * {Types::GetManagedApiResponse#created_at #created_at} => Time
1276
+ # * {Types::GetManagedApiResponse#updated_at #updated_at} => Time
1277
+ # * {Types::GetManagedApiResponse#findings #findings} => Array&lt;Types::ManagedApiFinding&gt;
1278
+ # * {Types::GetManagedApiResponse#tags #tags} => Hash&lt;String,String&gt;
1279
+ #
1280
+ # @example Request syntax with placeholder values
1281
+ #
1282
+ # resp = client.get_managed_api({
1283
+ # managed_api_id: "ManagedApiId", # required
1284
+ # })
1285
+ #
1286
+ # @example Response structure
1287
+ #
1288
+ # resp.managed_api_id #=> String
1289
+ # resp.managed_api_arn #=> String
1290
+ # resp.api_signature.resource_arn #=> String
1291
+ # resp.api_signature.method #=> String, one of "GET", "POST", "PUT", "DELETE", "PATCH", "ANY", "HEAD", "OPTIONS"
1292
+ # resp.api_signature.hostname #=> String
1293
+ # resp.api_signature.port #=> Integer
1294
+ # resp.api_signature.path #=> String
1295
+ # resp.created_at #=> Time
1296
+ # resp.updated_at #=> Time
1297
+ # resp.findings #=> Array
1298
+ # resp.findings[0].posture_id #=> String
1299
+ # resp.findings[0].posture_status #=> String, one of "TRUE", "FALSE", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
1300
+ # resp.findings[0].reason #=> String, one of "AUTHENTICATION_NOT_CONFIGURED", "REQUEST_VALIDATION_NOT_ENABLED", "API_KEY_NOT_CONFIGURED", "THROTTLING_NOT_ENABLED", "THROTTLING_RATE_LIMIT_NOT_SET", "THROTTLING_BURST_LIMIT_NOT_SET", "RESPONSE_CACHING_NOT_ENABLED", "STAGE_WAF_NOT_ASSOCIATED", "STAGE_ACCESS_LOGGING_NOT_ENABLED", "PRIVATE_API_RESOURCE_POLICY_MISSING", "REST_API_TLS_BELOW_1_2", "LOAD_BALANCER_WAF_NOT_ASSOCIATED", "LISTENER_TLS_BELOW_1_2", "DISTRIBUTION_TLS_BELOW_1_2", "DISTRIBUTION_WAF_NOT_ASSOCIATED", "DISTRIBUTION_SERVES_PLAINTEXT_HTTP", "DISTRIBUTION_ACCESS_LOGGING_NOT_ENABLED", "GEO_RESTRICTION_NOT_CONFIGURED", "UNKNOWN"
1301
+ # resp.findings[0].updated_at #=> Time
1302
+ # resp.tags #=> Hash
1303
+ # resp.tags["TagKey"] #=> String
1304
+ #
1305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetManagedApi AWS API Documentation
1306
+ #
1307
+ # @overload get_managed_api(params = {})
1308
+ # @param [Hash] params ({})
1309
+ def get_managed_api(params = {}, options = {})
1310
+ req = build_request(:get_managed_api, params)
1311
+ req.send_request(options)
1312
+ end
1313
+
1314
+ # Retrieves the organization-wide discovery configuration. Only the
1315
+ # organization management account and registered delegated
1316
+ # administrators may call this operation.
1317
+ #
1318
+ # @return [Types::GetOrganizationDiscoveryConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1319
+ #
1320
+ # * {Types::GetOrganizationDiscoveryConfigurationResponse#discovery_configuration #discovery_configuration} => Types::OrganizationDiscoveryConfigurationData
1321
+ # * {Types::GetOrganizationDiscoveryConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;
1322
+ #
1323
+ # @example Response structure
1324
+ #
1325
+ # resp.discovery_configuration.arn #=> String
1326
+ # resp.discovery_configuration.status #=> String, one of "DISABLED", "ENABLED", "UPDATING"
1327
+ # resp.discovery_configuration.discovery_sources #=> Array
1328
+ # resp.discovery_configuration.discovery_sources[0] #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
1329
+ # resp.discovery_configuration.exclusion_filters.organizational_unit_ids #=> Array
1330
+ # resp.discovery_configuration.exclusion_filters.organizational_unit_ids[0] #=> String
1331
+ # resp.discovery_configuration.exclusion_filters.account_ids #=> Array
1332
+ # resp.discovery_configuration.exclusion_filters.account_ids[0] #=> String
1333
+ # resp.discovery_configuration.exclusion_filters.resource_arns #=> Array
1334
+ # resp.discovery_configuration.exclusion_filters.resource_arns[0] #=> String
1335
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.organizational_unit_ids #=> Array
1336
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.organizational_unit_ids[0] #=> String
1337
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.account_ids #=> Array
1338
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.account_ids[0] #=> String
1339
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.resource_arns #=> Array
1340
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.resource_arns[0] #=> String
1341
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.organizational_unit_ids #=> Array
1342
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.organizational_unit_ids[0] #=> String
1343
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.account_ids #=> Array
1344
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.account_ids[0] #=> String
1345
+ # resp.discovery_configuration.features #=> Array
1346
+ # resp.discovery_configuration.features[0] #=> String, one of "AI_DISCOVERY"
1347
+ # resp.discovery_configuration.created_at #=> Time
1348
+ # resp.discovery_configuration.updated_at #=> Time
1349
+ # resp.tags #=> Hash
1350
+ # resp.tags["TagKey"] #=> String
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetOrganizationDiscoveryConfiguration AWS API Documentation
1353
+ #
1354
+ # @overload get_organization_discovery_configuration(params = {})
1355
+ # @param [Hash] params ({})
1356
+ def get_organization_discovery_configuration(params = {}, options = {})
1357
+ req = build_request(:get_organization_discovery_configuration, params)
1358
+ req.send_request(options)
1359
+ end
1360
+
1361
+ # Returns the configuration, publish status, and preview status of a
1362
+ # portal.
1363
+ #
1364
+ # @option params [required, String] :portal_id
1365
+ # The identifier of the portal.
1366
+ #
1367
+ # @return [Types::GetPortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1368
+ #
1369
+ # * {Types::GetPortalResponse#portal_id #portal_id} => String
1370
+ # * {Types::GetPortalResponse#portal_arn #portal_arn} => String
1371
+ # * {Types::GetPortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
1372
+ # * {Types::GetPortalResponse#authorization #authorization} => Types::Authorization
1373
+ # * {Types::GetPortalResponse#portal_content #portal_content} => Types::PortalContent
1374
+ # * {Types::GetPortalResponse#included_product_arns #included_product_arns} => Array&lt;String&gt;
1375
+ # * {Types::GetPortalResponse#publish_status #publish_status} => String
1376
+ # * {Types::GetPortalResponse#status_exception #status_exception} => Types::PortalStatusException
1377
+ # * {Types::GetPortalResponse#updated_at #updated_at} => Time
1378
+ # * {Types::GetPortalResponse#published_at #published_at} => Time
1379
+ # * {Types::GetPortalResponse#publish_description #publish_description} => String
1380
+ # * {Types::GetPortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
1381
+ # * {Types::GetPortalResponse#preview #preview} => Types::Preview
1382
+ # * {Types::GetPortalResponse#tags #tags} => Hash&lt;String,String&gt;
1383
+ #
1384
+ # @example Request syntax with placeholder values
1385
+ #
1386
+ # resp = client.get_portal({
1387
+ # portal_id: "PortalId", # required
1388
+ # })
1389
+ #
1390
+ # @example Response structure
1391
+ #
1392
+ # resp.portal_id #=> String
1393
+ # resp.portal_arn #=> String
1394
+ # resp.endpoint_configuration.domain_name #=> String
1395
+ # resp.endpoint_configuration.certificate_arn #=> String
1396
+ # resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
1397
+ # resp.endpoint_configuration.portal_default_domain_name #=> String
1398
+ # resp.authorization.authorization_config.cognito_config.user_pool_arn #=> String
1399
+ # resp.authorization.authorization_config.cognito_config.app_client_id #=> String
1400
+ # resp.authorization.authorization_config.cognito_config.user_pool_domain #=> String
1401
+ # resp.authorization.authorization_config.cognito_config.identity_pool_id #=> String
1402
+ # resp.authorization.fine_grained_access_control #=> String, one of "ENABLED", "DISABLED"
1403
+ # resp.portal_content.display_name #=> String
1404
+ # resp.portal_content.description #=> String
1405
+ # resp.portal_content.theme.custom_colors.background_color #=> String
1406
+ # resp.portal_content.theme.custom_colors.navigation_color #=> String
1407
+ # resp.portal_content.theme.custom_colors.header_color #=> String
1408
+ # resp.portal_content.theme.custom_colors.text_color #=> String
1409
+ # resp.portal_content.theme.custom_colors.accent_color #=> String
1410
+ # resp.portal_content.theme.custom_colors.error_validation_color #=> String
1411
+ # resp.portal_content.theme.logo_uploaded_at #=> Time
1412
+ # resp.included_product_arns #=> Array
1413
+ # resp.included_product_arns[0] #=> String
1414
+ # resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
1415
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
1416
+ # resp.status_exception.message #=> String
1417
+ # resp.updated_at #=> Time
1418
+ # resp.published_at #=> Time
1419
+ # resp.publish_description #=> String
1420
+ # resp.rum_app_monitor_name #=> String
1421
+ # resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
1422
+ # resp.preview.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
1423
+ # resp.preview.status_exception.message #=> String
1424
+ # resp.preview.preview_url #=> String
1425
+ # resp.tags #=> Hash
1426
+ # resp.tags["TagKey"] #=> String
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetPortal AWS API Documentation
1429
+ #
1430
+ # @overload get_portal(params = {})
1431
+ # @param [Hash] params ({})
1432
+ def get_portal(params = {}, options = {})
1433
+ req = build_request(:get_portal, params)
1434
+ req.send_request(options)
1435
+ end
1436
+
1437
+ # Returns a product. To read a product shared with you by another
1438
+ # account, supply `resourceOwnerAccountId`.
1439
+ #
1440
+ # @option params [required, String] :product_id
1441
+ # The identifier of the product.
1442
+ #
1443
+ # @option params [String] :resource_owner_account_id
1444
+ # The AWS account ID that owns the product. Supply it to read a product
1445
+ # shared with you by another account. Omit it for products in your own
1446
+ # account.
1447
+ #
1448
+ # @return [Types::GetProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1449
+ #
1450
+ # * {Types::GetProductResponse#product_id #product_id} => String
1451
+ # * {Types::GetProductResponse#product_arn #product_arn} => String
1452
+ # * {Types::GetProductResponse#display_name #display_name} => String
1453
+ # * {Types::GetProductResponse#display_order #display_order} => Types::DisplayOrder
1454
+ # * {Types::GetProductResponse#description #description} => String
1455
+ # * {Types::GetProductResponse#updated_at #updated_at} => Time
1456
+ # * {Types::GetProductResponse#tags #tags} => Hash&lt;String,String&gt;
1457
+ # * {Types::GetProductResponse#api_selection_configuration #api_selection_configuration} => Types::ApiSelectionConfiguration
1458
+ # * {Types::GetProductResponse#status #status} => String
1459
+ # * {Types::GetProductResponse#failure_reason #failure_reason} => String
1460
+ #
1461
+ # @example Request syntax with placeholder values
1462
+ #
1463
+ # resp = client.get_product({
1464
+ # product_id: "ProductId", # required
1465
+ # resource_owner_account_id: "AccountId",
1466
+ # })
1467
+ #
1468
+ # @example Response structure
1469
+ #
1470
+ # resp.product_id #=> String
1471
+ # resp.product_arn #=> String
1472
+ # resp.display_name #=> String
1473
+ # resp.display_order.overview_page_arn #=> String
1474
+ # resp.display_order.product_page_arns #=> Array
1475
+ # resp.display_order.product_page_arns[0] #=> String
1476
+ # resp.display_order.contents #=> Array
1477
+ # resp.display_order.contents[0].section_name #=> String
1478
+ # resp.display_order.contents[0].product_api_page_arns #=> Array
1479
+ # resp.display_order.contents[0].product_api_page_arns[0] #=> String
1480
+ # resp.description #=> String
1481
+ # resp.updated_at #=> Time
1482
+ # resp.tags #=> Hash
1483
+ # resp.tags["TagKey"] #=> String
1484
+ # resp.api_selection_configuration.api_selection_mode #=> String, one of "CUSTOM", "RULE_BASED"
1485
+ # resp.api_selection_configuration.rule_filters #=> Array
1486
+ # resp.api_selection_configuration.rule_filters[0].key #=> String, one of "RESOURCE_ARN", "HOST", "METHOD", "PATH", "PORT", "ACCOUNT"
1487
+ # resp.api_selection_configuration.rule_filters[0].values #=> Array
1488
+ # resp.api_selection_configuration.rule_filters[0].values[0] #=> String
1489
+ # resp.status #=> String, one of "ACTIVE", "IN_PROGRESS", "FAILED"
1490
+ # resp.failure_reason #=> String, one of "API_PAGE_ATTACHED", "EVALUATION_ERROR"
1491
+ #
1492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProduct AWS API Documentation
1493
+ #
1494
+ # @overload get_product(params = {})
1495
+ # @param [Hash] params ({})
1496
+ def get_product(params = {}, options = {})
1497
+ req = build_request(:get_product, params)
1498
+ req.send_request(options)
1499
+ end
1500
+
1501
+ # Returns an API page, including its body.
1502
+ #
1503
+ # @option params [required, String] :product_id
1504
+ # The identifier of the product.
1505
+ #
1506
+ # @option params [required, String] :product_api_page_id
1507
+ # The identifier of the API page.
1508
+ #
1509
+ # @option params [String] :resource_owner_account_id
1510
+ # The AWS account ID that owns the product. Supply it to read a product
1511
+ # shared with you by another account. Omit it for products in your own
1512
+ # account.
1513
+ #
1514
+ # @option params [Boolean] :include_raw_display_content
1515
+ # Set to `true` to also return the page body in `rawDisplayContent`.
1516
+ #
1517
+ # @return [Types::GetProductApiPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1518
+ #
1519
+ # * {Types::GetProductApiPageResponse#product_api_page_id #product_api_page_id} => String
1520
+ # * {Types::GetProductApiPageResponse#product_api_page_arn #product_api_page_arn} => String
1521
+ # * {Types::GetProductApiPageResponse#api_id #api_id} => Types::ApiId
1522
+ # * {Types::GetProductApiPageResponse#display_content #display_content} => Types::ApiPageDisplayContentResponse
1523
+ # * {Types::GetProductApiPageResponse#try_it_state #try_it_state} => String
1524
+ # * {Types::GetProductApiPageResponse#updated_at #updated_at} => Time
1525
+ # * {Types::GetProductApiPageResponse#status #status} => String
1526
+ # * {Types::GetProductApiPageResponse#raw_display_content #raw_display_content} => String
1527
+ # * {Types::GetProductApiPageResponse#status_exception #status_exception} => Types::ProductApiPageStatusException
1528
+ # * {Types::GetProductApiPageResponse#tags #tags} => Hash&lt;String,String&gt;
1529
+ #
1530
+ # @example Request syntax with placeholder values
1531
+ #
1532
+ # resp = client.get_product_api_page({
1533
+ # product_id: "ProductId", # required
1534
+ # product_api_page_id: "ProductApiPageId", # required
1535
+ # resource_owner_account_id: "AccountId",
1536
+ # include_raw_display_content: false,
1537
+ # })
1538
+ #
1539
+ # @example Response structure
1540
+ #
1541
+ # resp.product_api_page_id #=> String
1542
+ # resp.product_api_page_arn #=> String
1543
+ # resp.api_id.identifier_parts.path #=> String
1544
+ # resp.api_id.identifier_parts.method #=> String
1545
+ # resp.api_id.identifier_parts.resource_arn #=> String
1546
+ # resp.display_content.operation_name #=> String
1547
+ # resp.display_content.api_url #=> String
1548
+ # resp.display_content.body #=> String
1549
+ # resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
1550
+ # resp.updated_at #=> Time
1551
+ # resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
1552
+ # resp.raw_display_content #=> String
1553
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "RESOURCE_DELETED", "MEMBER_LEFT_ORG"
1554
+ # resp.status_exception.message #=> String
1555
+ # resp.tags #=> Hash
1556
+ # resp.tags["TagKey"] #=> String
1557
+ #
1558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductApiPage AWS API Documentation
1559
+ #
1560
+ # @overload get_product_api_page(params = {})
1561
+ # @param [Hash] params ({})
1562
+ def get_product_api_page(params = {}, options = {})
1563
+ req = build_request(:get_product_api_page, params)
1564
+ req.send_request(options)
1565
+ end
1566
+
1567
+ # Returns a product page, including its body.
1568
+ #
1569
+ # @option params [required, String] :product_id
1570
+ # The identifier of the product.
1571
+ #
1572
+ # @option params [required, String] :product_page_id
1573
+ # The identifier of the product page.
1574
+ #
1575
+ # @option params [String] :resource_owner_account_id
1576
+ # The AWS account ID that owns the product. Supply it to read a product
1577
+ # shared with you by another account. Omit it for products in your own
1578
+ # account.
1579
+ #
1580
+ # @return [Types::GetProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1581
+ #
1582
+ # * {Types::GetProductPageResponse#product_page_id #product_page_id} => String
1583
+ # * {Types::GetProductPageResponse#product_page_arn #product_page_arn} => String
1584
+ # * {Types::GetProductPageResponse#display_content #display_content} => Types::DisplayContent
1585
+ # * {Types::GetProductPageResponse#updated_at #updated_at} => Time
1586
+ # * {Types::GetProductPageResponse#tags #tags} => Hash&lt;String,String&gt;
1587
+ #
1588
+ # @example Request syntax with placeholder values
1589
+ #
1590
+ # resp = client.get_product_page({
1591
+ # product_id: "ProductId", # required
1592
+ # product_page_id: "ProductPageId", # required
1593
+ # resource_owner_account_id: "AccountId",
1594
+ # })
1595
+ #
1596
+ # @example Response structure
1597
+ #
1598
+ # resp.product_page_id #=> String
1599
+ # resp.product_page_arn #=> String
1600
+ # resp.display_content.title #=> String
1601
+ # resp.display_content.body #=> String
1602
+ # resp.updated_at #=> Time
1603
+ # resp.tags #=> Hash
1604
+ # resp.tags["TagKey"] #=> String
1605
+ #
1606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductPage AWS API Documentation
1607
+ #
1608
+ # @overload get_product_page(params = {})
1609
+ # @param [Hash] params ({})
1610
+ def get_product_page(params = {}, options = {})
1611
+ req = build_request(:get_product_page, params)
1612
+ req.send_request(options)
1613
+ end
1614
+
1615
+ # Returns the sharing policy of a product.
1616
+ #
1617
+ # @option params [required, String] :product_id
1618
+ # The identifier of the product.
1619
+ #
1620
+ # @return [Types::GetProductSharingPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1621
+ #
1622
+ # * {Types::GetProductSharingPolicyResponse#product_id #product_id} => String
1623
+ # * {Types::GetProductSharingPolicyResponse#policy_document #policy_document} => String
1624
+ # * {Types::GetProductSharingPolicyResponse#tags #tags} => Hash&lt;String,String&gt;
1625
+ #
1626
+ # @example Request syntax with placeholder values
1627
+ #
1628
+ # resp = client.get_product_sharing_policy({
1629
+ # product_id: "ProductId", # required
1630
+ # })
1631
+ #
1632
+ # @example Response structure
1633
+ #
1634
+ # resp.product_id #=> String
1635
+ # resp.policy_document #=> String
1636
+ # resp.tags #=> Hash
1637
+ # resp.tags["TagKey"] #=> String
1638
+ #
1639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductSharingPolicy AWS API Documentation
1640
+ #
1641
+ # @overload get_product_sharing_policy(params = {})
1642
+ # @param [Hash] params ({})
1643
+ def get_product_sharing_policy(params = {}, options = {})
1644
+ req = build_request(:get_product_sharing_policy, params)
1645
+ req.send_request(options)
1646
+ end
1647
+
1648
+ # Lists discovered API inventory items with filtering and pagination.
1649
+ #
1650
+ # @option params [Types::ApiInventoryFilters] :filters
1651
+ # Filters that limit the results. Omit it to list every discovered API.
1652
+ #
1653
+ # @option params [Integer] :max_results
1654
+ # The maximum number of results to return in one page, from 1 to 100.
1655
+ #
1656
+ # @option params [String] :next_token
1657
+ # The pagination token returned by a previous call. Omit it to get the
1658
+ # first page.
1659
+ #
1660
+ # @return [Types::ListApiInventoryItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1661
+ #
1662
+ # * {Types::ListApiInventoryItemsResponse#items #items} => Array&lt;Types::ApiInventoryItem&gt;
1663
+ # * {Types::ListApiInventoryItemsResponse#next_token #next_token} => String
1664
+ #
1665
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1666
+ #
1667
+ # @example Request syntax with placeholder values
1668
+ #
1669
+ # resp = client.list_api_inventory_items({
1670
+ # filters: {
1671
+ # discovery_source: "API_GATEWAY", # accepts API_GATEWAY, ELB, CLOUDFRONT
1672
+ # resource_arn: "ResourceArn",
1673
+ # },
1674
+ # max_results: 1,
1675
+ # next_token: "NextToken",
1676
+ # })
1677
+ #
1678
+ # @example Response structure
1679
+ #
1680
+ # resp.items #=> Array
1681
+ # resp.items[0].method #=> String, one of "GET", "POST", "PUT", "DELETE", "PATCH", "ANY", "HEAD", "OPTIONS"
1682
+ # resp.items[0].host #=> String
1683
+ # resp.items[0].port #=> Integer
1684
+ # resp.items[0].path #=> String
1685
+ # resp.items[0].account_id #=> String
1686
+ # resp.items[0].resource_arn #=> String
1687
+ # resp.items[0].region #=> String
1688
+ # resp.items[0].discovery_source #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
1689
+ # resp.items[0].first_seen #=> Time
1690
+ # resp.items[0].last_seen #=> Time
1691
+ # resp.items[0].visibility #=> String, one of "PUBLIC", "PRIVATE"
1692
+ # resp.items[0].waf_status #=> String, one of "ENABLED", "DISABLED"
1693
+ # resp.items[0].classification #=> String, one of "SHADOW", "MANAGED", "MANAGED_ZOMBIE", "MANAGED_ORPHANED"
1694
+ # resp.items[0].managed_by #=> String, one of "SELF", "ORGANIZATION"
1695
+ # resp.items[0].workloads #=> Array
1696
+ # resp.items[0].workloads[0] #=> String, one of "MCP", "LLM", "A2A"
1697
+ # resp.next_token #=> String
1698
+ #
1699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListApiInventoryItems AWS API Documentation
1700
+ #
1701
+ # @overload list_api_inventory_items(params = {})
1702
+ # @param [Hash] params ({})
1703
+ def list_api_inventory_items(params = {}, options = {})
1704
+ req = build_request(:list_api_inventory_items, params)
1705
+ req.send_request(options)
1706
+ end
1707
+
1708
+ # Lists discovery statuses for services.
1709
+ #
1710
+ # @option params [String] :discovery_source
1711
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
1712
+ # front-door service type whose resources discovery crawls to find APIs.
1713
+ # New source services may be added over time, so clients MUST treat any
1714
+ # unrecognized value gracefully.
1715
+ #
1716
+ # @option params [Integer] :max_results
1717
+ # The maximum number of results to return in one page, from 1 to 100.
1718
+ #
1719
+ # @option params [String] :next_token
1720
+ # The pagination token returned by a previous call. Omit it to get the
1721
+ # first page.
1722
+ #
1723
+ # @return [Types::ListDiscoveryStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1724
+ #
1725
+ # * {Types::ListDiscoveryStatusesResponse#items #items} => Array&lt;Types::DiscoveryStatus&gt;
1726
+ # * {Types::ListDiscoveryStatusesResponse#next_token #next_token} => String
1727
+ #
1728
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1729
+ #
1730
+ # @example Request syntax with placeholder values
1731
+ #
1732
+ # resp = client.list_discovery_statuses({
1733
+ # discovery_source: "API_GATEWAY", # accepts API_GATEWAY, ELB, CLOUDFRONT
1734
+ # max_results: 1,
1735
+ # next_token: "NextToken",
1736
+ # })
1737
+ #
1738
+ # @example Response structure
1739
+ #
1740
+ # resp.items #=> Array
1741
+ # resp.items[0].account_id #=> String
1742
+ # resp.items[0].discovery_source #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
1743
+ # resp.items[0].status #=> String, one of "STOPPED", "PROVISIONING", "RUNNING", "FAILED"
1744
+ # resp.items[0].failure_reason #=> String, one of "ACCESS_DENIED", "DEPENDENCY_ERROR", "THROTTLED", "INVALID_CONFIGURATION", "INTERNAL_ERROR"
1745
+ # resp.next_token #=> String
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListDiscoveryStatuses AWS API Documentation
1748
+ #
1749
+ # @overload list_discovery_statuses(params = {})
1750
+ # @param [Hash] params ({})
1751
+ def list_discovery_statuses(params = {}, options = {})
1752
+ req = build_request(:list_discovery_statuses, params)
1753
+ req.send_request(options)
1754
+ end
1755
+
1756
+ # Lists API-security events for a single managed API, most recent first.
1757
+ # Returns up to 20 of the most recent events (not paginated).
1758
+ #
1759
+ # @option params [required, String] :managed_api_id
1760
+ # The identifier of the Managed API.
1761
+ #
1762
+ # @option params [Time,DateTime,Date,Integer,String] :started_after
1763
+ # Inclusive lower bound on each event's start time; only events that
1764
+ # started at or after this time are returned. Optional; defaults to 30
1765
+ # days before the current time.
1766
+ #
1767
+ # @option params [Time,DateTime,Date,Integer,String] :started_before
1768
+ # Exclusive upper bound on each event's start time; only events that
1769
+ # started before this time are returned. Optional; defaults to the
1770
+ # current time.
1771
+ #
1772
+ # @option params [Integer] :max_results
1773
+ # The maximum number of results to return in one page, from 1 to 20.
1774
+ #
1775
+ # @option params [String] :next_token
1776
+ # The pagination token returned by a previous call. Omit it to get the
1777
+ # first page.
1778
+ #
1779
+ # @return [Types::ListManagedApiEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1780
+ #
1781
+ # * {Types::ListManagedApiEventsResponse#items #items} => Array&lt;Types::ManagedApiEventSummary&gt;
1782
+ # * {Types::ListManagedApiEventsResponse#next_token #next_token} => String
1783
+ #
1784
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1785
+ #
1786
+ # @example Request syntax with placeholder values
1787
+ #
1788
+ # resp = client.list_managed_api_events({
1789
+ # managed_api_id: "ManagedApiId", # required
1790
+ # started_after: Time.now,
1791
+ # started_before: Time.now,
1792
+ # max_results: 1,
1793
+ # next_token: "NextToken",
1794
+ # })
1795
+ #
1796
+ # @example Response structure
1797
+ #
1798
+ # resp.items #=> Array
1799
+ # resp.items[0].event_id #=> String
1800
+ # resp.items[0].event_type #=> String, one of "WAF_API_SECURITY"
1801
+ # resp.items[0].status #=> String, one of "EVENT_STARTED", "EVENT_IN_PROGRESS", "EVENT_ENDED"
1802
+ # resp.items[0].waf_api_security_event_detail.label #=> String
1803
+ # resp.items[0].waf_api_security_event_detail.category #=> String
1804
+ # resp.items[0].waf_api_security_event_detail.confidence #=> String, one of "LOW", "MEDIUM", "HIGH"
1805
+ # resp.items[0].waf_api_security_event_detail.web_acl_arn #=> String
1806
+ # resp.items[0].started_at #=> Time
1807
+ # resp.items[0].ended_at #=> Time
1808
+ # resp.items[0].updated_at #=> Time
1809
+ # resp.next_token #=> String
1810
+ #
1811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApiEvents AWS API Documentation
1812
+ #
1813
+ # @overload list_managed_api_events(params = {})
1814
+ # @param [Hash] params ({})
1815
+ def list_managed_api_events(params = {}, options = {})
1816
+ req = build_request(:list_managed_api_events, params)
1817
+ req.send_request(options)
1818
+ end
1819
+
1820
+ # Lists the Managed APIs in your account.
1821
+ #
1822
+ # @option params [Integer] :max_results
1823
+ # The maximum number of results to return in one page, from 1 to 100.
1824
+ #
1825
+ # @option params [String] :next_token
1826
+ # The pagination token returned by a previous call. Omit it to get the
1827
+ # first page.
1828
+ #
1829
+ # @option params [String] :product_id
1830
+ # Optional filter: when supplied, only Managed APIs associated with this
1831
+ # product are returned.
1832
+ #
1833
+ # @return [Types::ListManagedApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1834
+ #
1835
+ # * {Types::ListManagedApisResponse#next_token #next_token} => String
1836
+ # * {Types::ListManagedApisResponse#items #items} => Array&lt;Types::ManagedApiSummary&gt;
1837
+ #
1838
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1839
+ #
1840
+ # @example Request syntax with placeholder values
1841
+ #
1842
+ # resp = client.list_managed_apis({
1843
+ # max_results: 1,
1844
+ # next_token: "NextToken",
1845
+ # product_id: "ProductId",
1846
+ # })
1847
+ #
1848
+ # @example Response structure
1849
+ #
1850
+ # resp.next_token #=> String
1851
+ # resp.items #=> Array
1852
+ # resp.items[0].managed_api_id #=> String
1853
+ # resp.items[0].managed_api_arn #=> String
1854
+ # resp.items[0].api_signature.resource_arn #=> String
1855
+ # resp.items[0].api_signature.method #=> String, one of "GET", "POST", "PUT", "DELETE", "PATCH", "ANY", "HEAD", "OPTIONS"
1856
+ # resp.items[0].api_signature.hostname #=> String
1857
+ # resp.items[0].api_signature.port #=> Integer
1858
+ # resp.items[0].api_signature.path #=> String
1859
+ # resp.items[0].created_at #=> Time
1860
+ # resp.items[0].updated_at #=> Time
1861
+ #
1862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApis AWS API Documentation
1863
+ #
1864
+ # @overload list_managed_apis(params = {})
1865
+ # @param [Hash] params ({})
1866
+ def list_managed_apis(params = {}, options = {})
1867
+ req = build_request(:list_managed_apis, params)
1868
+ req.send_request(options)
1869
+ end
1870
+
1871
+ # Lists the portals in your account.
1872
+ #
1873
+ # @option params [Integer] :max_results
1874
+ # The maximum number of results to return in one page, from 1 to 100.
1875
+ #
1876
+ # @option params [String] :next_token
1877
+ # The pagination token returned by a previous call. Omit it to get the
1878
+ # first page.
1879
+ #
1880
+ # @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1881
+ #
1882
+ # * {Types::ListPortalsResponse#items #items} => Array&lt;Types::PortalSummary&gt;
1883
+ # * {Types::ListPortalsResponse#next_token #next_token} => String
1884
+ #
1885
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1886
+ #
1887
+ # @example Request syntax with placeholder values
1888
+ #
1889
+ # resp = client.list_portals({
1890
+ # max_results: 1,
1891
+ # next_token: "NextToken",
1892
+ # })
1893
+ #
1894
+ # @example Response structure
1895
+ #
1896
+ # resp.items #=> Array
1897
+ # resp.items[0].portal_id #=> String
1898
+ # resp.items[0].portal_arn #=> String
1899
+ # resp.items[0].endpoint_configuration.domain_name #=> String
1900
+ # resp.items[0].endpoint_configuration.certificate_arn #=> String
1901
+ # resp.items[0].endpoint_configuration.portal_domain_hosted_zone_id #=> String
1902
+ # resp.items[0].endpoint_configuration.portal_default_domain_name #=> String
1903
+ # resp.items[0].authorization.authorization_config.cognito_config.user_pool_arn #=> String
1904
+ # resp.items[0].authorization.authorization_config.cognito_config.app_client_id #=> String
1905
+ # resp.items[0].authorization.authorization_config.cognito_config.user_pool_domain #=> String
1906
+ # resp.items[0].authorization.authorization_config.cognito_config.identity_pool_id #=> String
1907
+ # resp.items[0].authorization.fine_grained_access_control #=> String, one of "ENABLED", "DISABLED"
1908
+ # resp.items[0].portal_content.display_name #=> String
1909
+ # resp.items[0].portal_content.description #=> String
1910
+ # resp.items[0].portal_content.theme.custom_colors.background_color #=> String
1911
+ # resp.items[0].portal_content.theme.custom_colors.navigation_color #=> String
1912
+ # resp.items[0].portal_content.theme.custom_colors.header_color #=> String
1913
+ # resp.items[0].portal_content.theme.custom_colors.text_color #=> String
1914
+ # resp.items[0].portal_content.theme.custom_colors.accent_color #=> String
1915
+ # resp.items[0].portal_content.theme.custom_colors.error_validation_color #=> String
1916
+ # resp.items[0].portal_content.theme.logo_uploaded_at #=> Time
1917
+ # resp.items[0].included_product_arns #=> Array
1918
+ # resp.items[0].included_product_arns[0] #=> String
1919
+ # resp.items[0].publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
1920
+ # resp.items[0].status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
1921
+ # resp.items[0].status_exception.message #=> String
1922
+ # resp.items[0].updated_at #=> Time
1923
+ # resp.items[0].published_at #=> Time
1924
+ # resp.items[0].publish_description #=> String
1925
+ # resp.items[0].rum_app_monitor_name #=> String
1926
+ # resp.items[0].preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
1927
+ # resp.items[0].preview.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
1928
+ # resp.items[0].preview.status_exception.message #=> String
1929
+ # resp.items[0].preview.preview_url #=> String
1930
+ # resp.next_token #=> String
1931
+ #
1932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListPortals AWS API Documentation
1933
+ #
1934
+ # @overload list_portals(params = {})
1935
+ # @param [Hash] params ({})
1936
+ def list_portals(params = {}, options = {})
1937
+ req = build_request(:list_portals, params)
1938
+ req.send_request(options)
1939
+ end
1940
+
1941
+ # Lists the API pages in a product. The results do not include page
1942
+ # bodies.
1943
+ #
1944
+ # @option params [required, String] :product_id
1945
+ # The identifier of the product.
1946
+ #
1947
+ # @option params [String] :next_token
1948
+ # The pagination token returned by a previous call. Omit it to get the
1949
+ # first page.
1950
+ #
1951
+ # @option params [Integer] :max_results
1952
+ # The maximum number of results to return in one page, from 1 to 100.
1953
+ #
1954
+ # @option params [String] :resource_owner_account_id
1955
+ # The AWS account ID that owns the product. Supply it to read a product
1956
+ # shared with you by another account. Omit it for products in your own
1957
+ # account.
1958
+ #
1959
+ # @return [Types::ListProductApiPagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1960
+ #
1961
+ # * {Types::ListProductApiPagesResponse#next_token #next_token} => String
1962
+ # * {Types::ListProductApiPagesResponse#items #items} => Array&lt;Types::ProductApiPageSummaryNoBody&gt;
1963
+ #
1964
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1965
+ #
1966
+ # @example Request syntax with placeholder values
1967
+ #
1968
+ # resp = client.list_product_api_pages({
1969
+ # product_id: "ProductId", # required
1970
+ # next_token: "NextToken",
1971
+ # max_results: 1,
1972
+ # resource_owner_account_id: "AccountId",
1973
+ # })
1974
+ #
1975
+ # @example Response structure
1976
+ #
1977
+ # resp.next_token #=> String
1978
+ # resp.items #=> Array
1979
+ # resp.items[0].product_api_page_id #=> String
1980
+ # resp.items[0].product_api_page_arn #=> String
1981
+ # resp.items[0].api_id.identifier_parts.path #=> String
1982
+ # resp.items[0].api_id.identifier_parts.method #=> String
1983
+ # resp.items[0].api_id.identifier_parts.resource_arn #=> String
1984
+ # resp.items[0].operation_name #=> String
1985
+ # resp.items[0].api_url #=> String
1986
+ # resp.items[0].try_it_state #=> String, one of "ENABLED", "DISABLED"
1987
+ # resp.items[0].updated_at #=> Time
1988
+ # resp.items[0].status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
1989
+ # resp.items[0].status_exception.exception #=> String, one of "INTERNAL_FAILURE", "RESOURCE_DELETED", "MEMBER_LEFT_ORG"
1990
+ # resp.items[0].status_exception.message #=> String
1991
+ #
1992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductApiPages AWS API Documentation
1993
+ #
1994
+ # @overload list_product_api_pages(params = {})
1995
+ # @param [Hash] params ({})
1996
+ def list_product_api_pages(params = {}, options = {})
1997
+ req = build_request(:list_product_api_pages, params)
1998
+ req.send_request(options)
1999
+ end
2000
+
2001
+ # Lists the product pages in a product. The results do not include page
2002
+ # bodies.
2003
+ #
2004
+ # @option params [required, String] :product_id
2005
+ # The identifier of the product.
2006
+ #
2007
+ # @option params [String] :next_token
2008
+ # The pagination token returned by a previous call. Omit it to get the
2009
+ # first page.
2010
+ #
2011
+ # @option params [Integer] :max_results
2012
+ # The maximum number of results to return in one page, from 1 to 100.
2013
+ #
2014
+ # @option params [String] :resource_owner_account_id
2015
+ # The AWS account ID that owns the product. Supply it to read a product
2016
+ # shared with you by another account. Omit it for products in your own
2017
+ # account.
2018
+ #
2019
+ # @return [Types::ListProductPagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2020
+ #
2021
+ # * {Types::ListProductPagesResponse#next_token #next_token} => String
2022
+ # * {Types::ListProductPagesResponse#items #items} => Array&lt;Types::ProductPageSummaryNoBody&gt;
2023
+ #
2024
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2025
+ #
2026
+ # @example Request syntax with placeholder values
2027
+ #
2028
+ # resp = client.list_product_pages({
2029
+ # product_id: "ProductId", # required
2030
+ # next_token: "NextToken",
2031
+ # max_results: 1,
2032
+ # resource_owner_account_id: "AccountId",
2033
+ # })
2034
+ #
2035
+ # @example Response structure
2036
+ #
2037
+ # resp.next_token #=> String
2038
+ # resp.items #=> Array
2039
+ # resp.items[0].product_page_id #=> String
2040
+ # resp.items[0].product_page_arn #=> String
2041
+ # resp.items[0].page_title #=> String
2042
+ # resp.items[0].updated_at #=> Time
2043
+ #
2044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductPages AWS API Documentation
2045
+ #
2046
+ # @overload list_product_pages(params = {})
2047
+ # @param [Hash] params ({})
2048
+ def list_product_pages(params = {}, options = {})
2049
+ req = build_request(:list_product_pages, params)
2050
+ req.send_request(options)
2051
+ end
2052
+
2053
+ # Lists products you own, products shared with you, or both.
2054
+ #
2055
+ # @option params [Integer] :max_results
2056
+ # The maximum number of results to return in one page, from 1 to 100.
2057
+ #
2058
+ # @option params [String] :next_token
2059
+ # The pagination token returned by a previous call. Omit it to get the
2060
+ # first page.
2061
+ #
2062
+ # @option params [String] :resource_owner
2063
+ # Whose products to return: `SELF` for your own, `OTHER_ACCOUNTS` for
2064
+ # products shared with you, or `ALL`. Defaults to `ALL`, or to `SELF`
2065
+ # when `managedApiId` is supplied.
2066
+ #
2067
+ # @option params [String] :managed_api_id
2068
+ # Optional filter: when supplied, only Products this Managed API is
2069
+ # associated with are returned.
2070
+ #
2071
+ # @return [Types::ListProductsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2072
+ #
2073
+ # * {Types::ListProductsResponse#next_token #next_token} => String
2074
+ # * {Types::ListProductsResponse#items #items} => Array&lt;Types::ProductSummary&gt;
2075
+ #
2076
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2077
+ #
2078
+ # @example Request syntax with placeholder values
2079
+ #
2080
+ # resp = client.list_products({
2081
+ # max_results: 1,
2082
+ # next_token: "NextToken",
2083
+ # resource_owner: "ALL", # accepts ALL, SELF, OTHER_ACCOUNTS
2084
+ # managed_api_id: "ManagedApiId",
2085
+ # })
2086
+ #
2087
+ # @example Response structure
2088
+ #
2089
+ # resp.next_token #=> String
2090
+ # resp.items #=> Array
2091
+ # resp.items[0].product_id #=> String
2092
+ # resp.items[0].product_arn #=> String
2093
+ # resp.items[0].display_name #=> String
2094
+ # resp.items[0].description #=> String
2095
+ # resp.items[0].updated_at #=> Time
2096
+ # resp.items[0].api_selection_configuration.api_selection_mode #=> String, one of "CUSTOM", "RULE_BASED"
2097
+ # resp.items[0].api_selection_configuration.rule_filters #=> Array
2098
+ # resp.items[0].api_selection_configuration.rule_filters[0].key #=> String, one of "RESOURCE_ARN", "HOST", "METHOD", "PATH", "PORT", "ACCOUNT"
2099
+ # resp.items[0].api_selection_configuration.rule_filters[0].values #=> Array
2100
+ # resp.items[0].api_selection_configuration.rule_filters[0].values[0] #=> String
2101
+ # resp.items[0].status #=> String, one of "ACTIVE", "IN_PROGRESS", "FAILED"
2102
+ # resp.items[0].failure_reason #=> String, one of "API_PAGE_ATTACHED", "EVALUATION_ERROR"
2103
+ #
2104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProducts AWS API Documentation
2105
+ #
2106
+ # @overload list_products(params = {})
2107
+ # @param [Hash] params ({})
2108
+ def list_products(params = {}, options = {})
2109
+ req = build_request(:list_products, params)
2110
+ req.send_request(options)
2111
+ end
2112
+
2113
+ # Lists the tags for an API Portal resource. One of the three basic
2114
+ # tagging operations generated for Tagris integration
2115
+ # (ListTagsForResource / TagResource / UntagResource).
2116
+ #
2117
+ # @option params [required, String] :resource_arn
2118
+ # The ARN of the resource.
2119
+ #
2120
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2121
+ #
2122
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
2123
+ #
2124
+ # @example Request syntax with placeholder values
2125
+ #
2126
+ # resp = client.list_tags_for_resource({
2127
+ # resource_arn: "ResourceArn", # required
2128
+ # })
2129
+ #
2130
+ # @example Response structure
2131
+ #
2132
+ # resp.tags #=> Hash
2133
+ # resp.tags["TagKey"] #=> String
2134
+ #
2135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListTagsForResource AWS API Documentation
2136
+ #
2137
+ # @overload list_tags_for_resource(params = {})
2138
+ # @param [Hash] params ({})
2139
+ def list_tags_for_resource(params = {}, options = {})
2140
+ req = build_request(:list_tags_for_resource, params)
2141
+ req.send_request(options)
2142
+ end
2143
+
2144
+ # Creates or updates the discovery configuration
2145
+ #
2146
+ # @option params [Array<String>] :discovery_sources
2147
+ # The sources to discover APIs from. Omitting it removes all sources,
2148
+ # which stops discovery for this configuration.
2149
+ #
2150
+ # @option params [Array<String>] :excluded_resources
2151
+ # The ARNs of resources to leave out of discovery, up to 50.
2152
+ #
2153
+ # @option params [Array<String>] :features
2154
+ # Optional capabilities to enable. Omitting it disables all of them, as
2155
+ # with the other fields.
2156
+ #
2157
+ # @option params [Hash<String,String>] :tags
2158
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2159
+ # per resource.
2160
+ #
2161
+ # @return [Types::PutDiscoveryConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2162
+ #
2163
+ # * {Types::PutDiscoveryConfigurationResponse#discovery_configuration #discovery_configuration} => Types::DiscoveryConfigurationData
2164
+ # * {Types::PutDiscoveryConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;
2165
+ #
2166
+ # @example Request syntax with placeholder values
2167
+ #
2168
+ # resp = client.put_discovery_configuration({
2169
+ # discovery_sources: ["API_GATEWAY"], # accepts API_GATEWAY, ELB, CLOUDFRONT
2170
+ # excluded_resources: ["ResourceArn"],
2171
+ # features: ["AI_DISCOVERY"], # accepts AI_DISCOVERY
2172
+ # tags: {
2173
+ # "TagKey" => "TagValue",
2174
+ # },
2175
+ # })
2176
+ #
2177
+ # @example Response structure
2178
+ #
2179
+ # resp.discovery_configuration.arn #=> String
2180
+ # resp.discovery_configuration.status #=> String, one of "DISABLED", "ENABLED", "UPDATING"
2181
+ # resp.discovery_configuration.discovery_sources #=> Array
2182
+ # resp.discovery_configuration.discovery_sources[0] #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
2183
+ # resp.discovery_configuration.excluded_resources #=> Array
2184
+ # resp.discovery_configuration.excluded_resources[0] #=> String
2185
+ # resp.discovery_configuration.features #=> Array
2186
+ # resp.discovery_configuration.features[0] #=> String, one of "AI_DISCOVERY"
2187
+ # resp.discovery_configuration.created_at #=> Time
2188
+ # resp.discovery_configuration.updated_at #=> Time
2189
+ # resp.tags #=> Hash
2190
+ # resp.tags["TagKey"] #=> String
2191
+ #
2192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutDiscoveryConfiguration AWS API Documentation
2193
+ #
2194
+ # @overload put_discovery_configuration(params = {})
2195
+ # @param [Hash] params ({})
2196
+ def put_discovery_configuration(params = {}, options = {})
2197
+ req = build_request(:put_discovery_configuration, params)
2198
+ req.send_request(options)
2199
+ end
2200
+
2201
+ # Creates or updates the organization-wide discovery configuration. This
2202
+ # is a singleton per organization. Only the organization management
2203
+ # account and registered delegated administrators may call this
2204
+ # operation.
2205
+ #
2206
+ # @option params [Array<String>] :discovery_sources
2207
+ # The sources to discover APIs from. Omitting it removes all sources,
2208
+ # which stops discovery for this configuration.
2209
+ #
2210
+ # @option params [Types::DiscoveryExclusionFilters] :exclusion_filters
2211
+ # Exclusion filters for organization-scoped discovery. @deprecated.
2212
+ # Remove this once client (Console) moves to discoveryFilters
2213
+ #
2214
+ # @option params [Types::OrganizationDiscoveryFilters] :discovery_filters
2215
+ # The accounts or organizational units to include in or exclude from
2216
+ # discovery.
2217
+ #
2218
+ # @option params [Array<String>] :features
2219
+ # Optional capabilities to enable. Omitting it disables all of them, as
2220
+ # with the other fields.
2221
+ #
2222
+ # @option params [Hash<String,String>] :tags
2223
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2224
+ # per resource.
2225
+ #
2226
+ # @return [Types::PutOrganizationDiscoveryConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2227
+ #
2228
+ # * {Types::PutOrganizationDiscoveryConfigurationResponse#discovery_configuration #discovery_configuration} => Types::OrganizationDiscoveryConfigurationData
2229
+ # * {Types::PutOrganizationDiscoveryConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;
2230
+ #
2231
+ # @example Request syntax with placeholder values
2232
+ #
2233
+ # resp = client.put_organization_discovery_configuration({
2234
+ # discovery_sources: ["API_GATEWAY"], # accepts API_GATEWAY, ELB, CLOUDFRONT
2235
+ # exclusion_filters: {
2236
+ # organizational_unit_ids: ["OrganizationalUnitId"],
2237
+ # account_ids: ["AccountId"],
2238
+ # resource_arns: ["ResourceArn"],
2239
+ # },
2240
+ # discovery_filters: {
2241
+ # exclusion_filters: {
2242
+ # organizational_unit_ids: ["OrganizationalUnitId"],
2243
+ # account_ids: ["AccountId"],
2244
+ # resource_arns: ["ResourceArn"],
2245
+ # },
2246
+ # inclusion_filters: {
2247
+ # organizational_unit_ids: ["OrganizationalUnitId"],
2248
+ # account_ids: ["AccountId"],
2249
+ # },
2250
+ # },
2251
+ # features: ["AI_DISCOVERY"], # accepts AI_DISCOVERY
2252
+ # tags: {
2253
+ # "TagKey" => "TagValue",
2254
+ # },
2255
+ # })
2256
+ #
2257
+ # @example Response structure
2258
+ #
2259
+ # resp.discovery_configuration.arn #=> String
2260
+ # resp.discovery_configuration.status #=> String, one of "DISABLED", "ENABLED", "UPDATING"
2261
+ # resp.discovery_configuration.discovery_sources #=> Array
2262
+ # resp.discovery_configuration.discovery_sources[0] #=> String, one of "API_GATEWAY", "ELB", "CLOUDFRONT"
2263
+ # resp.discovery_configuration.exclusion_filters.organizational_unit_ids #=> Array
2264
+ # resp.discovery_configuration.exclusion_filters.organizational_unit_ids[0] #=> String
2265
+ # resp.discovery_configuration.exclusion_filters.account_ids #=> Array
2266
+ # resp.discovery_configuration.exclusion_filters.account_ids[0] #=> String
2267
+ # resp.discovery_configuration.exclusion_filters.resource_arns #=> Array
2268
+ # resp.discovery_configuration.exclusion_filters.resource_arns[0] #=> String
2269
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.organizational_unit_ids #=> Array
2270
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.organizational_unit_ids[0] #=> String
2271
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.account_ids #=> Array
2272
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.account_ids[0] #=> String
2273
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.resource_arns #=> Array
2274
+ # resp.discovery_configuration.discovery_filters.exclusion_filters.resource_arns[0] #=> String
2275
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.organizational_unit_ids #=> Array
2276
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.organizational_unit_ids[0] #=> String
2277
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.account_ids #=> Array
2278
+ # resp.discovery_configuration.discovery_filters.inclusion_filters.account_ids[0] #=> String
2279
+ # resp.discovery_configuration.features #=> Array
2280
+ # resp.discovery_configuration.features[0] #=> String, one of "AI_DISCOVERY"
2281
+ # resp.discovery_configuration.created_at #=> Time
2282
+ # resp.discovery_configuration.updated_at #=> Time
2283
+ # resp.tags #=> Hash
2284
+ # resp.tags["TagKey"] #=> String
2285
+ #
2286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutOrganizationDiscoveryConfiguration AWS API Documentation
2287
+ #
2288
+ # @overload put_organization_discovery_configuration(params = {})
2289
+ # @param [Hash] params ({})
2290
+ def put_organization_discovery_configuration(params = {}, options = {})
2291
+ req = build_request(:put_organization_discovery_configuration, params)
2292
+ req.send_request(options)
2293
+ end
2294
+
2295
+ # Creates or replaces the sharing policy of a product. The policy
2296
+ # controls which other accounts can read the product.
2297
+ #
2298
+ # @option params [required, String] :product_id
2299
+ # The identifier of the product.
2300
+ #
2301
+ # @option params [required, String] :policy_document
2302
+ # The sharing policy as a JSON resource policy document.
2303
+ #
2304
+ # @option params [Hash<String,String>] :tags
2305
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2306
+ # per resource.
2307
+ #
2308
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2309
+ #
2310
+ # @example Request syntax with placeholder values
2311
+ #
2312
+ # resp = client.put_product_sharing_policy({
2313
+ # product_id: "ProductId", # required
2314
+ # policy_document: "PolicyDocument", # required
2315
+ # tags: {
2316
+ # "TagKey" => "TagValue",
2317
+ # },
2318
+ # })
2319
+ #
2320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutProductSharingPolicy AWS API Documentation
2321
+ #
2322
+ # @overload put_product_sharing_policy(params = {})
2323
+ # @param [Hash] params ({})
2324
+ def put_product_sharing_policy(params = {}, options = {})
2325
+ req = build_request(:put_product_sharing_policy, params)
2326
+ req.send_request(options)
2327
+ end
2328
+
2329
+ # Starts the API discovery process.
2330
+ #
2331
+ # @option params [required, String] :id
2332
+ # Identifier of the discovery configuration to start. Required. Today
2333
+ # this is the configuration ARN, which carries the owner account id so a
2334
+ # delegated admin or org admin can start an org-scoped configuration
2335
+ # that lives in a different account.
2336
+ #
2337
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2338
+ #
2339
+ # @example Request syntax with placeholder values
2340
+ #
2341
+ # resp = client.start_discovery({
2342
+ # id: "StringWithLengthBetween1And1600", # required
2343
+ # })
2344
+ #
2345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/StartDiscovery AWS API Documentation
2346
+ #
2347
+ # @overload start_discovery(params = {})
2348
+ # @param [Hash] params ({})
2349
+ def start_discovery(params = {}, options = {})
2350
+ req = build_request(:start_discovery, params)
2351
+ req.send_request(options)
2352
+ end
2353
+
2354
+ # Stops the running API discovery process.
2355
+ #
2356
+ # @option params [required, String] :id
2357
+ # Identifier of the discovery configuration to stop. Required. Today
2358
+ # this is the configuration ARN, which carries the owner account id so a
2359
+ # delegated admin or org admin can stop an org-scoped configuration that
2360
+ # lives in a different account.
2361
+ #
2362
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2363
+ #
2364
+ # @example Request syntax with placeholder values
2365
+ #
2366
+ # resp = client.stop_discovery({
2367
+ # id: "StringWithLengthBetween1And1600", # required
2368
+ # })
2369
+ #
2370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/StopDiscovery AWS API Documentation
2371
+ #
2372
+ # @overload stop_discovery(params = {})
2373
+ # @param [Hash] params ({})
2374
+ def stop_discovery(params = {}, options = {})
2375
+ req = build_request(:stop_discovery, params)
2376
+ req.send_request(options)
2377
+ end
2378
+
2379
+ # Adds or updates tags on an API Portal resource. One of the three basic
2380
+ # tagging operations generated for Tagris integration
2381
+ # (ListTagsForResource / TagResource / UntagResource).
2382
+ #
2383
+ # @option params [required, String] :resource_arn
2384
+ # The ARN of the resource.
2385
+ #
2386
+ # @option params [required, Hash<String,String>] :tags
2387
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2388
+ # per resource.
2389
+ #
2390
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2391
+ #
2392
+ # @example Request syntax with placeholder values
2393
+ #
2394
+ # resp = client.tag_resource({
2395
+ # resource_arn: "ResourceArn", # required
2396
+ # tags: { # required
2397
+ # "TagKey" => "TagValue",
2398
+ # },
2399
+ # })
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/TagResource AWS API Documentation
2402
+ #
2403
+ # @overload tag_resource(params = {})
2404
+ # @param [Hash] params ({})
2405
+ def tag_resource(params = {}, options = {})
2406
+ req = build_request(:tag_resource, params)
2407
+ req.send_request(options)
2408
+ end
2409
+
2410
+ # Removes tags from an API Portal resource. One of the three basic
2411
+ # tagging operations generated for Tagris integration
2412
+ # (ListTagsForResource / TagResource / UntagResource).
2413
+ #
2414
+ # tagKeys is a query string parameter: for tag-based access control
2415
+ # (TBAC/ABAC) to work correctly, API Gateway requires the keys to be
2416
+ # removed to be passed as a query string parameter.
2417
+ #
2418
+ # @option params [required, String] :resource_arn
2419
+ # The ARN of the resource.
2420
+ #
2421
+ # @option params [required, Array<String>] :tag_keys
2422
+ # The keys of the tags to remove, up to 50.
2423
+ #
2424
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2425
+ #
2426
+ # @example Request syntax with placeholder values
2427
+ #
2428
+ # resp = client.untag_resource({
2429
+ # resource_arn: "ResourceArn", # required
2430
+ # tag_keys: ["TagKey"], # required
2431
+ # })
2432
+ #
2433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UntagResource AWS API Documentation
2434
+ #
2435
+ # @overload untag_resource(params = {})
2436
+ # @param [Hash] params ({})
2437
+ def untag_resource(params = {}, options = {})
2438
+ req = build_request(:untag_resource, params)
2439
+ req.send_request(options)
2440
+ end
2441
+
2442
+ # Updates a portal. Only the fields supplied in the request are changed.
2443
+ #
2444
+ # @option params [required, String] :portal_id
2445
+ # The identifier of the portal.
2446
+ #
2447
+ # @option params [Types::PortalContent] :portal_content
2448
+ # The new display name, description, and theme. Omit it to keep the
2449
+ # current values.
2450
+ #
2451
+ # @option params [Types::EndpointConfigurationRequest] :endpoint_configuration
2452
+ # Exactly one of the members is set: `none` for no custom domain, or
2453
+ # `acmManaged` to bring a domain + ACM certificate. Modeled as a union
2454
+ # so the "exactly one" choice is enforced by type.
2455
+ #
2456
+ # @option params [Types::Authorization] :authorization
2457
+ # The new authorization settings. Omit it to keep the current settings.
2458
+ #
2459
+ # @option params [String] :rum_app_monitor_name
2460
+ # The new CloudWatch RUM app monitor name. Omit it to keep the current
2461
+ # value.
2462
+ #
2463
+ # @option params [Array<String>] :included_product_arns
2464
+ # The new list of product ARNs, up to 200. It replaces the current list.
2465
+ # Omit it to keep the current list.
2466
+ #
2467
+ # @option params [String] :logo_uri
2468
+ # The new S3 location of the portal logo, in the form `s3://bucket/key`.
2469
+ # An empty string removes the logo. Omit it to keep the current logo.
2470
+ #
2471
+ # @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2472
+ #
2473
+ # * {Types::UpdatePortalResponse#portal_id #portal_id} => String
2474
+ # * {Types::UpdatePortalResponse#portal_arn #portal_arn} => String
2475
+ # * {Types::UpdatePortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
2476
+ # * {Types::UpdatePortalResponse#authorization #authorization} => Types::Authorization
2477
+ # * {Types::UpdatePortalResponse#portal_content #portal_content} => Types::PortalContent
2478
+ # * {Types::UpdatePortalResponse#included_product_arns #included_product_arns} => Array&lt;String&gt;
2479
+ # * {Types::UpdatePortalResponse#publish_status #publish_status} => String
2480
+ # * {Types::UpdatePortalResponse#status_exception #status_exception} => Types::PortalStatusException
2481
+ # * {Types::UpdatePortalResponse#updated_at #updated_at} => Time
2482
+ # * {Types::UpdatePortalResponse#published_at #published_at} => Time
2483
+ # * {Types::UpdatePortalResponse#publish_description #publish_description} => String
2484
+ # * {Types::UpdatePortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
2485
+ # * {Types::UpdatePortalResponse#preview #preview} => Types::Preview
2486
+ #
2487
+ # @example Request syntax with placeholder values
2488
+ #
2489
+ # resp = client.update_portal({
2490
+ # portal_id: "PortalId", # required
2491
+ # portal_content: {
2492
+ # display_name: "PortalName", # required
2493
+ # description: "PortalDescription",
2494
+ # theme: { # required
2495
+ # custom_colors: { # required
2496
+ # background_color: "Color", # required
2497
+ # navigation_color: "Color", # required
2498
+ # header_color: "Color", # required
2499
+ # text_color: "Color", # required
2500
+ # accent_color: "Color", # required
2501
+ # error_validation_color: "Color", # required
2502
+ # },
2503
+ # logo_uploaded_at: Time.now,
2504
+ # },
2505
+ # },
2506
+ # endpoint_configuration: {
2507
+ # none: {
2508
+ # },
2509
+ # acm_managed: {
2510
+ # domain_name: "PortalDomainName", # required
2511
+ # certificate_arn: "CertificateArn", # required
2512
+ # },
2513
+ # },
2514
+ # authorization: {
2515
+ # authorization_config: { # required
2516
+ # none: {
2517
+ # },
2518
+ # cognito_config: {
2519
+ # user_pool_arn: "UserPoolArn", # required
2520
+ # app_client_id: "AppClientId", # required
2521
+ # user_pool_domain: "UserPoolDomain", # required
2522
+ # identity_pool_id: "IdentityPoolId",
2523
+ # },
2524
+ # },
2525
+ # fine_grained_access_control: "ENABLED", # required, accepts ENABLED, DISABLED
2526
+ # },
2527
+ # rum_app_monitor_name: "RUMAppMonitorName",
2528
+ # included_product_arns: ["ProductArn"],
2529
+ # logo_uri: "LogoUri",
2530
+ # })
2531
+ #
2532
+ # @example Response structure
2533
+ #
2534
+ # resp.portal_id #=> String
2535
+ # resp.portal_arn #=> String
2536
+ # resp.endpoint_configuration.domain_name #=> String
2537
+ # resp.endpoint_configuration.certificate_arn #=> String
2538
+ # resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
2539
+ # resp.endpoint_configuration.portal_default_domain_name #=> String
2540
+ # resp.authorization.authorization_config.cognito_config.user_pool_arn #=> String
2541
+ # resp.authorization.authorization_config.cognito_config.app_client_id #=> String
2542
+ # resp.authorization.authorization_config.cognito_config.user_pool_domain #=> String
2543
+ # resp.authorization.authorization_config.cognito_config.identity_pool_id #=> String
2544
+ # resp.authorization.fine_grained_access_control #=> String, one of "ENABLED", "DISABLED"
2545
+ # resp.portal_content.display_name #=> String
2546
+ # resp.portal_content.description #=> String
2547
+ # resp.portal_content.theme.custom_colors.background_color #=> String
2548
+ # resp.portal_content.theme.custom_colors.navigation_color #=> String
2549
+ # resp.portal_content.theme.custom_colors.header_color #=> String
2550
+ # resp.portal_content.theme.custom_colors.text_color #=> String
2551
+ # resp.portal_content.theme.custom_colors.accent_color #=> String
2552
+ # resp.portal_content.theme.custom_colors.error_validation_color #=> String
2553
+ # resp.portal_content.theme.logo_uploaded_at #=> Time
2554
+ # resp.included_product_arns #=> Array
2555
+ # resp.included_product_arns[0] #=> String
2556
+ # resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
2557
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
2558
+ # resp.status_exception.message #=> String
2559
+ # resp.updated_at #=> Time
2560
+ # resp.published_at #=> Time
2561
+ # resp.publish_description #=> String
2562
+ # resp.rum_app_monitor_name #=> String
2563
+ # resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
2564
+ # resp.preview.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "UNSHARED_PRODUCT_EXCEPTION", "CLOUDFRONT_DOMAIN_IN_USE", "MISSING_CLOUDFRONT_PERMISSIONS"
2565
+ # resp.preview.status_exception.message #=> String
2566
+ # resp.preview.preview_url #=> String
2567
+ #
2568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdatePortal AWS API Documentation
2569
+ #
2570
+ # @overload update_portal(params = {})
2571
+ # @param [Hash] params ({})
2572
+ def update_portal(params = {}, options = {})
2573
+ req = build_request(:update_portal, params)
2574
+ req.send_request(options)
2575
+ end
2576
+
2577
+ # Publishes or disables a portal. The change runs asynchronously. Use
2578
+ # GetPortal to track `publishStatus`.
2579
+ #
2580
+ # @option params [required, String] :portal_id
2581
+ # The identifier of the portal.
2582
+ #
2583
+ # @option params [required, String] :status
2584
+ # The terminal publish state a caller can request for a portal via
2585
+ # UpdatePortalPublishStatus. Only the two client-requestable targets are
2586
+ # modeled here; the transient and failed states in PublishStatus are set
2587
+ # by the service and are not valid caller input.
2588
+ #
2589
+ # @option params [String] :description
2590
+ # A description of this publish request, up to 1024 characters.
2591
+ #
2592
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2593
+ #
2594
+ # @example Request syntax with placeholder values
2595
+ #
2596
+ # resp = client.update_portal_publish_status({
2597
+ # portal_id: "PortalId", # required
2598
+ # status: "PUBLISHED", # required, accepts PUBLISHED, DISABLED
2599
+ # description: "PublishDescription",
2600
+ # })
2601
+ #
2602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdatePortalPublishStatus AWS API Documentation
2603
+ #
2604
+ # @overload update_portal_publish_status(params = {})
2605
+ # @param [Hash] params ({})
2606
+ def update_portal_publish_status(params = {}, options = {})
2607
+ req = build_request(:update_portal_publish_status, params)
2608
+ req.send_request(options)
2609
+ end
2610
+
2611
+ # Updates a product. Only the fields supplied in the request are
2612
+ # changed.
2613
+ #
2614
+ # @option params [required, String] :product_id
2615
+ # The identifier of the product.
2616
+ #
2617
+ # @option params [String] :display_name
2618
+ # The new name of the product. Omit it to keep the current name.
2619
+ #
2620
+ # @option params [String] :description
2621
+ # The new description of the product. Omit it to keep the current
2622
+ # description.
2623
+ #
2624
+ # @option params [Types::DisplayOrder] :display_order
2625
+ # The new page order. Omit it to keep the current order.
2626
+ #
2627
+ # @option params [Types::ApiSelectionConfiguration] :api_selection_configuration
2628
+ # The new API selection settings. The selection mode must match the mode
2629
+ # the product was created with. Omit it to keep the current settings.
2630
+ #
2631
+ # @return [Types::UpdateProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2632
+ #
2633
+ # * {Types::UpdateProductResponse#product_id #product_id} => String
2634
+ # * {Types::UpdateProductResponse#product_arn #product_arn} => String
2635
+ # * {Types::UpdateProductResponse#display_name #display_name} => String
2636
+ # * {Types::UpdateProductResponse#display_order #display_order} => Types::DisplayOrder
2637
+ # * {Types::UpdateProductResponse#description #description} => String
2638
+ # * {Types::UpdateProductResponse#updated_at #updated_at} => Time
2639
+ # * {Types::UpdateProductResponse#api_selection_configuration #api_selection_configuration} => Types::ApiSelectionConfiguration
2640
+ # * {Types::UpdateProductResponse#status #status} => String
2641
+ # * {Types::UpdateProductResponse#failure_reason #failure_reason} => String
2642
+ #
2643
+ # @example Request syntax with placeholder values
2644
+ #
2645
+ # resp = client.update_product({
2646
+ # product_id: "ProductId", # required
2647
+ # display_name: "ProductName",
2648
+ # description: "ProductDescription",
2649
+ # display_order: {
2650
+ # overview_page_arn: "ProductPageArn",
2651
+ # product_page_arns: ["ProductPageArn"],
2652
+ # contents: [
2653
+ # {
2654
+ # section_name: "SectionSectionNameString",
2655
+ # product_api_page_arns: ["ProductApiPageArn"],
2656
+ # },
2657
+ # ],
2658
+ # },
2659
+ # api_selection_configuration: {
2660
+ # api_selection_mode: "CUSTOM", # required, accepts CUSTOM, RULE_BASED
2661
+ # rule_filters: [
2662
+ # {
2663
+ # key: "RESOURCE_ARN", # required, accepts RESOURCE_ARN, HOST, METHOD, PATH, PORT, ACCOUNT
2664
+ # values: ["RuleFilterValue"], # required
2665
+ # },
2666
+ # ],
2667
+ # },
2668
+ # })
2669
+ #
2670
+ # @example Response structure
2671
+ #
2672
+ # resp.product_id #=> String
2673
+ # resp.product_arn #=> String
2674
+ # resp.display_name #=> String
2675
+ # resp.display_order.overview_page_arn #=> String
2676
+ # resp.display_order.product_page_arns #=> Array
2677
+ # resp.display_order.product_page_arns[0] #=> String
2678
+ # resp.display_order.contents #=> Array
2679
+ # resp.display_order.contents[0].section_name #=> String
2680
+ # resp.display_order.contents[0].product_api_page_arns #=> Array
2681
+ # resp.display_order.contents[0].product_api_page_arns[0] #=> String
2682
+ # resp.description #=> String
2683
+ # resp.updated_at #=> Time
2684
+ # resp.api_selection_configuration.api_selection_mode #=> String, one of "CUSTOM", "RULE_BASED"
2685
+ # resp.api_selection_configuration.rule_filters #=> Array
2686
+ # resp.api_selection_configuration.rule_filters[0].key #=> String, one of "RESOURCE_ARN", "HOST", "METHOD", "PATH", "PORT", "ACCOUNT"
2687
+ # resp.api_selection_configuration.rule_filters[0].values #=> Array
2688
+ # resp.api_selection_configuration.rule_filters[0].values[0] #=> String
2689
+ # resp.status #=> String, one of "ACTIVE", "IN_PROGRESS", "FAILED"
2690
+ # resp.failure_reason #=> String, one of "API_PAGE_ATTACHED", "EVALUATION_ERROR"
2691
+ #
2692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProduct AWS API Documentation
2693
+ #
2694
+ # @overload update_product(params = {})
2695
+ # @param [Hash] params ({})
2696
+ def update_product(params = {}, options = {})
2697
+ req = build_request(:update_product, params)
2698
+ req.send_request(options)
2699
+ end
2700
+
2701
+ # Updates an API page. Only the fields supplied in the request are
2702
+ # changed.
2703
+ #
2704
+ # @option params [required, String] :product_id
2705
+ # The identifier of the product.
2706
+ #
2707
+ # @option params [required, String] :product_api_page_id
2708
+ # The identifier of the API page.
2709
+ #
2710
+ # @option params [Types::ApiPageDisplayContent] :display_content
2711
+ # Exactly one of the members is set: `none` to use default display
2712
+ # content, or `overrides` to customize it. Modeled as a union so the
2713
+ # "exactly one" choice is enforced by type.
2714
+ #
2715
+ # @option params [String] :try_it_state
2716
+ # The new Try-It setting. Omit it to keep the current setting. To enable
2717
+ # it, the page's API URL must use HTTPS on a domain that supports
2718
+ # Try-It.
2719
+ #
2720
+ # @return [Types::UpdateProductApiPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2721
+ #
2722
+ # * {Types::UpdateProductApiPageResponse#product_api_page_id #product_api_page_id} => String
2723
+ # * {Types::UpdateProductApiPageResponse#product_api_page_arn #product_api_page_arn} => String
2724
+ # * {Types::UpdateProductApiPageResponse#api_id #api_id} => Types::ApiId
2725
+ # * {Types::UpdateProductApiPageResponse#display_content #display_content} => Types::ApiPageDisplayContentResponse
2726
+ # * {Types::UpdateProductApiPageResponse#try_it_state #try_it_state} => String
2727
+ # * {Types::UpdateProductApiPageResponse#updated_at #updated_at} => Time
2728
+ # * {Types::UpdateProductApiPageResponse#status #status} => String
2729
+ # * {Types::UpdateProductApiPageResponse#status_exception #status_exception} => Types::ProductApiPageStatusException
2730
+ #
2731
+ # @example Request syntax with placeholder values
2732
+ #
2733
+ # resp = client.update_product_api_page({
2734
+ # product_id: "ProductId", # required
2735
+ # product_api_page_id: "ProductApiPageId", # required
2736
+ # display_content: {
2737
+ # none: {
2738
+ # },
2739
+ # overrides: {
2740
+ # operation_name: "OperationName",
2741
+ # api_url: "DisplayContentOverridesApiUrlString",
2742
+ # body: "ApiPageBody",
2743
+ # },
2744
+ # },
2745
+ # try_it_state: "ENABLED", # accepts ENABLED, DISABLED
2746
+ # })
2747
+ #
2748
+ # @example Response structure
2749
+ #
2750
+ # resp.product_api_page_id #=> String
2751
+ # resp.product_api_page_arn #=> String
2752
+ # resp.api_id.identifier_parts.path #=> String
2753
+ # resp.api_id.identifier_parts.method #=> String
2754
+ # resp.api_id.identifier_parts.resource_arn #=> String
2755
+ # resp.display_content.operation_name #=> String
2756
+ # resp.display_content.api_url #=> String
2757
+ # resp.display_content.body #=> String
2758
+ # resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
2759
+ # resp.updated_at #=> Time
2760
+ # resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
2761
+ # resp.status_exception.exception #=> String, one of "INTERNAL_FAILURE", "RESOURCE_DELETED", "MEMBER_LEFT_ORG"
2762
+ # resp.status_exception.message #=> String
2763
+ #
2764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductApiPage AWS API Documentation
2765
+ #
2766
+ # @overload update_product_api_page(params = {})
2767
+ # @param [Hash] params ({})
2768
+ def update_product_api_page(params = {}, options = {})
2769
+ req = build_request(:update_product_api_page, params)
2770
+ req.send_request(options)
2771
+ end
2772
+
2773
+ # Updates a product page.
2774
+ #
2775
+ # @option params [required, String] :product_id
2776
+ # The identifier of the product.
2777
+ #
2778
+ # @option params [required, String] :product_page_id
2779
+ # The identifier of the product page.
2780
+ #
2781
+ # @option params [Types::DisplayContent] :display_content
2782
+ # The new title and body of the page. Omit it to keep the current
2783
+ # content.
2784
+ #
2785
+ # @return [Types::UpdateProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2786
+ #
2787
+ # * {Types::UpdateProductPageResponse#product_page_id #product_page_id} => String
2788
+ # * {Types::UpdateProductPageResponse#product_page_arn #product_page_arn} => String
2789
+ # * {Types::UpdateProductPageResponse#display_content #display_content} => Types::DisplayContent
2790
+ # * {Types::UpdateProductPageResponse#updated_at #updated_at} => Time
2791
+ #
2792
+ # @example Request syntax with placeholder values
2793
+ #
2794
+ # resp = client.update_product_page({
2795
+ # product_id: "ProductId", # required
2796
+ # product_page_id: "ProductPageId", # required
2797
+ # display_content: {
2798
+ # title: "PageTitle", # required
2799
+ # body: "PageBody", # required
2800
+ # },
2801
+ # })
2802
+ #
2803
+ # @example Response structure
2804
+ #
2805
+ # resp.product_page_id #=> String
2806
+ # resp.product_page_arn #=> String
2807
+ # resp.display_content.title #=> String
2808
+ # resp.display_content.body #=> String
2809
+ # resp.updated_at #=> Time
2810
+ #
2811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductPage AWS API Documentation
2812
+ #
2813
+ # @overload update_product_page(params = {})
2814
+ # @param [Hash] params ({})
2815
+ def update_product_page(params = {}, options = {})
2816
+ req = build_request(:update_product_page, params)
2817
+ req.send_request(options)
2818
+ end
2819
+
2820
+ # @!endgroup
2821
+
2822
+ # @param params ({})
2823
+ # @api private
2824
+ def build_request(operation_name, params = {})
2825
+ handlers = @handlers.for(operation_name)
2826
+ tracer = config.telemetry_provider.tracer_provider.tracer(
2827
+ Aws::Telemetry.module_to_tracer_name('Aws::APIPortal')
2828
+ )
2829
+ context = Seahorse::Client::RequestContext.new(
2830
+ operation_name: operation_name,
2831
+ operation: config.api.operation(operation_name),
2832
+ client: self,
2833
+ params: params,
2834
+ config: config,
2835
+ tracer: tracer
2836
+ )
2837
+ context[:gem_name] = 'aws-sdk-apiportal'
2838
+ context[:gem_version] = '1.0.0'
2839
+ Seahorse::Client::Request.new(handlers, context)
2840
+ end
2841
+
2842
+ # @api private
2843
+ # @deprecated
2844
+ def waiter_names
2845
+ []
2846
+ end
2847
+
2848
+ class << self
2849
+
2850
+ # @api private
2851
+ attr_reader :identifier
2852
+
2853
+ # @api private
2854
+ def errors_module
2855
+ Errors
2856
+ end
2857
+
2858
+ end
2859
+ end
2860
+ end