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,3641 @@
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
+ module Aws::APIPortal
11
+ module Types
12
+
13
+ # A custom domain for the portal and the ACM certificate that covers it.
14
+ #
15
+ # @!attribute [rw] domain_name
16
+ # The custom domain name for the portal.
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] certificate_arn
20
+ # The ARN of the ACM certificate for the domain. The certificate must
21
+ # be in us-east-1, issued, not private, and must cover the domain
22
+ # name.
23
+ # @return [String]
24
+ #
25
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ACMManaged AWS API Documentation
26
+ #
27
+ class ACMManaged < Struct.new(
28
+ :domain_name,
29
+ :certificate_arn)
30
+ SENSITIVE = []
31
+ include Aws::Structure
32
+ end
33
+
34
+ # You do not have permission to perform this operation.
35
+ #
36
+ # @!attribute [rw] message
37
+ # @return [String]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/AccessDeniedException AWS API Documentation
40
+ #
41
+ class AccessDeniedException < Struct.new(
42
+ :message)
43
+ SENSITIVE = []
44
+ include Aws::Structure
45
+ end
46
+
47
+ # Identifies the API an API page documents.
48
+ #
49
+ # @!attribute [rw] identifier_parts
50
+ # The resource, method, and path that identify the API.
51
+ # @return [Types::IdentifierParts]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiId AWS API Documentation
54
+ #
55
+ class ApiId < Struct.new(
56
+ :identifier_parts)
57
+ SENSITIVE = []
58
+ include Aws::Structure
59
+ end
60
+
61
+ # Filters for listing API inventory items. All supplied filters must
62
+ # match.
63
+ #
64
+ # @!attribute [rw] discovery_source
65
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
66
+ # front-door service type whose resources discovery crawls to find
67
+ # APIs. New source services may be added over time, so clients MUST
68
+ # treat any unrecognized value gracefully.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] resource_arn
72
+ # Return only APIs served by this resource.
73
+ # @return [String]
74
+ #
75
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiInventoryFilters AWS API Documentation
76
+ #
77
+ class ApiInventoryFilters < Struct.new(
78
+ :discovery_source,
79
+ :resource_arn)
80
+ SENSITIVE = []
81
+ include Aws::Structure
82
+ end
83
+
84
+ # An API found by discovery.
85
+ #
86
+ # @!attribute [rw] method
87
+ # The HTTP method of the API.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] host
91
+ # A discovered API's front-door hostname (e.g. an ALB, CloudFront, or
92
+ # API Gateway DNS name), bounded by the DNS name limit (RFC 1035).
93
+ # Usually literal, but may contain placeholders: &lt;*&gt; - stands
94
+ # for one dot-separated part of the hostname. When 10 or more hosts
95
+ # differ only in that part, they fold into one, e.g. a.example.com,
96
+ # b.example.com, ... become "&lt;*&gt;.example.com". Deeper levels
97
+ # fold the same way ("&lt;*&gt;.&lt;*&gt;.example.com"). The
98
+ # registrable domain never folds. <ip> - an IP-literal host.</p> </ip>
99
+ # @return [String]
100
+ #
101
+ # @!attribute [rw] port
102
+ # The port the API listens on, from 0 to 65535.
103
+ # @return [Integer]
104
+ #
105
+ # @!attribute [rw] path
106
+ # The request path of the API.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] account_id
110
+ # The AWS account ID that owns the API.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] resource_arn
114
+ # The ARN of the resource that serves the API, such as an API Gateway
115
+ # stage or a load balancer.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] region
119
+ # The AWS Region the API was discovered in.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] discovery_source
123
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
124
+ # front-door service type whose resources discovery crawls to find
125
+ # APIs. New source services may be added over time, so clients MUST
126
+ # treat any unrecognized value gracefully.
127
+ # @return [String]
128
+ #
129
+ # @!attribute [rw] first_seen
130
+ # When discovery first observed the API.
131
+ # @return [Time]
132
+ #
133
+ # @!attribute [rw] last_seen
134
+ # When discovery most recently observed the API.
135
+ # @return [Time]
136
+ #
137
+ # @!attribute [rw] visibility
138
+ # Whether a discovered API is reachable publicly or only from within a
139
+ # private network.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] waf_status
143
+ # Whether a WAF web ACL is attached to the API's front-door service.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] classification
147
+ # Whether any account has created a ManagedApi for a discovered API,
148
+ # and for a managed API whether it is unused or no longer in the
149
+ # caller's organization. SHADOW - no account has created a ManagedApi
150
+ # for this item. MANAGED - some account in the caller's organization
151
+ # has created a ManagedApi for this item. MANAGED\_ZOMBIE - managed
152
+ # and unused: no traffic for at least the account's no-traffic
153
+ # window. The API is still reachable, so this clears once traffic
154
+ # resumes. MANAGED\_ORPHANED - managed, but the account hosting the
155
+ # API has left the caller's organization or been closed. The item is
156
+ # a last-known snapshot: it is no longer rediscovered, and its
157
+ # findings are not authorized for the caller. An organizational unit
158
+ # move is not a trigger.
159
+ #
160
+ # MANAGED\_ZOMBIE and MANAGED\_ORPHANED add detail to a MANAGED item,
161
+ # so neither is returned for an item the caller does not manage, and
162
+ # MANAGED\_ORPHANED takes priority over MANAGED\_ZOMBIE. Both are
163
+ # derived per request rather than stored, so neither expires on its
164
+ # own.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] managed_by
168
+ # Who manages a MANAGED item, relative to the caller. Absent when the
169
+ # item is SHADOW. SELF - the caller account has created the
170
+ # ManagedApi. ORGANIZATION - some other account in the caller's
171
+ # organization has, but the caller has not.
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] workloads
175
+ # AI protocols seen in this API's traffic, each listed at most once.
176
+ # Absent when none has been reported, which includes an account that
177
+ # has not enabled AI discovery.
178
+ # @return [Array<String>]
179
+ #
180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiInventoryItem AWS API Documentation
181
+ #
182
+ class ApiInventoryItem < Struct.new(
183
+ :method,
184
+ :host,
185
+ :port,
186
+ :path,
187
+ :account_id,
188
+ :resource_arn,
189
+ :region,
190
+ :discovery_source,
191
+ :first_seen,
192
+ :last_seen,
193
+ :visibility,
194
+ :waf_status,
195
+ :classification,
196
+ :managed_by,
197
+ :workloads)
198
+ SENSITIVE = []
199
+ include Aws::Structure
200
+ end
201
+
202
+ # The full details of an API found by discovery.
203
+ #
204
+ # @!attribute [rw] method
205
+ # The HTTP method of the API.
206
+ # @return [String]
207
+ #
208
+ # @!attribute [rw] host
209
+ # A discovered API's front-door hostname (e.g. an ALB, CloudFront, or
210
+ # API Gateway DNS name), bounded by the DNS name limit (RFC 1035).
211
+ # Usually literal, but may contain placeholders: &lt;*&gt; - stands
212
+ # for one dot-separated part of the hostname. When 10 or more hosts
213
+ # differ only in that part, they fold into one, e.g. a.example.com,
214
+ # b.example.com, ... become "&lt;*&gt;.example.com". Deeper levels
215
+ # fold the same way ("&lt;*&gt;.&lt;*&gt;.example.com"). The
216
+ # registrable domain never folds. <ip> - an IP-literal host.</p> </ip>
217
+ # @return [String]
218
+ #
219
+ # @!attribute [rw] port
220
+ # The port the API listens on, from 0 to 65535.
221
+ # @return [Integer]
222
+ #
223
+ # @!attribute [rw] path
224
+ # The request path of the API.
225
+ # @return [String]
226
+ #
227
+ # @!attribute [rw] account_id
228
+ # The AWS account ID that owns the API.
229
+ # @return [String]
230
+ #
231
+ # @!attribute [rw] resource_arn
232
+ # The ARN of the resource that serves the API, such as an API Gateway
233
+ # stage or a load balancer.
234
+ # @return [String]
235
+ #
236
+ # @!attribute [rw] region
237
+ # The AWS Region the API was discovered in.
238
+ # @return [String]
239
+ #
240
+ # @!attribute [rw] discovery_source
241
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
242
+ # front-door service type whose resources discovery crawls to find
243
+ # APIs. New source services may be added over time, so clients MUST
244
+ # treat any unrecognized value gracefully.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] visibility
248
+ # Whether a discovered API is reachable publicly or only from within a
249
+ # private network.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] waf_status
253
+ # Whether a WAF web ACL is attached to the API's front-door service.
254
+ # @return [String]
255
+ #
256
+ # @!attribute [rw] classification
257
+ # Whether any account has created a ManagedApi for a discovered API,
258
+ # and for a managed API whether it is unused or no longer in the
259
+ # caller's organization. SHADOW - no account has created a ManagedApi
260
+ # for this item. MANAGED - some account in the caller's organization
261
+ # has created a ManagedApi for this item. MANAGED\_ZOMBIE - managed
262
+ # and unused: no traffic for at least the account's no-traffic
263
+ # window. The API is still reachable, so this clears once traffic
264
+ # resumes. MANAGED\_ORPHANED - managed, but the account hosting the
265
+ # API has left the caller's organization or been closed. The item is
266
+ # a last-known snapshot: it is no longer rediscovered, and its
267
+ # findings are not authorized for the caller. An organizational unit
268
+ # move is not a trigger.
269
+ #
270
+ # MANAGED\_ZOMBIE and MANAGED\_ORPHANED add detail to a MANAGED item,
271
+ # so neither is returned for an item the caller does not manage, and
272
+ # MANAGED\_ORPHANED takes priority over MANAGED\_ZOMBIE. Both are
273
+ # derived per request rather than stored, so neither expires on its
274
+ # own.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] managed_by
278
+ # Who manages a MANAGED item, relative to the caller. Absent when the
279
+ # item is SHADOW. SELF - the caller account has created the
280
+ # ManagedApi. ORGANIZATION - some other account in the caller's
281
+ # organization has, but the caller has not.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] workloads
285
+ # AI protocols seen in this API's traffic, each listed at most once.
286
+ # Absent when none has been reported, which includes an account that
287
+ # has not enabled AI discovery.
288
+ # @return [Array<String>]
289
+ #
290
+ # @!attribute [rw] managed_api_id
291
+ # The identifier of the Managed API created from this API. Absent if
292
+ # there is none.
293
+ # @return [String]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiInventoryItemDetail AWS API Documentation
296
+ #
297
+ class ApiInventoryItemDetail < Struct.new(
298
+ :method,
299
+ :host,
300
+ :port,
301
+ :path,
302
+ :account_id,
303
+ :resource_arn,
304
+ :region,
305
+ :discovery_source,
306
+ :visibility,
307
+ :waf_status,
308
+ :classification,
309
+ :managed_by,
310
+ :workloads,
311
+ :managed_api_id)
312
+ SENSITIVE = []
313
+ include Aws::Structure
314
+ end
315
+
316
+ # Exactly one of the members is set: `none` to use default display
317
+ # content, or `overrides` to customize it. Modeled as a union so the
318
+ # "exactly one" choice is enforced by type.
319
+ #
320
+ # @note ApiPageDisplayContent is a union - when making an API calls you must set exactly one of the members.
321
+ #
322
+ # @!attribute [rw] none
323
+ # Use the content generated from the Managed API.
324
+ # @return [Types::None]
325
+ #
326
+ # @!attribute [rw] overrides
327
+ # Replace the generated content with your own.
328
+ # @return [Types::DisplayContentOverrides]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiPageDisplayContent AWS API Documentation
331
+ #
332
+ class ApiPageDisplayContent < Struct.new(
333
+ :none,
334
+ :overrides,
335
+ :unknown)
336
+ SENSITIVE = []
337
+ include Aws::Structure
338
+ include Aws::Structure::Union
339
+
340
+ class None < ApiPageDisplayContent; end
341
+ class Overrides < ApiPageDisplayContent; end
342
+ class Unknown < ApiPageDisplayContent; end
343
+ end
344
+
345
+ # The content shown on an API page.
346
+ #
347
+ # @!attribute [rw] operation_name
348
+ # The operation name shown as the page title.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] api_url
352
+ # The invoke URL shown on the page and used by Try-It.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] body
356
+ # The Markdown body of the page. Absent while the page is
357
+ # `IN_PROGRESS`.
358
+ # @return [String]
359
+ #
360
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiPageDisplayContentResponse AWS API Documentation
361
+ #
362
+ class ApiPageDisplayContentResponse < Struct.new(
363
+ :operation_name,
364
+ :api_url,
365
+ :body)
366
+ SENSITIVE = []
367
+ include Aws::Structure
368
+ end
369
+
370
+ # How Managed APIs are selected for a product. With `CUSTOM`, you
371
+ # associate APIs yourself. With `RULE_BASED`, the APIs that match
372
+ # `ruleFilters` are selected.
373
+ #
374
+ # @!attribute [rw] api_selection_mode
375
+ # How a product's member Managed APIs are chosen. CUSTOM - the
376
+ # customer associates and disassociates Managed APIs explicitly.
377
+ # RULE\_BASED - membership is derived from ruleFilters: every Managed
378
+ # API in the account that matches is associated, and nothing else is.
379
+ # BatchAssociateManagedApi and BatchDisassociateManagedApi are
380
+ # rejected for these products.
381
+ #
382
+ # Fixed at create time. UpdateProduct cannot change the mode of an
383
+ # existing product.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] rule_filters
387
+ # Required for RULE\_BASED, rejected for CUSTOM. Filters are combined
388
+ # with AND, the values within one filter with OR, and evaluated only
389
+ # over the account's Managed APIs. Replaced as a whole on update, not
390
+ # merged.
391
+ # @return [Array<Types::RuleFilter>]
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiSelectionConfiguration AWS API Documentation
394
+ #
395
+ class ApiSelectionConfiguration < Struct.new(
396
+ :api_selection_mode,
397
+ :rule_filters)
398
+ SENSITIVE = []
399
+ include Aws::Structure
400
+ end
401
+
402
+ # The attributes that identify an API.
403
+ #
404
+ # @!attribute [rw] resource_arn
405
+ # The ARN of the resource that serves the API.
406
+ # @return [String]
407
+ #
408
+ # @!attribute [rw] method
409
+ # The HTTP method of the API.
410
+ # @return [String]
411
+ #
412
+ # @!attribute [rw] hostname
413
+ # The host name the API is served on.
414
+ # @return [String]
415
+ #
416
+ # @!attribute [rw] port
417
+ # The port the API listens on, from 0 to 65535.
418
+ # @return [Integer]
419
+ #
420
+ # @!attribute [rw] path
421
+ # The request path of the API.
422
+ # @return [String]
423
+ #
424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ApiSignature AWS API Documentation
425
+ #
426
+ class ApiSignature < Struct.new(
427
+ :resource_arn,
428
+ :method,
429
+ :hostname,
430
+ :port,
431
+ :path)
432
+ SENSITIVE = []
433
+ include Aws::Structure
434
+ end
435
+
436
+ # @!attribute [rw] product_id
437
+ # The identifier of the product to associate the Managed APIs with.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] managed_api_ids
441
+ # Bounded list of Managed API IDs, used as the request payload for
442
+ # batch associate/disassociate.
443
+ # @return [Array<String>]
444
+ #
445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/AssociateManagedApisRequest AWS API Documentation
446
+ #
447
+ class AssociateManagedApisRequest < Struct.new(
448
+ :product_id,
449
+ :managed_api_ids)
450
+ SENSITIVE = []
451
+ include Aws::Structure
452
+ end
453
+
454
+ # @!attribute [rw] failed_items
455
+ # The Managed APIs that could not be processed. IDs not listed here
456
+ # succeeded.
457
+ # @return [Array<Types::FailedManagedApiItem>]
458
+ #
459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/AssociateManagedApisResponse AWS API Documentation
460
+ #
461
+ class AssociateManagedApisResponse < Struct.new(
462
+ :failed_items)
463
+ SENSITIVE = []
464
+ include Aws::Structure
465
+ end
466
+
467
+ # How readers sign in to a portal.
468
+ #
469
+ # @!attribute [rw] authorization_config
470
+ # Exactly one of the members is set: `none` for no authorization, or
471
+ # `cognitoConfig` for Cognito. Modeled as a union so the "exactly one"
472
+ # choice is enforced by type.
473
+ # @return [Types::AuthorizationConfig]
474
+ #
475
+ # @!attribute [rw] fine_grained_access_control
476
+ # Whether access to individual products in the portal is controlled
477
+ # per reader.
478
+ # @return [String]
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/Authorization AWS API Documentation
481
+ #
482
+ class Authorization < Struct.new(
483
+ :authorization_config,
484
+ :fine_grained_access_control)
485
+ SENSITIVE = []
486
+ include Aws::Structure
487
+ end
488
+
489
+ # Exactly one of the members is set: `none` for no authorization, or
490
+ # `cognitoConfig` for Cognito. Modeled as a union so the "exactly one"
491
+ # choice is enforced by type.
492
+ #
493
+ # @note AuthorizationConfig is a union - when making an API calls you must set exactly one of the members.
494
+ #
495
+ # @note AuthorizationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AuthorizationConfig corresponding to the set member.
496
+ #
497
+ # @!attribute [rw] none
498
+ # The portal is public and readers do not sign in.
499
+ # @return [Types::None]
500
+ #
501
+ # @!attribute [rw] cognito_config
502
+ # Readers sign in through an Amazon Cognito user pool.
503
+ # @return [Types::CognitoConfig]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/AuthorizationConfig AWS API Documentation
506
+ #
507
+ class AuthorizationConfig < Struct.new(
508
+ :none,
509
+ :cognito_config,
510
+ :unknown)
511
+ SENSITIVE = []
512
+ include Aws::Structure
513
+ include Aws::Structure::Union
514
+
515
+ class None < AuthorizationConfig; end
516
+ class CognitoConfig < AuthorizationConfig; end
517
+ class Unknown < AuthorizationConfig; end
518
+ end
519
+
520
+ # The request is not valid. The message identifies the field or value
521
+ # that failed validation.
522
+ #
523
+ # @!attribute [rw] message
524
+ # @return [String]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/BadRequestException AWS API Documentation
527
+ #
528
+ class BadRequestException < Struct.new(
529
+ :message)
530
+ SENSITIVE = []
531
+ include Aws::Structure
532
+ end
533
+
534
+ # The Amazon Cognito resources readers use to sign in to a portal.
535
+ #
536
+ # @!attribute [rw] user_pool_arn
537
+ # The ARN of the Cognito user pool.
538
+ # @return [String]
539
+ #
540
+ # @!attribute [rw] app_client_id
541
+ # The ID of the user pool app client the portal uses.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] user_pool_domain
545
+ # The domain of the user pool's hosted sign-in pages.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] identity_pool_id
549
+ # The ID of the Cognito identity pool. Required only for fine-grained
550
+ # access control.
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CognitoConfig AWS API Documentation
554
+ #
555
+ class CognitoConfig < Struct.new(
556
+ :user_pool_arn,
557
+ :app_client_id,
558
+ :user_pool_domain,
559
+ :identity_pool_id)
560
+ SENSITIVE = []
561
+ include Aws::Structure
562
+ end
563
+
564
+ # The request conflicts with the current state of the resource, for
565
+ # example because another operation on it is still in progress.
566
+ #
567
+ # @!attribute [rw] message
568
+ # @return [String]
569
+ #
570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ConflictException AWS API Documentation
571
+ #
572
+ class ConflictException < Struct.new(
573
+ :message)
574
+ SENSITIVE = []
575
+ include Aws::Structure
576
+ end
577
+
578
+ # @!attribute [rw] api_signature
579
+ # The resource, method, host, port, and path that identify the API.
580
+ # @return [Types::ApiSignature]
581
+ #
582
+ # @!attribute [rw] tags
583
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
584
+ # per resource.
585
+ # @return [Hash<String,String>]
586
+ #
587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateManagedApiRequest AWS API Documentation
588
+ #
589
+ class CreateManagedApiRequest < Struct.new(
590
+ :api_signature,
591
+ :tags)
592
+ SENSITIVE = []
593
+ include Aws::Structure
594
+ end
595
+
596
+ # @!attribute [rw] managed_api_id
597
+ # The identifier of the Managed API.
598
+ # @return [String]
599
+ #
600
+ # @!attribute [rw] managed_api_arn
601
+ # The ARN of the Managed API.
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] api_signature
605
+ # The attributes that identify the API.
606
+ # @return [Types::ApiSignature]
607
+ #
608
+ # @!attribute [rw] created_at
609
+ # When the resource was created.
610
+ # @return [Time]
611
+ #
612
+ # @!attribute [rw] updated_at
613
+ # When the resource was last updated.
614
+ # @return [Time]
615
+ #
616
+ # @!attribute [rw] tags
617
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
618
+ # per resource.
619
+ # @return [Hash<String,String>]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateManagedApiResponse AWS API Documentation
622
+ #
623
+ class CreateManagedApiResponse < Struct.new(
624
+ :managed_api_id,
625
+ :managed_api_arn,
626
+ :api_signature,
627
+ :created_at,
628
+ :updated_at,
629
+ :tags)
630
+ SENSITIVE = []
631
+ include Aws::Structure
632
+ end
633
+
634
+ # @!attribute [rw] portal_id
635
+ # The identifier of the portal.
636
+ # @return [String]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreatePortalPreviewRequest AWS API Documentation
639
+ #
640
+ class CreatePortalPreviewRequest < Struct.new(
641
+ :portal_id)
642
+ SENSITIVE = []
643
+ include Aws::Structure
644
+ end
645
+
646
+ # @!attribute [rw] portal_content
647
+ # The portal's display name, description, and theme.
648
+ # @return [Types::PortalContent]
649
+ #
650
+ # @!attribute [rw] endpoint_configuration
651
+ # Exactly one of the members is set: `none` for no custom domain, or
652
+ # `acmManaged` to bring a domain + ACM certificate. Modeled as a union
653
+ # so the "exactly one" choice is enforced by type.
654
+ # @return [Types::EndpointConfigurationRequest]
655
+ #
656
+ # @!attribute [rw] authorization
657
+ # How readers sign in to the portal, and whether fine-grained access
658
+ # control is on.
659
+ # @return [Types::Authorization]
660
+ #
661
+ # @!attribute [rw] included_product_arns
662
+ # The ARNs of the products the portal includes, up to 200.
663
+ # @return [Array<String>]
664
+ #
665
+ # @!attribute [rw] logo_uri
666
+ # The S3 location of the portal logo, in the form `s3://bucket/key`.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] rum_app_monitor_name
670
+ # The name of the CloudWatch RUM app monitor that collects reader
671
+ # telemetry for the portal.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] tags
675
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
676
+ # per resource.
677
+ # @return [Hash<String,String>]
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreatePortalRequest AWS API Documentation
680
+ #
681
+ class CreatePortalRequest < Struct.new(
682
+ :portal_content,
683
+ :endpoint_configuration,
684
+ :authorization,
685
+ :included_product_arns,
686
+ :logo_uri,
687
+ :rum_app_monitor_name,
688
+ :tags)
689
+ SENSITIVE = []
690
+ include Aws::Structure
691
+ end
692
+
693
+ # @!attribute [rw] portal_id
694
+ # The identifier of the portal.
695
+ # @return [String]
696
+ #
697
+ # @!attribute [rw] portal_arn
698
+ # The ARN of the portal.
699
+ # @return [String]
700
+ #
701
+ # @!attribute [rw] endpoint_configuration
702
+ # The domain configuration of the portal.
703
+ # @return [Types::EndpointConfigurationResponse]
704
+ #
705
+ # @!attribute [rw] authorization
706
+ # How readers sign in to the portal, and whether fine-grained access
707
+ # control is on.
708
+ # @return [Types::Authorization]
709
+ #
710
+ # @!attribute [rw] portal_content
711
+ # The portal's display name, description, and theme.
712
+ # @return [Types::PortalContent]
713
+ #
714
+ # @!attribute [rw] included_product_arns
715
+ # The ARNs of the products the portal includes.
716
+ # @return [Array<String>]
717
+ #
718
+ # @!attribute [rw] publish_status
719
+ # The publish status of the portal. Absent if the portal has never
720
+ # been published.
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] status_exception
724
+ # Failure detail attached to a Portal's publish/preview status: a
725
+ # typed reason plus an optional human-readable message.
726
+ # @return [Types::PortalStatusException]
727
+ #
728
+ # @!attribute [rw] updated_at
729
+ # When the resource was last updated.
730
+ # @return [Time]
731
+ #
732
+ # @!attribute [rw] published_at
733
+ # When the portal was last published.
734
+ # @return [Time]
735
+ #
736
+ # @!attribute [rw] publish_description
737
+ # The description supplied with the most recent publish request.
738
+ # @return [String]
739
+ #
740
+ # @!attribute [rw] rum_app_monitor_name
741
+ # The name of the CloudWatch RUM app monitor that collects reader
742
+ # telemetry for the portal.
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] tags
746
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
747
+ # per resource.
748
+ # @return [Hash<String,String>]
749
+ #
750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreatePortalResponse AWS API Documentation
751
+ #
752
+ class CreatePortalResponse < Struct.new(
753
+ :portal_id,
754
+ :portal_arn,
755
+ :endpoint_configuration,
756
+ :authorization,
757
+ :portal_content,
758
+ :included_product_arns,
759
+ :publish_status,
760
+ :status_exception,
761
+ :updated_at,
762
+ :published_at,
763
+ :publish_description,
764
+ :rum_app_monitor_name,
765
+ :tags)
766
+ SENSITIVE = []
767
+ include Aws::Structure
768
+ end
769
+
770
+ # @!attribute [rw] product_id
771
+ # The identifier of the product.
772
+ # @return [String]
773
+ #
774
+ # @!attribute [rw] managed_api_id
775
+ # The Managed API this page documents. It must already be associated
776
+ # with the product, and the page's API identifier is taken from the
777
+ # Managed API rather than supplied by the caller.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] display_content
781
+ # Exactly one of the members is set: `none` to use default display
782
+ # content, or `overrides` to customize it. Modeled as a union so the
783
+ # "exactly one" choice is enforced by type.
784
+ # @return [Types::ApiPageDisplayContent]
785
+ #
786
+ # @!attribute [rw] try_it_state
787
+ # Whether readers can call the API from the page with Try-It. Defaults
788
+ # to `DISABLED`. To enable it, the page's API URL must use HTTPS on a
789
+ # domain that supports Try-It.
790
+ # @return [String]
791
+ #
792
+ # @!attribute [rw] tags
793
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
794
+ # per resource.
795
+ # @return [Hash<String,String>]
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductApiPageRequest AWS API Documentation
798
+ #
799
+ class CreateProductApiPageRequest < Struct.new(
800
+ :product_id,
801
+ :managed_api_id,
802
+ :display_content,
803
+ :try_it_state,
804
+ :tags)
805
+ SENSITIVE = []
806
+ include Aws::Structure
807
+ end
808
+
809
+ # @!attribute [rw] product_api_page_id
810
+ # The identifier of the API page.
811
+ # @return [String]
812
+ #
813
+ # @!attribute [rw] product_api_page_arn
814
+ # The ARN of the API page.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] api_id
818
+ # The API the page documents.
819
+ # @return [Types::ApiId]
820
+ #
821
+ # @!attribute [rw] display_content
822
+ # The content shown on the page.
823
+ # @return [Types::ApiPageDisplayContentResponse]
824
+ #
825
+ # @!attribute [rw] try_it_state
826
+ # Whether Try-It is enabled on the page.
827
+ # @return [String]
828
+ #
829
+ # @!attribute [rw] updated_at
830
+ # When the resource was last updated.
831
+ # @return [Time]
832
+ #
833
+ # @!attribute [rw] status
834
+ # The status of the page content: `IN_PROGRESS` while it is generated,
835
+ # then `AVAILABLE` or `FAILED`.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] status_exception
839
+ # Failure detail attached to a ProductApiPage's status: a typed
840
+ # reason plus an optional human-readable message.
841
+ # @return [Types::ProductApiPageStatusException]
842
+ #
843
+ # @!attribute [rw] tags
844
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
845
+ # per resource.
846
+ # @return [Hash<String,String>]
847
+ #
848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductApiPageResponse AWS API Documentation
849
+ #
850
+ class CreateProductApiPageResponse < Struct.new(
851
+ :product_api_page_id,
852
+ :product_api_page_arn,
853
+ :api_id,
854
+ :display_content,
855
+ :try_it_state,
856
+ :updated_at,
857
+ :status,
858
+ :status_exception,
859
+ :tags)
860
+ SENSITIVE = []
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @!attribute [rw] product_id
865
+ # The identifier of the product.
866
+ # @return [String]
867
+ #
868
+ # @!attribute [rw] display_content
869
+ # The title and body of the page.
870
+ # @return [Types::DisplayContent]
871
+ #
872
+ # @!attribute [rw] tags
873
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
874
+ # per resource.
875
+ # @return [Hash<String,String>]
876
+ #
877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductPageRequest AWS API Documentation
878
+ #
879
+ class CreateProductPageRequest < Struct.new(
880
+ :product_id,
881
+ :display_content,
882
+ :tags)
883
+ SENSITIVE = []
884
+ include Aws::Structure
885
+ end
886
+
887
+ # @!attribute [rw] product_page_id
888
+ # The identifier of the product page.
889
+ # @return [String]
890
+ #
891
+ # @!attribute [rw] product_page_arn
892
+ # The ARN of the product page.
893
+ # @return [String]
894
+ #
895
+ # @!attribute [rw] display_content
896
+ # The title and body of the page.
897
+ # @return [Types::DisplayContent]
898
+ #
899
+ # @!attribute [rw] updated_at
900
+ # When the resource was last updated.
901
+ # @return [Time]
902
+ #
903
+ # @!attribute [rw] tags
904
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
905
+ # per resource.
906
+ # @return [Hash<String,String>]
907
+ #
908
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductPageResponse AWS API Documentation
909
+ #
910
+ class CreateProductPageResponse < Struct.new(
911
+ :product_page_id,
912
+ :product_page_arn,
913
+ :display_content,
914
+ :updated_at,
915
+ :tags)
916
+ SENSITIVE = []
917
+ include Aws::Structure
918
+ end
919
+
920
+ # @!attribute [rw] display_name
921
+ # The name of the product, from 1 to 255 characters.
922
+ # @return [String]
923
+ #
924
+ # @!attribute [rw] description
925
+ # A description of the product, up to 1024 characters.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] tags
929
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
930
+ # per resource.
931
+ # @return [Hash<String,String>]
932
+ #
933
+ # @!attribute [rw] api_selection_configuration
934
+ # How Managed APIs are selected for the product. The selection mode
935
+ # can't be changed after the product is created.
936
+ # @return [Types::ApiSelectionConfiguration]
937
+ #
938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductRequest AWS API Documentation
939
+ #
940
+ class CreateProductRequest < Struct.new(
941
+ :display_name,
942
+ :description,
943
+ :tags,
944
+ :api_selection_configuration)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # @!attribute [rw] product_id
950
+ # The identifier of the product.
951
+ # @return [String]
952
+ #
953
+ # @!attribute [rw] product_arn
954
+ # The ARN of the product.
955
+ # @return [String]
956
+ #
957
+ # @!attribute [rw] display_name
958
+ # The name of the product, from 1 to 255 characters.
959
+ # @return [String]
960
+ #
961
+ # @!attribute [rw] display_order
962
+ # The order of the product's pages and API page sections in the
963
+ # portal navigation.
964
+ # @return [Types::DisplayOrder]
965
+ #
966
+ # @!attribute [rw] description
967
+ # A description of the product, up to 1024 characters.
968
+ # @return [String]
969
+ #
970
+ # @!attribute [rw] updated_at
971
+ # When the resource was last updated.
972
+ # @return [Time]
973
+ #
974
+ # @!attribute [rw] tags
975
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
976
+ # per resource.
977
+ # @return [Hash<String,String>]
978
+ #
979
+ # @!attribute [rw] api_selection_configuration
980
+ # How Managed APIs are selected for the product.
981
+ # @return [Types::ApiSelectionConfiguration]
982
+ #
983
+ # @!attribute [rw] status
984
+ # Whether the product's member APIs match its
985
+ # apiSelectionConfiguration. ACTIVE - membership matches. The only
986
+ # status a CUSTOM product reports. IN\_PROGRESS - ruleFilters changed
987
+ # and membership is still being evaluated. FAILED - evaluation could
988
+ # not finish and membership is incomplete; failureReason says why.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] failure_reason
992
+ # Reason a product's rules could not be fully applied, present only
993
+ # when `status` is `FAILED`. New reasons may be added over time, so
994
+ # clients MUST treat any unrecognized value as `UNKNOWN` and fall back
995
+ # to generic handling.
996
+ # @return [String]
997
+ #
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CreateProductResponse AWS API Documentation
999
+ #
1000
+ class CreateProductResponse < Struct.new(
1001
+ :product_id,
1002
+ :product_arn,
1003
+ :display_name,
1004
+ :display_order,
1005
+ :description,
1006
+ :updated_at,
1007
+ :tags,
1008
+ :api_selection_configuration,
1009
+ :status,
1010
+ :failure_reason)
1011
+ SENSITIVE = []
1012
+ include Aws::Structure
1013
+ end
1014
+
1015
+ # The colors of a portal. Each value is a color string of up to 16
1016
+ # characters.
1017
+ #
1018
+ # @!attribute [rw] background_color
1019
+ # The page background color.
1020
+ # @return [String]
1021
+ #
1022
+ # @!attribute [rw] navigation_color
1023
+ # The navigation pane color.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] header_color
1027
+ # The header color.
1028
+ # @return [String]
1029
+ #
1030
+ # @!attribute [rw] text_color
1031
+ # The text color.
1032
+ # @return [String]
1033
+ #
1034
+ # @!attribute [rw] accent_color
1035
+ # The color of links, buttons, and other highlighted elements.
1036
+ # @return [String]
1037
+ #
1038
+ # @!attribute [rw] error_validation_color
1039
+ # The color of error and validation messages.
1040
+ # @return [String]
1041
+ #
1042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/CustomColors AWS API Documentation
1043
+ #
1044
+ class CustomColors < Struct.new(
1045
+ :background_color,
1046
+ :navigation_color,
1047
+ :header_color,
1048
+ :text_color,
1049
+ :accent_color,
1050
+ :error_validation_color)
1051
+ SENSITIVE = []
1052
+ include Aws::Structure
1053
+ end
1054
+
1055
+ # @api private
1056
+ #
1057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteDiscoveryConfigurationRequest AWS API Documentation
1058
+ #
1059
+ class DeleteDiscoveryConfigurationRequest < Aws::EmptyStructure; end
1060
+
1061
+ # @!attribute [rw] managed_api_id
1062
+ # The identifier of the Managed API.
1063
+ # @return [String]
1064
+ #
1065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteManagedApiRequest AWS API Documentation
1066
+ #
1067
+ class DeleteManagedApiRequest < Struct.new(
1068
+ :managed_api_id)
1069
+ SENSITIVE = []
1070
+ include Aws::Structure
1071
+ end
1072
+
1073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteManagedApiResponse AWS API Documentation
1074
+ #
1075
+ class DeleteManagedApiResponse < Aws::EmptyStructure; end
1076
+
1077
+ # @api private
1078
+ #
1079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteOrganizationDiscoveryConfigurationRequest AWS API Documentation
1080
+ #
1081
+ class DeleteOrganizationDiscoveryConfigurationRequest < Aws::EmptyStructure; end
1082
+
1083
+ # @!attribute [rw] portal_id
1084
+ # The identifier of the portal.
1085
+ # @return [String]
1086
+ #
1087
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeletePortalRequest AWS API Documentation
1088
+ #
1089
+ class DeletePortalRequest < Struct.new(
1090
+ :portal_id)
1091
+ SENSITIVE = []
1092
+ include Aws::Structure
1093
+ end
1094
+
1095
+ # @!attribute [rw] product_id
1096
+ # The identifier of the product.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] product_api_page_id
1100
+ # The identifier of the API page.
1101
+ # @return [String]
1102
+ #
1103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductApiPageRequest AWS API Documentation
1104
+ #
1105
+ class DeleteProductApiPageRequest < Struct.new(
1106
+ :product_id,
1107
+ :product_api_page_id)
1108
+ SENSITIVE = []
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # @!attribute [rw] product_id
1113
+ # The identifier of the product.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] product_page_id
1117
+ # The identifier of the product page.
1118
+ # @return [String]
1119
+ #
1120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductPageRequest AWS API Documentation
1121
+ #
1122
+ class DeleteProductPageRequest < Struct.new(
1123
+ :product_id,
1124
+ :product_page_id)
1125
+ SENSITIVE = []
1126
+ include Aws::Structure
1127
+ end
1128
+
1129
+ # @!attribute [rw] product_id
1130
+ # The identifier of the product.
1131
+ # @return [String]
1132
+ #
1133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductRequest AWS API Documentation
1134
+ #
1135
+ class DeleteProductRequest < Struct.new(
1136
+ :product_id)
1137
+ SENSITIVE = []
1138
+ include Aws::Structure
1139
+ end
1140
+
1141
+ # @!attribute [rw] product_id
1142
+ # The identifier of the product.
1143
+ # @return [String]
1144
+ #
1145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DeleteProductSharingPolicyRequest AWS API Documentation
1146
+ #
1147
+ class DeleteProductSharingPolicyRequest < Struct.new(
1148
+ :product_id)
1149
+ SENSITIVE = []
1150
+ include Aws::Structure
1151
+ end
1152
+
1153
+ # @!attribute [rw] product_id
1154
+ # The identifier of the product to disassociate the Managed APIs from.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] managed_api_ids
1158
+ # Bounded list of Managed API IDs, used as the request payload for
1159
+ # batch associate/disassociate.
1160
+ # @return [Array<String>]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisassociateManagedApisRequest AWS API Documentation
1163
+ #
1164
+ class DisassociateManagedApisRequest < Struct.new(
1165
+ :product_id,
1166
+ :managed_api_ids)
1167
+ SENSITIVE = []
1168
+ include Aws::Structure
1169
+ end
1170
+
1171
+ # @!attribute [rw] failed_items
1172
+ # The Managed APIs that could not be processed. IDs not listed here
1173
+ # succeeded.
1174
+ # @return [Array<Types::FailedManagedApiItem>]
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisassociateManagedApisResponse AWS API Documentation
1177
+ #
1178
+ class DisassociateManagedApisResponse < Struct.new(
1179
+ :failed_items)
1180
+ SENSITIVE = []
1181
+ include Aws::Structure
1182
+ end
1183
+
1184
+ # An account-level discovery configuration.
1185
+ #
1186
+ # @!attribute [rw] arn
1187
+ # The ARN of the discovery configuration.
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] status
1191
+ # The current status of the discovery configuration.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] discovery_sources
1195
+ # The sources APIs are discovered from.
1196
+ # @return [Array<String>]
1197
+ #
1198
+ # @!attribute [rw] excluded_resources
1199
+ # The ARNs of resources left out of discovery.
1200
+ # @return [Array<String>]
1201
+ #
1202
+ # @!attribute [rw] features
1203
+ # Optional capabilities enabled for this configuration. Absent when
1204
+ # none are.
1205
+ # @return [Array<String>]
1206
+ #
1207
+ # @!attribute [rw] created_at
1208
+ # When the resource was created.
1209
+ # @return [Time]
1210
+ #
1211
+ # @!attribute [rw] updated_at
1212
+ # When the resource was last updated.
1213
+ # @return [Time]
1214
+ #
1215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DiscoveryConfigurationData AWS API Documentation
1216
+ #
1217
+ class DiscoveryConfigurationData < Struct.new(
1218
+ :arn,
1219
+ :status,
1220
+ :discovery_sources,
1221
+ :excluded_resources,
1222
+ :features,
1223
+ :created_at,
1224
+ :updated_at)
1225
+ SENSITIVE = []
1226
+ include Aws::Structure
1227
+ end
1228
+
1229
+ # Exclusion filters for organization-scoped discovery. Resources
1230
+ # matching any of these filters are excluded from discovery.
1231
+ #
1232
+ # @!attribute [rw] organizational_unit_ids
1233
+ # List of organizational unit IDs to exclude from discovery.
1234
+ # @return [Array<String>]
1235
+ #
1236
+ # @!attribute [rw] account_ids
1237
+ # List of AWS account IDs to exclude from discovery.
1238
+ # @return [Array<String>]
1239
+ #
1240
+ # @!attribute [rw] resource_arns
1241
+ # List of resource ARNs to exclude. Only ELB and CloudFront resource
1242
+ # ARNs are supported.
1243
+ # @return [Array<String>]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DiscoveryExclusionFilters AWS API Documentation
1246
+ #
1247
+ class DiscoveryExclusionFilters < Struct.new(
1248
+ :organizational_unit_ids,
1249
+ :account_ids,
1250
+ :resource_arns)
1251
+ SENSITIVE = []
1252
+ include Aws::Structure
1253
+ end
1254
+
1255
+ # Inclusion filters for organization-scoped discovery. Only Resources
1256
+ # matching any of these filters are included in discovery.
1257
+ #
1258
+ # @!attribute [rw] organizational_unit_ids
1259
+ # List of organizational unit IDs to include in discovery.
1260
+ # @return [Array<String>]
1261
+ #
1262
+ # @!attribute [rw] account_ids
1263
+ # List of AWS account IDs to include in discovery.
1264
+ # @return [Array<String>]
1265
+ #
1266
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DiscoveryInclusionFilters AWS API Documentation
1267
+ #
1268
+ class DiscoveryInclusionFilters < Struct.new(
1269
+ :organizational_unit_ids,
1270
+ :account_ids)
1271
+ SENSITIVE = []
1272
+ include Aws::Structure
1273
+ end
1274
+
1275
+ # The state of API discovery for one discovery source.
1276
+ #
1277
+ # @!attribute [rw] account_id
1278
+ # The AWS account ID the status applies to.
1279
+ # @return [String]
1280
+ #
1281
+ # @!attribute [rw] discovery_source
1282
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
1283
+ # front-door service type whose resources discovery crawls to find
1284
+ # APIs. New source services may be added over time, so clients MUST
1285
+ # treat any unrecognized value gracefully.
1286
+ # @return [String]
1287
+ #
1288
+ # @!attribute [rw] status
1289
+ # The current state of discovery for this source.
1290
+ # @return [String]
1291
+ #
1292
+ # @!attribute [rw] failure_reason
1293
+ # Typed reason for failure, present only when `status` is `FAILED`
1294
+ # @return [String]
1295
+ #
1296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DiscoveryStatus AWS API Documentation
1297
+ #
1298
+ class DiscoveryStatus < Struct.new(
1299
+ :account_id,
1300
+ :discovery_source,
1301
+ :status,
1302
+ :failure_reason)
1303
+ SENSITIVE = []
1304
+ include Aws::Structure
1305
+ end
1306
+
1307
+ # The content of a product page.
1308
+ #
1309
+ # @!attribute [rw] title
1310
+ # The page title, from 1 to 255 characters.
1311
+ # @return [String]
1312
+ #
1313
+ # @!attribute [rw] body
1314
+ # The Markdown body of the page, from 1 to 32,768 characters.
1315
+ # @return [String]
1316
+ #
1317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisplayContent AWS API Documentation
1318
+ #
1319
+ class DisplayContent < Struct.new(
1320
+ :title,
1321
+ :body)
1322
+ SENSITIVE = []
1323
+ include Aws::Structure
1324
+ end
1325
+
1326
+ # Content that replaces the defaults generated for an API page.
1327
+ #
1328
+ # @!attribute [rw] operation_name
1329
+ # The operation name shown as the page title, from 1 to 255
1330
+ # characters.
1331
+ # @return [String]
1332
+ #
1333
+ # @!attribute [rw] api_url
1334
+ # The invoke URL shown on the page and used for Try-It and the
1335
+ # portal's allowed-domain list: http(s)://host\[:port\]\[/path\],
1336
+ # with no whitespace, quotes or angle brackets. On this request member
1337
+ # only, as ApiEndpoint is also returned in responses.
1338
+ # @return [String]
1339
+ #
1340
+ # @!attribute [rw] body
1341
+ # The Markdown body of the page, from 1 to 32,768 characters.
1342
+ # @return [String]
1343
+ #
1344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisplayContentOverrides AWS API Documentation
1345
+ #
1346
+ class DisplayContentOverrides < Struct.new(
1347
+ :operation_name,
1348
+ :api_url,
1349
+ :body)
1350
+ SENSITIVE = []
1351
+ include Aws::Structure
1352
+ end
1353
+
1354
+ # The order of a product's content in the portal navigation.
1355
+ #
1356
+ # @!attribute [rw] overview_page_arn
1357
+ # The ARN of the product page shown as the product overview.
1358
+ # @return [String]
1359
+ #
1360
+ # @!attribute [rw] product_page_arns
1361
+ # A product has at most
1362
+ # DocHubLimits.DEFAULT\_PAGES\_PER\_PRODUCT\_LIMIT (40) pages,
1363
+ # enforced by LimitsHelper.
1364
+ # @return [Array<String>]
1365
+ #
1366
+ # @!attribute [rw] contents
1367
+ # Sections in a product's navigation. No service-side limit exists
1368
+ # today; this bound caps request size.
1369
+ # @return [Array<Types::Section>]
1370
+ #
1371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/DisplayOrder AWS API Documentation
1372
+ #
1373
+ class DisplayOrder < Struct.new(
1374
+ :overview_page_arn,
1375
+ :product_page_arns,
1376
+ :contents)
1377
+ SENSITIVE = []
1378
+ include Aws::Structure
1379
+ end
1380
+
1381
+ # Exactly one of the members is set: `none` for no custom domain, or
1382
+ # `acmManaged` to bring a domain + ACM certificate. Modeled as a union
1383
+ # so the "exactly one" choice is enforced by type.
1384
+ #
1385
+ # @note EndpointConfigurationRequest is a union - when making an API calls you must set exactly one of the members.
1386
+ #
1387
+ # @!attribute [rw] none
1388
+ # Serve the portal only on its default domain.
1389
+ # @return [Types::None]
1390
+ #
1391
+ # @!attribute [rw] acm_managed
1392
+ # Serve the portal on your own domain, using a certificate from AWS
1393
+ # Certificate Manager.
1394
+ # @return [Types::ACMManaged]
1395
+ #
1396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/EndpointConfigurationRequest AWS API Documentation
1397
+ #
1398
+ class EndpointConfigurationRequest < Struct.new(
1399
+ :none,
1400
+ :acm_managed,
1401
+ :unknown)
1402
+ SENSITIVE = []
1403
+ include Aws::Structure
1404
+ include Aws::Structure::Union
1405
+
1406
+ class None < EndpointConfigurationRequest; end
1407
+ class AcmManaged < EndpointConfigurationRequest; end
1408
+ class Unknown < EndpointConfigurationRequest; end
1409
+ end
1410
+
1411
+ # The domains a portal is served on.
1412
+ #
1413
+ # @!attribute [rw] domain_name
1414
+ # The custom domain name of the portal. Absent if the portal has no
1415
+ # custom domain.
1416
+ # @return [String]
1417
+ #
1418
+ # @!attribute [rw] certificate_arn
1419
+ # The ARN of the ACM certificate for the custom domain. Absent if the
1420
+ # portal has no custom domain.
1421
+ # @return [String]
1422
+ #
1423
+ # @!attribute [rw] portal_domain_hosted_zone_id
1424
+ # The ID of the hosted zone for the portal's distribution. Use it to
1425
+ # create an alias record for a custom domain.
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] portal_default_domain_name
1429
+ # The default domain name assigned to the portal.
1430
+ # @return [String]
1431
+ #
1432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/EndpointConfigurationResponse AWS API Documentation
1433
+ #
1434
+ class EndpointConfigurationResponse < Struct.new(
1435
+ :domain_name,
1436
+ :certificate_arn,
1437
+ :portal_domain_hosted_zone_id,
1438
+ :portal_default_domain_name)
1439
+ SENSITIVE = []
1440
+ include Aws::Structure
1441
+ end
1442
+
1443
+ # One entry per Managed API ID that could not be processed in a batch
1444
+ # call. Ids that succeed are omitted from the response — callers infer
1445
+ # success by absence.
1446
+ #
1447
+ # @!attribute [rw] managed_api_id
1448
+ # The identifier of the Managed API that could not be processed.
1449
+ # @return [String]
1450
+ #
1451
+ # @!attribute [rw] error_code
1452
+ # Machine-readable reason a Managed API ID couldn't be processed in a
1453
+ # batch call. Clients should key retry logic off this enum rather than
1454
+ # parsing errorMessage.
1455
+ # @return [String]
1456
+ #
1457
+ # @!attribute [rw] error_message
1458
+ # A description of the failure.
1459
+ # @return [String]
1460
+ #
1461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/FailedManagedApiItem AWS API Documentation
1462
+ #
1463
+ class FailedManagedApiItem < Struct.new(
1464
+ :managed_api_id,
1465
+ :error_code,
1466
+ :error_message)
1467
+ SENSITIVE = []
1468
+ include Aws::Structure
1469
+ end
1470
+
1471
+ # @!attribute [rw] method
1472
+ # The HTTP method of the API.
1473
+ # @return [String]
1474
+ #
1475
+ # @!attribute [rw] host
1476
+ # A discovered API's front-door hostname (e.g. an ALB, CloudFront, or
1477
+ # API Gateway DNS name), bounded by the DNS name limit (RFC 1035).
1478
+ # Usually literal, but may contain placeholders: &lt;*&gt; - stands
1479
+ # for one dot-separated part of the hostname. When 10 or more hosts
1480
+ # differ only in that part, they fold into one, e.g. a.example.com,
1481
+ # b.example.com, ... become "&lt;*&gt;.example.com". Deeper levels
1482
+ # fold the same way ("&lt;*&gt;.&lt;*&gt;.example.com"). The
1483
+ # registrable domain never folds. <ip> - an IP-literal host.</p> </ip>
1484
+ # @return [String]
1485
+ #
1486
+ # @!attribute [rw] port
1487
+ # The port the API listens on, from 0 to 65535.
1488
+ # @return [Integer]
1489
+ #
1490
+ # @!attribute [rw] path
1491
+ # The request path of the API.
1492
+ # @return [String]
1493
+ #
1494
+ # @!attribute [rw] resource_arn
1495
+ # The ARN of the resource that serves the API, such as an API Gateway
1496
+ # stage or a load balancer.
1497
+ # @return [String]
1498
+ #
1499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetApiInventoryItemRequest AWS API Documentation
1500
+ #
1501
+ class GetApiInventoryItemRequest < Struct.new(
1502
+ :method,
1503
+ :host,
1504
+ :port,
1505
+ :path,
1506
+ :resource_arn)
1507
+ SENSITIVE = []
1508
+ include Aws::Structure
1509
+ end
1510
+
1511
+ # @!attribute [rw] item
1512
+ # The details of the API inventory item.
1513
+ # @return [Types::ApiInventoryItemDetail]
1514
+ #
1515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetApiInventoryItemResponse AWS API Documentation
1516
+ #
1517
+ class GetApiInventoryItemResponse < Struct.new(
1518
+ :item)
1519
+ SENSITIVE = []
1520
+ include Aws::Structure
1521
+ end
1522
+
1523
+ # @api private
1524
+ #
1525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetDiscoveryConfigurationRequest AWS API Documentation
1526
+ #
1527
+ class GetDiscoveryConfigurationRequest < Aws::EmptyStructure; end
1528
+
1529
+ # @!attribute [rw] discovery_configuration
1530
+ # The discovery configuration for the account.
1531
+ # @return [Types::DiscoveryConfigurationData]
1532
+ #
1533
+ # @!attribute [rw] tags
1534
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1535
+ # per resource.
1536
+ # @return [Hash<String,String>]
1537
+ #
1538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetDiscoveryConfigurationResponse AWS API Documentation
1539
+ #
1540
+ class GetDiscoveryConfigurationResponse < Struct.new(
1541
+ :discovery_configuration,
1542
+ :tags)
1543
+ SENSITIVE = []
1544
+ include Aws::Structure
1545
+ end
1546
+
1547
+ # @!attribute [rw] managed_api_id
1548
+ # The identifier of the Managed API.
1549
+ # @return [String]
1550
+ #
1551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetManagedApiRequest AWS API Documentation
1552
+ #
1553
+ class GetManagedApiRequest < Struct.new(
1554
+ :managed_api_id)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1559
+ # @!attribute [rw] managed_api_id
1560
+ # The identifier of the Managed API.
1561
+ # @return [String]
1562
+ #
1563
+ # @!attribute [rw] managed_api_arn
1564
+ # The ARN of the Managed API.
1565
+ # @return [String]
1566
+ #
1567
+ # @!attribute [rw] api_signature
1568
+ # The attributes that identify the API.
1569
+ # @return [Types::ApiSignature]
1570
+ #
1571
+ # @!attribute [rw] created_at
1572
+ # When the resource was created.
1573
+ # @return [Time]
1574
+ #
1575
+ # @!attribute [rw] updated_at
1576
+ # When the resource was last updated.
1577
+ # @return [Time]
1578
+ #
1579
+ # @!attribute [rw] findings
1580
+ # The security posture findings for the API, up to 100.
1581
+ # @return [Array<Types::ManagedApiFinding>]
1582
+ #
1583
+ # @!attribute [rw] tags
1584
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1585
+ # per resource.
1586
+ # @return [Hash<String,String>]
1587
+ #
1588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetManagedApiResponse AWS API Documentation
1589
+ #
1590
+ class GetManagedApiResponse < Struct.new(
1591
+ :managed_api_id,
1592
+ :managed_api_arn,
1593
+ :api_signature,
1594
+ :created_at,
1595
+ :updated_at,
1596
+ :findings,
1597
+ :tags)
1598
+ SENSITIVE = []
1599
+ include Aws::Structure
1600
+ end
1601
+
1602
+ # @api private
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetOrganizationDiscoveryConfigurationRequest AWS API Documentation
1605
+ #
1606
+ class GetOrganizationDiscoveryConfigurationRequest < Aws::EmptyStructure; end
1607
+
1608
+ # @!attribute [rw] discovery_configuration
1609
+ # The discovery configuration for the organization.
1610
+ # @return [Types::OrganizationDiscoveryConfigurationData]
1611
+ #
1612
+ # @!attribute [rw] tags
1613
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1614
+ # per resource.
1615
+ # @return [Hash<String,String>]
1616
+ #
1617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetOrganizationDiscoveryConfigurationResponse AWS API Documentation
1618
+ #
1619
+ class GetOrganizationDiscoveryConfigurationResponse < Struct.new(
1620
+ :discovery_configuration,
1621
+ :tags)
1622
+ SENSITIVE = []
1623
+ include Aws::Structure
1624
+ end
1625
+
1626
+ # @!attribute [rw] portal_id
1627
+ # The identifier of the portal.
1628
+ # @return [String]
1629
+ #
1630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetPortalRequest AWS API Documentation
1631
+ #
1632
+ class GetPortalRequest < Struct.new(
1633
+ :portal_id)
1634
+ SENSITIVE = []
1635
+ include Aws::Structure
1636
+ end
1637
+
1638
+ # @!attribute [rw] portal_id
1639
+ # The identifier of the portal.
1640
+ # @return [String]
1641
+ #
1642
+ # @!attribute [rw] portal_arn
1643
+ # The ARN of the portal.
1644
+ # @return [String]
1645
+ #
1646
+ # @!attribute [rw] endpoint_configuration
1647
+ # The domain configuration of the portal.
1648
+ # @return [Types::EndpointConfigurationResponse]
1649
+ #
1650
+ # @!attribute [rw] authorization
1651
+ # How readers sign in to the portal, and whether fine-grained access
1652
+ # control is on.
1653
+ # @return [Types::Authorization]
1654
+ #
1655
+ # @!attribute [rw] portal_content
1656
+ # The portal's display name, description, and theme.
1657
+ # @return [Types::PortalContent]
1658
+ #
1659
+ # @!attribute [rw] included_product_arns
1660
+ # The ARNs of the products the portal includes.
1661
+ # @return [Array<String>]
1662
+ #
1663
+ # @!attribute [rw] publish_status
1664
+ # The publish status of the portal. Absent if the portal has never
1665
+ # been published.
1666
+ # @return [String]
1667
+ #
1668
+ # @!attribute [rw] status_exception
1669
+ # Failure detail attached to a Portal's publish/preview status: a
1670
+ # typed reason plus an optional human-readable message.
1671
+ # @return [Types::PortalStatusException]
1672
+ #
1673
+ # @!attribute [rw] updated_at
1674
+ # When the resource was last updated.
1675
+ # @return [Time]
1676
+ #
1677
+ # @!attribute [rw] published_at
1678
+ # When the portal was last published.
1679
+ # @return [Time]
1680
+ #
1681
+ # @!attribute [rw] publish_description
1682
+ # The description supplied with the most recent publish request.
1683
+ # @return [String]
1684
+ #
1685
+ # @!attribute [rw] rum_app_monitor_name
1686
+ # The name of the CloudWatch RUM app monitor that collects reader
1687
+ # telemetry for the portal.
1688
+ # @return [String]
1689
+ #
1690
+ # @!attribute [rw] preview
1691
+ # The most recent preview of the portal. Absent if no preview has been
1692
+ # created.
1693
+ # @return [Types::Preview]
1694
+ #
1695
+ # @!attribute [rw] tags
1696
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1697
+ # per resource.
1698
+ # @return [Hash<String,String>]
1699
+ #
1700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetPortalResponse AWS API Documentation
1701
+ #
1702
+ class GetPortalResponse < Struct.new(
1703
+ :portal_id,
1704
+ :portal_arn,
1705
+ :endpoint_configuration,
1706
+ :authorization,
1707
+ :portal_content,
1708
+ :included_product_arns,
1709
+ :publish_status,
1710
+ :status_exception,
1711
+ :updated_at,
1712
+ :published_at,
1713
+ :publish_description,
1714
+ :rum_app_monitor_name,
1715
+ :preview,
1716
+ :tags)
1717
+ SENSITIVE = []
1718
+ include Aws::Structure
1719
+ end
1720
+
1721
+ # @!attribute [rw] product_id
1722
+ # The identifier of the product.
1723
+ # @return [String]
1724
+ #
1725
+ # @!attribute [rw] product_api_page_id
1726
+ # The identifier of the API page.
1727
+ # @return [String]
1728
+ #
1729
+ # @!attribute [rw] resource_owner_account_id
1730
+ # The AWS account ID that owns the product. Supply it to read a
1731
+ # product shared with you by another account. Omit it for products in
1732
+ # your own account.
1733
+ # @return [String]
1734
+ #
1735
+ # @!attribute [rw] include_raw_display_content
1736
+ # Set to `true` to also return the page body in `rawDisplayContent`.
1737
+ # @return [Boolean]
1738
+ #
1739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductApiPageRequest AWS API Documentation
1740
+ #
1741
+ class GetProductApiPageRequest < Struct.new(
1742
+ :product_id,
1743
+ :product_api_page_id,
1744
+ :resource_owner_account_id,
1745
+ :include_raw_display_content)
1746
+ SENSITIVE = []
1747
+ include Aws::Structure
1748
+ end
1749
+
1750
+ # @!attribute [rw] product_api_page_id
1751
+ # The identifier of the API page.
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] product_api_page_arn
1755
+ # The ARN of the API page.
1756
+ # @return [String]
1757
+ #
1758
+ # @!attribute [rw] api_id
1759
+ # The API the page documents.
1760
+ # @return [Types::ApiId]
1761
+ #
1762
+ # @!attribute [rw] display_content
1763
+ # The content shown on the page.
1764
+ # @return [Types::ApiPageDisplayContentResponse]
1765
+ #
1766
+ # @!attribute [rw] try_it_state
1767
+ # Whether Try-It is enabled on the page.
1768
+ # @return [String]
1769
+ #
1770
+ # @!attribute [rw] updated_at
1771
+ # When the resource was last updated.
1772
+ # @return [Time]
1773
+ #
1774
+ # @!attribute [rw] status
1775
+ # The status of the page content: `IN_PROGRESS` while it is generated,
1776
+ # then `AVAILABLE` or `FAILED`.
1777
+ # @return [String]
1778
+ #
1779
+ # @!attribute [rw] raw_display_content
1780
+ # The Markdown body of the page. Returned only when
1781
+ # `includeRawDisplayContent` is `true`.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] status_exception
1785
+ # Failure detail attached to a ProductApiPage's status: a typed
1786
+ # reason plus an optional human-readable message.
1787
+ # @return [Types::ProductApiPageStatusException]
1788
+ #
1789
+ # @!attribute [rw] tags
1790
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1791
+ # per resource.
1792
+ # @return [Hash<String,String>]
1793
+ #
1794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductApiPageResponse AWS API Documentation
1795
+ #
1796
+ class GetProductApiPageResponse < Struct.new(
1797
+ :product_api_page_id,
1798
+ :product_api_page_arn,
1799
+ :api_id,
1800
+ :display_content,
1801
+ :try_it_state,
1802
+ :updated_at,
1803
+ :status,
1804
+ :raw_display_content,
1805
+ :status_exception,
1806
+ :tags)
1807
+ SENSITIVE = []
1808
+ include Aws::Structure
1809
+ end
1810
+
1811
+ # @!attribute [rw] product_id
1812
+ # The identifier of the product.
1813
+ # @return [String]
1814
+ #
1815
+ # @!attribute [rw] product_page_id
1816
+ # The identifier of the product page.
1817
+ # @return [String]
1818
+ #
1819
+ # @!attribute [rw] resource_owner_account_id
1820
+ # The AWS account ID that owns the product. Supply it to read a
1821
+ # product shared with you by another account. Omit it for products in
1822
+ # your own account.
1823
+ # @return [String]
1824
+ #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductPageRequest AWS API Documentation
1826
+ #
1827
+ class GetProductPageRequest < Struct.new(
1828
+ :product_id,
1829
+ :product_page_id,
1830
+ :resource_owner_account_id)
1831
+ SENSITIVE = []
1832
+ include Aws::Structure
1833
+ end
1834
+
1835
+ # @!attribute [rw] product_page_id
1836
+ # The identifier of the product page.
1837
+ # @return [String]
1838
+ #
1839
+ # @!attribute [rw] product_page_arn
1840
+ # The ARN of the product page.
1841
+ # @return [String]
1842
+ #
1843
+ # @!attribute [rw] display_content
1844
+ # The title and body of the page.
1845
+ # @return [Types::DisplayContent]
1846
+ #
1847
+ # @!attribute [rw] updated_at
1848
+ # When the resource was last updated.
1849
+ # @return [Time]
1850
+ #
1851
+ # @!attribute [rw] tags
1852
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1853
+ # per resource.
1854
+ # @return [Hash<String,String>]
1855
+ #
1856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductPageResponse AWS API Documentation
1857
+ #
1858
+ class GetProductPageResponse < Struct.new(
1859
+ :product_page_id,
1860
+ :product_page_arn,
1861
+ :display_content,
1862
+ :updated_at,
1863
+ :tags)
1864
+ SENSITIVE = []
1865
+ include Aws::Structure
1866
+ end
1867
+
1868
+ # @!attribute [rw] product_id
1869
+ # The identifier of the product.
1870
+ # @return [String]
1871
+ #
1872
+ # @!attribute [rw] resource_owner_account_id
1873
+ # The AWS account ID that owns the product. Supply it to read a
1874
+ # product shared with you by another account. Omit it for products in
1875
+ # your own account.
1876
+ # @return [String]
1877
+ #
1878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductRequest AWS API Documentation
1879
+ #
1880
+ class GetProductRequest < Struct.new(
1881
+ :product_id,
1882
+ :resource_owner_account_id)
1883
+ SENSITIVE = []
1884
+ include Aws::Structure
1885
+ end
1886
+
1887
+ # @!attribute [rw] product_id
1888
+ # The identifier of the product.
1889
+ # @return [String]
1890
+ #
1891
+ # @!attribute [rw] product_arn
1892
+ # The ARN of the product.
1893
+ # @return [String]
1894
+ #
1895
+ # @!attribute [rw] display_name
1896
+ # The name of the product, from 1 to 255 characters.
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] display_order
1900
+ # The order of the product's pages and API page sections in the
1901
+ # portal navigation.
1902
+ # @return [Types::DisplayOrder]
1903
+ #
1904
+ # @!attribute [rw] description
1905
+ # A description of the product, up to 1024 characters.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] updated_at
1909
+ # When the resource was last updated.
1910
+ # @return [Time]
1911
+ #
1912
+ # @!attribute [rw] tags
1913
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1914
+ # per resource.
1915
+ # @return [Hash<String,String>]
1916
+ #
1917
+ # @!attribute [rw] api_selection_configuration
1918
+ # How Managed APIs are selected for the product.
1919
+ # @return [Types::ApiSelectionConfiguration]
1920
+ #
1921
+ # @!attribute [rw] status
1922
+ # Whether the product's member APIs match its
1923
+ # apiSelectionConfiguration. ACTIVE - membership matches. The only
1924
+ # status a CUSTOM product reports. IN\_PROGRESS - ruleFilters changed
1925
+ # and membership is still being evaluated. FAILED - evaluation could
1926
+ # not finish and membership is incomplete; failureReason says why.
1927
+ # @return [String]
1928
+ #
1929
+ # @!attribute [rw] failure_reason
1930
+ # Reason a product's rules could not be fully applied, present only
1931
+ # when `status` is `FAILED`. New reasons may be added over time, so
1932
+ # clients MUST treat any unrecognized value as `UNKNOWN` and fall back
1933
+ # to generic handling.
1934
+ # @return [String]
1935
+ #
1936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductResponse AWS API Documentation
1937
+ #
1938
+ class GetProductResponse < Struct.new(
1939
+ :product_id,
1940
+ :product_arn,
1941
+ :display_name,
1942
+ :display_order,
1943
+ :description,
1944
+ :updated_at,
1945
+ :tags,
1946
+ :api_selection_configuration,
1947
+ :status,
1948
+ :failure_reason)
1949
+ SENSITIVE = []
1950
+ include Aws::Structure
1951
+ end
1952
+
1953
+ # @!attribute [rw] product_id
1954
+ # The identifier of the product.
1955
+ # @return [String]
1956
+ #
1957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductSharingPolicyRequest AWS API Documentation
1958
+ #
1959
+ class GetProductSharingPolicyRequest < Struct.new(
1960
+ :product_id)
1961
+ SENSITIVE = []
1962
+ include Aws::Structure
1963
+ end
1964
+
1965
+ # @!attribute [rw] product_id
1966
+ # The identifier of the product.
1967
+ # @return [String]
1968
+ #
1969
+ # @!attribute [rw] policy_document
1970
+ # The sharing policy as a JSON resource policy document.
1971
+ # @return [String]
1972
+ #
1973
+ # @!attribute [rw] tags
1974
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
1975
+ # per resource.
1976
+ # @return [Hash<String,String>]
1977
+ #
1978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/GetProductSharingPolicyResponse AWS API Documentation
1979
+ #
1980
+ class GetProductSharingPolicyResponse < Struct.new(
1981
+ :product_id,
1982
+ :policy_document,
1983
+ :tags)
1984
+ SENSITIVE = []
1985
+ include Aws::Structure
1986
+ end
1987
+
1988
+ # The parts that together identify an API.
1989
+ #
1990
+ # @!attribute [rw] path
1991
+ # The request path of the API.
1992
+ # @return [String]
1993
+ #
1994
+ # @!attribute [rw] method
1995
+ # The HTTP method of the API.
1996
+ # @return [String]
1997
+ #
1998
+ # @!attribute [rw] resource_arn
1999
+ # The ARN of the resource that serves the API.
2000
+ # @return [String]
2001
+ #
2002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/IdentifierParts AWS API Documentation
2003
+ #
2004
+ class IdentifierParts < Struct.new(
2005
+ :path,
2006
+ :method,
2007
+ :resource_arn)
2008
+ SENSITIVE = []
2009
+ include Aws::Structure
2010
+ end
2011
+
2012
+ # The service encountered an internal error. Try the request again.
2013
+ #
2014
+ # @!attribute [rw] message
2015
+ # @return [String]
2016
+ #
2017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/InternalServerException AWS API Documentation
2018
+ #
2019
+ class InternalServerException < Struct.new(
2020
+ :message)
2021
+ SENSITIVE = []
2022
+ include Aws::Structure
2023
+ end
2024
+
2025
+ # The request rate or a service quota was exceeded. Reduce the request
2026
+ # rate or the number of resources and try again.
2027
+ #
2028
+ # @!attribute [rw] message
2029
+ # @return [String]
2030
+ #
2031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/LimitExceededException AWS API Documentation
2032
+ #
2033
+ class LimitExceededException < Struct.new(
2034
+ :message)
2035
+ SENSITIVE = []
2036
+ include Aws::Structure
2037
+ end
2038
+
2039
+ # @!attribute [rw] filters
2040
+ # Filters that limit the results. Omit it to list every discovered
2041
+ # API.
2042
+ # @return [Types::ApiInventoryFilters]
2043
+ #
2044
+ # @!attribute [rw] max_results
2045
+ # The maximum number of results to return in one page, from 1 to 100.
2046
+ # @return [Integer]
2047
+ #
2048
+ # @!attribute [rw] next_token
2049
+ # The pagination token returned by a previous call. Omit it to get the
2050
+ # first page.
2051
+ # @return [String]
2052
+ #
2053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListApiInventoryItemsRequest AWS API Documentation
2054
+ #
2055
+ class ListApiInventoryItemsRequest < Struct.new(
2056
+ :filters,
2057
+ :max_results,
2058
+ :next_token)
2059
+ SENSITIVE = []
2060
+ include Aws::Structure
2061
+ end
2062
+
2063
+ # @!attribute [rw] items
2064
+ # The discovered APIs in this page of results.
2065
+ # @return [Array<Types::ApiInventoryItem>]
2066
+ #
2067
+ # @!attribute [rw] next_token
2068
+ # The token to pass in the next request to get the next page. Absent
2069
+ # when there are no more results.
2070
+ # @return [String]
2071
+ #
2072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListApiInventoryItemsResponse AWS API Documentation
2073
+ #
2074
+ class ListApiInventoryItemsResponse < Struct.new(
2075
+ :items,
2076
+ :next_token)
2077
+ SENSITIVE = []
2078
+ include Aws::Structure
2079
+ end
2080
+
2081
+ # @!attribute [rw] discovery_source
2082
+ # The AWS service that is the SOURCE of discovered APIs — i.e. the
2083
+ # front-door service type whose resources discovery crawls to find
2084
+ # APIs. New source services may be added over time, so clients MUST
2085
+ # treat any unrecognized value gracefully.
2086
+ # @return [String]
2087
+ #
2088
+ # @!attribute [rw] max_results
2089
+ # The maximum number of results to return in one page, from 1 to 100.
2090
+ # @return [Integer]
2091
+ #
2092
+ # @!attribute [rw] next_token
2093
+ # The pagination token returned by a previous call. Omit it to get the
2094
+ # first page.
2095
+ # @return [String]
2096
+ #
2097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListDiscoveryStatusesRequest AWS API Documentation
2098
+ #
2099
+ class ListDiscoveryStatusesRequest < Struct.new(
2100
+ :discovery_source,
2101
+ :max_results,
2102
+ :next_token)
2103
+ SENSITIVE = []
2104
+ include Aws::Structure
2105
+ end
2106
+
2107
+ # @!attribute [rw] items
2108
+ # The discovery status for each account and discovery source.
2109
+ # @return [Array<Types::DiscoveryStatus>]
2110
+ #
2111
+ # @!attribute [rw] next_token
2112
+ # The token to pass in the next request to get the next page. Absent
2113
+ # when there are no more results.
2114
+ # @return [String]
2115
+ #
2116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListDiscoveryStatusesResponse AWS API Documentation
2117
+ #
2118
+ class ListDiscoveryStatusesResponse < Struct.new(
2119
+ :items,
2120
+ :next_token)
2121
+ SENSITIVE = []
2122
+ include Aws::Structure
2123
+ end
2124
+
2125
+ # @!attribute [rw] managed_api_id
2126
+ # The identifier of the Managed API.
2127
+ # @return [String]
2128
+ #
2129
+ # @!attribute [rw] started_after
2130
+ # Inclusive lower bound on each event's start time; only events that
2131
+ # started at or after this time are returned. Optional; defaults to 30
2132
+ # days before the current time.
2133
+ # @return [Time]
2134
+ #
2135
+ # @!attribute [rw] started_before
2136
+ # Exclusive upper bound on each event's start time; only events that
2137
+ # started before this time are returned. Optional; defaults to the
2138
+ # current time.
2139
+ # @return [Time]
2140
+ #
2141
+ # @!attribute [rw] max_results
2142
+ # The maximum number of results to return in one page, from 1 to 20.
2143
+ # @return [Integer]
2144
+ #
2145
+ # @!attribute [rw] next_token
2146
+ # The pagination token returned by a previous call. Omit it to get the
2147
+ # first page.
2148
+ # @return [String]
2149
+ #
2150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApiEventsRequest AWS API Documentation
2151
+ #
2152
+ class ListManagedApiEventsRequest < Struct.new(
2153
+ :managed_api_id,
2154
+ :started_after,
2155
+ :started_before,
2156
+ :max_results,
2157
+ :next_token)
2158
+ SENSITIVE = []
2159
+ include Aws::Structure
2160
+ end
2161
+
2162
+ # @!attribute [rw] items
2163
+ # A page of security events for a managed API. Page size is bounded by
2164
+ # the operation's maxResults; callers retrieve all events by
2165
+ # following nextToken.
2166
+ # @return [Array<Types::ManagedApiEventSummary>]
2167
+ #
2168
+ # @!attribute [rw] next_token
2169
+ # The token to pass in the next request to get the next page. Absent
2170
+ # when there are no more results.
2171
+ # @return [String]
2172
+ #
2173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApiEventsResponse AWS API Documentation
2174
+ #
2175
+ class ListManagedApiEventsResponse < Struct.new(
2176
+ :items,
2177
+ :next_token)
2178
+ SENSITIVE = []
2179
+ include Aws::Structure
2180
+ end
2181
+
2182
+ # @!attribute [rw] max_results
2183
+ # The maximum number of results to return in one page, from 1 to 100.
2184
+ # @return [Integer]
2185
+ #
2186
+ # @!attribute [rw] next_token
2187
+ # The pagination token returned by a previous call. Omit it to get the
2188
+ # first page.
2189
+ # @return [String]
2190
+ #
2191
+ # @!attribute [rw] product_id
2192
+ # Optional filter: when supplied, only Managed APIs associated with
2193
+ # this product are returned.
2194
+ # @return [String]
2195
+ #
2196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApisRequest AWS API Documentation
2197
+ #
2198
+ class ListManagedApisRequest < Struct.new(
2199
+ :max_results,
2200
+ :next_token,
2201
+ :product_id)
2202
+ SENSITIVE = []
2203
+ include Aws::Structure
2204
+ end
2205
+
2206
+ # @!attribute [rw] next_token
2207
+ # The token to pass in the next request to get the next page. Absent
2208
+ # when there are no more results.
2209
+ # @return [String]
2210
+ #
2211
+ # @!attribute [rw] items
2212
+ # The Managed APIs in this page of results.
2213
+ # @return [Array<Types::ManagedApiSummary>]
2214
+ #
2215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListManagedApisResponse AWS API Documentation
2216
+ #
2217
+ class ListManagedApisResponse < Struct.new(
2218
+ :next_token,
2219
+ :items)
2220
+ SENSITIVE = []
2221
+ include Aws::Structure
2222
+ end
2223
+
2224
+ # @!attribute [rw] max_results
2225
+ # The maximum number of results to return in one page, from 1 to 100.
2226
+ # @return [Integer]
2227
+ #
2228
+ # @!attribute [rw] next_token
2229
+ # The pagination token returned by a previous call. Omit it to get the
2230
+ # first page.
2231
+ # @return [String]
2232
+ #
2233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListPortalsRequest AWS API Documentation
2234
+ #
2235
+ class ListPortalsRequest < Struct.new(
2236
+ :max_results,
2237
+ :next_token)
2238
+ SENSITIVE = []
2239
+ include Aws::Structure
2240
+ end
2241
+
2242
+ # @!attribute [rw] items
2243
+ # The portals in this page of results.
2244
+ # @return [Array<Types::PortalSummary>]
2245
+ #
2246
+ # @!attribute [rw] next_token
2247
+ # The token to pass in the next request to get the next page. Absent
2248
+ # when there are no more results.
2249
+ # @return [String]
2250
+ #
2251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListPortalsResponse AWS API Documentation
2252
+ #
2253
+ class ListPortalsResponse < Struct.new(
2254
+ :items,
2255
+ :next_token)
2256
+ SENSITIVE = []
2257
+ include Aws::Structure
2258
+ end
2259
+
2260
+ # @!attribute [rw] product_id
2261
+ # The identifier of the product.
2262
+ # @return [String]
2263
+ #
2264
+ # @!attribute [rw] next_token
2265
+ # The pagination token returned by a previous call. Omit it to get the
2266
+ # first page.
2267
+ # @return [String]
2268
+ #
2269
+ # @!attribute [rw] max_results
2270
+ # The maximum number of results to return in one page, from 1 to 100.
2271
+ # @return [Integer]
2272
+ #
2273
+ # @!attribute [rw] resource_owner_account_id
2274
+ # The AWS account ID that owns the product. Supply it to read a
2275
+ # product shared with you by another account. Omit it for products in
2276
+ # your own account.
2277
+ # @return [String]
2278
+ #
2279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductApiPagesRequest AWS API Documentation
2280
+ #
2281
+ class ListProductApiPagesRequest < Struct.new(
2282
+ :product_id,
2283
+ :next_token,
2284
+ :max_results,
2285
+ :resource_owner_account_id)
2286
+ SENSITIVE = []
2287
+ include Aws::Structure
2288
+ end
2289
+
2290
+ # @!attribute [rw] next_token
2291
+ # The token to pass in the next request to get the next page. Absent
2292
+ # when there are no more results.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] items
2296
+ # The API pages in this page of results.
2297
+ # @return [Array<Types::ProductApiPageSummaryNoBody>]
2298
+ #
2299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductApiPagesResponse AWS API Documentation
2300
+ #
2301
+ class ListProductApiPagesResponse < Struct.new(
2302
+ :next_token,
2303
+ :items)
2304
+ SENSITIVE = []
2305
+ include Aws::Structure
2306
+ end
2307
+
2308
+ # @!attribute [rw] product_id
2309
+ # The identifier of the product.
2310
+ # @return [String]
2311
+ #
2312
+ # @!attribute [rw] next_token
2313
+ # The pagination token returned by a previous call. Omit it to get the
2314
+ # first page.
2315
+ # @return [String]
2316
+ #
2317
+ # @!attribute [rw] max_results
2318
+ # The maximum number of results to return in one page, from 1 to 100.
2319
+ # @return [Integer]
2320
+ #
2321
+ # @!attribute [rw] resource_owner_account_id
2322
+ # The AWS account ID that owns the product. Supply it to read a
2323
+ # product shared with you by another account. Omit it for products in
2324
+ # your own account.
2325
+ # @return [String]
2326
+ #
2327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductPagesRequest AWS API Documentation
2328
+ #
2329
+ class ListProductPagesRequest < Struct.new(
2330
+ :product_id,
2331
+ :next_token,
2332
+ :max_results,
2333
+ :resource_owner_account_id)
2334
+ SENSITIVE = []
2335
+ include Aws::Structure
2336
+ end
2337
+
2338
+ # @!attribute [rw] next_token
2339
+ # The token to pass in the next request to get the next page. Absent
2340
+ # when there are no more results.
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] items
2344
+ # The product pages in this page of results.
2345
+ # @return [Array<Types::ProductPageSummaryNoBody>]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductPagesResponse AWS API Documentation
2348
+ #
2349
+ class ListProductPagesResponse < Struct.new(
2350
+ :next_token,
2351
+ :items)
2352
+ SENSITIVE = []
2353
+ include Aws::Structure
2354
+ end
2355
+
2356
+ # @!attribute [rw] max_results
2357
+ # The maximum number of results to return in one page, from 1 to 100.
2358
+ # @return [Integer]
2359
+ #
2360
+ # @!attribute [rw] next_token
2361
+ # The pagination token returned by a previous call. Omit it to get the
2362
+ # first page.
2363
+ # @return [String]
2364
+ #
2365
+ # @!attribute [rw] resource_owner
2366
+ # Whose products to return: `SELF` for your own, `OTHER_ACCOUNTS` for
2367
+ # products shared with you, or `ALL`. Defaults to `ALL`, or to `SELF`
2368
+ # when `managedApiId` is supplied.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] managed_api_id
2372
+ # Optional filter: when supplied, only Products this Managed API is
2373
+ # associated with are returned.
2374
+ # @return [String]
2375
+ #
2376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductsRequest AWS API Documentation
2377
+ #
2378
+ class ListProductsRequest < Struct.new(
2379
+ :max_results,
2380
+ :next_token,
2381
+ :resource_owner,
2382
+ :managed_api_id)
2383
+ SENSITIVE = []
2384
+ include Aws::Structure
2385
+ end
2386
+
2387
+ # @!attribute [rw] next_token
2388
+ # The token to pass in the next request to get the next page. Absent
2389
+ # when there are no more results.
2390
+ # @return [String]
2391
+ #
2392
+ # @!attribute [rw] items
2393
+ # The products in this page of results.
2394
+ # @return [Array<Types::ProductSummary>]
2395
+ #
2396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListProductsResponse AWS API Documentation
2397
+ #
2398
+ class ListProductsResponse < Struct.new(
2399
+ :next_token,
2400
+ :items)
2401
+ SENSITIVE = []
2402
+ include Aws::Structure
2403
+ end
2404
+
2405
+ # @!attribute [rw] resource_arn
2406
+ # The ARN of the resource.
2407
+ # @return [String]
2408
+ #
2409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListTagsForResourceRequest AWS API Documentation
2410
+ #
2411
+ class ListTagsForResourceRequest < Struct.new(
2412
+ :resource_arn)
2413
+ SENSITIVE = []
2414
+ include Aws::Structure
2415
+ end
2416
+
2417
+ # @!attribute [rw] tags
2418
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2419
+ # per resource.
2420
+ # @return [Hash<String,String>]
2421
+ #
2422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ListTagsForResourceResponse AWS API Documentation
2423
+ #
2424
+ class ListTagsForResourceResponse < Struct.new(
2425
+ :tags)
2426
+ SENSITIVE = []
2427
+ include Aws::Structure
2428
+ end
2429
+
2430
+ # Summary of a single security event attributed to a managed API. This
2431
+ # is the list view; full per-event detail will come from
2432
+ # GetManagedApiEvent in future.
2433
+ #
2434
+ # @!attribute [rw] event_id
2435
+ # Event identifier; row identity and input to GetManagedApiEvent.
2436
+ # @return [String]
2437
+ #
2438
+ # @!attribute [rw] event_type
2439
+ # Always WAF\_API\_SECURITY today.
2440
+ # @return [String]
2441
+ #
2442
+ # @!attribute [rw] status
2443
+ # Lifecycle status of a security event.
2444
+ # @return [String]
2445
+ #
2446
+ # @!attribute [rw] waf_api_security_event_detail
2447
+ # Detail specific to a WAF API-security event; populated when
2448
+ # eventType is WAF\_API\_SECURITY.
2449
+ # @return [Types::WafApiSecurityEventDetail]
2450
+ #
2451
+ # @!attribute [rw] started_at
2452
+ # When the event was first observed.
2453
+ # @return [Time]
2454
+ #
2455
+ # @!attribute [rw] ended_at
2456
+ # When the event completed; absent while it is still in progress.
2457
+ # @return [Time]
2458
+ #
2459
+ # @!attribute [rw] updated_at
2460
+ # When the event was last updated.
2461
+ # @return [Time]
2462
+ #
2463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ManagedApiEventSummary AWS API Documentation
2464
+ #
2465
+ class ManagedApiEventSummary < Struct.new(
2466
+ :event_id,
2467
+ :event_type,
2468
+ :status,
2469
+ :waf_api_security_event_detail,
2470
+ :started_at,
2471
+ :ended_at,
2472
+ :updated_at)
2473
+ SENSITIVE = []
2474
+ include Aws::Structure
2475
+ end
2476
+
2477
+ # Security posture finding attached to this API. Shape mirrors the
2478
+ # inventory's Finding sub-document.
2479
+ #
2480
+ # @!attribute [rw] posture_id
2481
+ # The identifier of the posture check that produced the finding.
2482
+ # @return [String]
2483
+ #
2484
+ # @!attribute [rw] posture_status
2485
+ # Values are spelled exactly as the inventory document stores them, so
2486
+ # the same string means the same thing at both layers and no second
2487
+ # translation sits between the index and the wire.
2488
+ # @return [String]
2489
+ #
2490
+ # @!attribute [rw] reason
2491
+ # Why a posture is not satisfied, or why no verdict was reached.
2492
+ # Present only when `postureStatus` is `FALSE` or `INSUFFICIENT_DATA`.
2493
+ # New reasons may be added over time, so clients MUST treat any
2494
+ # unrecognized value as `UNKNOWN` and fall back to generic handling.
2495
+ # @return [String]
2496
+ #
2497
+ # @!attribute [rw] updated_at
2498
+ # When the finding was last updated.
2499
+ # @return [Time]
2500
+ #
2501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ManagedApiFinding AWS API Documentation
2502
+ #
2503
+ class ManagedApiFinding < Struct.new(
2504
+ :posture_id,
2505
+ :posture_status,
2506
+ :reason,
2507
+ :updated_at)
2508
+ SENSITIVE = []
2509
+ include Aws::Structure
2510
+ end
2511
+
2512
+ # A summary of a Managed API.
2513
+ #
2514
+ # @!attribute [rw] managed_api_id
2515
+ # The identifier of the Managed API.
2516
+ # @return [String]
2517
+ #
2518
+ # @!attribute [rw] managed_api_arn
2519
+ # The ARN of the Managed API.
2520
+ # @return [String]
2521
+ #
2522
+ # @!attribute [rw] api_signature
2523
+ # The attributes that identify the API.
2524
+ # @return [Types::ApiSignature]
2525
+ #
2526
+ # @!attribute [rw] created_at
2527
+ # When the resource was created.
2528
+ # @return [Time]
2529
+ #
2530
+ # @!attribute [rw] updated_at
2531
+ # When the resource was last updated.
2532
+ # @return [Time]
2533
+ #
2534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ManagedApiSummary AWS API Documentation
2535
+ #
2536
+ class ManagedApiSummary < Struct.new(
2537
+ :managed_api_id,
2538
+ :managed_api_arn,
2539
+ :api_signature,
2540
+ :created_at,
2541
+ :updated_at)
2542
+ SENSITIVE = []
2543
+ include Aws::Structure
2544
+ end
2545
+
2546
+ # An empty value, used in a union to choose the option that has no
2547
+ # settings.
2548
+ #
2549
+ # @api private
2550
+ #
2551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/None AWS API Documentation
2552
+ #
2553
+ class None < Aws::EmptyStructure; end
2554
+
2555
+ # An organization-level discovery configuration.
2556
+ #
2557
+ # @!attribute [rw] arn
2558
+ # The ARN of the organization discovery configuration.
2559
+ # @return [String]
2560
+ #
2561
+ # @!attribute [rw] status
2562
+ # The current status of the discovery configuration.
2563
+ # @return [String]
2564
+ #
2565
+ # @!attribute [rw] discovery_sources
2566
+ # The sources APIs are discovered from.
2567
+ # @return [Array<String>]
2568
+ #
2569
+ # @!attribute [rw] exclusion_filters
2570
+ # Exclusion filters for organization-scoped discovery. @deprecated.
2571
+ # Remove this once client (Console) moves to discoveryFilters
2572
+ # @return [Types::DiscoveryExclusionFilters]
2573
+ #
2574
+ # @!attribute [rw] discovery_filters
2575
+ # The accounts or organizational units included in or excluded from
2576
+ # discovery.
2577
+ # @return [Types::OrganizationDiscoveryFilters]
2578
+ #
2579
+ # @!attribute [rw] features
2580
+ # Optional capabilities enabled for this configuration. Absent when
2581
+ # none are.
2582
+ # @return [Array<String>]
2583
+ #
2584
+ # @!attribute [rw] created_at
2585
+ # When the resource was created.
2586
+ # @return [Time]
2587
+ #
2588
+ # @!attribute [rw] updated_at
2589
+ # When the resource was last updated.
2590
+ # @return [Time]
2591
+ #
2592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/OrganizationDiscoveryConfigurationData AWS API Documentation
2593
+ #
2594
+ class OrganizationDiscoveryConfigurationData < Struct.new(
2595
+ :arn,
2596
+ :status,
2597
+ :discovery_sources,
2598
+ :exclusion_filters,
2599
+ :discovery_filters,
2600
+ :features,
2601
+ :created_at,
2602
+ :updated_at)
2603
+ SENSITIVE = []
2604
+ include Aws::Structure
2605
+ end
2606
+
2607
+ # Limits organization-scoped discovery. Set exactly one member:
2608
+ # `inclusionFilters` to discover only the matching targets, or
2609
+ # `exclusionFilters` to discover everything except them.
2610
+ #
2611
+ # @note OrganizationDiscoveryFilters is a union - when making an API calls you must set exactly one of the members.
2612
+ #
2613
+ # @note OrganizationDiscoveryFilters is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OrganizationDiscoveryFilters corresponding to the set member.
2614
+ #
2615
+ # @!attribute [rw] exclusion_filters
2616
+ # Exclusion filters for organization-scoped discovery. Resources
2617
+ # matching any of these filters are excluded from discovery.
2618
+ # @return [Types::DiscoveryExclusionFilters]
2619
+ #
2620
+ # @!attribute [rw] inclusion_filters
2621
+ # Inclusion filters for organization-scoped discovery. Only Resources
2622
+ # matching any of these filters are included in discovery.
2623
+ # @return [Types::DiscoveryInclusionFilters]
2624
+ #
2625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/OrganizationDiscoveryFilters AWS API Documentation
2626
+ #
2627
+ class OrganizationDiscoveryFilters < Struct.new(
2628
+ :exclusion_filters,
2629
+ :inclusion_filters,
2630
+ :unknown)
2631
+ SENSITIVE = []
2632
+ include Aws::Structure
2633
+ include Aws::Structure::Union
2634
+
2635
+ class ExclusionFilters < OrganizationDiscoveryFilters; end
2636
+ class InclusionFilters < OrganizationDiscoveryFilters; end
2637
+ class Unknown < OrganizationDiscoveryFilters; end
2638
+ end
2639
+
2640
+ # The display settings of a portal.
2641
+ #
2642
+ # @!attribute [rw] display_name
2643
+ # The name shown in the portal, from 3 to 255 characters.
2644
+ # @return [String]
2645
+ #
2646
+ # @!attribute [rw] description
2647
+ # A description of the portal, up to 1024 characters.
2648
+ # @return [String]
2649
+ #
2650
+ # @!attribute [rw] theme
2651
+ # The colors and logo of the portal.
2652
+ # @return [Types::PortalTheme]
2653
+ #
2654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PortalContent AWS API Documentation
2655
+ #
2656
+ class PortalContent < Struct.new(
2657
+ :display_name,
2658
+ :description,
2659
+ :theme)
2660
+ SENSITIVE = []
2661
+ include Aws::Structure
2662
+ end
2663
+
2664
+ # Failure detail attached to a Portal's publish/preview status: a typed
2665
+ # reason plus an optional human-readable message.
2666
+ #
2667
+ # @!attribute [rw] exception
2668
+ # Treat any unrecognized value as INTERNAL\_FAILURE.
2669
+ # @return [String]
2670
+ #
2671
+ # @!attribute [rw] message
2672
+ # A description of the failure.
2673
+ # @return [String]
2674
+ #
2675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PortalStatusException AWS API Documentation
2676
+ #
2677
+ class PortalStatusException < Struct.new(
2678
+ :exception,
2679
+ :message)
2680
+ SENSITIVE = []
2681
+ include Aws::Structure
2682
+ end
2683
+
2684
+ # A summary of a portal.
2685
+ #
2686
+ # @!attribute [rw] portal_id
2687
+ # The identifier of the portal.
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] portal_arn
2691
+ # The ARN of the portal.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] endpoint_configuration
2695
+ # The domain configuration of the portal.
2696
+ # @return [Types::EndpointConfigurationResponse]
2697
+ #
2698
+ # @!attribute [rw] authorization
2699
+ # How readers sign in to the portal, and whether fine-grained access
2700
+ # control is on.
2701
+ # @return [Types::Authorization]
2702
+ #
2703
+ # @!attribute [rw] portal_content
2704
+ # The portal's display name, description, and theme.
2705
+ # @return [Types::PortalContent]
2706
+ #
2707
+ # @!attribute [rw] included_product_arns
2708
+ # The ARNs of the products the portal includes.
2709
+ # @return [Array<String>]
2710
+ #
2711
+ # @!attribute [rw] publish_status
2712
+ # The publish status of the portal. Absent if the portal has never
2713
+ # been published.
2714
+ # @return [String]
2715
+ #
2716
+ # @!attribute [rw] status_exception
2717
+ # Failure detail attached to a Portal's publish/preview status: a
2718
+ # typed reason plus an optional human-readable message.
2719
+ # @return [Types::PortalStatusException]
2720
+ #
2721
+ # @!attribute [rw] updated_at
2722
+ # When the resource was last updated.
2723
+ # @return [Time]
2724
+ #
2725
+ # @!attribute [rw] published_at
2726
+ # When the portal was last published.
2727
+ # @return [Time]
2728
+ #
2729
+ # @!attribute [rw] publish_description
2730
+ # The description supplied with the most recent publish request.
2731
+ # @return [String]
2732
+ #
2733
+ # @!attribute [rw] rum_app_monitor_name
2734
+ # The name of the CloudWatch RUM app monitor that collects reader
2735
+ # telemetry for the portal.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] preview
2739
+ # The most recent preview of the portal. Absent if no preview has been
2740
+ # created.
2741
+ # @return [Types::Preview]
2742
+ #
2743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PortalSummary AWS API Documentation
2744
+ #
2745
+ class PortalSummary < Struct.new(
2746
+ :portal_id,
2747
+ :portal_arn,
2748
+ :endpoint_configuration,
2749
+ :authorization,
2750
+ :portal_content,
2751
+ :included_product_arns,
2752
+ :publish_status,
2753
+ :status_exception,
2754
+ :updated_at,
2755
+ :published_at,
2756
+ :publish_description,
2757
+ :rum_app_monitor_name,
2758
+ :preview)
2759
+ SENSITIVE = []
2760
+ include Aws::Structure
2761
+ end
2762
+
2763
+ # The visual theme of a portal.
2764
+ #
2765
+ # @!attribute [rw] custom_colors
2766
+ # The colors used in the portal.
2767
+ # @return [Types::CustomColors]
2768
+ #
2769
+ # @!attribute [rw] logo_uploaded_at
2770
+ # When the portal logo was last uploaded. Absent if the portal has no
2771
+ # logo.
2772
+ # @return [Time]
2773
+ #
2774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PortalTheme AWS API Documentation
2775
+ #
2776
+ class PortalTheme < Struct.new(
2777
+ :custom_colors,
2778
+ :logo_uploaded_at)
2779
+ SENSITIVE = []
2780
+ include Aws::Structure
2781
+ end
2782
+
2783
+ # A preview of a portal.
2784
+ #
2785
+ # @!attribute [rw] preview_status
2786
+ # The status of the preview.
2787
+ # @return [String]
2788
+ #
2789
+ # @!attribute [rw] status_exception
2790
+ # Failure detail attached to a Portal's publish/preview status: a
2791
+ # typed reason plus an optional human-readable message.
2792
+ # @return [Types::PortalStatusException]
2793
+ #
2794
+ # @!attribute [rw] preview_url
2795
+ # The URL to view the preview. Present when `previewStatus` is
2796
+ # `PREVIEW_READY`.
2797
+ # @return [String]
2798
+ #
2799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/Preview AWS API Documentation
2800
+ #
2801
+ class Preview < Struct.new(
2802
+ :preview_status,
2803
+ :status_exception,
2804
+ :preview_url)
2805
+ SENSITIVE = []
2806
+ include Aws::Structure
2807
+ end
2808
+
2809
+ # Failure detail attached to a ProductApiPage's status: a typed reason
2810
+ # plus an optional human-readable message.
2811
+ #
2812
+ # @!attribute [rw] exception
2813
+ # treat any unrecognized value as INTERNAL\_FAILURE.
2814
+ # @return [String]
2815
+ #
2816
+ # @!attribute [rw] message
2817
+ # A description of the failure.
2818
+ # @return [String]
2819
+ #
2820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ProductApiPageStatusException AWS API Documentation
2821
+ #
2822
+ class ProductApiPageStatusException < Struct.new(
2823
+ :exception,
2824
+ :message)
2825
+ SENSITIVE = []
2826
+ include Aws::Structure
2827
+ end
2828
+
2829
+ # A summary of an API page, without its body.
2830
+ #
2831
+ # @!attribute [rw] product_api_page_id
2832
+ # The identifier of the API page.
2833
+ # @return [String]
2834
+ #
2835
+ # @!attribute [rw] product_api_page_arn
2836
+ # The ARN of the API page.
2837
+ # @return [String]
2838
+ #
2839
+ # @!attribute [rw] api_id
2840
+ # The API the page documents.
2841
+ # @return [Types::ApiId]
2842
+ #
2843
+ # @!attribute [rw] operation_name
2844
+ # The operation name shown as the page title.
2845
+ # @return [String]
2846
+ #
2847
+ # @!attribute [rw] api_url
2848
+ # The invoke URL shown on the page and used by Try-It.
2849
+ # @return [String]
2850
+ #
2851
+ # @!attribute [rw] try_it_state
2852
+ # Whether Try-It is enabled on the page.
2853
+ # @return [String]
2854
+ #
2855
+ # @!attribute [rw] updated_at
2856
+ # When the resource was last updated.
2857
+ # @return [Time]
2858
+ #
2859
+ # @!attribute [rw] status
2860
+ # The status of the page content: `IN_PROGRESS` while it is generated,
2861
+ # then `AVAILABLE` or `FAILED`.
2862
+ # @return [String]
2863
+ #
2864
+ # @!attribute [rw] status_exception
2865
+ # Failure detail attached to a ProductApiPage's status: a typed
2866
+ # reason plus an optional human-readable message.
2867
+ # @return [Types::ProductApiPageStatusException]
2868
+ #
2869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ProductApiPageSummaryNoBody AWS API Documentation
2870
+ #
2871
+ class ProductApiPageSummaryNoBody < Struct.new(
2872
+ :product_api_page_id,
2873
+ :product_api_page_arn,
2874
+ :api_id,
2875
+ :operation_name,
2876
+ :api_url,
2877
+ :try_it_state,
2878
+ :updated_at,
2879
+ :status,
2880
+ :status_exception)
2881
+ SENSITIVE = []
2882
+ include Aws::Structure
2883
+ end
2884
+
2885
+ # A summary of a product page, without its body.
2886
+ #
2887
+ # @!attribute [rw] product_page_id
2888
+ # The identifier of the product page.
2889
+ # @return [String]
2890
+ #
2891
+ # @!attribute [rw] product_page_arn
2892
+ # The ARN of the product page.
2893
+ # @return [String]
2894
+ #
2895
+ # @!attribute [rw] page_title
2896
+ # The page title.
2897
+ # @return [String]
2898
+ #
2899
+ # @!attribute [rw] updated_at
2900
+ # When the resource was last updated.
2901
+ # @return [Time]
2902
+ #
2903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ProductPageSummaryNoBody AWS API Documentation
2904
+ #
2905
+ class ProductPageSummaryNoBody < Struct.new(
2906
+ :product_page_id,
2907
+ :product_page_arn,
2908
+ :page_title,
2909
+ :updated_at)
2910
+ SENSITIVE = []
2911
+ include Aws::Structure
2912
+ end
2913
+
2914
+ # A summary of a product.
2915
+ #
2916
+ # @!attribute [rw] product_id
2917
+ # The identifier of the product.
2918
+ # @return [String]
2919
+ #
2920
+ # @!attribute [rw] product_arn
2921
+ # The ARN of the product.
2922
+ # @return [String]
2923
+ #
2924
+ # @!attribute [rw] display_name
2925
+ # The name of the product, from 1 to 255 characters.
2926
+ # @return [String]
2927
+ #
2928
+ # @!attribute [rw] description
2929
+ # A description of the product, up to 1024 characters.
2930
+ # @return [String]
2931
+ #
2932
+ # @!attribute [rw] updated_at
2933
+ # When the resource was last updated.
2934
+ # @return [Time]
2935
+ #
2936
+ # @!attribute [rw] api_selection_configuration
2937
+ # How Managed APIs are selected for the product.
2938
+ # @return [Types::ApiSelectionConfiguration]
2939
+ #
2940
+ # @!attribute [rw] status
2941
+ # Whether the product's member APIs match its
2942
+ # apiSelectionConfiguration. ACTIVE - membership matches. The only
2943
+ # status a CUSTOM product reports. IN\_PROGRESS - ruleFilters changed
2944
+ # and membership is still being evaluated. FAILED - evaluation could
2945
+ # not finish and membership is incomplete; failureReason says why.
2946
+ # @return [String]
2947
+ #
2948
+ # @!attribute [rw] failure_reason
2949
+ # Reason a product's rules could not be fully applied, present only
2950
+ # when `status` is `FAILED`. New reasons may be added over time, so
2951
+ # clients MUST treat any unrecognized value as `UNKNOWN` and fall back
2952
+ # to generic handling.
2953
+ # @return [String]
2954
+ #
2955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ProductSummary AWS API Documentation
2956
+ #
2957
+ class ProductSummary < Struct.new(
2958
+ :product_id,
2959
+ :product_arn,
2960
+ :display_name,
2961
+ :description,
2962
+ :updated_at,
2963
+ :api_selection_configuration,
2964
+ :status,
2965
+ :failure_reason)
2966
+ SENSITIVE = []
2967
+ include Aws::Structure
2968
+ end
2969
+
2970
+ # @!attribute [rw] discovery_sources
2971
+ # The sources to discover APIs from. Omitting it removes all sources,
2972
+ # which stops discovery for this configuration.
2973
+ # @return [Array<String>]
2974
+ #
2975
+ # @!attribute [rw] excluded_resources
2976
+ # The ARNs of resources to leave out of discovery, up to 50.
2977
+ # @return [Array<String>]
2978
+ #
2979
+ # @!attribute [rw] features
2980
+ # Optional capabilities to enable. Omitting it disables all of them,
2981
+ # as with the other fields.
2982
+ # @return [Array<String>]
2983
+ #
2984
+ # @!attribute [rw] tags
2985
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
2986
+ # per resource.
2987
+ # @return [Hash<String,String>]
2988
+ #
2989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutDiscoveryConfigurationRequest AWS API Documentation
2990
+ #
2991
+ class PutDiscoveryConfigurationRequest < Struct.new(
2992
+ :discovery_sources,
2993
+ :excluded_resources,
2994
+ :features,
2995
+ :tags)
2996
+ SENSITIVE = []
2997
+ include Aws::Structure
2998
+ end
2999
+
3000
+ # @!attribute [rw] discovery_configuration
3001
+ # The discovery configuration for the account.
3002
+ # @return [Types::DiscoveryConfigurationData]
3003
+ #
3004
+ # @!attribute [rw] tags
3005
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
3006
+ # per resource.
3007
+ # @return [Hash<String,String>]
3008
+ #
3009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutDiscoveryConfigurationResponse AWS API Documentation
3010
+ #
3011
+ class PutDiscoveryConfigurationResponse < Struct.new(
3012
+ :discovery_configuration,
3013
+ :tags)
3014
+ SENSITIVE = []
3015
+ include Aws::Structure
3016
+ end
3017
+
3018
+ # @!attribute [rw] discovery_sources
3019
+ # The sources to discover APIs from. Omitting it removes all sources,
3020
+ # which stops discovery for this configuration.
3021
+ # @return [Array<String>]
3022
+ #
3023
+ # @!attribute [rw] exclusion_filters
3024
+ # Exclusion filters for organization-scoped discovery. @deprecated.
3025
+ # Remove this once client (Console) moves to discoveryFilters
3026
+ # @return [Types::DiscoveryExclusionFilters]
3027
+ #
3028
+ # @!attribute [rw] discovery_filters
3029
+ # The accounts or organizational units to include in or exclude from
3030
+ # discovery.
3031
+ # @return [Types::OrganizationDiscoveryFilters]
3032
+ #
3033
+ # @!attribute [rw] features
3034
+ # Optional capabilities to enable. Omitting it disables all of them,
3035
+ # as with the other fields.
3036
+ # @return [Array<String>]
3037
+ #
3038
+ # @!attribute [rw] tags
3039
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
3040
+ # per resource.
3041
+ # @return [Hash<String,String>]
3042
+ #
3043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutOrganizationDiscoveryConfigurationRequest AWS API Documentation
3044
+ #
3045
+ class PutOrganizationDiscoveryConfigurationRequest < Struct.new(
3046
+ :discovery_sources,
3047
+ :exclusion_filters,
3048
+ :discovery_filters,
3049
+ :features,
3050
+ :tags)
3051
+ SENSITIVE = []
3052
+ include Aws::Structure
3053
+ end
3054
+
3055
+ # @!attribute [rw] discovery_configuration
3056
+ # The discovery configuration for the organization.
3057
+ # @return [Types::OrganizationDiscoveryConfigurationData]
3058
+ #
3059
+ # @!attribute [rw] tags
3060
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
3061
+ # per resource.
3062
+ # @return [Hash<String,String>]
3063
+ #
3064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutOrganizationDiscoveryConfigurationResponse AWS API Documentation
3065
+ #
3066
+ class PutOrganizationDiscoveryConfigurationResponse < Struct.new(
3067
+ :discovery_configuration,
3068
+ :tags)
3069
+ SENSITIVE = []
3070
+ include Aws::Structure
3071
+ end
3072
+
3073
+ # @!attribute [rw] product_id
3074
+ # The identifier of the product.
3075
+ # @return [String]
3076
+ #
3077
+ # @!attribute [rw] policy_document
3078
+ # The sharing policy as a JSON resource policy document.
3079
+ # @return [String]
3080
+ #
3081
+ # @!attribute [rw] tags
3082
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
3083
+ # per resource.
3084
+ # @return [Hash<String,String>]
3085
+ #
3086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/PutProductSharingPolicyRequest AWS API Documentation
3087
+ #
3088
+ class PutProductSharingPolicyRequest < Struct.new(
3089
+ :product_id,
3090
+ :policy_document,
3091
+ :tags)
3092
+ SENSITIVE = []
3093
+ include Aws::Structure
3094
+ end
3095
+
3096
+ # The requested resource does not exist, or you do not have access to
3097
+ # it.
3098
+ #
3099
+ # @!attribute [rw] message
3100
+ # @return [String]
3101
+ #
3102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/ResourceNotFoundException AWS API Documentation
3103
+ #
3104
+ class ResourceNotFoundException < Struct.new(
3105
+ :message)
3106
+ SENSITIVE = []
3107
+ include Aws::Structure
3108
+ end
3109
+
3110
+ # Values are compared to the attribute as literals: exact and
3111
+ # case-sensitive, no wildcards.
3112
+ #
3113
+ # @!attribute [rw] key
3114
+ # The Managed API attribute a RuleFilter compares against.
3115
+ # RESOURCE\_ARN - apiSignature.resourceArn HOST -
3116
+ # apiSignature.hostname METHOD - apiSignature.method, so values must
3117
+ # be HttpMethod names PATH - apiSignature.path PORT -
3118
+ # apiSignature.port, compared as its decimal string, so values must be
3119
+ # 0-65535 with no leading zeros ACCOUNT - the account hosting the API,
3120
+ # which for an ORGANIZATION-scoped Managed API is the member account
3121
+ # rather than the account that created it
3122
+ # @return [String]
3123
+ #
3124
+ # @!attribute [rw] values
3125
+ # The values to match. The filter matches when the attribute equals
3126
+ # any of them.
3127
+ # @return [Array<String>]
3128
+ #
3129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/RuleFilter AWS API Documentation
3130
+ #
3131
+ class RuleFilter < Struct.new(
3132
+ :key,
3133
+ :values)
3134
+ SENSITIVE = []
3135
+ include Aws::Structure
3136
+ end
3137
+
3138
+ # A named group of API pages in the portal navigation.
3139
+ #
3140
+ # @!attribute [rw] section_name
3141
+ # Shown in the portal navigation. Same bound as page titles and
3142
+ # operation names, and no control characters (the service rejects a
3143
+ # blank name).
3144
+ # @return [String]
3145
+ #
3146
+ # @!attribute [rw] product_api_page_arns
3147
+ # API pages in one section. No service-side limit exists today; this
3148
+ # bound caps request size.
3149
+ # @return [Array<String>]
3150
+ #
3151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/Section AWS API Documentation
3152
+ #
3153
+ class Section < Struct.new(
3154
+ :section_name,
3155
+ :product_api_page_arns)
3156
+ SENSITIVE = []
3157
+ include Aws::Structure
3158
+ end
3159
+
3160
+ # @!attribute [rw] id
3161
+ # Identifier of the discovery configuration to start. Required. Today
3162
+ # this is the configuration ARN, which carries the owner account id so
3163
+ # a delegated admin or org admin can start an org-scoped configuration
3164
+ # that lives in a different account.
3165
+ # @return [String]
3166
+ #
3167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/StartDiscoveryRequest AWS API Documentation
3168
+ #
3169
+ class StartDiscoveryRequest < Struct.new(
3170
+ :id)
3171
+ SENSITIVE = []
3172
+ include Aws::Structure
3173
+ end
3174
+
3175
+ # @!attribute [rw] id
3176
+ # Identifier of the discovery configuration to stop. Required. Today
3177
+ # this is the configuration ARN, which carries the owner account id so
3178
+ # a delegated admin or org admin can stop an org-scoped configuration
3179
+ # that lives in a different account.
3180
+ # @return [String]
3181
+ #
3182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/StopDiscoveryRequest AWS API Documentation
3183
+ #
3184
+ class StopDiscoveryRequest < Struct.new(
3185
+ :id)
3186
+ SENSITIVE = []
3187
+ include Aws::Structure
3188
+ end
3189
+
3190
+ # @!attribute [rw] resource_arn
3191
+ # The ARN of the resource.
3192
+ # @return [String]
3193
+ #
3194
+ # @!attribute [rw] tags
3195
+ # Up to 50 tags per request, matching API Gateway's limit of 50 tags
3196
+ # per resource.
3197
+ # @return [Hash<String,String>]
3198
+ #
3199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/TagResourceRequest AWS API Documentation
3200
+ #
3201
+ class TagResourceRequest < Struct.new(
3202
+ :resource_arn,
3203
+ :tags)
3204
+ SENSITIVE = []
3205
+ include Aws::Structure
3206
+ end
3207
+
3208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/TagResourceResponse AWS API Documentation
3209
+ #
3210
+ class TagResourceResponse < Aws::EmptyStructure; end
3211
+
3212
+ # @!attribute [rw] resource_arn
3213
+ # The ARN of the resource.
3214
+ # @return [String]
3215
+ #
3216
+ # @!attribute [rw] tag_keys
3217
+ # The keys of the tags to remove, up to 50.
3218
+ # @return [Array<String>]
3219
+ #
3220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UntagResourceRequest AWS API Documentation
3221
+ #
3222
+ class UntagResourceRequest < Struct.new(
3223
+ :resource_arn,
3224
+ :tag_keys)
3225
+ SENSITIVE = []
3226
+ include Aws::Structure
3227
+ end
3228
+
3229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UntagResourceResponse AWS API Documentation
3230
+ #
3231
+ class UntagResourceResponse < Aws::EmptyStructure; end
3232
+
3233
+ # @!attribute [rw] portal_id
3234
+ # The identifier of the portal.
3235
+ # @return [String]
3236
+ #
3237
+ # @!attribute [rw] status
3238
+ # The terminal publish state a caller can request for a portal via
3239
+ # UpdatePortalPublishStatus. Only the two client-requestable targets
3240
+ # are modeled here; the transient and failed states in PublishStatus
3241
+ # are set by the service and are not valid caller input.
3242
+ # @return [String]
3243
+ #
3244
+ # @!attribute [rw] description
3245
+ # A description of this publish request, up to 1024 characters.
3246
+ # @return [String]
3247
+ #
3248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdatePortalPublishStatusRequest AWS API Documentation
3249
+ #
3250
+ class UpdatePortalPublishStatusRequest < Struct.new(
3251
+ :portal_id,
3252
+ :status,
3253
+ :description)
3254
+ SENSITIVE = []
3255
+ include Aws::Structure
3256
+ end
3257
+
3258
+ # @!attribute [rw] portal_id
3259
+ # The identifier of the portal.
3260
+ # @return [String]
3261
+ #
3262
+ # @!attribute [rw] portal_content
3263
+ # The new display name, description, and theme. Omit it to keep the
3264
+ # current values.
3265
+ # @return [Types::PortalContent]
3266
+ #
3267
+ # @!attribute [rw] endpoint_configuration
3268
+ # Exactly one of the members is set: `none` for no custom domain, or
3269
+ # `acmManaged` to bring a domain + ACM certificate. Modeled as a union
3270
+ # so the "exactly one" choice is enforced by type.
3271
+ # @return [Types::EndpointConfigurationRequest]
3272
+ #
3273
+ # @!attribute [rw] authorization
3274
+ # The new authorization settings. Omit it to keep the current
3275
+ # settings.
3276
+ # @return [Types::Authorization]
3277
+ #
3278
+ # @!attribute [rw] rum_app_monitor_name
3279
+ # The new CloudWatch RUM app monitor name. Omit it to keep the current
3280
+ # value.
3281
+ # @return [String]
3282
+ #
3283
+ # @!attribute [rw] included_product_arns
3284
+ # The new list of product ARNs, up to 200. It replaces the current
3285
+ # list. Omit it to keep the current list.
3286
+ # @return [Array<String>]
3287
+ #
3288
+ # @!attribute [rw] logo_uri
3289
+ # The new S3 location of the portal logo, in the form
3290
+ # `s3://bucket/key`. An empty string removes the logo. Omit it to keep
3291
+ # the current logo.
3292
+ # @return [String]
3293
+ #
3294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdatePortalRequest AWS API Documentation
3295
+ #
3296
+ class UpdatePortalRequest < Struct.new(
3297
+ :portal_id,
3298
+ :portal_content,
3299
+ :endpoint_configuration,
3300
+ :authorization,
3301
+ :rum_app_monitor_name,
3302
+ :included_product_arns,
3303
+ :logo_uri)
3304
+ SENSITIVE = []
3305
+ include Aws::Structure
3306
+ end
3307
+
3308
+ # @!attribute [rw] portal_id
3309
+ # The identifier of the portal.
3310
+ # @return [String]
3311
+ #
3312
+ # @!attribute [rw] portal_arn
3313
+ # The ARN of the portal.
3314
+ # @return [String]
3315
+ #
3316
+ # @!attribute [rw] endpoint_configuration
3317
+ # The domain configuration of the portal.
3318
+ # @return [Types::EndpointConfigurationResponse]
3319
+ #
3320
+ # @!attribute [rw] authorization
3321
+ # How readers sign in to the portal, and whether fine-grained access
3322
+ # control is on.
3323
+ # @return [Types::Authorization]
3324
+ #
3325
+ # @!attribute [rw] portal_content
3326
+ # The portal's display name, description, and theme.
3327
+ # @return [Types::PortalContent]
3328
+ #
3329
+ # @!attribute [rw] included_product_arns
3330
+ # The ARNs of the products the portal includes.
3331
+ # @return [Array<String>]
3332
+ #
3333
+ # @!attribute [rw] publish_status
3334
+ # The publish status of the portal. Absent if the portal has never
3335
+ # been published.
3336
+ # @return [String]
3337
+ #
3338
+ # @!attribute [rw] status_exception
3339
+ # Failure detail attached to a Portal's publish/preview status: a
3340
+ # typed reason plus an optional human-readable message.
3341
+ # @return [Types::PortalStatusException]
3342
+ #
3343
+ # @!attribute [rw] updated_at
3344
+ # When the resource was last updated.
3345
+ # @return [Time]
3346
+ #
3347
+ # @!attribute [rw] published_at
3348
+ # When the portal was last published.
3349
+ # @return [Time]
3350
+ #
3351
+ # @!attribute [rw] publish_description
3352
+ # The description supplied with the most recent publish request.
3353
+ # @return [String]
3354
+ #
3355
+ # @!attribute [rw] rum_app_monitor_name
3356
+ # The name of the CloudWatch RUM app monitor that collects reader
3357
+ # telemetry for the portal.
3358
+ # @return [String]
3359
+ #
3360
+ # @!attribute [rw] preview
3361
+ # The most recent preview of the portal. Absent if no preview has been
3362
+ # created.
3363
+ # @return [Types::Preview]
3364
+ #
3365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdatePortalResponse AWS API Documentation
3366
+ #
3367
+ class UpdatePortalResponse < Struct.new(
3368
+ :portal_id,
3369
+ :portal_arn,
3370
+ :endpoint_configuration,
3371
+ :authorization,
3372
+ :portal_content,
3373
+ :included_product_arns,
3374
+ :publish_status,
3375
+ :status_exception,
3376
+ :updated_at,
3377
+ :published_at,
3378
+ :publish_description,
3379
+ :rum_app_monitor_name,
3380
+ :preview)
3381
+ SENSITIVE = []
3382
+ include Aws::Structure
3383
+ end
3384
+
3385
+ # @!attribute [rw] product_id
3386
+ # The identifier of the product.
3387
+ # @return [String]
3388
+ #
3389
+ # @!attribute [rw] product_api_page_id
3390
+ # The identifier of the API page.
3391
+ # @return [String]
3392
+ #
3393
+ # @!attribute [rw] display_content
3394
+ # Exactly one of the members is set: `none` to use default display
3395
+ # content, or `overrides` to customize it. Modeled as a union so the
3396
+ # "exactly one" choice is enforced by type.
3397
+ # @return [Types::ApiPageDisplayContent]
3398
+ #
3399
+ # @!attribute [rw] try_it_state
3400
+ # The new Try-It setting. Omit it to keep the current setting. To
3401
+ # enable it, the page's API URL must use HTTPS on a domain that
3402
+ # supports Try-It.
3403
+ # @return [String]
3404
+ #
3405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductApiPageRequest AWS API Documentation
3406
+ #
3407
+ class UpdateProductApiPageRequest < Struct.new(
3408
+ :product_id,
3409
+ :product_api_page_id,
3410
+ :display_content,
3411
+ :try_it_state)
3412
+ SENSITIVE = []
3413
+ include Aws::Structure
3414
+ end
3415
+
3416
+ # @!attribute [rw] product_api_page_id
3417
+ # The identifier of the API page.
3418
+ # @return [String]
3419
+ #
3420
+ # @!attribute [rw] product_api_page_arn
3421
+ # The ARN of the API page.
3422
+ # @return [String]
3423
+ #
3424
+ # @!attribute [rw] api_id
3425
+ # The API the page documents.
3426
+ # @return [Types::ApiId]
3427
+ #
3428
+ # @!attribute [rw] display_content
3429
+ # The content shown on the page.
3430
+ # @return [Types::ApiPageDisplayContentResponse]
3431
+ #
3432
+ # @!attribute [rw] try_it_state
3433
+ # Whether Try-It is enabled on the page.
3434
+ # @return [String]
3435
+ #
3436
+ # @!attribute [rw] updated_at
3437
+ # When the resource was last updated.
3438
+ # @return [Time]
3439
+ #
3440
+ # @!attribute [rw] status
3441
+ # The status of the page content: `IN_PROGRESS` while it is generated,
3442
+ # then `AVAILABLE` or `FAILED`.
3443
+ # @return [String]
3444
+ #
3445
+ # @!attribute [rw] status_exception
3446
+ # Failure detail attached to a ProductApiPage's status: a typed
3447
+ # reason plus an optional human-readable message.
3448
+ # @return [Types::ProductApiPageStatusException]
3449
+ #
3450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductApiPageResponse AWS API Documentation
3451
+ #
3452
+ class UpdateProductApiPageResponse < Struct.new(
3453
+ :product_api_page_id,
3454
+ :product_api_page_arn,
3455
+ :api_id,
3456
+ :display_content,
3457
+ :try_it_state,
3458
+ :updated_at,
3459
+ :status,
3460
+ :status_exception)
3461
+ SENSITIVE = []
3462
+ include Aws::Structure
3463
+ end
3464
+
3465
+ # @!attribute [rw] product_id
3466
+ # The identifier of the product.
3467
+ # @return [String]
3468
+ #
3469
+ # @!attribute [rw] product_page_id
3470
+ # The identifier of the product page.
3471
+ # @return [String]
3472
+ #
3473
+ # @!attribute [rw] display_content
3474
+ # The new title and body of the page. Omit it to keep the current
3475
+ # content.
3476
+ # @return [Types::DisplayContent]
3477
+ #
3478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductPageRequest AWS API Documentation
3479
+ #
3480
+ class UpdateProductPageRequest < Struct.new(
3481
+ :product_id,
3482
+ :product_page_id,
3483
+ :display_content)
3484
+ SENSITIVE = []
3485
+ include Aws::Structure
3486
+ end
3487
+
3488
+ # @!attribute [rw] product_page_id
3489
+ # The identifier of the product page.
3490
+ # @return [String]
3491
+ #
3492
+ # @!attribute [rw] product_page_arn
3493
+ # The ARN of the product page.
3494
+ # @return [String]
3495
+ #
3496
+ # @!attribute [rw] display_content
3497
+ # The title and body of the page.
3498
+ # @return [Types::DisplayContent]
3499
+ #
3500
+ # @!attribute [rw] updated_at
3501
+ # When the resource was last updated.
3502
+ # @return [Time]
3503
+ #
3504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductPageResponse AWS API Documentation
3505
+ #
3506
+ class UpdateProductPageResponse < Struct.new(
3507
+ :product_page_id,
3508
+ :product_page_arn,
3509
+ :display_content,
3510
+ :updated_at)
3511
+ SENSITIVE = []
3512
+ include Aws::Structure
3513
+ end
3514
+
3515
+ # @!attribute [rw] product_id
3516
+ # The identifier of the product.
3517
+ # @return [String]
3518
+ #
3519
+ # @!attribute [rw] display_name
3520
+ # The new name of the product. Omit it to keep the current name.
3521
+ # @return [String]
3522
+ #
3523
+ # @!attribute [rw] description
3524
+ # The new description of the product. Omit it to keep the current
3525
+ # description.
3526
+ # @return [String]
3527
+ #
3528
+ # @!attribute [rw] display_order
3529
+ # The new page order. Omit it to keep the current order.
3530
+ # @return [Types::DisplayOrder]
3531
+ #
3532
+ # @!attribute [rw] api_selection_configuration
3533
+ # The new API selection settings. The selection mode must match the
3534
+ # mode the product was created with. Omit it to keep the current
3535
+ # settings.
3536
+ # @return [Types::ApiSelectionConfiguration]
3537
+ #
3538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductRequest AWS API Documentation
3539
+ #
3540
+ class UpdateProductRequest < Struct.new(
3541
+ :product_id,
3542
+ :display_name,
3543
+ :description,
3544
+ :display_order,
3545
+ :api_selection_configuration)
3546
+ SENSITIVE = []
3547
+ include Aws::Structure
3548
+ end
3549
+
3550
+ # @!attribute [rw] product_id
3551
+ # The identifier of the product.
3552
+ # @return [String]
3553
+ #
3554
+ # @!attribute [rw] product_arn
3555
+ # The ARN of the product.
3556
+ # @return [String]
3557
+ #
3558
+ # @!attribute [rw] display_name
3559
+ # The name of the product, from 1 to 255 characters.
3560
+ # @return [String]
3561
+ #
3562
+ # @!attribute [rw] display_order
3563
+ # The order of the product's pages and API page sections in the
3564
+ # portal navigation.
3565
+ # @return [Types::DisplayOrder]
3566
+ #
3567
+ # @!attribute [rw] description
3568
+ # A description of the product, up to 1024 characters.
3569
+ # @return [String]
3570
+ #
3571
+ # @!attribute [rw] updated_at
3572
+ # When the resource was last updated.
3573
+ # @return [Time]
3574
+ #
3575
+ # @!attribute [rw] api_selection_configuration
3576
+ # How Managed APIs are selected for the product.
3577
+ # @return [Types::ApiSelectionConfiguration]
3578
+ #
3579
+ # @!attribute [rw] status
3580
+ # Whether the product's member APIs match its
3581
+ # apiSelectionConfiguration. ACTIVE - membership matches. The only
3582
+ # status a CUSTOM product reports. IN\_PROGRESS - ruleFilters changed
3583
+ # and membership is still being evaluated. FAILED - evaluation could
3584
+ # not finish and membership is incomplete; failureReason says why.
3585
+ # @return [String]
3586
+ #
3587
+ # @!attribute [rw] failure_reason
3588
+ # Reason a product's rules could not be fully applied, present only
3589
+ # when `status` is `FAILED`. New reasons may be added over time, so
3590
+ # clients MUST treat any unrecognized value as `UNKNOWN` and fall back
3591
+ # to generic handling.
3592
+ # @return [String]
3593
+ #
3594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/UpdateProductResponse AWS API Documentation
3595
+ #
3596
+ class UpdateProductResponse < Struct.new(
3597
+ :product_id,
3598
+ :product_arn,
3599
+ :display_name,
3600
+ :display_order,
3601
+ :description,
3602
+ :updated_at,
3603
+ :api_selection_configuration,
3604
+ :status,
3605
+ :failure_reason)
3606
+ SENSITIVE = []
3607
+ include Aws::Structure
3608
+ end
3609
+
3610
+ # Detail specific to a WAF API-security event.
3611
+ #
3612
+ # @!attribute [rw] label
3613
+ # Detection label (attack type + confidence tier).
3614
+ # @return [String]
3615
+ #
3616
+ # @!attribute [rw] category
3617
+ # OWASP class — the primary display value (e.g. "API2:2023").
3618
+ # @return [String]
3619
+ #
3620
+ # @!attribute [rw] confidence
3621
+ # Confidence tier of the detection.
3622
+ # @return [String]
3623
+ #
3624
+ # @!attribute [rw] web_acl_arn
3625
+ # WebACL that produced the event.
3626
+ # @return [String]
3627
+ #
3628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/apiportal-2026-04-30/WafApiSecurityEventDetail AWS API Documentation
3629
+ #
3630
+ class WafApiSecurityEventDetail < Struct.new(
3631
+ :label,
3632
+ :category,
3633
+ :confidence,
3634
+ :web_acl_arn)
3635
+ SENSITIVE = []
3636
+ include Aws::Structure
3637
+ end
3638
+
3639
+ end
3640
+ end
3641
+