aws-sdk-apigatewayv2 1.85.0 → 1.86.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.
@@ -10,6 +10,23 @@
10
10
  module Aws::ApiGatewayV2
11
11
  module Types
12
12
 
13
+ # Represents a domain name and certificate for a portal.
14
+ #
15
+ # @!attribute [rw] certificate_arn
16
+ # The certificate ARN.
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] domain_name
20
+ # The domain name.
21
+ # @return [String]
22
+ #
23
+ class ACMManaged < Struct.new(
24
+ :certificate_arn,
25
+ :domain_name)
26
+ SENSITIVE = []
27
+ include Aws::Structure
28
+ end
29
+
13
30
  # @!attribute [rw] message
14
31
  # @return [String]
15
32
  #
@@ -19,6 +36,18 @@ module Aws::ApiGatewayV2
19
36
  include Aws::Structure
20
37
  end
21
38
 
39
+ # The error message.
40
+ #
41
+ # @!attribute [rw] message
42
+ # The message.
43
+ # @return [String]
44
+ #
45
+ class AccessDeniedExceptionResponseContent < Struct.new(
46
+ :message)
47
+ SENSITIVE = []
48
+ include Aws::Structure
49
+ end
50
+
22
51
  # Settings for logging access in a stage.
23
52
  #
24
53
  # @!attribute [rw] destination_arn
@@ -214,6 +243,24 @@ module Aws::ApiGatewayV2
214
243
  include Aws::Structure
215
244
  end
216
245
 
246
+ # Represents an authorization configuration for a portal.
247
+ #
248
+ # @!attribute [rw] cognito_config
249
+ # The Amazon Cognito configuration.
250
+ # @return [Types::CognitoConfig]
251
+ #
252
+ # @!attribute [rw] none
253
+ # Provide no authorization for your portal. This makes your portal
254
+ # publicly accesible on the web.
255
+ # @return [Types::None]
256
+ #
257
+ class Authorization < Struct.new(
258
+ :cognito_config,
259
+ :none)
260
+ SENSITIVE = []
261
+ include Aws::Structure
262
+ end
263
+
217
264
  # Represents an authorizer.
218
265
  #
219
266
  # @!attribute [rw] authorizer_credentials_arn
@@ -242,18 +289,16 @@ module Aws::ApiGatewayV2
242
289
  # @return [String]
243
290
  #
244
291
  # @!attribute [rw] authorizer_uri
245
- # The authorizer's Uniform Resource Identifier (URI). For REQUEST
292
+ # The authorizer's Uniform Resource Identifier (URI). ForREQUEST
246
293
  # authorizers, this must be a well-formed Lambda function URI, for
247
294
  # example,
248
295
  # arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:*\{account\_id}*:function:*\{lambda\_function\_name}*/invocations.
249
296
  # In general, the URI has this form:
250
- # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}* , where
251
- # <replaceable />
252
- #
253
- # \{region} is the same as the region hosting the Lambda function,
254
- # path indicates that the remaining substring in the URI should be
255
- # treated as the path to the resource, including the initial /. For
256
- # Lambda functions, this is usually of the form
297
+ # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}*
298
+ # replaceable/>\{region} is the same as the region hosting the Lambda
299
+ # function, path indicates that the remaining substring in the URI
300
+ # should be treated as the path to the resource, including the initial
301
+ # /. For Lambda functions, this is usually of the form
257
302
  # /2015-03-31/functions/\[FunctionARN\]/invocations. Supported only
258
303
  # for REQUEST authorizers.
259
304
  # @return [String]
@@ -277,7 +322,8 @@ module Aws::ApiGatewayV2
277
322
  # Otherwise, it returns a 401 Unauthorized response without calling
278
323
  # the Lambda function. For HTTP APIs, identity sources are also used
279
324
  # as the cache key when caching is enabled. To learn more, see
280
- # [Working with AWS Lambda authorizers for HTTP APIs][1].
325
+ # [Working with Amazon Web Services Lambda authorizers for HTTP
326
+ # APIs][1].
281
327
  #
282
328
  # For JWT, a single entry that specifies where to extract the JSON Web
283
329
  # Token (JWT) from inbound requests. Currently only header-based and
@@ -305,8 +351,8 @@ module Aws::ApiGatewayV2
305
351
  # @!attribute [rw] authorizer_payload_format_version
306
352
  # Specifies the format of the payload sent to an HTTP API Lambda
307
353
  # authorizer. Required for HTTP API Lambda authorizers. Supported
308
- # values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
309
- # authorizers for HTTP APIs][1].
354
+ # values are 1.0 and 2.0. To learn more, see [Working with Amazon Web
355
+ # Services Lambda authorizers for HTTP APIs][1].
310
356
  #
311
357
  #
312
358
  #
@@ -317,7 +363,8 @@ module Aws::ApiGatewayV2
317
363
  # Specifies whether a Lambda authorizer returns a response in a simple
318
364
  # format. If enabled, the Lambda authorizer can return a boolean value
319
365
  # instead of an IAM policy. Supported only for HTTP APIs. To learn
320
- # more, see [Working with AWS Lambda authorizers for HTTP APIs][1]
366
+ # more, see [Working with Amazon Web Services Lambda authorizers for
367
+ # HTTP APIs][1].
321
368
  #
322
369
  #
323
370
  #
@@ -371,6 +418,41 @@ module Aws::ApiGatewayV2
371
418
  include Aws::Structure
372
419
  end
373
420
 
421
+ # The response content for bad request exception.
422
+ #
423
+ # @!attribute [rw] message
424
+ # The message of the bad request exception response content.
425
+ # @return [String]
426
+ #
427
+ class BadRequestExceptionResponseContent < Struct.new(
428
+ :message)
429
+ SENSITIVE = []
430
+ include Aws::Structure
431
+ end
432
+
433
+ # The configuration for using Amazon Cognito user pools to control
434
+ # access to your portal.
435
+ #
436
+ # @!attribute [rw] app_client_id
437
+ # The app client ID.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] user_pool_arn
441
+ # The user pool ARN.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] user_pool_domain
445
+ # The user pool domain.
446
+ # @return [String]
447
+ #
448
+ class CognitoConfig < Struct.new(
449
+ :app_client_id,
450
+ :user_pool_arn,
451
+ :user_pool_domain)
452
+ SENSITIVE = []
453
+ include Aws::Structure
454
+ end
455
+
374
456
  # The requested operation would cause a conflict with the current state
375
457
  # of a service resource associated with the request. Resolve the
376
458
  # conflict before retrying this request. See the accompanying error
@@ -386,6 +468,18 @@ module Aws::ApiGatewayV2
386
468
  include Aws::Structure
387
469
  end
388
470
 
471
+ # The resource identifier.
472
+ #
473
+ # @!attribute [rw] message
474
+ # The error message.
475
+ # @return [String]
476
+ #
477
+ class ConflictExceptionResponseContent < Struct.new(
478
+ :message)
479
+ SENSITIVE = []
480
+ include Aws::Structure
481
+ end
482
+
389
483
  # Represents a CORS configuration. Supported only for HTTP APIs. See
390
484
  # [Configuring CORS][1] for more information.
391
485
  #
@@ -461,8 +555,9 @@ module Aws::ApiGatewayV2
461
555
  # to assume, use the role's Amazon Resource Name (ARN). To require
462
556
  # that the caller's identity be passed through from the request,
463
557
  # specify arn:aws:iam::*:user/*. To use resource-based permissions
464
- # on supported AWS services, specify null. Currently, this property is
465
- # not used for HTTP integrations. Supported only for HTTP APIs.
558
+ # on supported Amazon Web Services services, specify null. Currently,
559
+ # this property is not used for HTTP integrations. Supported only for
560
+ # HTTP APIs.
466
561
  # @return [String]
467
562
  #
468
563
  # @!attribute [rw] description
@@ -475,6 +570,11 @@ module Aws::ApiGatewayV2
475
570
  # @return [Boolean]
476
571
  #
477
572
  # @!attribute [rw] disable_execute_api_endpoint
573
+ # Specifies whether clients can invoke your API by using the default
574
+ # execute-api endpoint. By default, clients can invoke your API with
575
+ # the default https://\{api\_id}.execute-api.\{region}.amazonaws.com
576
+ # endpoint. To require that clients use a custom domain name to invoke
577
+ # your API, disable the default endpoint.
478
578
  # @return [Boolean]
479
579
  #
480
580
  # @!attribute [rw] name
@@ -845,13 +945,11 @@ module Aws::ApiGatewayV2
845
945
  # example,
846
946
  # arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:*\{account\_id}*:function:*\{lambda\_function\_name}*/invocations.
847
947
  # In general, the URI has this form:
848
- # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}* , where
849
- # <replaceable />
850
- #
851
- # \{region} is the same as the region hosting the Lambda function,
852
- # path indicates that the remaining substring in the URI should be
853
- # treated as the path to the resource, including the initial /. For
854
- # Lambda functions, this is usually of the form
948
+ # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}*
949
+ # replaceable/>\{region} is the same as the region hosting the Lambda
950
+ # function, path indicates that the remaining substring in the URI
951
+ # should be treated as the path to the resource, including the initial
952
+ # /. For Lambda functions, this is usually of the form
855
953
  # /2015-03-31/functions/\[FunctionARN\]/invocations. Supported only
856
954
  # for REQUEST authorizers.
857
955
  # @return [String]
@@ -875,7 +973,8 @@ module Aws::ApiGatewayV2
875
973
  # Otherwise, it returns a 401 Unauthorized response without calling
876
974
  # the Lambda function. For HTTP APIs, identity sources are also used
877
975
  # as the cache key when caching is enabled. To learn more, see
878
- # [Working with AWS Lambda authorizers for HTTP APIs][1].
976
+ # [Working with Amazon Web Services Lambda authorizers for HTTP
977
+ # APIs][1].
879
978
  #
880
979
  # For JWT, a single entry that specifies where to extract the JSON Web
881
980
  # Token (JWT) from inbound requests. Currently only header-based and
@@ -903,8 +1002,8 @@ module Aws::ApiGatewayV2
903
1002
  # @!attribute [rw] authorizer_payload_format_version
904
1003
  # Specifies the format of the payload sent to an HTTP API Lambda
905
1004
  # authorizer. Required for HTTP API Lambda authorizers. Supported
906
- # values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
907
- # authorizers for HTTP APIs][1].
1005
+ # values are 1.0 and 2.0. To learn more, see [Working with Amazon Web
1006
+ # Services Lambda authorizers for HTTP APIs][1].
908
1007
  #
909
1008
  #
910
1009
  #
@@ -916,7 +1015,8 @@ module Aws::ApiGatewayV2
916
1015
  # format. By default, a Lambda authorizer must return an IAM policy.
917
1016
  # If enabled, the Lambda authorizer can return a boolean value instead
918
1017
  # of an IAM policy. Supported only for HTTP APIs. To learn more, see
919
- # [Working with AWS Lambda authorizers for HTTP APIs][1]
1018
+ # [Working with Amazon Web Services Lambda authorizers for HTTP
1019
+ # APIs][1].
920
1020
  #
921
1021
  #
922
1022
  #
@@ -1098,8 +1198,7 @@ module Aws::ApiGatewayV2
1098
1198
  # @return [String]
1099
1199
  #
1100
1200
  # @!attribute [rw] stage_name
1101
- # The name of the Stage resource for the Deployment resource to
1102
- # create.
1201
+ # The name of an existing stage to associate with the deployment.
1103
1202
  # @return [String]
1104
1203
  #
1105
1204
  class CreateDeploymentInput < Struct.new(
@@ -1176,6 +1275,7 @@ module Aws::ApiGatewayV2
1176
1275
  # @return [Types::MutualTlsAuthenticationInput]
1177
1276
  #
1178
1277
  # @!attribute [rw] routing_mode
1278
+ # The routing mode API Gateway uses to route traffic to your APIs.
1179
1279
  # @return [String]
1180
1280
  #
1181
1281
  # @!attribute [rw] tags
@@ -1207,6 +1307,7 @@ module Aws::ApiGatewayV2
1207
1307
  # @return [Types::MutualTlsAuthenticationInput]
1208
1308
  #
1209
1309
  # @!attribute [rw] routing_mode
1310
+ # The routing mode API Gateway uses to route traffic to your APIs.
1210
1311
  # @return [String]
1211
1312
  #
1212
1313
  # @!attribute [rw] tags
@@ -1251,6 +1352,7 @@ module Aws::ApiGatewayV2
1251
1352
  # @return [Types::MutualTlsAuthentication]
1252
1353
  #
1253
1354
  # @!attribute [rw] routing_mode
1355
+ # The routing mode API Gateway uses to route traffic to your APIs.
1254
1356
  # @return [String]
1255
1357
  #
1256
1358
  # @!attribute [rw] tags
@@ -1302,11 +1404,13 @@ module Aws::ApiGatewayV2
1302
1404
  #
1303
1405
  # @!attribute [rw] credentials_arn
1304
1406
  # Specifies the credentials required for the integration, if any. For
1305
- # AWS integrations, three options are available. To specify an IAM
1306
- # Role for API Gateway to assume, use the role's Amazon Resource Name
1307
- # (ARN). To require that the caller's identity be passed through from
1308
- # the request, specify the string arn:aws:iam::*:user/*. To use
1309
- # resource-based permissions on supported AWS services, specify null.
1407
+ # Amazon Web Services integrations, three options are available. To
1408
+ # specify an IAM Role for API Gateway to assume, use the role's
1409
+ # Amazon Resource Name (ARN). To require that the caller's identity
1410
+ # be passed through from the request, specify the string
1411
+ # arn:aws:iam::*:user/*. To use resource-based permissions on
1412
+ # supported Amazon Web Services services, don't specify this
1413
+ # parameter.
1310
1414
  # @return [String]
1311
1415
  #
1312
1416
  # @!attribute [rw] description
@@ -1314,13 +1418,15 @@ module Aws::ApiGatewayV2
1314
1418
  # @return [String]
1315
1419
  #
1316
1420
  # @!attribute [rw] integration_method
1317
- # Specifies the integration's HTTP method type.
1421
+ # Specifies the integration's HTTP method type. For WebSocket APIs,
1422
+ # if you use a Lambda integration, you must set the integration method
1423
+ # to POST.
1318
1424
  # @return [String]
1319
1425
  #
1320
1426
  # @!attribute [rw] integration_subtype
1321
1427
  # Supported only for HTTP API AWS\_PROXY integrations. Specifies the
1322
- # AWS service action to invoke. To learn more, see [Integration
1323
- # subtype reference][1].
1428
+ # Amazon Web Services service action to invoke. To learn more, see
1429
+ # [Integration subtype reference][1].
1324
1430
  #
1325
1431
  #
1326
1432
  #
@@ -1330,15 +1436,16 @@ module Aws::ApiGatewayV2
1330
1436
  # @!attribute [rw] integration_type
1331
1437
  # The integration type of an integration. One of the following:
1332
1438
  #
1333
- # AWS: for integrating the route or method request with an AWS service
1334
- # action, including the Lambda function-invoking action. With the
1335
- # Lambda function-invoking action, this is referred to as the Lambda
1336
- # custom integration. With any other AWS service action, this is known
1337
- # as AWS integration. Supported only for WebSocket APIs.
1439
+ # AWS: for integrating the route or method request with an Amazon Web
1440
+ # Services service action, including the Lambda function-invoking
1441
+ # action. With the Lambda function-invoking action, this is referred
1442
+ # to as the Lambda custom integration. With any other Amazon Web
1443
+ # Services service action, this is known as Amazon Web Services
1444
+ # integration. Supported only for WebSocket APIs.
1338
1445
  #
1339
1446
  # AWS\_PROXY: for integrating the route or method request with a
1340
- # Lambda function or other AWS service action. This integration is
1341
- # also referred to as a Lambda proxy integration.
1447
+ # Lambda function or other Amazon Web Services service action. This
1448
+ # integration is also referred to as a Lambda proxy integration.
1342
1449
  #
1343
1450
  # HTTP: for integrating the route or method request with an HTTP
1344
1451
  # endpoint. This integration is also referred to as the HTTP custom
@@ -1361,11 +1468,12 @@ module Aws::ApiGatewayV2
1361
1468
  #
1362
1469
  # For an HTTP API private integration, specify the ARN of an
1363
1470
  # Application Load Balancer listener, Network Load Balancer listener,
1364
- # or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map
1365
- # service, API Gateway uses DiscoverInstances to identify resources.
1366
- # You can use query parameters to target specific resources. To learn
1367
- # more, see [DiscoverInstances][1]. For private integrations, all
1368
- # resources must be owned by the same AWS account.
1471
+ # or Amazon Web Services Cloud Map service. If you specify the ARN of
1472
+ # an Amazon Web Services Cloud Map service, API Gateway uses
1473
+ # DiscoverInstances to identify resources. You can use query
1474
+ # parameters to target specific resources. To learn more, see
1475
+ # [DiscoverInstances][1]. For private integrations, all resources must
1476
+ # be owned by the same Amazon Web Services account.
1369
1477
  #
1370
1478
  #
1371
1479
  #
@@ -1393,7 +1501,14 @@ module Aws::ApiGatewayV2
1393
1501
  #
1394
1502
  # @!attribute [rw] payload_format_version
1395
1503
  # Specifies the format of the payload sent to an integration. Required
1396
- # for HTTP APIs.
1504
+ # for HTTP APIs. For HTTP APIs, supported values for Lambda proxy
1505
+ # integrations are 1.0 and 2.0. For all other integrations, 1.0 is the
1506
+ # only supported value. To learn more, see [Working with Amazon Web
1507
+ # Services Lambda proxy integrations for HTTP APIs][1].
1508
+ #
1509
+ #
1510
+ #
1511
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
1397
1512
  # @return [String]
1398
1513
  #
1399
1514
  # @!attribute [rw] request_parameters
@@ -1411,15 +1526,15 @@ module Aws::ApiGatewayV2
1411
1526
  # request parameters are a key-value map specifying parameters that
1412
1527
  # are passed to AWS\_PROXY integrations. You can provide static
1413
1528
  # values, or map request data, stage variables, or context variables
1414
- # that are evaluated at runtime. To learn more, see [Working with AWS
1415
- # service integrations for HTTP APIs][1].
1529
+ # that are evaluated at runtime. To learn more, see [Working with
1530
+ # Amazon Web Services service integrations for HTTP APIs][1].
1416
1531
  #
1417
1532
  # For HTTP API integrations without a specified integrationSubtype
1418
1533
  # request parameters are a key-value map specifying how to transform
1419
1534
  # HTTP requests before sending them to the backend. The key should
1420
1535
  # follow the pattern
1421
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
1422
- # where action can be append, overwrite or remove. For values, you can
1536
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
1537
+ # action can be append, overwrite or remove. For values, you can
1423
1538
  # provide static values, or map request data, stage variables, or
1424
1539
  # context variables that are evaluated at runtime. To learn more, see
1425
1540
  # [Transforming API requests and responses][2].
@@ -1436,12 +1551,12 @@ module Aws::ApiGatewayV2
1436
1551
  # returning the response to clients. Specify a key-value map from a
1437
1552
  # selection key to response parameters. The selection key must be a
1438
1553
  # valid HTTP status code within the range of 200-599. Response
1439
- # parameters are a key-value map. The key must match pattern
1440
- # &lt;action&gt;:&lt;header&gt;.&lt;location&gt; or
1441
- # overwrite.statuscode. The action can be append, overwrite or remove.
1442
- # The value can be a static value, or map to response data, stage
1443
- # variables, or context variables that are evaluated at runtime. To
1444
- # learn more, see [Transforming API requests and responses][1].
1554
+ # parameters are a key-value map. The key must match the pattern
1555
+ # &lt;action>:&lt;header>.&lt;location> or overwrite.statuscode. The
1556
+ # action can be append, overwrite or remove. The value can be a static
1557
+ # value, or map to response data, stage variables, or context
1558
+ # variables that are evaluated at runtime. To learn more, see
1559
+ # [Transforming API requests and responses][1].
1445
1560
  #
1446
1561
  #
1447
1562
  #
@@ -1559,15 +1674,15 @@ module Aws::ApiGatewayV2
1559
1674
  # request parameters are a key-value map specifying parameters that
1560
1675
  # are passed to AWS\_PROXY integrations. You can provide static
1561
1676
  # values, or map request data, stage variables, or context variables
1562
- # that are evaluated at runtime. To learn more, see [Working with AWS
1563
- # service integrations for HTTP APIs][1].
1677
+ # that are evaluated at runtime. To learn more, see [Working with
1678
+ # Amazon Web Services service integrations for HTTP APIs][1].
1564
1679
  #
1565
1680
  # For HTTP API integrations without a specified integrationSubtype
1566
1681
  # request parameters are a key-value map specifying how to transform
1567
1682
  # HTTP requests before sending them to the backend. The key should
1568
1683
  # follow the pattern
1569
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
1570
- # where action can be append, overwrite or remove. For values, you can
1684
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
1685
+ # action can be append, overwrite or remove. For values, you can
1571
1686
  # provide static values, or map request data, stage variables, or
1572
1687
  # context variables that are evaluated at runtime. To learn more, see
1573
1688
  # [Transforming API requests and responses][2].
@@ -1709,15 +1824,15 @@ module Aws::ApiGatewayV2
1709
1824
  # request parameters are a key-value map specifying parameters that
1710
1825
  # are passed to AWS\_PROXY integrations. You can provide static
1711
1826
  # values, or map request data, stage variables, or context variables
1712
- # that are evaluated at runtime. To learn more, see [Working with AWS
1713
- # service integrations for HTTP APIs][1].
1827
+ # that are evaluated at runtime. To learn more, see [Working with
1828
+ # Amazon Web Services service integrations for HTTP APIs][1].
1714
1829
  #
1715
1830
  # For HTTP API integrations without a specified integrationSubtype
1716
1831
  # request parameters are a key-value map specifying how to transform
1717
1832
  # HTTP requests before sending them to the backend. The key should
1718
1833
  # follow the pattern
1719
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
1720
- # where action can be append, overwrite or remove. For values, you can
1834
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
1835
+ # action can be append, overwrite or remove. For values, you can
1721
1836
  # provide static values, or map request data, stage variables, or
1722
1837
  # context variables that are evaluated at runtime. To learn more, see
1723
1838
  # [Transforming API requests and responses][2].
@@ -1881,15 +1996,15 @@ module Aws::ApiGatewayV2
1881
1996
  # request parameters are a key-value map specifying parameters that
1882
1997
  # are passed to AWS\_PROXY integrations. You can provide static
1883
1998
  # values, or map request data, stage variables, or context variables
1884
- # that are evaluated at runtime. To learn more, see [Working with AWS
1885
- # service integrations for HTTP APIs][1].
1999
+ # that are evaluated at runtime. To learn more, see [Working with
2000
+ # Amazon Web Services service integrations for HTTP APIs][1].
1886
2001
  #
1887
2002
  # For HTTP API integrations without a specified integrationSubtype
1888
2003
  # request parameters are a key-value map specifying how to transform
1889
2004
  # HTTP requests before sending them to the backend. The key should
1890
2005
  # follow the pattern
1891
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
1892
- # where action can be append, overwrite or remove. For values, you can
2006
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
2007
+ # action can be append, overwrite or remove. For values, you can
1893
2008
  # provide static values, or map request data, stage variables, or
1894
2009
  # context variables that are evaluated at runtime. To learn more, see
1895
2010
  # [Transforming API requests and responses][2].
@@ -1962,15 +2077,15 @@ module Aws::ApiGatewayV2
1962
2077
  # request parameters are a key-value map specifying parameters that
1963
2078
  # are passed to AWS\_PROXY integrations. You can provide static
1964
2079
  # values, or map request data, stage variables, or context variables
1965
- # that are evaluated at runtime. To learn more, see [Working with AWS
1966
- # service integrations for HTTP APIs][1].
2080
+ # that are evaluated at runtime. To learn more, see [Working with
2081
+ # Amazon Web Services service integrations for HTTP APIs][1].
1967
2082
  #
1968
2083
  # For HTTP API integrations without a specified integrationSubtype
1969
2084
  # request parameters are a key-value map specifying how to transform
1970
2085
  # HTTP requests before sending them to the backend. The key should
1971
2086
  # follow the pattern
1972
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
1973
- # where action can be append, overwrite or remove. For values, you can
2087
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
2088
+ # action can be append, overwrite or remove. For values, you can
1974
2089
  # provide static values, or map request data, stage variables, or
1975
2090
  # context variables that are evaluated at runtime. To learn more, see
1976
2091
  # [Transforming API requests and responses][2].
@@ -2094,208 +2209,766 @@ module Aws::ApiGatewayV2
2094
2209
  include Aws::Structure
2095
2210
  end
2096
2211
 
2097
- # Represents the input parameters for a CreateRoute request.
2212
+ # @!attribute [rw] description
2213
+ # @return [String]
2098
2214
  #
2099
- # @!attribute [rw] api_key_required
2100
- # Specifies whether an API key is required for the route. Supported
2101
- # only for WebSocket APIs.
2102
- # @return [Boolean]
2215
+ # @!attribute [rw] display_name
2216
+ # @return [String]
2103
2217
  #
2104
- # @!attribute [rw] authorization_scopes
2105
- # The authorization scopes supported by this route.
2106
- # @return [Array<String>]
2218
+ # @!attribute [rw] tags
2219
+ # Represents a collection of tags associated with the resource.
2220
+ # @return [Hash<String,String>]
2107
2221
  #
2108
- # @!attribute [rw] authorization_type
2109
- # The authorization type for the route. For WebSocket APIs, valid
2110
- # values are NONE for open access, AWS\_IAM for using AWS IAM
2111
- # permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
2112
- # valid values are NONE for open access, JWT for using JSON Web
2113
- # Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
2114
- # a Lambda authorizer.
2222
+ class CreatePortalProductRequest < Struct.new(
2223
+ :description,
2224
+ :display_name,
2225
+ :tags)
2226
+ SENSITIVE = []
2227
+ include Aws::Structure
2228
+ end
2229
+
2230
+ # Creates a portal product.
2231
+ #
2232
+ # @!attribute [rw] description
2233
+ # A description of the portal product.
2115
2234
  # @return [String]
2116
2235
  #
2117
- # @!attribute [rw] authorizer_id
2118
- # The identifier of the Authorizer resource to be associated with this
2119
- # route. The authorizer identifier is generated by API Gateway when
2120
- # you created the authorizer.
2236
+ # @!attribute [rw] display_name
2237
+ # The name of the portal product as it appears in a published portal.
2121
2238
  # @return [String]
2122
2239
  #
2123
- # @!attribute [rw] model_selection_expression
2124
- # The model selection expression for the route. Supported only for
2125
- # WebSocket APIs.
2240
+ # @!attribute [rw] tags
2241
+ # The collection of tags. Each tag element is associated with a given
2242
+ # resource.
2243
+ # @return [Hash<String,String>]
2244
+ #
2245
+ class CreatePortalProductRequestContent < Struct.new(
2246
+ :description,
2247
+ :display_name,
2248
+ :tags)
2249
+ SENSITIVE = []
2250
+ include Aws::Structure
2251
+ end
2252
+
2253
+ # @!attribute [rw] description
2126
2254
  # @return [String]
2127
2255
  #
2128
- # @!attribute [rw] operation_name
2129
- # The operation name for the route.
2256
+ # @!attribute [rw] display_name
2130
2257
  # @return [String]
2131
2258
  #
2132
- # @!attribute [rw] request_models
2133
- # The request models for the route. Supported only for WebSocket APIs.
2134
- # @return [Hash<String,String>]
2259
+ # @!attribute [rw] display_order
2260
+ # The display order.
2261
+ # @return [Types::DisplayOrder]
2135
2262
  #
2136
- # @!attribute [rw] request_parameters
2137
- # The request parameters for the route. Supported only for WebSocket
2138
- # APIs.
2139
- # @return [Hash<String,Types::ParameterConstraints>]
2263
+ # @!attribute [rw] last_modified
2264
+ # @return [Time]
2140
2265
  #
2141
- # @!attribute [rw] route_key
2142
- # The route key for the route.
2266
+ # @!attribute [rw] portal_product_arn
2143
2267
  # @return [String]
2144
2268
  #
2145
- # @!attribute [rw] route_response_selection_expression
2146
- # The route response selection expression for the route. Supported
2147
- # only for WebSocket APIs.
2269
+ # @!attribute [rw] portal_product_id
2148
2270
  # @return [String]
2149
2271
  #
2150
- # @!attribute [rw] target
2151
- # The target for the route.
2152
- # @return [String]
2272
+ # @!attribute [rw] tags
2273
+ # Represents a collection of tags associated with the resource.
2274
+ # @return [Hash<String,String>]
2153
2275
  #
2154
- class CreateRouteInput < Struct.new(
2155
- :api_key_required,
2156
- :authorization_scopes,
2157
- :authorization_type,
2158
- :authorizer_id,
2159
- :model_selection_expression,
2160
- :operation_name,
2161
- :request_models,
2162
- :request_parameters,
2163
- :route_key,
2164
- :route_response_selection_expression,
2165
- :target)
2276
+ class CreatePortalProductResponse < Struct.new(
2277
+ :description,
2278
+ :display_name,
2279
+ :display_order,
2280
+ :last_modified,
2281
+ :portal_product_arn,
2282
+ :portal_product_id,
2283
+ :tags)
2166
2284
  SENSITIVE = []
2167
2285
  include Aws::Structure
2168
2286
  end
2169
2287
 
2170
- # @!attribute [rw] api_id
2171
- # @return [String]
2172
- #
2173
- # @!attribute [rw] api_key_required
2174
- # @return [Boolean]
2175
- #
2176
- # @!attribute [rw] authorization_scopes
2177
- # A list of authorization scopes configured on a route. The scopes are
2178
- # used with a JWT authorizer to authorize the method invocation. The
2179
- # authorization works by matching the route scopes against the scopes
2180
- # parsed from the access token in the incoming request. The method
2181
- # invocation is authorized if any route scope matches a claimed scope
2182
- # in the access token. Otherwise, the invocation is not authorized.
2183
- # When the route scope is configured, the client must provide an
2184
- # access token instead of an identity token for authorization
2185
- # purposes.
2186
- # @return [Array<String>]
2288
+ # Creates a portal product.
2187
2289
  #
2188
- # @!attribute [rw] authorization_type
2189
- # The authorization type. For WebSocket APIs, valid values are NONE
2190
- # for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
2191
- # for using a Lambda authorizer. For HTTP APIs, valid values are NONE
2192
- # for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
2193
- # AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
2290
+ # @!attribute [rw] description
2291
+ # A description of the portal product.
2194
2292
  # @return [String]
2195
2293
  #
2196
- # @!attribute [rw] authorizer_id
2197
- # The identifier.
2294
+ # @!attribute [rw] display_name
2295
+ # The display name for the portal product.
2198
2296
  # @return [String]
2199
2297
  #
2200
- # @!attribute [rw] model_selection_expression
2201
- # An expression used to extract information at runtime. See [Selection
2202
- # Expressions][1] for more information.
2203
- #
2298
+ # @!attribute [rw] display_order
2299
+ # The visual ordering of the product pages and product REST endpoint
2300
+ # pages in a published portal.
2301
+ # @return [Types::DisplayOrder]
2204
2302
  #
2303
+ # @!attribute [rw] last_modified
2304
+ # The timestamp when the portal product was last modified.
2305
+ # @return [Time]
2205
2306
  #
2206
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2307
+ # @!attribute [rw] portal_product_arn
2308
+ # The ARN of the portal product.
2207
2309
  # @return [String]
2208
2310
  #
2209
- # @!attribute [rw] operation_name
2210
- # A string with a length between \[1-64\].
2311
+ # @!attribute [rw] portal_product_id
2312
+ # The portal product identifier.
2211
2313
  # @return [String]
2212
2314
  #
2213
- # @!attribute [rw] request_models
2214
- # The route models.
2315
+ # @!attribute [rw] tags
2316
+ # The collection of tags. Each tag element is associated with a given
2317
+ # resource.
2215
2318
  # @return [Hash<String,String>]
2216
2319
  #
2217
- # @!attribute [rw] request_parameters
2218
- # The route parameters.
2219
- # @return [Hash<String,Types::ParameterConstraints>]
2220
- #
2221
- # @!attribute [rw] route_key
2222
- # After evaluating a selection expression, the result is compared
2223
- # against one or more selection keys to find a matching key. See
2224
- # [Selection Expressions][1] for a list of expressions and each
2225
- # expression's associated selection key type.
2320
+ class CreatePortalProductResponseContent < Struct.new(
2321
+ :description,
2322
+ :display_name,
2323
+ :display_order,
2324
+ :last_modified,
2325
+ :portal_product_arn,
2326
+ :portal_product_id,
2327
+ :tags)
2328
+ SENSITIVE = []
2329
+ include Aws::Structure
2330
+ end
2331
+
2332
+ # @!attribute [rw] authorization
2333
+ # Represents an authorization configuration for a portal.
2334
+ # @return [Types::Authorization]
2226
2335
  #
2336
+ # @!attribute [rw] endpoint_configuration
2337
+ # Represents an endpoint configuration.
2338
+ # @return [Types::EndpointConfigurationRequest]
2227
2339
  #
2340
+ # @!attribute [rw] included_portal_product_arns
2341
+ # @return [Array<String>]
2228
2342
  #
2229
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2343
+ # @!attribute [rw] logo_uri
2230
2344
  # @return [String]
2231
2345
  #
2232
- # @!attribute [rw] route_response_selection_expression
2233
- # An expression used to extract information at runtime. See [Selection
2234
- # Expressions][1] for more information.
2235
- #
2236
- #
2346
+ # @!attribute [rw] portal_content
2347
+ # Contains the content that is visible to portal consumers including
2348
+ # the themes, display names, and description.
2349
+ # @return [Types::PortalContent]
2237
2350
  #
2238
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2351
+ # @!attribute [rw] rum_app_monitor_name
2239
2352
  # @return [String]
2240
2353
  #
2241
- # @!attribute [rw] target
2242
- # A string with a length between \[1-128\].
2243
- # @return [String]
2354
+ # @!attribute [rw] tags
2355
+ # Represents a collection of tags associated with the resource.
2356
+ # @return [Hash<String,String>]
2244
2357
  #
2245
- class CreateRouteRequest < Struct.new(
2246
- :api_id,
2247
- :api_key_required,
2248
- :authorization_scopes,
2249
- :authorization_type,
2250
- :authorizer_id,
2251
- :model_selection_expression,
2252
- :operation_name,
2253
- :request_models,
2254
- :request_parameters,
2255
- :route_key,
2256
- :route_response_selection_expression,
2257
- :target)
2358
+ class CreatePortalRequest < Struct.new(
2359
+ :authorization,
2360
+ :endpoint_configuration,
2361
+ :included_portal_product_arns,
2362
+ :logo_uri,
2363
+ :portal_content,
2364
+ :rum_app_monitor_name,
2365
+ :tags)
2258
2366
  SENSITIVE = []
2259
2367
  include Aws::Structure
2260
2368
  end
2261
2369
 
2262
- # @!attribute [rw] api_gateway_managed
2263
- # @return [Boolean]
2370
+ # Creates a portal.
2264
2371
  #
2265
- # @!attribute [rw] api_key_required
2266
- # @return [Boolean]
2372
+ # @!attribute [rw] authorization
2373
+ # The authentication configuration for the portal.
2374
+ # @return [Types::Authorization]
2267
2375
  #
2268
- # @!attribute [rw] authorization_scopes
2269
- # A list of authorization scopes configured on a route. The scopes are
2270
- # used with a JWT authorizer to authorize the method invocation. The
2271
- # authorization works by matching the route scopes against the scopes
2272
- # parsed from the access token in the incoming request. The method
2273
- # invocation is authorized if any route scope matches a claimed scope
2274
- # in the access token. Otherwise, the invocation is not authorized.
2275
- # When the route scope is configured, the client must provide an
2276
- # access token instead of an identity token for authorization
2277
- # purposes.
2278
- # @return [Array<String>]
2376
+ # @!attribute [rw] endpoint_configuration
2377
+ # The domain configuration for the portal. Use a default domain
2378
+ # provided by API Gateway or provide a fully-qualified domain name
2379
+ # that you own.
2380
+ # @return [Types::EndpointConfigurationRequest]
2279
2381
  #
2280
- # @!attribute [rw] authorization_type
2281
- # The authorization type. For WebSocket APIs, valid values are NONE
2282
- # for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
2283
- # for using a Lambda authorizer. For HTTP APIs, valid values are NONE
2284
- # for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
2285
- # AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
2286
- # @return [String]
2382
+ # @!attribute [rw] included_portal_product_arns
2383
+ # The ARNs of the portal products included in the portal.
2384
+ # @return [Array<String>]
2287
2385
  #
2288
- # @!attribute [rw] authorizer_id
2289
- # The identifier.
2386
+ # @!attribute [rw] logo_uri
2387
+ # The URI for the portal logo image that is displayed in the portal
2388
+ # header.
2290
2389
  # @return [String]
2291
2390
  #
2292
- # @!attribute [rw] model_selection_expression
2293
- # An expression used to extract information at runtime. See [Selection
2294
- # Expressions][1] for more information.
2295
- #
2391
+ # @!attribute [rw] portal_content
2392
+ # The content of the portal.
2393
+ # @return [Types::PortalContent]
2296
2394
  #
2297
- #
2298
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2395
+ # @!attribute [rw] rum_app_monitor_name
2396
+ # The name of the Amazon CloudWatch RUM app monitor for the portal.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] tags
2400
+ # The collection of tags. Each tag element is associated with a given
2401
+ # resource.
2402
+ # @return [Hash<String,String>]
2403
+ #
2404
+ class CreatePortalRequestContent < Struct.new(
2405
+ :authorization,
2406
+ :endpoint_configuration,
2407
+ :included_portal_product_arns,
2408
+ :logo_uri,
2409
+ :portal_content,
2410
+ :rum_app_monitor_name,
2411
+ :tags)
2412
+ SENSITIVE = []
2413
+ include Aws::Structure
2414
+ end
2415
+
2416
+ # @!attribute [rw] authorization
2417
+ # Represents an authorization configuration for a portal.
2418
+ # @return [Types::Authorization]
2419
+ #
2420
+ # @!attribute [rw] endpoint_configuration
2421
+ # Represents an endpoint configuration.
2422
+ # @return [Types::EndpointConfigurationResponse]
2423
+ #
2424
+ # @!attribute [rw] included_portal_product_arns
2425
+ # @return [Array<String>]
2426
+ #
2427
+ # @!attribute [rw] last_modified
2428
+ # @return [Time]
2429
+ #
2430
+ # @!attribute [rw] last_published
2431
+ # @return [Time]
2432
+ #
2433
+ # @!attribute [rw] last_published_description
2434
+ # @return [String]
2435
+ #
2436
+ # @!attribute [rw] portal_arn
2437
+ # @return [String]
2438
+ #
2439
+ # @!attribute [rw] portal_content
2440
+ # Contains the content that is visible to portal consumers including
2441
+ # the themes, display names, and description.
2442
+ # @return [Types::PortalContent]
2443
+ #
2444
+ # @!attribute [rw] portal_id
2445
+ # @return [String]
2446
+ #
2447
+ # @!attribute [rw] publish_status
2448
+ # Represents a publish status.
2449
+ # @return [String]
2450
+ #
2451
+ # @!attribute [rw] rum_app_monitor_name
2452
+ # @return [String]
2453
+ #
2454
+ # @!attribute [rw] status_exception
2455
+ # Represents a StatusException.
2456
+ # @return [Types::StatusException]
2457
+ #
2458
+ # @!attribute [rw] tags
2459
+ # Represents a collection of tags associated with the resource.
2460
+ # @return [Hash<String,String>]
2461
+ #
2462
+ class CreatePortalResponse < Struct.new(
2463
+ :authorization,
2464
+ :endpoint_configuration,
2465
+ :included_portal_product_arns,
2466
+ :last_modified,
2467
+ :last_published,
2468
+ :last_published_description,
2469
+ :portal_arn,
2470
+ :portal_content,
2471
+ :portal_id,
2472
+ :publish_status,
2473
+ :rum_app_monitor_name,
2474
+ :status_exception,
2475
+ :tags)
2476
+ SENSITIVE = []
2477
+ include Aws::Structure
2478
+ end
2479
+
2480
+ # Creates a portal.
2481
+ #
2482
+ # @!attribute [rw] authorization
2483
+ # The authorization for the portal. Supports Cognito-based user
2484
+ # authentication or no authentication.
2485
+ # @return [Types::Authorization]
2486
+ #
2487
+ # @!attribute [rw] endpoint_configuration
2488
+ # The endpoint configuration.
2489
+ # @return [Types::EndpointConfigurationResponse]
2490
+ #
2491
+ # @!attribute [rw] included_portal_product_arns
2492
+ # The ARNs of the portal products included in the portal.
2493
+ # @return [Array<String>]
2494
+ #
2495
+ # @!attribute [rw] last_modified
2496
+ # The timestamp when the portal configuration was last modified.
2497
+ # @return [Time]
2498
+ #
2499
+ # @!attribute [rw] last_published
2500
+ # The timestamp when the portal was last published.
2501
+ # @return [Time]
2502
+ #
2503
+ # @!attribute [rw] last_published_description
2504
+ # A user-written description of the changes made in the last published
2505
+ # version of the portal.
2506
+ # @return [String]
2507
+ #
2508
+ # @!attribute [rw] portal_arn
2509
+ # The ARN of the portal.
2510
+ # @return [String]
2511
+ #
2512
+ # @!attribute [rw] portal_content
2513
+ # The name, description, and theme for the portal.
2514
+ # @return [Types::PortalContent]
2515
+ #
2516
+ # @!attribute [rw] portal_id
2517
+ # The portal identifier.
2518
+ # @return [String]
2519
+ #
2520
+ # @!attribute [rw] publish_status
2521
+ # The current publishing status of the portal.
2522
+ # @return [String]
2523
+ #
2524
+ # @!attribute [rw] rum_app_monitor_name
2525
+ # The name of the Amazon CloudWatch RUM app monitor.
2526
+ # @return [String]
2527
+ #
2528
+ # @!attribute [rw] status_exception
2529
+ # Error information for failed portal operations. Contains details
2530
+ # about any issues encountered during portal creation or publishing.
2531
+ # @return [Types::StatusException]
2532
+ #
2533
+ # @!attribute [rw] tags
2534
+ # The collection of tags. Each tag element is associated with a given
2535
+ # resource.
2536
+ # @return [Hash<String,String>]
2537
+ #
2538
+ class CreatePortalResponseContent < Struct.new(
2539
+ :authorization,
2540
+ :endpoint_configuration,
2541
+ :included_portal_product_arns,
2542
+ :last_modified,
2543
+ :last_published,
2544
+ :last_published_description,
2545
+ :portal_arn,
2546
+ :portal_content,
2547
+ :portal_id,
2548
+ :publish_status,
2549
+ :rum_app_monitor_name,
2550
+ :status_exception,
2551
+ :tags)
2552
+ SENSITIVE = []
2553
+ include Aws::Structure
2554
+ end
2555
+
2556
+ # @!attribute [rw] display_content
2557
+ # The content of the product page.
2558
+ # @return [Types::DisplayContent]
2559
+ #
2560
+ # @!attribute [rw] portal_product_id
2561
+ # @return [String]
2562
+ #
2563
+ class CreateProductPageRequest < Struct.new(
2564
+ :display_content,
2565
+ :portal_product_id)
2566
+ SENSITIVE = []
2567
+ include Aws::Structure
2568
+ end
2569
+
2570
+ # Creates a product page.
2571
+ #
2572
+ # @!attribute [rw] display_content
2573
+ # The content of the product page.
2574
+ # @return [Types::DisplayContent]
2575
+ #
2576
+ class CreateProductPageRequestContent < Struct.new(
2577
+ :display_content)
2578
+ SENSITIVE = []
2579
+ include Aws::Structure
2580
+ end
2581
+
2582
+ # @!attribute [rw] display_content
2583
+ # The content of the product page.
2584
+ # @return [Types::DisplayContent]
2585
+ #
2586
+ # @!attribute [rw] last_modified
2587
+ # @return [Time]
2588
+ #
2589
+ # @!attribute [rw] product_page_arn
2590
+ # @return [String]
2591
+ #
2592
+ # @!attribute [rw] product_page_id
2593
+ # @return [String]
2594
+ #
2595
+ class CreateProductPageResponse < Struct.new(
2596
+ :display_content,
2597
+ :last_modified,
2598
+ :product_page_arn,
2599
+ :product_page_id)
2600
+ SENSITIVE = []
2601
+ include Aws::Structure
2602
+ end
2603
+
2604
+ # Creates a product page.
2605
+ #
2606
+ # @!attribute [rw] display_content
2607
+ # The content of the product page.
2608
+ # @return [Types::DisplayContent]
2609
+ #
2610
+ # @!attribute [rw] last_modified
2611
+ # The timestamp when the product page was last modified.
2612
+ # @return [Time]
2613
+ #
2614
+ # @!attribute [rw] product_page_arn
2615
+ # The ARN of the product page.
2616
+ # @return [String]
2617
+ #
2618
+ # @!attribute [rw] product_page_id
2619
+ # The product page identifier.
2620
+ # @return [String]
2621
+ #
2622
+ class CreateProductPageResponseContent < Struct.new(
2623
+ :display_content,
2624
+ :last_modified,
2625
+ :product_page_arn,
2626
+ :product_page_id)
2627
+ SENSITIVE = []
2628
+ include Aws::Structure
2629
+ end
2630
+
2631
+ # @!attribute [rw] display_content
2632
+ # Represents the endpoint display content.
2633
+ # @return [Types::EndpointDisplayContent]
2634
+ #
2635
+ # @!attribute [rw] portal_product_id
2636
+ # @return [String]
2637
+ #
2638
+ # @!attribute [rw] rest_endpoint_identifier
2639
+ # The REST API endpoint identifier.
2640
+ # @return [Types::RestEndpointIdentifier]
2641
+ #
2642
+ # @!attribute [rw] try_it_state
2643
+ # Represents the try it state for a product REST endpoint page.
2644
+ # @return [String]
2645
+ #
2646
+ class CreateProductRestEndpointPageRequest < Struct.new(
2647
+ :display_content,
2648
+ :portal_product_id,
2649
+ :rest_endpoint_identifier,
2650
+ :try_it_state)
2651
+ SENSITIVE = []
2652
+ include Aws::Structure
2653
+ end
2654
+
2655
+ # Creates a product REST endpoint page.
2656
+ #
2657
+ # @!attribute [rw] display_content
2658
+ # The content of the product REST endpoint page.
2659
+ # @return [Types::EndpointDisplayContent]
2660
+ #
2661
+ # @!attribute [rw] rest_endpoint_identifier
2662
+ # The REST endpoint identifier.
2663
+ # @return [Types::RestEndpointIdentifier]
2664
+ #
2665
+ # @!attribute [rw] try_it_state
2666
+ # The try it state of the product REST endpoint page.
2667
+ # @return [String]
2668
+ #
2669
+ class CreateProductRestEndpointPageRequestContent < Struct.new(
2670
+ :display_content,
2671
+ :rest_endpoint_identifier,
2672
+ :try_it_state)
2673
+ SENSITIVE = []
2674
+ include Aws::Structure
2675
+ end
2676
+
2677
+ # @!attribute [rw] display_content
2678
+ # The product REST endpoint page.
2679
+ # @return [Types::EndpointDisplayContentResponse]
2680
+ #
2681
+ # @!attribute [rw] last_modified
2682
+ # @return [Time]
2683
+ #
2684
+ # @!attribute [rw] product_rest_endpoint_page_arn
2685
+ # @return [String]
2686
+ #
2687
+ # @!attribute [rw] product_rest_endpoint_page_id
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] rest_endpoint_identifier
2691
+ # The REST API endpoint identifier.
2692
+ # @return [Types::RestEndpointIdentifier]
2693
+ #
2694
+ # @!attribute [rw] status
2695
+ # The status.
2696
+ # @return [String]
2697
+ #
2698
+ # @!attribute [rw] status_exception
2699
+ # Represents a StatusException.
2700
+ # @return [Types::StatusException]
2701
+ #
2702
+ # @!attribute [rw] try_it_state
2703
+ # Represents the try it state for a product REST endpoint page.
2704
+ # @return [String]
2705
+ #
2706
+ class CreateProductRestEndpointPageResponse < Struct.new(
2707
+ :display_content,
2708
+ :last_modified,
2709
+ :product_rest_endpoint_page_arn,
2710
+ :product_rest_endpoint_page_id,
2711
+ :rest_endpoint_identifier,
2712
+ :status,
2713
+ :status_exception,
2714
+ :try_it_state)
2715
+ SENSITIVE = []
2716
+ include Aws::Structure
2717
+ end
2718
+
2719
+ # Creates a product REST endpoint page.
2720
+ #
2721
+ # @!attribute [rw] display_content
2722
+ # The display content.
2723
+ # @return [Types::EndpointDisplayContentResponse]
2724
+ #
2725
+ # @!attribute [rw] last_modified
2726
+ # The timestamp when the product REST endpoint page was last modified.
2727
+ # @return [Time]
2728
+ #
2729
+ # @!attribute [rw] product_rest_endpoint_page_arn
2730
+ # The ARN of the product REST endpoint page.
2731
+ # @return [String]
2732
+ #
2733
+ # @!attribute [rw] product_rest_endpoint_page_id
2734
+ # The product REST endpoint page identifier.
2735
+ # @return [String]
2736
+ #
2737
+ # @!attribute [rw] rest_endpoint_identifier
2738
+ # The REST endpoint identifier.
2739
+ # @return [Types::RestEndpointIdentifier]
2740
+ #
2741
+ # @!attribute [rw] status
2742
+ # The status.
2743
+ # @return [String]
2744
+ #
2745
+ # @!attribute [rw] status_exception
2746
+ # The status exception information.
2747
+ # @return [Types::StatusException]
2748
+ #
2749
+ # @!attribute [rw] try_it_state
2750
+ # The try it state.
2751
+ # @return [String]
2752
+ #
2753
+ class CreateProductRestEndpointPageResponseContent < Struct.new(
2754
+ :display_content,
2755
+ :last_modified,
2756
+ :product_rest_endpoint_page_arn,
2757
+ :product_rest_endpoint_page_id,
2758
+ :rest_endpoint_identifier,
2759
+ :status,
2760
+ :status_exception,
2761
+ :try_it_state)
2762
+ SENSITIVE = []
2763
+ include Aws::Structure
2764
+ end
2765
+
2766
+ # Represents the input parameters for a CreateRoute request.
2767
+ #
2768
+ # @!attribute [rw] api_key_required
2769
+ # Specifies whether an API key is required for the route. Supported
2770
+ # only for WebSocket APIs.
2771
+ # @return [Boolean]
2772
+ #
2773
+ # @!attribute [rw] authorization_scopes
2774
+ # The authorization scopes supported by this route.
2775
+ # @return [Array<String>]
2776
+ #
2777
+ # @!attribute [rw] authorization_type
2778
+ # The authorization type for the route. For WebSocket APIs, valid
2779
+ # values are NONE for open access, AWS\_IAM for using Amazon Web
2780
+ # Services IAM permissions, and CUSTOM for using a Lambda authorizer.
2781
+ # For HTTP APIs, valid values are NONE for open access, JWT for using
2782
+ # JSON Web Tokens, AWS\_IAM for using Amazon Web Services IAM
2783
+ # permissions, and CUSTOM for using a Lambda authorizer.
2784
+ # @return [String]
2785
+ #
2786
+ # @!attribute [rw] authorizer_id
2787
+ # The identifier of the Authorizer resource to be associated with this
2788
+ # route. The authorizer identifier is generated by API Gateway when
2789
+ # you created the authorizer.
2790
+ # @return [String]
2791
+ #
2792
+ # @!attribute [rw] model_selection_expression
2793
+ # The model selection expression for the route. Supported only for
2794
+ # WebSocket APIs.
2795
+ # @return [String]
2796
+ #
2797
+ # @!attribute [rw] operation_name
2798
+ # The operation name for the route.
2799
+ # @return [String]
2800
+ #
2801
+ # @!attribute [rw] request_models
2802
+ # The request models for the route. Supported only for WebSocket APIs.
2803
+ # @return [Hash<String,String>]
2804
+ #
2805
+ # @!attribute [rw] request_parameters
2806
+ # The request parameters for the route. Supported only for WebSocket
2807
+ # APIs.
2808
+ # @return [Hash<String,Types::ParameterConstraints>]
2809
+ #
2810
+ # @!attribute [rw] route_key
2811
+ # The route key for the route. For HTTP APIs, the route key can be
2812
+ # either $default, or a combination of an HTTP method and resource
2813
+ # path, for example, GET /pets.
2814
+ # @return [String]
2815
+ #
2816
+ # @!attribute [rw] route_response_selection_expression
2817
+ # The route response selection expression for the route. Supported
2818
+ # only for WebSocket APIs.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] target
2822
+ # The target for the route.
2823
+ # @return [String]
2824
+ #
2825
+ class CreateRouteInput < Struct.new(
2826
+ :api_key_required,
2827
+ :authorization_scopes,
2828
+ :authorization_type,
2829
+ :authorizer_id,
2830
+ :model_selection_expression,
2831
+ :operation_name,
2832
+ :request_models,
2833
+ :request_parameters,
2834
+ :route_key,
2835
+ :route_response_selection_expression,
2836
+ :target)
2837
+ SENSITIVE = []
2838
+ include Aws::Structure
2839
+ end
2840
+
2841
+ # @!attribute [rw] api_id
2842
+ # @return [String]
2843
+ #
2844
+ # @!attribute [rw] api_key_required
2845
+ # @return [Boolean]
2846
+ #
2847
+ # @!attribute [rw] authorization_scopes
2848
+ # A list of authorization scopes configured on a route. The scopes are
2849
+ # used with a JWT authorizer to authorize the method invocation. The
2850
+ # authorization works by matching the route scopes against the scopes
2851
+ # parsed from the access token in the incoming request. The method
2852
+ # invocation is authorized if any route scope matches a claimed scope
2853
+ # in the access token. Otherwise, the invocation is not authorized.
2854
+ # When the route scope is configured, the client must provide an
2855
+ # access token instead of an identity token for authorization
2856
+ # purposes.
2857
+ # @return [Array<String>]
2858
+ #
2859
+ # @!attribute [rw] authorization_type
2860
+ # The authorization type. For WebSocket APIs, valid values are NONE
2861
+ # for open access, AWS\_IAM for using Amazon Web Services IAM
2862
+ # permissions, and CUSTOM for using a Lambda authorizer. For HTTP
2863
+ # APIs, valid values are NONE for open access, JWT for using JSON Web
2864
+ # Tokens, AWS\_IAM for using Amazon Web Services IAM permissions, and
2865
+ # CUSTOM for using a Lambda authorizer.
2866
+ # @return [String]
2867
+ #
2868
+ # @!attribute [rw] authorizer_id
2869
+ # The identifier.
2870
+ # @return [String]
2871
+ #
2872
+ # @!attribute [rw] model_selection_expression
2873
+ # An expression used to extract information at runtime. See [Selection
2874
+ # Expressions][1] for more information.
2875
+ #
2876
+ #
2877
+ #
2878
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2879
+ # @return [String]
2880
+ #
2881
+ # @!attribute [rw] operation_name
2882
+ # A string with a length between \[1-64\].
2883
+ # @return [String]
2884
+ #
2885
+ # @!attribute [rw] request_models
2886
+ # The route models.
2887
+ # @return [Hash<String,String>]
2888
+ #
2889
+ # @!attribute [rw] request_parameters
2890
+ # The route parameters.
2891
+ # @return [Hash<String,Types::ParameterConstraints>]
2892
+ #
2893
+ # @!attribute [rw] route_key
2894
+ # After evaluating a selection expression, the result is compared
2895
+ # against one or more selection keys to find a matching key. See
2896
+ # [Selection Expressions][1] for a list of expressions and each
2897
+ # expression's associated selection key type.
2898
+ #
2899
+ #
2900
+ #
2901
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2902
+ # @return [String]
2903
+ #
2904
+ # @!attribute [rw] route_response_selection_expression
2905
+ # An expression used to extract information at runtime. See [Selection
2906
+ # Expressions][1] for more information.
2907
+ #
2908
+ #
2909
+ #
2910
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2911
+ # @return [String]
2912
+ #
2913
+ # @!attribute [rw] target
2914
+ # A string with a length between \[1-128\].
2915
+ # @return [String]
2916
+ #
2917
+ class CreateRouteRequest < Struct.new(
2918
+ :api_id,
2919
+ :api_key_required,
2920
+ :authorization_scopes,
2921
+ :authorization_type,
2922
+ :authorizer_id,
2923
+ :model_selection_expression,
2924
+ :operation_name,
2925
+ :request_models,
2926
+ :request_parameters,
2927
+ :route_key,
2928
+ :route_response_selection_expression,
2929
+ :target)
2930
+ SENSITIVE = []
2931
+ include Aws::Structure
2932
+ end
2933
+
2934
+ # @!attribute [rw] api_gateway_managed
2935
+ # @return [Boolean]
2936
+ #
2937
+ # @!attribute [rw] api_key_required
2938
+ # @return [Boolean]
2939
+ #
2940
+ # @!attribute [rw] authorization_scopes
2941
+ # A list of authorization scopes configured on a route. The scopes are
2942
+ # used with a JWT authorizer to authorize the method invocation. The
2943
+ # authorization works by matching the route scopes against the scopes
2944
+ # parsed from the access token in the incoming request. The method
2945
+ # invocation is authorized if any route scope matches a claimed scope
2946
+ # in the access token. Otherwise, the invocation is not authorized.
2947
+ # When the route scope is configured, the client must provide an
2948
+ # access token instead of an identity token for authorization
2949
+ # purposes.
2950
+ # @return [Array<String>]
2951
+ #
2952
+ # @!attribute [rw] authorization_type
2953
+ # The authorization type. For WebSocket APIs, valid values are NONE
2954
+ # for open access, AWS\_IAM for using Amazon Web Services IAM
2955
+ # permissions, and CUSTOM for using a Lambda authorizer. For HTTP
2956
+ # APIs, valid values are NONE for open access, JWT for using JSON Web
2957
+ # Tokens, AWS\_IAM for using Amazon Web Services IAM permissions, and
2958
+ # CUSTOM for using a Lambda authorizer.
2959
+ # @return [String]
2960
+ #
2961
+ # @!attribute [rw] authorizer_id
2962
+ # The identifier.
2963
+ # @return [String]
2964
+ #
2965
+ # @!attribute [rw] model_selection_expression
2966
+ # An expression used to extract information at runtime. See [Selection
2967
+ # Expressions][1] for more information.
2968
+ #
2969
+ #
2970
+ #
2971
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
2299
2972
  # @return [String]
2300
2973
  #
2301
2974
  # @!attribute [rw] operation_name
@@ -2484,7 +3157,9 @@ module Aws::ApiGatewayV2
2484
3157
  # @return [String]
2485
3158
  #
2486
3159
  # @!attribute [rw] priority
2487
- # Represents the priority of the routing rule.
3160
+ # The order in which API Gateway evaluates a rule. Priority is
3161
+ # evaluated from the lowest value to the highest value. Rules can't
3162
+ # have the same priority. Priority values 1-1,000,000 are supported.
2488
3163
  # @return [Integer]
2489
3164
  #
2490
3165
  class CreateRoutingRuleRequest < Struct.new(
@@ -2504,7 +3179,9 @@ module Aws::ApiGatewayV2
2504
3179
  # @return [Array<Types::RoutingRuleCondition>]
2505
3180
  #
2506
3181
  # @!attribute [rw] priority
2507
- # Represents the priority of the routing rule.
3182
+ # The order in which API Gateway evaluates a rule. Priority is
3183
+ # evaluated from the lowest value to the highest value. Rules can't
3184
+ # have the same priority. Priority values 1-1,000,000 are supported.
2508
3185
  # @return [Integer]
2509
3186
  #
2510
3187
  # @!attribute [rw] routing_rule_arn
@@ -2816,6 +3493,43 @@ module Aws::ApiGatewayV2
2816
3493
  include Aws::Structure
2817
3494
  end
2818
3495
 
3496
+ # Represents custom colors for a published portal.
3497
+ #
3498
+ # @!attribute [rw] accent_color
3499
+ # Represents the accent color.
3500
+ # @return [String]
3501
+ #
3502
+ # @!attribute [rw] background_color
3503
+ # Represents the background color.
3504
+ # @return [String]
3505
+ #
3506
+ # @!attribute [rw] error_validation_color
3507
+ # The errorValidationColor.
3508
+ # @return [String]
3509
+ #
3510
+ # @!attribute [rw] header_color
3511
+ # Represents the header color.
3512
+ # @return [String]
3513
+ #
3514
+ # @!attribute [rw] navigation_color
3515
+ # Represents the navigation color.
3516
+ # @return [String]
3517
+ #
3518
+ # @!attribute [rw] text_color
3519
+ # Represents the text color.
3520
+ # @return [String]
3521
+ #
3522
+ class CustomColors < Struct.new(
3523
+ :accent_color,
3524
+ :background_color,
3525
+ :error_validation_color,
3526
+ :header_color,
3527
+ :navigation_color,
3528
+ :text_color)
3529
+ SENSITIVE = []
3530
+ include Aws::Structure
3531
+ end
3532
+
2819
3533
  # @!attribute [rw] api_id
2820
3534
  # @return [String]
2821
3535
  #
@@ -2938,6 +3652,59 @@ module Aws::ApiGatewayV2
2938
3652
  include Aws::Structure
2939
3653
  end
2940
3654
 
3655
+ # @!attribute [rw] portal_product_id
3656
+ # @return [String]
3657
+ #
3658
+ class DeletePortalProductRequest < Struct.new(
3659
+ :portal_product_id)
3660
+ SENSITIVE = []
3661
+ include Aws::Structure
3662
+ end
3663
+
3664
+ # @!attribute [rw] portal_product_id
3665
+ # @return [String]
3666
+ #
3667
+ class DeletePortalProductSharingPolicyRequest < Struct.new(
3668
+ :portal_product_id)
3669
+ SENSITIVE = []
3670
+ include Aws::Structure
3671
+ end
3672
+
3673
+ # @!attribute [rw] portal_id
3674
+ # @return [String]
3675
+ #
3676
+ class DeletePortalRequest < Struct.new(
3677
+ :portal_id)
3678
+ SENSITIVE = []
3679
+ include Aws::Structure
3680
+ end
3681
+
3682
+ # @!attribute [rw] portal_product_id
3683
+ # @return [String]
3684
+ #
3685
+ # @!attribute [rw] product_page_id
3686
+ # @return [String]
3687
+ #
3688
+ class DeleteProductPageRequest < Struct.new(
3689
+ :portal_product_id,
3690
+ :product_page_id)
3691
+ SENSITIVE = []
3692
+ include Aws::Structure
3693
+ end
3694
+
3695
+ # @!attribute [rw] portal_product_id
3696
+ # @return [String]
3697
+ #
3698
+ # @!attribute [rw] product_rest_endpoint_page_id
3699
+ # @return [String]
3700
+ #
3701
+ class DeleteProductRestEndpointPageRequest < Struct.new(
3702
+ :portal_product_id,
3703
+ :product_rest_endpoint_page_id)
3704
+ SENSITIVE = []
3705
+ include Aws::Structure
3706
+ end
3707
+
2941
3708
  # @!attribute [rw] api_id
2942
3709
  # @return [String]
2943
3710
  #
@@ -3103,6 +3870,82 @@ module Aws::ApiGatewayV2
3103
3870
  include Aws::Structure
3104
3871
  end
3105
3872
 
3873
+ # @!attribute [rw] portal_id
3874
+ # @return [String]
3875
+ #
3876
+ class DisablePortalRequest < Struct.new(
3877
+ :portal_id)
3878
+ SENSITIVE = []
3879
+ include Aws::Structure
3880
+ end
3881
+
3882
+ # The content of the product page.
3883
+ #
3884
+ # @!attribute [rw] body
3885
+ # The body.
3886
+ # @return [String]
3887
+ #
3888
+ # @!attribute [rw] title
3889
+ # The title.
3890
+ # @return [String]
3891
+ #
3892
+ class DisplayContent < Struct.new(
3893
+ :body,
3894
+ :title)
3895
+ SENSITIVE = []
3896
+ include Aws::Structure
3897
+ end
3898
+
3899
+ # Contains any values that override the default configuration generated
3900
+ # from API Gateway.
3901
+ #
3902
+ # @!attribute [rw] body
3903
+ # By default, this is the documentation of your REST API from API
3904
+ # Gateway. You can provide custom documentation to override this
3905
+ # value.
3906
+ # @return [String]
3907
+ #
3908
+ # @!attribute [rw] endpoint
3909
+ # The URL for your REST API. By default, API Gateway uses the default
3910
+ # execute API endpoint. You can provide a custom domain to override
3911
+ # this value.
3912
+ # @return [String]
3913
+ #
3914
+ # @!attribute [rw] operation_name
3915
+ # The operation name of the product REST endpoint.
3916
+ # @return [String]
3917
+ #
3918
+ class DisplayContentOverrides < Struct.new(
3919
+ :body,
3920
+ :endpoint,
3921
+ :operation_name)
3922
+ SENSITIVE = []
3923
+ include Aws::Structure
3924
+ end
3925
+
3926
+ # The display order.
3927
+ #
3928
+ # @!attribute [rw] contents
3929
+ # Represents a list of sections which include section name and list of
3930
+ # product REST endpoints for a product.
3931
+ # @return [Array<Types::Section>]
3932
+ #
3933
+ # @!attribute [rw] overview_page_arn
3934
+ # The ARN of the overview page.
3935
+ # @return [String]
3936
+ #
3937
+ # @!attribute [rw] product_page_arns
3938
+ # The product page ARNs.
3939
+ # @return [Array<String>]
3940
+ #
3941
+ class DisplayOrder < Struct.new(
3942
+ :contents,
3943
+ :overview_page_arn,
3944
+ :product_page_arns)
3945
+ SENSITIVE = []
3946
+ include Aws::Structure
3947
+ end
3948
+
3106
3949
  # Represents a domain name.
3107
3950
  #
3108
3951
  # @!attribute [rw] api_mapping_selection_expression
@@ -3114,7 +3957,7 @@ module Aws::ApiGatewayV2
3114
3957
  # @return [String]
3115
3958
  #
3116
3959
  # @!attribute [rw] domain_name_arn
3117
- # Represents an Amazon Resource Name (ARN).
3960
+ # The ARN of the DomainName resource.
3118
3961
  # @return [String]
3119
3962
  #
3120
3963
  # @!attribute [rw] domain_name_configurations
@@ -3127,6 +3970,7 @@ module Aws::ApiGatewayV2
3127
3970
  # @return [Types::MutualTlsAuthentication]
3128
3971
  #
3129
3972
  # @!attribute [rw] routing_mode
3973
+ # The routing mode API Gateway uses to route traffic to your APIs.
3130
3974
  # @return [String]
3131
3975
  #
3132
3976
  # @!attribute [rw] tags
@@ -3152,9 +3996,9 @@ module Aws::ApiGatewayV2
3152
3996
  # @return [String]
3153
3997
  #
3154
3998
  # @!attribute [rw] certificate_arn
3155
- # An AWS-managed certificate that will be used by the edge-optimized
3156
- # endpoint for this domain name. AWS Certificate Manager is the only
3157
- # supported source.
3999
+ # An Amazon Web Services-managed certificate that will be used by the
4000
+ # edge-optimized endpoint for this domain name. Amazon Web Services
4001
+ # Certificate Manager is the only supported source.
3158
4002
  # @return [String]
3159
4003
  #
3160
4004
  # @!attribute [rw] certificate_name
@@ -3168,11 +4012,11 @@ module Aws::ApiGatewayV2
3168
4012
  # @return [Time]
3169
4013
  #
3170
4014
  # @!attribute [rw] domain_name_status
3171
- # The status of the domain name migration. The valid values are
3172
- # AVAILABLE, UPDATING, PENDING\_CERTIFICATE\_REIMPORT, and
3173
- # PENDING\_OWNERSHIP\_VERIFICATION. If the status is UPDATING, the
3174
- # domain cannot be modified further until the existing operation is
3175
- # complete. If it is AVAILABLE, the domain can be updated.
4015
+ # Identifies the status of a domain name migration. Statuses can have
4016
+ # a value of AVAILABLE, UPDATING, PENDING\_CERTIFICATE\_REIMPORT, or
4017
+ # PENDING\_OWNERSHIP VERIFICATION. A domain can be modified if its
4018
+ # status is AVAILABLE. If the domain's status is UPDATING, you must
4019
+ # wait until the current operation is complete.
3176
4020
  # @return [String]
3177
4021
  #
3178
4022
  # @!attribute [rw] domain_name_status_message
@@ -3200,43 +4044,130 @@ module Aws::ApiGatewayV2
3200
4044
  # for this domain name. The valid values are TLS\_1\_0 and TLS\_1\_2.
3201
4045
  # @return [String]
3202
4046
  #
3203
- # @!attribute [rw] ownership_verification_certificate_arn
3204
- # The ARN of the public certificate issued by ACM to validate
3205
- # ownership of your custom domain. Only required when configuring
3206
- # mutual TLS and using an ACM imported or private CA certificate ARN
3207
- # as the regionalCertificateArn
4047
+ # @!attribute [rw] ownership_verification_certificate_arn
4048
+ # The Amazon resource name (ARN) for the public certificate issued by
4049
+ # Certificate Manager. This ARN is used to validate custom domain
4050
+ # ownership. It's required only if you configure mutual TLS and use
4051
+ # either an ACM-imported or a private CA certificate ARN as the
4052
+ # regionalCertificateArn.
4053
+ # @return [String]
4054
+ #
4055
+ class DomainNameConfiguration < Struct.new(
4056
+ :api_gateway_domain_name,
4057
+ :certificate_arn,
4058
+ :certificate_name,
4059
+ :certificate_upload_date,
4060
+ :domain_name_status,
4061
+ :domain_name_status_message,
4062
+ :endpoint_type,
4063
+ :hosted_zone_id,
4064
+ :ip_address_type,
4065
+ :security_policy,
4066
+ :ownership_verification_certificate_arn)
4067
+ SENSITIVE = []
4068
+ include Aws::Structure
4069
+ end
4070
+
4071
+ # Represents a collection of domain names.
4072
+ #
4073
+ # @!attribute [rw] items
4074
+ # The elements from this collection.
4075
+ # @return [Array<Types::DomainName>]
4076
+ #
4077
+ # @!attribute [rw] next_token
4078
+ # The next page of elements from this collection. Not valid for the
4079
+ # last element of the collection.
4080
+ # @return [String]
4081
+ #
4082
+ class DomainNames < Struct.new(
4083
+ :items,
4084
+ :next_token)
4085
+ SENSITIVE = []
4086
+ include Aws::Structure
4087
+ end
4088
+
4089
+ # Represents an endpoint configuration.
4090
+ #
4091
+ # @!attribute [rw] acm_managed
4092
+ # Represents a domain name and certificate for a portal.
4093
+ # @return [Types::ACMManaged]
4094
+ #
4095
+ # @!attribute [rw] none
4096
+ # Use the default portal domain name that is generated and managed by
4097
+ # API Gateway.
4098
+ # @return [Types::None]
4099
+ #
4100
+ class EndpointConfigurationRequest < Struct.new(
4101
+ :acm_managed,
4102
+ :none)
4103
+ SENSITIVE = []
4104
+ include Aws::Structure
4105
+ end
4106
+
4107
+ # Represents an endpoint configuration.
4108
+ #
4109
+ # @!attribute [rw] certificate_arn
4110
+ # The ARN of the ACM certificate.
4111
+ # @return [String]
4112
+ #
4113
+ # @!attribute [rw] domain_name
4114
+ # The domain name.
4115
+ # @return [String]
4116
+ #
4117
+ # @!attribute [rw] portal_default_domain_name
4118
+ # The portal default domain name. This domain name is generated and
4119
+ # managed by API Gateway.
4120
+ # @return [String]
4121
+ #
4122
+ # @!attribute [rw] portal_domain_hosted_zone_id
4123
+ # The portal domain hosted zone identifier.
3208
4124
  # @return [String]
3209
4125
  #
3210
- class DomainNameConfiguration < Struct.new(
3211
- :api_gateway_domain_name,
4126
+ class EndpointConfigurationResponse < Struct.new(
3212
4127
  :certificate_arn,
3213
- :certificate_name,
3214
- :certificate_upload_date,
3215
- :domain_name_status,
3216
- :domain_name_status_message,
3217
- :endpoint_type,
3218
- :hosted_zone_id,
3219
- :ip_address_type,
3220
- :security_policy,
3221
- :ownership_verification_certificate_arn)
4128
+ :domain_name,
4129
+ :portal_default_domain_name,
4130
+ :portal_domain_hosted_zone_id)
3222
4131
  SENSITIVE = []
3223
4132
  include Aws::Structure
3224
4133
  end
3225
4134
 
3226
- # Represents a collection of domain names.
4135
+ # Represents the endpoint display content.
3227
4136
  #
3228
- # @!attribute [rw] items
3229
- # The elements from this collection.
3230
- # @return [Array<Types::DomainName>]
4137
+ # @!attribute [rw] none
4138
+ # If your product REST endpoint contains no overrides, the none object
4139
+ # is returned.
4140
+ # @return [Types::None]
3231
4141
  #
3232
- # @!attribute [rw] next_token
3233
- # The next page of elements from this collection. Not valid for the
3234
- # last element of the collection.
4142
+ # @!attribute [rw] overrides
4143
+ # The overrides for endpoint display content.
4144
+ # @return [Types::DisplayContentOverrides]
4145
+ #
4146
+ class EndpointDisplayContent < Struct.new(
4147
+ :none,
4148
+ :overrides)
4149
+ SENSITIVE = []
4150
+ include Aws::Structure
4151
+ end
4152
+
4153
+ # The product REST endpoint page.
4154
+ #
4155
+ # @!attribute [rw] body
4156
+ # The API documentation.
3235
4157
  # @return [String]
3236
4158
  #
3237
- class DomainNames < Struct.new(
3238
- :items,
3239
- :next_token)
4159
+ # @!attribute [rw] endpoint
4160
+ # The URL to invoke your REST API.
4161
+ # @return [String]
4162
+ #
4163
+ # @!attribute [rw] operation_name
4164
+ # The operation name.
4165
+ # @return [String]
4166
+ #
4167
+ class EndpointDisplayContentResponse < Struct.new(
4168
+ :body,
4169
+ :endpoint,
4170
+ :operation_name)
3240
4171
  SENSITIVE = []
3241
4172
  include Aws::Structure
3242
4173
  end
@@ -3743,6 +4674,7 @@ module Aws::ApiGatewayV2
3743
4674
  # @return [Types::MutualTlsAuthentication]
3744
4675
  #
3745
4676
  # @!attribute [rw] routing_mode
4677
+ # The routing mode API Gateway uses to route traffic to your APIs.
3746
4678
  # @return [String]
3747
4679
  #
3748
4680
  # @!attribute [rw] tags
@@ -3879,15 +4811,15 @@ module Aws::ApiGatewayV2
3879
4811
  # request parameters are a key-value map specifying parameters that
3880
4812
  # are passed to AWS\_PROXY integrations. You can provide static
3881
4813
  # values, or map request data, stage variables, or context variables
3882
- # that are evaluated at runtime. To learn more, see [Working with AWS
3883
- # service integrations for HTTP APIs][1].
4814
+ # that are evaluated at runtime. To learn more, see [Working with
4815
+ # Amazon Web Services service integrations for HTTP APIs][1].
3884
4816
  #
3885
4817
  # For HTTP API integrations without a specified integrationSubtype
3886
4818
  # request parameters are a key-value map specifying how to transform
3887
4819
  # HTTP requests before sending them to the backend. The key should
3888
4820
  # follow the pattern
3889
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
3890
- # where action can be append, overwrite or remove. For values, you can
4821
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
4822
+ # action can be append, overwrite or remove. For values, you can
3891
4823
  # provide static values, or map request data, stage variables, or
3892
4824
  # context variables that are evaluated at runtime. To learn more, see
3893
4825
  # [Transforming API requests and responses][2].
@@ -4006,15 +4938,15 @@ module Aws::ApiGatewayV2
4006
4938
  # request parameters are a key-value map specifying parameters that
4007
4939
  # are passed to AWS\_PROXY integrations. You can provide static
4008
4940
  # values, or map request data, stage variables, or context variables
4009
- # that are evaluated at runtime. To learn more, see [Working with AWS
4010
- # service integrations for HTTP APIs][1].
4941
+ # that are evaluated at runtime. To learn more, see [Working with
4942
+ # Amazon Web Services service integrations for HTTP APIs][1].
4011
4943
  #
4012
4944
  # For HTTP API integrations without a specified integrationSubtype
4013
4945
  # request parameters are a key-value map specifying how to transform
4014
4946
  # HTTP requests before sending them to the backend. The key should
4015
4947
  # follow the pattern
4016
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
4017
- # where action can be append, overwrite or remove. For values, you can
4948
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
4949
+ # action can be append, overwrite or remove. For values, you can
4018
4950
  # provide static values, or map request data, stage variables, or
4019
4951
  # context variables that are evaluated at runtime. To learn more, see
4020
4952
  # [Transforming API requests and responses][2].
@@ -4165,53 +5097,526 @@ module Aws::ApiGatewayV2
4165
5097
  # @!attribute [rw] api_id
4166
5098
  # @return [String]
4167
5099
  #
4168
- # @!attribute [rw] model_id
5100
+ # @!attribute [rw] model_id
5101
+ # @return [String]
5102
+ #
5103
+ class GetModelTemplateRequest < Struct.new(
5104
+ :api_id,
5105
+ :model_id)
5106
+ SENSITIVE = []
5107
+ include Aws::Structure
5108
+ end
5109
+
5110
+ # @!attribute [rw] value
5111
+ # @return [String]
5112
+ #
5113
+ class GetModelTemplateResponse < Struct.new(
5114
+ :value)
5115
+ SENSITIVE = []
5116
+ include Aws::Structure
5117
+ end
5118
+
5119
+ # @!attribute [rw] api_id
5120
+ # @return [String]
5121
+ #
5122
+ # @!attribute [rw] max_results
5123
+ # @return [String]
5124
+ #
5125
+ # @!attribute [rw] next_token
5126
+ # @return [String]
5127
+ #
5128
+ class GetModelsRequest < Struct.new(
5129
+ :api_id,
5130
+ :max_results,
5131
+ :next_token)
5132
+ SENSITIVE = []
5133
+ include Aws::Structure
5134
+ end
5135
+
5136
+ # @!attribute [rw] items
5137
+ # @return [Array<Types::Model>]
5138
+ #
5139
+ # @!attribute [rw] next_token
5140
+ # The next page of elements from this collection. Not valid for the
5141
+ # last element of the collection.
5142
+ # @return [String]
5143
+ #
5144
+ class GetModelsResponse < Struct.new(
5145
+ :items,
5146
+ :next_token)
5147
+ SENSITIVE = []
5148
+ include Aws::Structure
5149
+ end
5150
+
5151
+ # @!attribute [rw] portal_product_id
5152
+ # @return [String]
5153
+ #
5154
+ # @!attribute [rw] resource_owner_account_id
5155
+ # @return [String]
5156
+ #
5157
+ class GetPortalProductRequest < Struct.new(
5158
+ :portal_product_id,
5159
+ :resource_owner_account_id)
5160
+ SENSITIVE = []
5161
+ include Aws::Structure
5162
+ end
5163
+
5164
+ # @!attribute [rw] description
5165
+ # @return [String]
5166
+ #
5167
+ # @!attribute [rw] display_name
5168
+ # @return [String]
5169
+ #
5170
+ # @!attribute [rw] display_order
5171
+ # The display order.
5172
+ # @return [Types::DisplayOrder]
5173
+ #
5174
+ # @!attribute [rw] last_modified
5175
+ # @return [Time]
5176
+ #
5177
+ # @!attribute [rw] portal_product_arn
5178
+ # @return [String]
5179
+ #
5180
+ # @!attribute [rw] portal_product_id
5181
+ # @return [String]
5182
+ #
5183
+ # @!attribute [rw] tags
5184
+ # Represents a collection of tags associated with the resource.
5185
+ # @return [Hash<String,String>]
5186
+ #
5187
+ class GetPortalProductResponse < Struct.new(
5188
+ :description,
5189
+ :display_name,
5190
+ :display_order,
5191
+ :last_modified,
5192
+ :portal_product_arn,
5193
+ :portal_product_id,
5194
+ :tags)
5195
+ SENSITIVE = []
5196
+ include Aws::Structure
5197
+ end
5198
+
5199
+ # Gets a portal product.
5200
+ #
5201
+ # @!attribute [rw] description
5202
+ # The description of a portal product.
5203
+ # @return [String]
5204
+ #
5205
+ # @!attribute [rw] display_name
5206
+ # The display name.
5207
+ # @return [String]
5208
+ #
5209
+ # @!attribute [rw] display_order
5210
+ # The display order.
5211
+ # @return [Types::DisplayOrder]
5212
+ #
5213
+ # @!attribute [rw] last_modified
5214
+ # The timestamp when the portal product was last modified.
5215
+ # @return [Time]
5216
+ #
5217
+ # @!attribute [rw] portal_product_arn
5218
+ # The ARN of the portal product.
5219
+ # @return [String]
5220
+ #
5221
+ # @!attribute [rw] portal_product_id
5222
+ # The portal product identifier.
5223
+ # @return [String]
5224
+ #
5225
+ # @!attribute [rw] tags
5226
+ # The collection of tags. Each tag element is associated with a given
5227
+ # resource.
5228
+ # @return [Hash<String,String>]
5229
+ #
5230
+ class GetPortalProductResponseContent < Struct.new(
5231
+ :description,
5232
+ :display_name,
5233
+ :display_order,
5234
+ :last_modified,
5235
+ :portal_product_arn,
5236
+ :portal_product_id,
5237
+ :tags)
5238
+ SENSITIVE = []
5239
+ include Aws::Structure
5240
+ end
5241
+
5242
+ # @!attribute [rw] portal_product_id
5243
+ # @return [String]
5244
+ #
5245
+ class GetPortalProductSharingPolicyRequest < Struct.new(
5246
+ :portal_product_id)
5247
+ SENSITIVE = []
5248
+ include Aws::Structure
5249
+ end
5250
+
5251
+ # @!attribute [rw] policy_document
5252
+ # @return [String]
5253
+ #
5254
+ # @!attribute [rw] portal_product_id
5255
+ # @return [String]
5256
+ #
5257
+ class GetPortalProductSharingPolicyResponse < Struct.new(
5258
+ :policy_document,
5259
+ :portal_product_id)
5260
+ SENSITIVE = []
5261
+ include Aws::Structure
5262
+ end
5263
+
5264
+ # Gets a product sharing policy.
5265
+ #
5266
+ # @!attribute [rw] policy_document
5267
+ # The product sharing policy.
5268
+ # @return [String]
5269
+ #
5270
+ # @!attribute [rw] portal_product_id
5271
+ # The portal product identifier.
5272
+ # @return [String]
5273
+ #
5274
+ class GetPortalProductSharingPolicyResponseContent < Struct.new(
5275
+ :policy_document,
5276
+ :portal_product_id)
5277
+ SENSITIVE = []
5278
+ include Aws::Structure
5279
+ end
5280
+
5281
+ # @!attribute [rw] portal_id
5282
+ # @return [String]
5283
+ #
5284
+ class GetPortalRequest < Struct.new(
5285
+ :portal_id)
5286
+ SENSITIVE = []
5287
+ include Aws::Structure
5288
+ end
5289
+
5290
+ # @!attribute [rw] authorization
5291
+ # Represents an authorization configuration for a portal.
5292
+ # @return [Types::Authorization]
5293
+ #
5294
+ # @!attribute [rw] endpoint_configuration
5295
+ # Represents an endpoint configuration.
5296
+ # @return [Types::EndpointConfigurationResponse]
5297
+ #
5298
+ # @!attribute [rw] included_portal_product_arns
5299
+ # @return [Array<String>]
5300
+ #
5301
+ # @!attribute [rw] last_modified
5302
+ # @return [Time]
5303
+ #
5304
+ # @!attribute [rw] last_published
5305
+ # @return [Time]
5306
+ #
5307
+ # @!attribute [rw] last_published_description
5308
+ # @return [String]
5309
+ #
5310
+ # @!attribute [rw] portal_arn
5311
+ # @return [String]
5312
+ #
5313
+ # @!attribute [rw] portal_content
5314
+ # Contains the content that is visible to portal consumers including
5315
+ # the themes, display names, and description.
5316
+ # @return [Types::PortalContent]
5317
+ #
5318
+ # @!attribute [rw] portal_id
5319
+ # @return [String]
5320
+ #
5321
+ # @!attribute [rw] preview
5322
+ # Contains the preview status and preview URL.
5323
+ # @return [Types::Preview]
5324
+ #
5325
+ # @!attribute [rw] publish_status
5326
+ # Represents a publish status.
5327
+ # @return [String]
5328
+ #
5329
+ # @!attribute [rw] rum_app_monitor_name
5330
+ # @return [String]
5331
+ #
5332
+ # @!attribute [rw] status_exception
5333
+ # Represents a StatusException.
5334
+ # @return [Types::StatusException]
5335
+ #
5336
+ # @!attribute [rw] tags
5337
+ # Represents a collection of tags associated with the resource.
5338
+ # @return [Hash<String,String>]
5339
+ #
5340
+ class GetPortalResponse < Struct.new(
5341
+ :authorization,
5342
+ :endpoint_configuration,
5343
+ :included_portal_product_arns,
5344
+ :last_modified,
5345
+ :last_published,
5346
+ :last_published_description,
5347
+ :portal_arn,
5348
+ :portal_content,
5349
+ :portal_id,
5350
+ :preview,
5351
+ :publish_status,
5352
+ :rum_app_monitor_name,
5353
+ :status_exception,
5354
+ :tags)
5355
+ SENSITIVE = []
5356
+ include Aws::Structure
5357
+ end
5358
+
5359
+ # Gets a portal.
5360
+ #
5361
+ # @!attribute [rw] authorization
5362
+ # The authorization for the portal.
5363
+ # @return [Types::Authorization]
5364
+ #
5365
+ # @!attribute [rw] endpoint_configuration
5366
+ # The endpoint configuration.
5367
+ # @return [Types::EndpointConfigurationResponse]
5368
+ #
5369
+ # @!attribute [rw] included_portal_product_arns
5370
+ # The ARNs of the portal products included in the portal.
5371
+ # @return [Array<String>]
5372
+ #
5373
+ # @!attribute [rw] last_modified
5374
+ # The timestamp when the portal was last modified.
5375
+ # @return [Time]
5376
+ #
5377
+ # @!attribute [rw] last_published
5378
+ # The timestamp when the portal was last published.
5379
+ # @return [Time]
5380
+ #
5381
+ # @!attribute [rw] last_published_description
5382
+ # The publish description used when the portal was last published.
5383
+ # @return [String]
5384
+ #
5385
+ # @!attribute [rw] portal_arn
5386
+ # The ARN of the portal.
5387
+ # @return [String]
5388
+ #
5389
+ # @!attribute [rw] portal_content
5390
+ # Contains the content that is visible to portal consumers including
5391
+ # the themes, display names, and description.
5392
+ # @return [Types::PortalContent]
5393
+ #
5394
+ # @!attribute [rw] portal_id
5395
+ # The portal identifier.
5396
+ # @return [String]
5397
+ #
5398
+ # @!attribute [rw] preview
5399
+ # Represents the preview endpoint and the any possible error messages
5400
+ # during preview generation.
5401
+ # @return [Types::Preview]
5402
+ #
5403
+ # @!attribute [rw] publish_status
5404
+ # The publish status of a portal.
5405
+ # @return [String]
5406
+ #
5407
+ # @!attribute [rw] rum_app_monitor_name
5408
+ # The CloudWatch RUM app monitor name.
5409
+ # @return [String]
5410
+ #
5411
+ # @!attribute [rw] status_exception
5412
+ # The status exception information.
5413
+ # @return [Types::StatusException]
5414
+ #
5415
+ # @!attribute [rw] tags
5416
+ # The collection of tags. Each tag element is associated with a given
5417
+ # resource.
5418
+ # @return [Hash<String,String>]
5419
+ #
5420
+ class GetPortalResponseContent < Struct.new(
5421
+ :authorization,
5422
+ :endpoint_configuration,
5423
+ :included_portal_product_arns,
5424
+ :last_modified,
5425
+ :last_published,
5426
+ :last_published_description,
5427
+ :portal_arn,
5428
+ :portal_content,
5429
+ :portal_id,
5430
+ :preview,
5431
+ :publish_status,
5432
+ :rum_app_monitor_name,
5433
+ :status_exception,
5434
+ :tags)
5435
+ SENSITIVE = []
5436
+ include Aws::Structure
5437
+ end
5438
+
5439
+ # @!attribute [rw] portal_product_id
5440
+ # @return [String]
5441
+ #
5442
+ # @!attribute [rw] product_page_id
5443
+ # @return [String]
5444
+ #
5445
+ # @!attribute [rw] resource_owner_account_id
5446
+ # @return [String]
5447
+ #
5448
+ class GetProductPageRequest < Struct.new(
5449
+ :portal_product_id,
5450
+ :product_page_id,
5451
+ :resource_owner_account_id)
5452
+ SENSITIVE = []
5453
+ include Aws::Structure
5454
+ end
5455
+
5456
+ # @!attribute [rw] display_content
5457
+ # The content of the product page.
5458
+ # @return [Types::DisplayContent]
5459
+ #
5460
+ # @!attribute [rw] last_modified
5461
+ # @return [Time]
5462
+ #
5463
+ # @!attribute [rw] product_page_arn
5464
+ # @return [String]
5465
+ #
5466
+ # @!attribute [rw] product_page_id
5467
+ # @return [String]
5468
+ #
5469
+ class GetProductPageResponse < Struct.new(
5470
+ :display_content,
5471
+ :last_modified,
5472
+ :product_page_arn,
5473
+ :product_page_id)
5474
+ SENSITIVE = []
5475
+ include Aws::Structure
5476
+ end
5477
+
5478
+ # Gets a product page.
5479
+ #
5480
+ # @!attribute [rw] display_content
5481
+ # The content of the product page.
5482
+ # @return [Types::DisplayContent]
5483
+ #
5484
+ # @!attribute [rw] last_modified
5485
+ # The timestamp when the product page was last modified.
5486
+ # @return [Time]
5487
+ #
5488
+ # @!attribute [rw] product_page_arn
5489
+ # The ARN of the product page.
5490
+ # @return [String]
5491
+ #
5492
+ # @!attribute [rw] product_page_id
5493
+ # The product page identifier.
4169
5494
  # @return [String]
4170
5495
  #
4171
- class GetModelTemplateRequest < Struct.new(
4172
- :api_id,
4173
- :model_id)
5496
+ class GetProductPageResponseContent < Struct.new(
5497
+ :display_content,
5498
+ :last_modified,
5499
+ :product_page_arn,
5500
+ :product_page_id)
4174
5501
  SENSITIVE = []
4175
5502
  include Aws::Structure
4176
5503
  end
4177
5504
 
4178
- # @!attribute [rw] value
5505
+ # @!attribute [rw] include_raw_display_content
4179
5506
  # @return [String]
4180
5507
  #
4181
- class GetModelTemplateResponse < Struct.new(
4182
- :value)
5508
+ # @!attribute [rw] portal_product_id
5509
+ # @return [String]
5510
+ #
5511
+ # @!attribute [rw] product_rest_endpoint_page_id
5512
+ # @return [String]
5513
+ #
5514
+ # @!attribute [rw] resource_owner_account_id
5515
+ # @return [String]
5516
+ #
5517
+ class GetProductRestEndpointPageRequest < Struct.new(
5518
+ :include_raw_display_content,
5519
+ :portal_product_id,
5520
+ :product_rest_endpoint_page_id,
5521
+ :resource_owner_account_id)
4183
5522
  SENSITIVE = []
4184
5523
  include Aws::Structure
4185
5524
  end
4186
5525
 
4187
- # @!attribute [rw] api_id
5526
+ # @!attribute [rw] display_content
5527
+ # The product REST endpoint page.
5528
+ # @return [Types::EndpointDisplayContentResponse]
5529
+ #
5530
+ # @!attribute [rw] last_modified
5531
+ # @return [Time]
5532
+ #
5533
+ # @!attribute [rw] product_rest_endpoint_page_arn
4188
5534
  # @return [String]
4189
5535
  #
4190
- # @!attribute [rw] max_results
5536
+ # @!attribute [rw] product_rest_endpoint_page_id
4191
5537
  # @return [String]
4192
5538
  #
4193
- # @!attribute [rw] next_token
5539
+ # @!attribute [rw] raw_display_content
4194
5540
  # @return [String]
4195
5541
  #
4196
- class GetModelsRequest < Struct.new(
4197
- :api_id,
4198
- :max_results,
4199
- :next_token)
5542
+ # @!attribute [rw] rest_endpoint_identifier
5543
+ # The REST API endpoint identifier.
5544
+ # @return [Types::RestEndpointIdentifier]
5545
+ #
5546
+ # @!attribute [rw] status
5547
+ # The status.
5548
+ # @return [String]
5549
+ #
5550
+ # @!attribute [rw] status_exception
5551
+ # Represents a StatusException.
5552
+ # @return [Types::StatusException]
5553
+ #
5554
+ # @!attribute [rw] try_it_state
5555
+ # Represents the try it state for a product REST endpoint page.
5556
+ # @return [String]
5557
+ #
5558
+ class GetProductRestEndpointPageResponse < Struct.new(
5559
+ :display_content,
5560
+ :last_modified,
5561
+ :product_rest_endpoint_page_arn,
5562
+ :product_rest_endpoint_page_id,
5563
+ :raw_display_content,
5564
+ :rest_endpoint_identifier,
5565
+ :status,
5566
+ :status_exception,
5567
+ :try_it_state)
4200
5568
  SENSITIVE = []
4201
5569
  include Aws::Structure
4202
5570
  end
4203
5571
 
4204
- # @!attribute [rw] items
4205
- # @return [Array<Types::Model>]
5572
+ # Gets a product REST endpoint page.
4206
5573
  #
4207
- # @!attribute [rw] next_token
4208
- # The next page of elements from this collection. Not valid for the
4209
- # last element of the collection.
5574
+ # @!attribute [rw] display_content
5575
+ # The content of the product REST endpoint page.
5576
+ # @return [Types::EndpointDisplayContentResponse]
5577
+ #
5578
+ # @!attribute [rw] last_modified
5579
+ # The timestamp when the product REST endpoint page was last modified.
5580
+ # @return [Time]
5581
+ #
5582
+ # @!attribute [rw] product_rest_endpoint_page_arn
5583
+ # The ARN of the product REST endpoint page.
4210
5584
  # @return [String]
4211
5585
  #
4212
- class GetModelsResponse < Struct.new(
4213
- :items,
4214
- :next_token)
5586
+ # @!attribute [rw] product_rest_endpoint_page_id
5587
+ # The product REST endpoint page identifier.
5588
+ # @return [String]
5589
+ #
5590
+ # @!attribute [rw] raw_display_content
5591
+ # The raw display content of the product REST endpoint page.
5592
+ # @return [String]
5593
+ #
5594
+ # @!attribute [rw] rest_endpoint_identifier
5595
+ # The REST endpoint identifier.
5596
+ # @return [Types::RestEndpointIdentifier]
5597
+ #
5598
+ # @!attribute [rw] status
5599
+ # The status of the product REST endpoint page.
5600
+ # @return [String]
5601
+ #
5602
+ # @!attribute [rw] status_exception
5603
+ # The status exception information.
5604
+ # @return [Types::StatusException]
5605
+ #
5606
+ # @!attribute [rw] try_it_state
5607
+ # The try it state.
5608
+ # @return [String]
5609
+ #
5610
+ class GetProductRestEndpointPageResponseContent < Struct.new(
5611
+ :display_content,
5612
+ :last_modified,
5613
+ :product_rest_endpoint_page_arn,
5614
+ :product_rest_endpoint_page_id,
5615
+ :raw_display_content,
5616
+ :rest_endpoint_identifier,
5617
+ :status,
5618
+ :status_exception,
5619
+ :try_it_state)
4215
5620
  SENSITIVE = []
4216
5621
  include Aws::Structure
4217
5622
  end
@@ -4249,10 +5654,11 @@ module Aws::ApiGatewayV2
4249
5654
  #
4250
5655
  # @!attribute [rw] authorization_type
4251
5656
  # The authorization type. For WebSocket APIs, valid values are NONE
4252
- # for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
4253
- # for using a Lambda authorizer. For HTTP APIs, valid values are NONE
4254
- # for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
4255
- # AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
5657
+ # for open access, AWS\_IAM for using Amazon Web Services IAM
5658
+ # permissions, and CUSTOM for using a Lambda authorizer. For HTTP
5659
+ # APIs, valid values are NONE for open access, JWT for using JSON Web
5660
+ # Tokens, AWS\_IAM for using Amazon Web Services IAM permissions, and
5661
+ # CUSTOM for using a Lambda authorizer.
4256
5662
  # @return [String]
4257
5663
  #
4258
5664
  # @!attribute [rw] authorizer_id
@@ -4490,7 +5896,9 @@ module Aws::ApiGatewayV2
4490
5896
  # @return [Array<Types::RoutingRuleCondition>]
4491
5897
  #
4492
5898
  # @!attribute [rw] priority
4493
- # Represents the priority of the routing rule.
5899
+ # The order in which API Gateway evaluates a rule. Priority is
5900
+ # evaluated from the lowest value to the highest value. Rules can't
5901
+ # have the same priority. Priority values 1-1,000,000 are supported.
4494
5902
  # @return [Integer]
4495
5903
  #
4496
5904
  # @!attribute [rw] routing_rule_arn
@@ -4754,6 +6162,33 @@ module Aws::ApiGatewayV2
4754
6162
  include Aws::Structure
4755
6163
  end
4756
6164
 
6165
+ # The identifier parts of a product REST endpoint.
6166
+ #
6167
+ # @!attribute [rw] method
6168
+ # The method of the product REST endpoint.
6169
+ # @return [String]
6170
+ #
6171
+ # @!attribute [rw] path
6172
+ # The path of the product REST endpoint.
6173
+ # @return [String]
6174
+ #
6175
+ # @!attribute [rw] rest_api_id
6176
+ # The REST API ID of the product REST endpoint.
6177
+ # @return [String]
6178
+ #
6179
+ # @!attribute [rw] stage
6180
+ # The stage of the product REST endpoint.
6181
+ # @return [String]
6182
+ #
6183
+ class IdentifierParts < Struct.new(
6184
+ :method,
6185
+ :path,
6186
+ :rest_api_id,
6187
+ :stage)
6188
+ SENSITIVE = []
6189
+ include Aws::Structure
6190
+ end
6191
+
4757
6192
  # Represents the input to ImportAPI. Supported only for HTTP APIs.
4758
6193
  #
4759
6194
  # @!attribute [rw] body
@@ -4921,11 +6356,13 @@ module Aws::ApiGatewayV2
4921
6356
  #
4922
6357
  # @!attribute [rw] credentials_arn
4923
6358
  # Specifies the credentials required for the integration, if any. For
4924
- # AWS integrations, three options are available. To specify an IAM
4925
- # Role for API Gateway to assume, use the role's Amazon Resource Name
4926
- # (ARN). To require that the caller's identity be passed through from
4927
- # the request, specify the string arn:aws:iam::*:user/*. To use
4928
- # resource-based permissions on supported AWS services, specify null.
6359
+ # Amazon Web Services integrations, three options are available. To
6360
+ # specify an IAM Role for API Gateway to assume, use the role's
6361
+ # Amazon Resource Name (ARN). To require that the caller's identity
6362
+ # be passed through from the request, specify the string
6363
+ # arn:aws:iam::*:user/*. To use resource-based permissions on
6364
+ # supported Amazon Web Services services, don't specify this
6365
+ # parameter.
4929
6366
  # @return [String]
4930
6367
  #
4931
6368
  # @!attribute [rw] description
@@ -4952,8 +6389,8 @@ module Aws::ApiGatewayV2
4952
6389
  #
4953
6390
  # @!attribute [rw] integration_subtype
4954
6391
  # Supported only for HTTP API AWS\_PROXY integrations. Specifies the
4955
- # AWS service action to invoke. To learn more, see [Integration
4956
- # subtype reference][1].
6392
+ # Amazon Web Services service action to invoke. To learn more, see
6393
+ # [Integration subtype reference][1].
4957
6394
  #
4958
6395
  #
4959
6396
  #
@@ -4963,15 +6400,16 @@ module Aws::ApiGatewayV2
4963
6400
  # @!attribute [rw] integration_type
4964
6401
  # The integration type of an integration. One of the following:
4965
6402
  #
4966
- # AWS: for integrating the route or method request with an AWS service
4967
- # action, including the Lambda function-invoking action. With the
4968
- # Lambda function-invoking action, this is referred to as the Lambda
4969
- # custom integration. With any other AWS service action, this is known
4970
- # as AWS integration. Supported only for WebSocket APIs.
6403
+ # AWS: for integrating the route or method request with an Amazon Web
6404
+ # Services service action, including the Lambda function-invoking
6405
+ # action. With the Lambda function-invoking action, this is referred
6406
+ # to as the Lambda custom integration. With any other Amazon Web
6407
+ # Services service action, this is known as Amazon Web Services
6408
+ # integration. Supported only for WebSocket APIs.
4971
6409
  #
4972
6410
  # AWS\_PROXY: for integrating the route or method request with a
4973
- # Lambda function or other AWS service action. This integration is
4974
- # also referred to as a Lambda proxy integration.
6411
+ # Lambda function or other Amazon Web Services service action. This
6412
+ # integration is also referred to as a Lambda proxy integration.
4975
6413
  #
4976
6414
  # HTTP: for integrating the route or method request with an HTTP
4977
6415
  # endpoint. This integration is also referred to as the HTTP custom
@@ -4993,11 +6431,12 @@ module Aws::ApiGatewayV2
4993
6431
  #
4994
6432
  # For an HTTP API private integration, specify the ARN of an
4995
6433
  # Application Load Balancer listener, Network Load Balancer listener,
4996
- # or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map
4997
- # service, API Gateway uses DiscoverInstances to identify resources.
4998
- # You can use query parameters to target specific resources. To learn
4999
- # more, see [DiscoverInstances][1]. For private integrations, all
5000
- # resources must be owned by the same AWS account.
6434
+ # or Amazon Web Services Cloud Map service. If you specify the ARN of
6435
+ # an Amazon Web Services Cloud Map service, API Gateway uses
6436
+ # DiscoverInstances to identify resources. You can use query
6437
+ # parameters to target specific resources. To learn more, see
6438
+ # [DiscoverInstances][1]. For private integrations, all resources must
6439
+ # be owned by the same Amazon Web Services account.
5001
6440
  #
5002
6441
  #
5003
6442
  #
@@ -5025,7 +6464,14 @@ module Aws::ApiGatewayV2
5025
6464
  #
5026
6465
  # @!attribute [rw] payload_format_version
5027
6466
  # Specifies the format of the payload sent to an integration. Required
5028
- # for HTTP APIs.
6467
+ # for HTTP APIs. For HTTP APIs, supported values for Lambda proxy
6468
+ # integrations are 1.0 and 2.0. For all other integrations, 1.0 is the
6469
+ # only supported value. To learn more, see [Working with Amazon Web
6470
+ # Services Lambda proxy integrations for HTTP APIs][1].
6471
+ #
6472
+ #
6473
+ #
6474
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
5029
6475
  # @return [String]
5030
6476
  #
5031
6477
  # @!attribute [rw] request_parameters
@@ -5043,17 +6489,17 @@ module Aws::ApiGatewayV2
5043
6489
  # request parameters are a key-value map specifying parameters that
5044
6490
  # are passed to AWS\_PROXY integrations. You can provide static
5045
6491
  # values, or map request data, stage variables, or context variables
5046
- # that are evaluated at runtime. To learn more, see [Working with AWS
5047
- # service integrations for HTTP APIs][1].
6492
+ # that are evaluated at runtime. To learn more, see [Working with
6493
+ # Amazon Web Services service integrations for HTTP APIs][1].
5048
6494
  #
5049
- # For HTTP API itegrations, without a specified integrationSubtype
6495
+ # For HTTP API integrations without a specified integrationSubtype
5050
6496
  # request parameters are a key-value map specifying how to transform
5051
6497
  # HTTP requests before sending them to backend integrations. The key
5052
6498
  # should follow the pattern
5053
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;.
5054
- # The action can be append, overwrite or remove. For values, you can
5055
- # provide static values, or map request data, stage variables, or
5056
- # context variables that are evaluated at runtime. To learn more, see
6499
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location>. The action
6500
+ # can be append, overwrite or remove. For values, you can provide
6501
+ # static values, or map request data, stage variables, or context
6502
+ # variables that are evaluated at runtime. To learn more, see
5057
6503
  # [Transforming API requests and responses][2].
5058
6504
  #
5059
6505
  #
@@ -5068,12 +6514,12 @@ module Aws::ApiGatewayV2
5068
6514
  # returning the response to clients. Specify a key-value map from a
5069
6515
  # selection key to response parameters. The selection key must be a
5070
6516
  # valid HTTP status code within the range of 200-599. Response
5071
- # parameters are a key-value map. The key must match pattern
5072
- # &lt;action&gt;:&lt;header&gt;.&lt;location&gt; or
5073
- # overwrite.statuscode. The action can be append, overwrite or remove.
5074
- # The value can be a static value, or map to response data, stage
5075
- # variables, or context variables that are evaluated at runtime. To
5076
- # learn more, see [Transforming API requests and responses][1].
6517
+ # parameters are a key-value map. The key must match the pattern
6518
+ # &lt;action>:&lt;header>.&lt;location> or overwrite.statuscode. The
6519
+ # action can be append, overwrite or remove. The value can be a static
6520
+ # value, or map to response data, stage variables, or context
6521
+ # variables that are evaluated at runtime. To learn more, see
6522
+ # [Transforming API requests and responses][1].
5077
6523
  #
5078
6524
  #
5079
6525
  #
@@ -5237,7 +6683,8 @@ module Aws::ApiGatewayV2
5237
6683
  # @!attribute [rw] audience
5238
6684
  # A list of the intended recipients of the JWT. A valid JWT must
5239
6685
  # provide an aud that matches at least one entry in this list. See
5240
- # [RFC 7519][1]. Supported only for HTTP APIs.
6686
+ # [RFC 7519][1]. Required for the JWT authorizer type. Supported only
6687
+ # for HTTP APIs.
5241
6688
  #
5242
6689
  #
5243
6690
  #
@@ -5259,20 +6706,233 @@ module Aws::ApiGatewayV2
5259
6706
  include Aws::Structure
5260
6707
  end
5261
6708
 
5262
- # A limit has been exceeded. See the accompanying error message for
5263
- # details.
6709
+ # A limit has been exceeded. See the accompanying error message for
6710
+ # details.
6711
+ #
6712
+ # @!attribute [rw] limit_type
6713
+ # The limit type.
6714
+ # @return [String]
6715
+ #
6716
+ # @!attribute [rw] message
6717
+ # Describes the error encountered.
6718
+ # @return [String]
6719
+ #
6720
+ class LimitExceededException < Struct.new(
6721
+ :limit_type,
6722
+ :message)
6723
+ SENSITIVE = []
6724
+ include Aws::Structure
6725
+ end
6726
+
6727
+ # The response content for limit exceeded exception.
6728
+ #
6729
+ # @!attribute [rw] limit_type
6730
+ # The limit type of the limit exceeded exception response content.
6731
+ # @return [String]
6732
+ #
6733
+ # @!attribute [rw] message
6734
+ # The message of the limit exceeded exception response content.
6735
+ # @return [String]
6736
+ #
6737
+ class LimitExceededExceptionResponseContent < Struct.new(
6738
+ :limit_type,
6739
+ :message)
6740
+ SENSITIVE = []
6741
+ include Aws::Structure
6742
+ end
6743
+
6744
+ # @!attribute [rw] max_results
6745
+ # @return [String]
6746
+ #
6747
+ # @!attribute [rw] next_token
6748
+ # @return [String]
6749
+ #
6750
+ # @!attribute [rw] resource_owner
6751
+ # @return [String]
6752
+ #
6753
+ class ListPortalProductsRequest < Struct.new(
6754
+ :max_results,
6755
+ :next_token,
6756
+ :resource_owner)
6757
+ SENSITIVE = []
6758
+ include Aws::Structure
6759
+ end
6760
+
6761
+ # @!attribute [rw] items
6762
+ # @return [Array<Types::PortalProductSummary>]
6763
+ #
6764
+ # @!attribute [rw] next_token
6765
+ # @return [String]
6766
+ #
6767
+ class ListPortalProductsResponse < Struct.new(
6768
+ :items,
6769
+ :next_token)
6770
+ SENSITIVE = []
6771
+ include Aws::Structure
6772
+ end
6773
+
6774
+ # Lists portal products.
6775
+ #
6776
+ # @!attribute [rw] items
6777
+ # The elements from this collection.
6778
+ # @return [Array<Types::PortalProductSummary>]
6779
+ #
6780
+ # @!attribute [rw] next_token
6781
+ # The next page of elements from this collection. Not valid for the
6782
+ # last element of the collection.
6783
+ # @return [String]
6784
+ #
6785
+ class ListPortalProductsResponseContent < Struct.new(
6786
+ :items,
6787
+ :next_token)
6788
+ SENSITIVE = []
6789
+ include Aws::Structure
6790
+ end
6791
+
6792
+ # @!attribute [rw] max_results
6793
+ # @return [String]
6794
+ #
6795
+ # @!attribute [rw] next_token
6796
+ # @return [String]
6797
+ #
6798
+ class ListPortalsRequest < Struct.new(
6799
+ :max_results,
6800
+ :next_token)
6801
+ SENSITIVE = []
6802
+ include Aws::Structure
6803
+ end
6804
+
6805
+ # @!attribute [rw] items
6806
+ # @return [Array<Types::PortalSummary>]
6807
+ #
6808
+ # @!attribute [rw] next_token
6809
+ # @return [String]
6810
+ #
6811
+ class ListPortalsResponse < Struct.new(
6812
+ :items,
6813
+ :next_token)
6814
+ SENSITIVE = []
6815
+ include Aws::Structure
6816
+ end
6817
+
6818
+ # Lists portals.
6819
+ #
6820
+ # @!attribute [rw] items
6821
+ # The elements from this collection.
6822
+ # @return [Array<Types::PortalSummary>]
6823
+ #
6824
+ # @!attribute [rw] next_token
6825
+ # The next page of elements from this collection. Not valid for the
6826
+ # last element of the collection.
6827
+ # @return [String]
6828
+ #
6829
+ class ListPortalsResponseContent < Struct.new(
6830
+ :items,
6831
+ :next_token)
6832
+ SENSITIVE = []
6833
+ include Aws::Structure
6834
+ end
6835
+
6836
+ # @!attribute [rw] max_results
6837
+ # @return [String]
6838
+ #
6839
+ # @!attribute [rw] next_token
6840
+ # @return [String]
6841
+ #
6842
+ # @!attribute [rw] portal_product_id
6843
+ # @return [String]
6844
+ #
6845
+ # @!attribute [rw] resource_owner_account_id
6846
+ # @return [String]
6847
+ #
6848
+ class ListProductPagesRequest < Struct.new(
6849
+ :max_results,
6850
+ :next_token,
6851
+ :portal_product_id,
6852
+ :resource_owner_account_id)
6853
+ SENSITIVE = []
6854
+ include Aws::Structure
6855
+ end
6856
+
6857
+ # @!attribute [rw] items
6858
+ # @return [Array<Types::ProductPageSummaryNoBody>]
6859
+ #
6860
+ # @!attribute [rw] next_token
6861
+ # @return [String]
6862
+ #
6863
+ class ListProductPagesResponse < Struct.new(
6864
+ :items,
6865
+ :next_token)
6866
+ SENSITIVE = []
6867
+ include Aws::Structure
6868
+ end
6869
+
6870
+ # Lists product pages.
6871
+ #
6872
+ # @!attribute [rw] items
6873
+ # The elements from this collection.
6874
+ # @return [Array<Types::ProductPageSummaryNoBody>]
6875
+ #
6876
+ # @!attribute [rw] next_token
6877
+ # The next page of elements from this collection. Not valid for the
6878
+ # last element of the collection.
6879
+ # @return [String]
6880
+ #
6881
+ class ListProductPagesResponseContent < Struct.new(
6882
+ :items,
6883
+ :next_token)
6884
+ SENSITIVE = []
6885
+ include Aws::Structure
6886
+ end
6887
+
6888
+ # @!attribute [rw] max_results
6889
+ # @return [String]
6890
+ #
6891
+ # @!attribute [rw] next_token
6892
+ # @return [String]
6893
+ #
6894
+ # @!attribute [rw] portal_product_id
6895
+ # @return [String]
6896
+ #
6897
+ # @!attribute [rw] resource_owner_account_id
6898
+ # @return [String]
6899
+ #
6900
+ class ListProductRestEndpointPagesRequest < Struct.new(
6901
+ :max_results,
6902
+ :next_token,
6903
+ :portal_product_id,
6904
+ :resource_owner_account_id)
6905
+ SENSITIVE = []
6906
+ include Aws::Structure
6907
+ end
6908
+
6909
+ # @!attribute [rw] items
6910
+ # @return [Array<Types::ProductRestEndpointPageSummaryNoBody>]
6911
+ #
6912
+ # @!attribute [rw] next_token
6913
+ # @return [String]
6914
+ #
6915
+ class ListProductRestEndpointPagesResponse < Struct.new(
6916
+ :items,
6917
+ :next_token)
6918
+ SENSITIVE = []
6919
+ include Aws::Structure
6920
+ end
6921
+
6922
+ # Lists the product rest endpoint pages in a portal product.
5264
6923
  #
5265
- # @!attribute [rw] limit_type
5266
- # The limit type.
5267
- # @return [String]
6924
+ # @!attribute [rw] items
6925
+ # The elements from this collection.
6926
+ # @return [Array<Types::ProductRestEndpointPageSummaryNoBody>]
5268
6927
  #
5269
- # @!attribute [rw] message
5270
- # Describes the error encountered.
6928
+ # @!attribute [rw] next_token
6929
+ # The next page of elements from this collection. Not valid for the
6930
+ # last element of the collection.
5271
6931
  # @return [String]
5272
6932
  #
5273
- class LimitExceededException < Struct.new(
5274
- :limit_type,
5275
- :message)
6933
+ class ListProductRestEndpointPagesResponseContent < Struct.new(
6934
+ :items,
6935
+ :next_token)
5276
6936
  SENSITIVE = []
5277
6937
  include Aws::Structure
5278
6938
  end
@@ -5402,6 +7062,12 @@ module Aws::ApiGatewayV2
5402
7062
  include Aws::Structure
5403
7063
  end
5404
7064
 
7065
+ # The none option.
7066
+ #
7067
+ # @api private
7068
+ #
7069
+ class None < Aws::EmptyStructure; end
7070
+
5405
7071
  # The resource specified in the request was not found. See the message
5406
7072
  # field for more information.
5407
7073
  #
@@ -5420,6 +7086,23 @@ module Aws::ApiGatewayV2
5420
7086
  include Aws::Structure
5421
7087
  end
5422
7088
 
7089
+ # The response content for not found exception.
7090
+ #
7091
+ # @!attribute [rw] message
7092
+ # The message of the not found exception response content.
7093
+ # @return [String]
7094
+ #
7095
+ # @!attribute [rw] resource_type
7096
+ # The resource type of the not found exception response content.
7097
+ # @return [String]
7098
+ #
7099
+ class NotFoundExceptionResponseContent < Struct.new(
7100
+ :message,
7101
+ :resource_type)
7102
+ SENSITIVE = []
7103
+ include Aws::Structure
7104
+ end
7105
+
5423
7106
  # Validation constraints imposed on parameters of a request (path, query
5424
7107
  # string, headers).
5425
7108
  #
@@ -5433,6 +7116,332 @@ module Aws::ApiGatewayV2
5433
7116
  include Aws::Structure
5434
7117
  end
5435
7118
 
7119
+ # Contains the content that is visible to portal consumers including the
7120
+ # themes, display names, and description.
7121
+ #
7122
+ # @!attribute [rw] description
7123
+ # A description of the portal.
7124
+ # @return [String]
7125
+ #
7126
+ # @!attribute [rw] display_name
7127
+ # The display name for the portal.
7128
+ # @return [String]
7129
+ #
7130
+ # @!attribute [rw] theme
7131
+ # The theme for the portal.
7132
+ # @return [Types::PortalTheme]
7133
+ #
7134
+ class PortalContent < Struct.new(
7135
+ :description,
7136
+ :display_name,
7137
+ :theme)
7138
+ SENSITIVE = []
7139
+ include Aws::Structure
7140
+ end
7141
+
7142
+ # Represents a portal product.
7143
+ #
7144
+ # @!attribute [rw] description
7145
+ # The description.
7146
+ # @return [String]
7147
+ #
7148
+ # @!attribute [rw] display_name
7149
+ # The display name of a portal product.
7150
+ # @return [String]
7151
+ #
7152
+ # @!attribute [rw] last_modified
7153
+ # The timestamp when the portal product was last modified.
7154
+ # @return [Time]
7155
+ #
7156
+ # @!attribute [rw] portal_product_arn
7157
+ # The ARN of a portal product.
7158
+ # @return [String]
7159
+ #
7160
+ # @!attribute [rw] portal_product_id
7161
+ # The portal product identifier.
7162
+ # @return [String]
7163
+ #
7164
+ # @!attribute [rw] tags
7165
+ # The collection of tags. Each tag element is associated with a given
7166
+ # resource.
7167
+ # @return [Hash<String,String>]
7168
+ #
7169
+ class PortalProductSummary < Struct.new(
7170
+ :description,
7171
+ :display_name,
7172
+ :last_modified,
7173
+ :portal_product_arn,
7174
+ :portal_product_id,
7175
+ :tags)
7176
+ SENSITIVE = []
7177
+ include Aws::Structure
7178
+ end
7179
+
7180
+ # Represents a portal summary.
7181
+ #
7182
+ # @!attribute [rw] authorization
7183
+ # The authorization of the portal.
7184
+ # @return [Types::Authorization]
7185
+ #
7186
+ # @!attribute [rw] endpoint_configuration
7187
+ # The endpoint configuration of the portal.
7188
+ # @return [Types::EndpointConfigurationResponse]
7189
+ #
7190
+ # @!attribute [rw] included_portal_product_arns
7191
+ # The ARNs of the portal products included in the portal.
7192
+ # @return [Array<String>]
7193
+ #
7194
+ # @!attribute [rw] last_modified
7195
+ # The timestamp when the portal was last modified.
7196
+ # @return [Time]
7197
+ #
7198
+ # @!attribute [rw] last_published
7199
+ # The timestamp when the portal was last published.
7200
+ # @return [Time]
7201
+ #
7202
+ # @!attribute [rw] last_published_description
7203
+ # The description of the portal the last time it was published.
7204
+ # @return [String]
7205
+ #
7206
+ # @!attribute [rw] portal_arn
7207
+ # The ARN of the portal.
7208
+ # @return [String]
7209
+ #
7210
+ # @!attribute [rw] portal_content
7211
+ # Contains the content that is visible to portal consumers including
7212
+ # the themes, display names, and description.
7213
+ # @return [Types::PortalContent]
7214
+ #
7215
+ # @!attribute [rw] portal_id
7216
+ # The portal identifier.
7217
+ # @return [String]
7218
+ #
7219
+ # @!attribute [rw] preview
7220
+ # Represents the preview endpoint and the any possible error messages
7221
+ # during preview generation.
7222
+ # @return [Types::Preview]
7223
+ #
7224
+ # @!attribute [rw] publish_status
7225
+ # The publish status.
7226
+ # @return [String]
7227
+ #
7228
+ # @!attribute [rw] rum_app_monitor_name
7229
+ # The CloudWatch RUM app monitor name.
7230
+ # @return [String]
7231
+ #
7232
+ # @!attribute [rw] status_exception
7233
+ # The status exception information.
7234
+ # @return [Types::StatusException]
7235
+ #
7236
+ # @!attribute [rw] tags
7237
+ # The collection of tags. Each tag element is associated with a given
7238
+ # resource.
7239
+ # @return [Hash<String,String>]
7240
+ #
7241
+ class PortalSummary < Struct.new(
7242
+ :authorization,
7243
+ :endpoint_configuration,
7244
+ :included_portal_product_arns,
7245
+ :last_modified,
7246
+ :last_published,
7247
+ :last_published_description,
7248
+ :portal_arn,
7249
+ :portal_content,
7250
+ :portal_id,
7251
+ :preview,
7252
+ :publish_status,
7253
+ :rum_app_monitor_name,
7254
+ :status_exception,
7255
+ :tags)
7256
+ SENSITIVE = []
7257
+ include Aws::Structure
7258
+ end
7259
+
7260
+ # Defines the theme for a portal.
7261
+ #
7262
+ # @!attribute [rw] custom_colors
7263
+ # Defines custom color values.
7264
+ # @return [Types::CustomColors]
7265
+ #
7266
+ # @!attribute [rw] logo_last_uploaded
7267
+ # The timestamp when the logo was last uploaded.
7268
+ # @return [Time]
7269
+ #
7270
+ class PortalTheme < Struct.new(
7271
+ :custom_colors,
7272
+ :logo_last_uploaded)
7273
+ SENSITIVE = []
7274
+ include Aws::Structure
7275
+ end
7276
+
7277
+ # Contains the preview status and preview URL.
7278
+ #
7279
+ # @!attribute [rw] preview_status
7280
+ # The status of the preview.
7281
+ # @return [String]
7282
+ #
7283
+ # @!attribute [rw] preview_url
7284
+ # The URL of the preview.
7285
+ # @return [String]
7286
+ #
7287
+ # @!attribute [rw] status_exception
7288
+ # The status exception information.
7289
+ # @return [Types::StatusException]
7290
+ #
7291
+ class Preview < Struct.new(
7292
+ :preview_status,
7293
+ :preview_url,
7294
+ :status_exception)
7295
+ SENSITIVE = []
7296
+ include Aws::Structure
7297
+ end
7298
+
7299
+ # @!attribute [rw] portal_id
7300
+ # @return [String]
7301
+ #
7302
+ class PreviewPortalRequest < Struct.new(
7303
+ :portal_id)
7304
+ SENSITIVE = []
7305
+ include Aws::Structure
7306
+ end
7307
+
7308
+ class PreviewPortalResponse < Aws::EmptyStructure; end
7309
+
7310
+ # Represents a product page summary without listing any page content.
7311
+ #
7312
+ # @!attribute [rw] last_modified
7313
+ # The timestamp when the product page was last modified.
7314
+ # @return [Time]
7315
+ #
7316
+ # @!attribute [rw] page_title
7317
+ # The page title.
7318
+ # @return [String]
7319
+ #
7320
+ # @!attribute [rw] product_page_arn
7321
+ # The ARN of the product page.
7322
+ # @return [String]
7323
+ #
7324
+ # @!attribute [rw] product_page_id
7325
+ # The product page identifier.
7326
+ # @return [String]
7327
+ #
7328
+ class ProductPageSummaryNoBody < Struct.new(
7329
+ :last_modified,
7330
+ :page_title,
7331
+ :product_page_arn,
7332
+ :product_page_id)
7333
+ SENSITIVE = []
7334
+ include Aws::Structure
7335
+ end
7336
+
7337
+ # A summary of a product REST endpoint page, without providing the page
7338
+ # content.
7339
+ #
7340
+ # @!attribute [rw] endpoint
7341
+ # The endpoint of the product REST endpoint page.
7342
+ # @return [String]
7343
+ #
7344
+ # @!attribute [rw] last_modified
7345
+ # The timestamp when the product REST endpoint page was last modified.
7346
+ # @return [Time]
7347
+ #
7348
+ # @!attribute [rw] operation_name
7349
+ # The operation name of the product REST endpoint.
7350
+ # @return [String]
7351
+ #
7352
+ # @!attribute [rw] product_rest_endpoint_page_arn
7353
+ # The ARN of the product REST endpoint page.
7354
+ # @return [String]
7355
+ #
7356
+ # @!attribute [rw] product_rest_endpoint_page_id
7357
+ # The product REST endpoint page identifier.
7358
+ # @return [String]
7359
+ #
7360
+ # @!attribute [rw] rest_endpoint_identifier
7361
+ # The REST endpoint identifier.
7362
+ # @return [Types::RestEndpointIdentifier]
7363
+ #
7364
+ # @!attribute [rw] status
7365
+ # The status.
7366
+ # @return [String]
7367
+ #
7368
+ # @!attribute [rw] status_exception
7369
+ # The status exception information.
7370
+ # @return [Types::StatusException]
7371
+ #
7372
+ # @!attribute [rw] try_it_state
7373
+ # The try it state of a product REST endpoint page.
7374
+ # @return [String]
7375
+ #
7376
+ class ProductRestEndpointPageSummaryNoBody < Struct.new(
7377
+ :endpoint,
7378
+ :last_modified,
7379
+ :operation_name,
7380
+ :product_rest_endpoint_page_arn,
7381
+ :product_rest_endpoint_page_id,
7382
+ :rest_endpoint_identifier,
7383
+ :status,
7384
+ :status_exception,
7385
+ :try_it_state)
7386
+ SENSITIVE = []
7387
+ include Aws::Structure
7388
+ end
7389
+
7390
+ # @!attribute [rw] description
7391
+ # @return [String]
7392
+ #
7393
+ # @!attribute [rw] portal_id
7394
+ # @return [String]
7395
+ #
7396
+ class PublishPortalRequest < Struct.new(
7397
+ :description,
7398
+ :portal_id)
7399
+ SENSITIVE = []
7400
+ include Aws::Structure
7401
+ end
7402
+
7403
+ # Publish a portal.
7404
+ #
7405
+ # @!attribute [rw] description
7406
+ # The description of the portal. When the portal is published, this
7407
+ # description becomes the last published description.
7408
+ # @return [String]
7409
+ #
7410
+ class PublishPortalRequestContent < Struct.new(
7411
+ :description)
7412
+ SENSITIVE = []
7413
+ include Aws::Structure
7414
+ end
7415
+
7416
+ class PublishPortalResponse < Aws::EmptyStructure; end
7417
+
7418
+ # @!attribute [rw] policy_document
7419
+ # @return [String]
7420
+ #
7421
+ # @!attribute [rw] portal_product_id
7422
+ # @return [String]
7423
+ #
7424
+ class PutPortalProductSharingPolicyRequest < Struct.new(
7425
+ :policy_document,
7426
+ :portal_product_id)
7427
+ SENSITIVE = []
7428
+ include Aws::Structure
7429
+ end
7430
+
7431
+ # The request content.
7432
+ #
7433
+ # @!attribute [rw] policy_document
7434
+ # The product sharing policy.
7435
+ # @return [String]
7436
+ #
7437
+ class PutPortalProductSharingPolicyRequestContent < Struct.new(
7438
+ :policy_document)
7439
+ SENSITIVE = []
7440
+ include Aws::Structure
7441
+ end
7442
+
7443
+ class PutPortalProductSharingPolicyResponse < Aws::EmptyStructure; end
7444
+
5436
7445
  # @!attribute [rw] actions
5437
7446
  # @return [Array<Types::RoutingRuleAction>]
5438
7447
  #
@@ -5446,7 +7455,9 @@ module Aws::ApiGatewayV2
5446
7455
  # @return [String]
5447
7456
  #
5448
7457
  # @!attribute [rw] priority
5449
- # Represents the priority of the routing rule.
7458
+ # The order in which API Gateway evaluates a rule. Priority is
7459
+ # evaluated from the lowest value to the highest value. Rules can't
7460
+ # have the same priority. Priority values 1-1,000,000 are supported.
5450
7461
  # @return [Integer]
5451
7462
  #
5452
7463
  # @!attribute [rw] routing_rule_id
@@ -5470,7 +7481,9 @@ module Aws::ApiGatewayV2
5470
7481
  # @return [Array<Types::RoutingRuleCondition>]
5471
7482
  #
5472
7483
  # @!attribute [rw] priority
5473
- # Represents the priority of the routing rule.
7484
+ # The order in which API Gateway evaluates a rule. Priority is
7485
+ # evaluated from the lowest value to the highest value. Rules can't
7486
+ # have the same priority. Priority values 1-1,000,000 are supported.
5474
7487
  # @return [Integer]
5475
7488
  #
5476
7489
  # @!attribute [rw] routing_rule_arn
@@ -5623,6 +7636,18 @@ module Aws::ApiGatewayV2
5623
7636
  include Aws::Structure
5624
7637
  end
5625
7638
 
7639
+ # The REST API endpoint identifier.
7640
+ #
7641
+ # @!attribute [rw] identifier_parts
7642
+ # The identifier parts of the REST endpoint identifier.
7643
+ # @return [Types::IdentifierParts]
7644
+ #
7645
+ class RestEndpointIdentifier < Struct.new(
7646
+ :identifier_parts)
7647
+ SENSITIVE = []
7648
+ include Aws::Structure
7649
+ end
7650
+
5626
7651
  # Represents a route.
5627
7652
  #
5628
7653
  # @!attribute [rw] api_gateway_managed
@@ -5650,11 +7675,11 @@ module Aws::ApiGatewayV2
5650
7675
  #
5651
7676
  # @!attribute [rw] authorization_type
5652
7677
  # The authorization type for the route. For WebSocket APIs, valid
5653
- # values are NONE for open access, AWS\_IAM for using AWS IAM
5654
- # permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
5655
- # valid values are NONE for open access, JWT for using JSON Web
5656
- # Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
5657
- # a Lambda authorizer.
7678
+ # values are NONE for open access, AWS\_IAM for using Amazon Web
7679
+ # Services IAM permissions, and CUSTOM for using a Lambda authorizer.
7680
+ # For HTTP APIs, valid values are NONE for open access, JWT for using
7681
+ # JSON Web Tokens, AWS\_IAM for using Amazon Web Services IAM
7682
+ # permissions, and CUSTOM for using a Lambda authorizer.
5658
7683
  # @return [String]
5659
7684
  #
5660
7685
  # @!attribute [rw] authorizer_id
@@ -5686,7 +7711,9 @@ module Aws::ApiGatewayV2
5686
7711
  # @return [String]
5687
7712
  #
5688
7713
  # @!attribute [rw] route_key
5689
- # The route key for the route.
7714
+ # The route key for the route. For HTTP APIs, the route key can be
7715
+ # either $default, or a combination of an HTTP method and resource
7716
+ # path, for example, GET /pets.
5690
7717
  # @return [String]
5691
7718
  #
5692
7719
  # @!attribute [rw] route_response_selection_expression
@@ -5824,17 +7851,22 @@ module Aws::ApiGatewayV2
5824
7851
  # Represents a routing rule.
5825
7852
  #
5826
7853
  # @!attribute [rw] actions
7854
+ # The resulting action based on matching a routing rules condition.
7855
+ # Only InvokeApi is supported.
5827
7856
  # @return [Array<Types::RoutingRuleAction>]
5828
7857
  #
5829
7858
  # @!attribute [rw] conditions
7859
+ # The conditions of the routing rule.
5830
7860
  # @return [Array<Types::RoutingRuleCondition>]
5831
7861
  #
5832
7862
  # @!attribute [rw] priority
5833
- # Represents the priority of the routing rule.
7863
+ # The order in which API Gateway evaluates a rule. Priority is
7864
+ # evaluated from the lowest value to the highest value. Rules can't
7865
+ # have the same priority. Priority values 1-1,000,000 are supported.
5834
7866
  # @return [Integer]
5835
7867
  #
5836
7868
  # @!attribute [rw] routing_rule_arn
5837
- # Represents an Amazon Resource Name (ARN).
7869
+ # The ARN of the routing rule.
5838
7870
  # @return [String]
5839
7871
  #
5840
7872
  # @!attribute [rw] routing_rule_id
@@ -5868,8 +7900,7 @@ module Aws::ApiGatewayV2
5868
7900
  # Represents an InvokeApi action.
5869
7901
  #
5870
7902
  # @!attribute [rw] api_id
5871
- # Action to invoke a stage of a target API. Only REST APIs are
5872
- # supported.
7903
+ # The API identifier of the target API.
5873
7904
  # @return [String]
5874
7905
  #
5875
7906
  # @!attribute [rw] stage
@@ -5900,7 +7931,7 @@ module Aws::ApiGatewayV2
5900
7931
  # @return [Types::RoutingRuleMatchBasePaths]
5901
7932
  #
5902
7933
  # @!attribute [rw] match_headers
5903
- # The header to be matched.
7934
+ # The headers to be matched.
5904
7935
  # @return [Types::RoutingRuleMatchHeaders]
5905
7936
  #
5906
7937
  class RoutingRuleCondition < Struct.new(
@@ -5913,11 +7944,12 @@ module Aws::ApiGatewayV2
5913
7944
  # Represents the input parameters for an RoutingRule request.
5914
7945
  #
5915
7946
  # @!attribute [rw] actions
5916
- # The elements from this collection.
7947
+ # The resulting action based on matching a routing rules condition.
7948
+ # Only InvokeApi is supported.
5917
7949
  # @return [Array<Types::RoutingRuleAction>]
5918
7950
  #
5919
7951
  # @!attribute [rw] conditions
5920
- # The elements from this collection.
7952
+ # The conditions of the routing rule.
5921
7953
  # @return [Array<Types::RoutingRuleCondition>]
5922
7954
  #
5923
7955
  # @!attribute [rw] priority
@@ -5937,7 +7969,7 @@ module Aws::ApiGatewayV2
5937
7969
  # Represents a MatchBasePaths condition.
5938
7970
  #
5939
7971
  # @!attribute [rw] any_of
5940
- # The elements from this collection.
7972
+ # The string of the case sensitive base path to be matched.
5941
7973
  # @return [Array<String>]
5942
7974
  #
5943
7975
  class RoutingRuleMatchBasePaths < Struct.new(
@@ -5952,14 +7984,14 @@ module Aws::ApiGatewayV2
5952
7984
  # The case insensitive header name to be matched. The header name must
5953
7985
  # be less than 40 characters and the only allowed characters are a-z,
5954
7986
  # A-Z, 0-9, and the following special characters:
5955
- # *?-!#$%&'.^\_`\|~.
7987
+ # *?-!#$%&amp;'.^\_`\|~.
5956
7988
  # @return [String]
5957
7989
  #
5958
7990
  # @!attribute [rw] value_glob
5959
7991
  # The case sensitive header glob value to be matched against entire
5960
7992
  # header value. The header glob value must be less than 128 characters
5961
7993
  # and the only allowed characters are a-z, A-Z, 0-9, and the following
5962
- # special characters: *?-!#$%&'.^\_`\|~. Wildcard matching is
7994
+ # special characters: *?-!#$%&amp;'.^\_`\|~. Wildcard matching is
5963
7995
  # supported for header glob values but must be for *prefix-match,
5964
7996
  # suffix-match*, or *infix*-match.
5965
7997
  # @return [String]
@@ -5974,7 +8006,9 @@ module Aws::ApiGatewayV2
5974
8006
  # Represents a MatchHeaders condition.
5975
8007
  #
5976
8008
  # @!attribute [rw] any_of
5977
- # The elements from this collection.
8009
+ # The header name and header value glob to be matched. The
8010
+ # matchHeaders condition is matched if any of the header name and
8011
+ # header value globs are matched.
5978
8012
  # @return [Array<Types::RoutingRuleMatchHeaderValue>]
5979
8013
  #
5980
8014
  class RoutingRuleMatchHeaders < Struct.new(
@@ -5991,7 +8025,6 @@ module Aws::ApiGatewayV2
5991
8025
  # @return [String]
5992
8026
  #
5993
8027
  # @!attribute [rw] routing_rules
5994
- # The elements from this collection.
5995
8028
  # @return [Array<Types::RoutingRule>]
5996
8029
  #
5997
8030
  class RoutingRules < Struct.new(
@@ -6001,6 +8034,24 @@ module Aws::ApiGatewayV2
6001
8034
  include Aws::Structure
6002
8035
  end
6003
8036
 
8037
+ # Contains the section name and list of product REST endpoints for a
8038
+ # product.
8039
+ #
8040
+ # @!attribute [rw] product_rest_endpoint_page_arns
8041
+ # The ARNs of the product REST endpoint pages in a portal product.
8042
+ # @return [Array<String>]
8043
+ #
8044
+ # @!attribute [rw] section_name
8045
+ # The section name.
8046
+ # @return [String]
8047
+ #
8048
+ class Section < Struct.new(
8049
+ :product_rest_endpoint_page_arns,
8050
+ :section_name)
8051
+ SENSITIVE = []
8052
+ include Aws::Structure
8053
+ end
8054
+
6004
8055
  # Represents an API stage.
6005
8056
  #
6006
8057
  # @!attribute [rw] access_log_settings
@@ -6106,6 +8157,23 @@ module Aws::ApiGatewayV2
6106
8157
  include Aws::Structure
6107
8158
  end
6108
8159
 
8160
+ # Represents a StatusException.
8161
+ #
8162
+ # @!attribute [rw] exception
8163
+ # The exception.
8164
+ # @return [String]
8165
+ #
8166
+ # @!attribute [rw] message
8167
+ # The error message.
8168
+ # @return [String]
8169
+ #
8170
+ class StatusException < Struct.new(
8171
+ :exception,
8172
+ :message)
8173
+ SENSITIVE = []
8174
+ include Aws::Structure
8175
+ end
8176
+
6109
8177
  # Represents the input parameters for a TagResource request.
6110
8178
  #
6111
8179
  # @!attribute [rw] tags
@@ -6232,10 +8300,11 @@ module Aws::ApiGatewayV2
6232
8300
  # to assume, use the role's Amazon Resource Name (ARN). To require
6233
8301
  # that the caller's identity be passed through from the request,
6234
8302
  # specify arn:aws:iam::*:user/*. To use resource-based permissions
6235
- # on supported AWS services, specify null. Currently, this property is
6236
- # not used for HTTP integrations. If provided, this value replaces the
6237
- # credentials associated with the quick create integration. Supported
6238
- # only for HTTP APIs.
8303
+ # on supported Amazon Web Services services, don't specify this
8304
+ # parameter. Currently, this property is not used for HTTP
8305
+ # integrations. If provided, this value replaces the credentials
8306
+ # associated with the quick create integration. Supported only for
8307
+ # HTTP APIs.
6239
8308
  # @return [String]
6240
8309
  #
6241
8310
  # @!attribute [rw] description
@@ -6248,12 +8317,17 @@ module Aws::ApiGatewayV2
6248
8317
  # @return [Boolean]
6249
8318
  #
6250
8319
  # @!attribute [rw] disable_execute_api_endpoint
8320
+ # Specifies whether clients can invoke your API by using the default
8321
+ # execute-api endpoint. By default, clients can invoke your API with
8322
+ # the default https://\{api\_id}.execute-api.\{region}.amazonaws.com
8323
+ # endpoint. To require that clients use a custom domain name to invoke
8324
+ # your API, disable the default execute-api endpoint.
6251
8325
  # @return [Boolean]
6252
8326
  #
6253
8327
  # @!attribute [rw] ip_address_type
6254
8328
  # The IP address types that can invoke the API. Use ipv4 to allow only
6255
8329
  # IPv4 addresses to invoke your API, or use dualstack to allow both
6256
- # IPv4 and IPv6 addresses to invoke your domain name.
8330
+ # IPv4 and IPv6 addresses to invoke your API.
6257
8331
  # @return [String]
6258
8332
  #
6259
8333
  # @!attribute [rw] name
@@ -6586,7 +8660,8 @@ module Aws::ApiGatewayV2
6586
8660
  # Specifies the required credentials as an IAM role for API Gateway to
6587
8661
  # invoke the authorizer. To specify an IAM role for API Gateway to
6588
8662
  # assume, use the role's Amazon Resource Name (ARN). To use
6589
- # resource-based permissions on the Lambda function, specify null.
8663
+ # resource-based permissions on the Lambda function, don't specify
8664
+ # this parameter.
6590
8665
  # @return [String]
6591
8666
  #
6592
8667
  # @!attribute [rw] authorizer_result_ttl_in_seconds
@@ -6608,13 +8683,11 @@ module Aws::ApiGatewayV2
6608
8683
  # example,
6609
8684
  # arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:*\{account\_id}*:function:*\{lambda\_function\_name}*/invocations.
6610
8685
  # In general, the URI has this form:
6611
- # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}* , where
6612
- # <replaceable />
6613
- #
6614
- # \{region} is the same as the region hosting the Lambda function,
6615
- # path indicates that the remaining substring in the URI should be
6616
- # treated as the path to the resource, including the initial /. For
6617
- # Lambda functions, this is usually of the form
8686
+ # arn:aws:apigateway:*\{region}*:lambda:path/*\{service\_api}*
8687
+ # replaceable/>\{region} is the same as the region hosting the Lambda
8688
+ # function, path indicates that the remaining substring in the URI
8689
+ # should be treated as the path to the resource, including the initial
8690
+ # /. For Lambda functions, this is usually of the form
6618
8691
  # /2015-03-31/functions/\[FunctionARN\]/invocations. Supported only
6619
8692
  # for REQUEST authorizers.
6620
8693
  # @return [String]
@@ -6638,7 +8711,8 @@ module Aws::ApiGatewayV2
6638
8711
  # Otherwise, it returns a 401 Unauthorized response without calling
6639
8712
  # the Lambda function. For HTTP APIs, identity sources are also used
6640
8713
  # as the cache key when caching is enabled. To learn more, see
6641
- # [Working with AWS Lambda authorizers for HTTP APIs][1].
8714
+ # [Working with Amazon Web Services Lambda authorizers for HTTP
8715
+ # APIs][1].
6642
8716
  #
6643
8717
  # For JWT, a single entry that specifies where to extract the JSON Web
6644
8718
  # Token (JWT) from inbound requests. Currently only header-based and
@@ -6666,8 +8740,8 @@ module Aws::ApiGatewayV2
6666
8740
  # @!attribute [rw] authorizer_payload_format_version
6667
8741
  # Specifies the format of the payload sent to an HTTP API Lambda
6668
8742
  # authorizer. Required for HTTP API Lambda authorizers. Supported
6669
- # values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
6670
- # authorizers for HTTP APIs][1].
8743
+ # values are 1.0 and 2.0. To learn more, see [Working with Amazon Web
8744
+ # Services Lambda authorizers for HTTP APIs][1].
6671
8745
  #
6672
8746
  #
6673
8747
  #
@@ -6679,7 +8753,8 @@ module Aws::ApiGatewayV2
6679
8753
  # format. By default, a Lambda authorizer must return an IAM policy.
6680
8754
  # If enabled, the Lambda authorizer can return a boolean value instead
6681
8755
  # of an IAM policy. Supported only for HTTP APIs. To learn more, see
6682
- # [Working with AWS Lambda authorizers for HTTP APIs][1]
8756
+ # [Working with Amazon Web Services Lambda authorizers for HTTP
8757
+ # APIs][1].
6683
8758
  #
6684
8759
  #
6685
8760
  #
@@ -6932,6 +9007,7 @@ module Aws::ApiGatewayV2
6932
9007
  # @return [Types::MutualTlsAuthenticationInput]
6933
9008
  #
6934
9009
  # @!attribute [rw] routing_mode
9010
+ # The routing mode API Gateway uses to route traffic to your APIs.
6935
9011
  # @return [String]
6936
9012
  #
6937
9013
  class UpdateDomainNameInput < Struct.new(
@@ -6956,6 +9032,7 @@ module Aws::ApiGatewayV2
6956
9032
  # @return [Types::MutualTlsAuthenticationInput]
6957
9033
  #
6958
9034
  # @!attribute [rw] routing_mode
9035
+ # The routing mode API Gateway uses to route traffic to your APIs.
6959
9036
  # @return [String]
6960
9037
  #
6961
9038
  class UpdateDomainNameRequest < Struct.new(
@@ -6995,6 +9072,7 @@ module Aws::ApiGatewayV2
6995
9072
  # @return [Types::MutualTlsAuthentication]
6996
9073
  #
6997
9074
  # @!attribute [rw] routing_mode
9075
+ # The routing mode API Gateway uses to route traffic to your APIs.
6998
9076
  # @return [String]
6999
9077
  #
7000
9078
  # @!attribute [rw] tags
@@ -7046,11 +9124,13 @@ module Aws::ApiGatewayV2
7046
9124
  #
7047
9125
  # @!attribute [rw] credentials_arn
7048
9126
  # Specifies the credentials required for the integration, if any. For
7049
- # AWS integrations, three options are available. To specify an IAM
7050
- # Role for API Gateway to assume, use the role's Amazon Resource Name
7051
- # (ARN). To require that the caller's identity be passed through from
7052
- # the request, specify the string arn:aws:iam::*:user/*. To use
7053
- # resource-based permissions on supported AWS services, specify null.
9127
+ # Amazon Web Services integrations, three options are available. To
9128
+ # specify an IAM Role for API Gateway to assume, use the role's
9129
+ # Amazon Resource Name (ARN). To require that the caller's identity
9130
+ # be passed through from the request, specify the string
9131
+ # arn:aws:iam::*:user/*. To use resource-based permissions on
9132
+ # supported Amazon Web Services services, don't specify this
9133
+ # parameter.
7054
9134
  # @return [String]
7055
9135
  #
7056
9136
  # @!attribute [rw] description
@@ -7058,13 +9138,15 @@ module Aws::ApiGatewayV2
7058
9138
  # @return [String]
7059
9139
  #
7060
9140
  # @!attribute [rw] integration_method
7061
- # Specifies the integration's HTTP method type.
9141
+ # Specifies the integration's HTTP method type. For WebSocket APIs,
9142
+ # if you use a Lambda integration, you must set the integration method
9143
+ # to POST.
7062
9144
  # @return [String]
7063
9145
  #
7064
9146
  # @!attribute [rw] integration_subtype
7065
9147
  # Supported only for HTTP API AWS\_PROXY integrations. Specifies the
7066
- # AWS service action to invoke. To learn more, see [Integration
7067
- # subtype reference][1].
9148
+ # Amazon Web Services service action to invoke. To learn more, see
9149
+ # [Integration subtype reference][1].
7068
9150
  #
7069
9151
  #
7070
9152
  #
@@ -7074,15 +9156,16 @@ module Aws::ApiGatewayV2
7074
9156
  # @!attribute [rw] integration_type
7075
9157
  # The integration type of an integration. One of the following:
7076
9158
  #
7077
- # AWS: for integrating the route or method request with an AWS service
7078
- # action, including the Lambda function-invoking action. With the
7079
- # Lambda function-invoking action, this is referred to as the Lambda
7080
- # custom integration. With any other AWS service action, this is known
7081
- # as AWS integration. Supported only for WebSocket APIs.
9159
+ # AWS: for integrating the route or method request with an Amazon Web
9160
+ # Services service action, including the Lambda function-invoking
9161
+ # action. With the Lambda function-invoking action, this is referred
9162
+ # to as the Lambda custom integration. With any other Amazon Web
9163
+ # Services service action, this is known as Amazon Web Services
9164
+ # integration. Supported only for WebSocket APIs.
7082
9165
  #
7083
9166
  # AWS\_PROXY: for integrating the route or method request with a
7084
- # Lambda function or other AWS service action. This integration is
7085
- # also referred to as a Lambda proxy integration.
9167
+ # Lambda function or other Amazon Web Services service action. This
9168
+ # integration is also referred to as a Lambda proxy integration.
7086
9169
  #
7087
9170
  # HTTP: for integrating the route or method request with an HTTP
7088
9171
  # endpoint. This integration is also referred to as the HTTP custom
@@ -7105,11 +9188,12 @@ module Aws::ApiGatewayV2
7105
9188
  #
7106
9189
  # For an HTTP API private integration, specify the ARN of an
7107
9190
  # Application Load Balancer listener, Network Load Balancer listener,
7108
- # or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map
7109
- # service, API Gateway uses DiscoverInstances to identify resources.
7110
- # You can use query parameters to target specific resources. To learn
7111
- # more, see [DiscoverInstances][1]. For private integrations, all
7112
- # resources must be owned by the same AWS account.
9191
+ # or Amazon Web Services Cloud Map service. If you specify the ARN of
9192
+ # an Amazon Web Services Cloud Map service, API Gateway uses
9193
+ # DiscoverInstances to identify resources. You can use query
9194
+ # parameters to target specific resources. To learn more, see
9195
+ # [DiscoverInstances][1]. For private integrations, all resources must
9196
+ # be owned by the same Amazon Web Services account.
7113
9197
  #
7114
9198
  #
7115
9199
  #
@@ -7137,7 +9221,14 @@ module Aws::ApiGatewayV2
7137
9221
  #
7138
9222
  # @!attribute [rw] payload_format_version
7139
9223
  # Specifies the format of the payload sent to an integration. Required
7140
- # for HTTP APIs.
9224
+ # for HTTP APIs. For HTTP APIs, supported values for Lambda proxy
9225
+ # integrations are 1.0 and 2.0. For all other integrations, 1.0 is the
9226
+ # only supported value. To learn more, see [Working with Amazon Web
9227
+ # Services Lambda proxy integrations for HTTP APIs][1].
9228
+ #
9229
+ #
9230
+ #
9231
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
7141
9232
  # @return [String]
7142
9233
  #
7143
9234
  # @!attribute [rw] request_parameters
@@ -7155,15 +9246,15 @@ module Aws::ApiGatewayV2
7155
9246
  # request parameters are a key-value map specifying parameters that
7156
9247
  # are passed to AWS\_PROXY integrations. You can provide static
7157
9248
  # values, or map request data, stage variables, or context variables
7158
- # that are evaluated at runtime. To learn more, see [Working with AWS
7159
- # service integrations for HTTP APIs][1].
9249
+ # that are evaluated at runtime. To learn more, see [Working with
9250
+ # Amazon Web Services service integrations for HTTP APIs][1].
7160
9251
  #
7161
- # For HTTP API integrations, without a specified integrationSubtype
9252
+ # For HTTP API integrations without a specified integrationSubtype
7162
9253
  # request parameters are a key-value map specifying how to transform
7163
9254
  # HTTP requests before sending them to the backend. The key should
7164
9255
  # follow the pattern
7165
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
7166
- # where action can be append, overwrite or remove. For values, you can
9256
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
9257
+ # action can be append, overwrite or remove. For values, you can
7167
9258
  # provide static values, or map request data, stage variables, or
7168
9259
  # context variables that are evaluated at runtime. To learn more, see
7169
9260
  # [Transforming API requests and responses][2].
@@ -7171,7 +9262,7 @@ module Aws::ApiGatewayV2
7171
9262
  #
7172
9263
  #
7173
9264
  # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html
7174
- # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.
9265
+ # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
7175
9266
  # @return [Hash<String,String>]
7176
9267
  #
7177
9268
  # @!attribute [rw] response_parameters
@@ -7180,12 +9271,12 @@ module Aws::ApiGatewayV2
7180
9271
  # returning the response to clients. Specify a key-value map from a
7181
9272
  # selection key to response parameters. The selection key must be a
7182
9273
  # valid HTTP status code within the range of 200-599. Response
7183
- # parameters are a key-value map. The key must match pattern
7184
- # &lt;action&gt;:&lt;header&gt;.&lt;location&gt; or
7185
- # overwrite.statuscode. The action can be append, overwrite or remove.
7186
- # The value can be a static value, or map to response data, stage
7187
- # variables, or context variables that are evaluated at runtime. To
7188
- # learn more, see [Transforming API requests and responses][1].
9274
+ # parameters are a key-value map. The key must match the pattern
9275
+ # &lt;action>:&lt;header>.&lt;location> or overwrite.statuscode. The
9276
+ # action can be append, overwrite or remove. The value can be a static
9277
+ # value, or map to response data, stage variables, or context
9278
+ # variables that are evaluated at runtime. To learn more, see
9279
+ # [Transforming API requests and responses][1].
7189
9280
  #
7190
9281
  #
7191
9282
  #
@@ -7306,15 +9397,15 @@ module Aws::ApiGatewayV2
7306
9397
  # request parameters are a key-value map specifying parameters that
7307
9398
  # are passed to AWS\_PROXY integrations. You can provide static
7308
9399
  # values, or map request data, stage variables, or context variables
7309
- # that are evaluated at runtime. To learn more, see [Working with AWS
7310
- # service integrations for HTTP APIs][1].
9400
+ # that are evaluated at runtime. To learn more, see [Working with
9401
+ # Amazon Web Services service integrations for HTTP APIs][1].
7311
9402
  #
7312
9403
  # For HTTP API integrations without a specified integrationSubtype
7313
9404
  # request parameters are a key-value map specifying how to transform
7314
9405
  # HTTP requests before sending them to the backend. The key should
7315
9406
  # follow the pattern
7316
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
7317
- # where action can be append, overwrite or remove. For values, you can
9407
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
9408
+ # action can be append, overwrite or remove. For values, you can
7318
9409
  # provide static values, or map request data, stage variables, or
7319
9410
  # context variables that are evaluated at runtime. To learn more, see
7320
9411
  # [Transforming API requests and responses][2].
@@ -7457,15 +9548,15 @@ module Aws::ApiGatewayV2
7457
9548
  # request parameters are a key-value map specifying parameters that
7458
9549
  # are passed to AWS\_PROXY integrations. You can provide static
7459
9550
  # values, or map request data, stage variables, or context variables
7460
- # that are evaluated at runtime. To learn more, see [Working with AWS
7461
- # service integrations for HTTP APIs][1].
9551
+ # that are evaluated at runtime. To learn more, see [Working with
9552
+ # Amazon Web Services service integrations for HTTP APIs][1].
7462
9553
  #
7463
9554
  # For HTTP API integrations without a specified integrationSubtype
7464
9555
  # request parameters are a key-value map specifying how to transform
7465
9556
  # HTTP requests before sending them to the backend. The key should
7466
9557
  # follow the pattern
7467
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
7468
- # where action can be append, overwrite or remove. For values, you can
9558
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
9559
+ # action can be append, overwrite or remove. For values, you can
7469
9560
  # provide static values, or map request data, stage variables, or
7470
9561
  # context variables that are evaluated at runtime. To learn more, see
7471
9562
  # [Transforming API requests and responses][2].
@@ -7633,15 +9724,15 @@ module Aws::ApiGatewayV2
7633
9724
  # request parameters are a key-value map specifying parameters that
7634
9725
  # are passed to AWS\_PROXY integrations. You can provide static
7635
9726
  # values, or map request data, stage variables, or context variables
7636
- # that are evaluated at runtime. To learn more, see [Working with AWS
7637
- # service integrations for HTTP APIs][1].
9727
+ # that are evaluated at runtime. To learn more, see [Working with
9728
+ # Amazon Web Services service integrations for HTTP APIs][1].
7638
9729
  #
7639
9730
  # For HTTP API integrations without a specified integrationSubtype
7640
9731
  # request parameters are a key-value map specifying how to transform
7641
9732
  # HTTP requests before sending them to the backend. The key should
7642
9733
  # follow the pattern
7643
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
7644
- # where action can be append, overwrite or remove. For values, you can
9734
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
9735
+ # action can be append, overwrite or remove. For values, you can
7645
9736
  # provide static values, or map request data, stage variables, or
7646
9737
  # context variables that are evaluated at runtime. To learn more, see
7647
9738
  # [Transforming API requests and responses][2].
@@ -7715,15 +9806,15 @@ module Aws::ApiGatewayV2
7715
9806
  # request parameters are a key-value map specifying parameters that
7716
9807
  # are passed to AWS\_PROXY integrations. You can provide static
7717
9808
  # values, or map request data, stage variables, or context variables
7718
- # that are evaluated at runtime. To learn more, see [Working with AWS
7719
- # service integrations for HTTP APIs][1].
9809
+ # that are evaluated at runtime. To learn more, see [Working with
9810
+ # Amazon Web Services service integrations for HTTP APIs][1].
7720
9811
  #
7721
9812
  # For HTTP API integrations without a specified integrationSubtype
7722
9813
  # request parameters are a key-value map specifying how to transform
7723
9814
  # HTTP requests before sending them to the backend. The key should
7724
9815
  # follow the pattern
7725
- # &lt;action&gt;:&lt;header\|querystring\|path&gt;.&lt;location&gt;
7726
- # where action can be append, overwrite or remove. For values, you can
9816
+ # &lt;action>:&lt;header\|querystring\|path>.&lt;location> where
9817
+ # action can be append, overwrite or remove. For values, you can
7727
9818
  # provide static values, or map request data, stage variables, or
7728
9819
  # context variables that are evaluated at runtime. To learn more, see
7729
9820
  # [Transforming API requests and responses][2].
@@ -7852,6 +9943,561 @@ module Aws::ApiGatewayV2
7852
9943
  include Aws::Structure
7853
9944
  end
7854
9945
 
9946
+ # @!attribute [rw] description
9947
+ # @return [String]
9948
+ #
9949
+ # @!attribute [rw] display_name
9950
+ # @return [String]
9951
+ #
9952
+ # @!attribute [rw] display_order
9953
+ # The display order.
9954
+ # @return [Types::DisplayOrder]
9955
+ #
9956
+ # @!attribute [rw] portal_product_id
9957
+ # @return [String]
9958
+ #
9959
+ class UpdatePortalProductRequest < Struct.new(
9960
+ :description,
9961
+ :display_name,
9962
+ :display_order,
9963
+ :portal_product_id)
9964
+ SENSITIVE = []
9965
+ include Aws::Structure
9966
+ end
9967
+
9968
+ # Updates a portal product.
9969
+ #
9970
+ # @!attribute [rw] description
9971
+ # The description.
9972
+ # @return [String]
9973
+ #
9974
+ # @!attribute [rw] display_name
9975
+ # The displayName.
9976
+ # @return [String]
9977
+ #
9978
+ # @!attribute [rw] display_order
9979
+ # The display order.
9980
+ # @return [Types::DisplayOrder]
9981
+ #
9982
+ class UpdatePortalProductRequestContent < Struct.new(
9983
+ :description,
9984
+ :display_name,
9985
+ :display_order)
9986
+ SENSITIVE = []
9987
+ include Aws::Structure
9988
+ end
9989
+
9990
+ # @!attribute [rw] description
9991
+ # @return [String]
9992
+ #
9993
+ # @!attribute [rw] display_name
9994
+ # @return [String]
9995
+ #
9996
+ # @!attribute [rw] display_order
9997
+ # The display order.
9998
+ # @return [Types::DisplayOrder]
9999
+ #
10000
+ # @!attribute [rw] last_modified
10001
+ # @return [Time]
10002
+ #
10003
+ # @!attribute [rw] portal_product_arn
10004
+ # @return [String]
10005
+ #
10006
+ # @!attribute [rw] portal_product_id
10007
+ # @return [String]
10008
+ #
10009
+ # @!attribute [rw] tags
10010
+ # Represents a collection of tags associated with the resource.
10011
+ # @return [Hash<String,String>]
10012
+ #
10013
+ class UpdatePortalProductResponse < Struct.new(
10014
+ :description,
10015
+ :display_name,
10016
+ :display_order,
10017
+ :last_modified,
10018
+ :portal_product_arn,
10019
+ :portal_product_id,
10020
+ :tags)
10021
+ SENSITIVE = []
10022
+ include Aws::Structure
10023
+ end
10024
+
10025
+ # Updates a portal product.
10026
+ #
10027
+ # @!attribute [rw] description
10028
+ # The description of the portal product.
10029
+ # @return [String]
10030
+ #
10031
+ # @!attribute [rw] display_name
10032
+ # The display name of a portal product.
10033
+ # @return [String]
10034
+ #
10035
+ # @!attribute [rw] display_order
10036
+ # The display order that the portal products will appear in a portal.
10037
+ # @return [Types::DisplayOrder]
10038
+ #
10039
+ # @!attribute [rw] last_modified
10040
+ # The timestamp when the portal product was last modified.
10041
+ # @return [Time]
10042
+ #
10043
+ # @!attribute [rw] portal_product_arn
10044
+ # The ARN of the portal product.
10045
+ # @return [String]
10046
+ #
10047
+ # @!attribute [rw] portal_product_id
10048
+ # The portal product identifier.
10049
+ # @return [String]
10050
+ #
10051
+ # @!attribute [rw] tags
10052
+ # The collection of tags. Each tag element is associated with a given
10053
+ # resource.
10054
+ # @return [Hash<String,String>]
10055
+ #
10056
+ class UpdatePortalProductResponseContent < Struct.new(
10057
+ :description,
10058
+ :display_name,
10059
+ :display_order,
10060
+ :last_modified,
10061
+ :portal_product_arn,
10062
+ :portal_product_id,
10063
+ :tags)
10064
+ SENSITIVE = []
10065
+ include Aws::Structure
10066
+ end
10067
+
10068
+ # @!attribute [rw] authorization
10069
+ # Represents an authorization configuration for a portal.
10070
+ # @return [Types::Authorization]
10071
+ #
10072
+ # @!attribute [rw] endpoint_configuration
10073
+ # Represents an endpoint configuration.
10074
+ # @return [Types::EndpointConfigurationRequest]
10075
+ #
10076
+ # @!attribute [rw] included_portal_product_arns
10077
+ # @return [Array<String>]
10078
+ #
10079
+ # @!attribute [rw] logo_uri
10080
+ # @return [String]
10081
+ #
10082
+ # @!attribute [rw] portal_content
10083
+ # Contains the content that is visible to portal consumers including
10084
+ # the themes, display names, and description.
10085
+ # @return [Types::PortalContent]
10086
+ #
10087
+ # @!attribute [rw] portal_id
10088
+ # @return [String]
10089
+ #
10090
+ # @!attribute [rw] rum_app_monitor_name
10091
+ # @return [String]
10092
+ #
10093
+ class UpdatePortalRequest < Struct.new(
10094
+ :authorization,
10095
+ :endpoint_configuration,
10096
+ :included_portal_product_arns,
10097
+ :logo_uri,
10098
+ :portal_content,
10099
+ :portal_id,
10100
+ :rum_app_monitor_name)
10101
+ SENSITIVE = []
10102
+ include Aws::Structure
10103
+ end
10104
+
10105
+ # Updates a portal.
10106
+ #
10107
+ # @!attribute [rw] authorization
10108
+ # The authorization of the portal.
10109
+ # @return [Types::Authorization]
10110
+ #
10111
+ # @!attribute [rw] endpoint_configuration
10112
+ # Represents an endpoint configuration.
10113
+ # @return [Types::EndpointConfigurationRequest]
10114
+ #
10115
+ # @!attribute [rw] included_portal_product_arns
10116
+ # The ARNs of the portal products included in the portal.
10117
+ # @return [Array<String>]
10118
+ #
10119
+ # @!attribute [rw] logo_uri
10120
+ # The logo URI.
10121
+ # @return [String]
10122
+ #
10123
+ # @!attribute [rw] portal_content
10124
+ # Contains the content that is visible to portal consumers including
10125
+ # the themes, display names, and description.
10126
+ # @return [Types::PortalContent]
10127
+ #
10128
+ # @!attribute [rw] rum_app_monitor_name
10129
+ # The CloudWatch RUM app monitor name.
10130
+ # @return [String]
10131
+ #
10132
+ class UpdatePortalRequestContent < Struct.new(
10133
+ :authorization,
10134
+ :endpoint_configuration,
10135
+ :included_portal_product_arns,
10136
+ :logo_uri,
10137
+ :portal_content,
10138
+ :rum_app_monitor_name)
10139
+ SENSITIVE = []
10140
+ include Aws::Structure
10141
+ end
10142
+
10143
+ # @!attribute [rw] authorization
10144
+ # Represents an authorization configuration for a portal.
10145
+ # @return [Types::Authorization]
10146
+ #
10147
+ # @!attribute [rw] endpoint_configuration
10148
+ # Represents an endpoint configuration.
10149
+ # @return [Types::EndpointConfigurationResponse]
10150
+ #
10151
+ # @!attribute [rw] included_portal_product_arns
10152
+ # @return [Array<String>]
10153
+ #
10154
+ # @!attribute [rw] last_modified
10155
+ # @return [Time]
10156
+ #
10157
+ # @!attribute [rw] last_published
10158
+ # @return [Time]
10159
+ #
10160
+ # @!attribute [rw] last_published_description
10161
+ # @return [String]
10162
+ #
10163
+ # @!attribute [rw] portal_arn
10164
+ # @return [String]
10165
+ #
10166
+ # @!attribute [rw] portal_content
10167
+ # Contains the content that is visible to portal consumers including
10168
+ # the themes, display names, and description.
10169
+ # @return [Types::PortalContent]
10170
+ #
10171
+ # @!attribute [rw] portal_id
10172
+ # @return [String]
10173
+ #
10174
+ # @!attribute [rw] preview
10175
+ # Contains the preview status and preview URL.
10176
+ # @return [Types::Preview]
10177
+ #
10178
+ # @!attribute [rw] publish_status
10179
+ # Represents a publish status.
10180
+ # @return [String]
10181
+ #
10182
+ # @!attribute [rw] rum_app_monitor_name
10183
+ # @return [String]
10184
+ #
10185
+ # @!attribute [rw] status_exception
10186
+ # Represents a StatusException.
10187
+ # @return [Types::StatusException]
10188
+ #
10189
+ # @!attribute [rw] tags
10190
+ # Represents a collection of tags associated with the resource.
10191
+ # @return [Hash<String,String>]
10192
+ #
10193
+ class UpdatePortalResponse < Struct.new(
10194
+ :authorization,
10195
+ :endpoint_configuration,
10196
+ :included_portal_product_arns,
10197
+ :last_modified,
10198
+ :last_published,
10199
+ :last_published_description,
10200
+ :portal_arn,
10201
+ :portal_content,
10202
+ :portal_id,
10203
+ :preview,
10204
+ :publish_status,
10205
+ :rum_app_monitor_name,
10206
+ :status_exception,
10207
+ :tags)
10208
+ SENSITIVE = []
10209
+ include Aws::Structure
10210
+ end
10211
+
10212
+ # Updates a portal.
10213
+ #
10214
+ # @!attribute [rw] authorization
10215
+ # The authorization for the portal.
10216
+ # @return [Types::Authorization]
10217
+ #
10218
+ # @!attribute [rw] endpoint_configuration
10219
+ # The endpoint configuration.
10220
+ # @return [Types::EndpointConfigurationResponse]
10221
+ #
10222
+ # @!attribute [rw] included_portal_product_arns
10223
+ # The ARNs of the portal products included in the portal.
10224
+ # @return [Array<String>]
10225
+ #
10226
+ # @!attribute [rw] last_modified
10227
+ # The timestamp when the portal was last modified.
10228
+ # @return [Time]
10229
+ #
10230
+ # @!attribute [rw] last_published
10231
+ # The timestamp when the portal was last published.
10232
+ # @return [Time]
10233
+ #
10234
+ # @!attribute [rw] last_published_description
10235
+ # The description associated with the last time the portal was
10236
+ # published.
10237
+ # @return [String]
10238
+ #
10239
+ # @!attribute [rw] portal_arn
10240
+ # The ARN of the portal.
10241
+ # @return [String]
10242
+ #
10243
+ # @!attribute [rw] portal_content
10244
+ # Contains the content that is visible to portal consumers including
10245
+ # the themes, display names, and description.
10246
+ # @return [Types::PortalContent]
10247
+ #
10248
+ # @!attribute [rw] portal_id
10249
+ # The portal identifier.
10250
+ # @return [String]
10251
+ #
10252
+ # @!attribute [rw] preview
10253
+ # Represents the preview endpoint and the any possible error messages
10254
+ # during preview generation.
10255
+ # @return [Types::Preview]
10256
+ #
10257
+ # @!attribute [rw] publish_status
10258
+ # The publishStatus.
10259
+ # @return [String]
10260
+ #
10261
+ # @!attribute [rw] rum_app_monitor_name
10262
+ # The CloudWatch RUM app monitor name.
10263
+ # @return [String]
10264
+ #
10265
+ # @!attribute [rw] status_exception
10266
+ # The status exception information.
10267
+ # @return [Types::StatusException]
10268
+ #
10269
+ # @!attribute [rw] tags
10270
+ # The collection of tags. Each tag element is associated with a given
10271
+ # resource.
10272
+ # @return [Hash<String,String>]
10273
+ #
10274
+ class UpdatePortalResponseContent < Struct.new(
10275
+ :authorization,
10276
+ :endpoint_configuration,
10277
+ :included_portal_product_arns,
10278
+ :last_modified,
10279
+ :last_published,
10280
+ :last_published_description,
10281
+ :portal_arn,
10282
+ :portal_content,
10283
+ :portal_id,
10284
+ :preview,
10285
+ :publish_status,
10286
+ :rum_app_monitor_name,
10287
+ :status_exception,
10288
+ :tags)
10289
+ SENSITIVE = []
10290
+ include Aws::Structure
10291
+ end
10292
+
10293
+ # @!attribute [rw] display_content
10294
+ # The content of the product page.
10295
+ # @return [Types::DisplayContent]
10296
+ #
10297
+ # @!attribute [rw] portal_product_id
10298
+ # @return [String]
10299
+ #
10300
+ # @!attribute [rw] product_page_id
10301
+ # @return [String]
10302
+ #
10303
+ class UpdateProductPageRequest < Struct.new(
10304
+ :display_content,
10305
+ :portal_product_id,
10306
+ :product_page_id)
10307
+ SENSITIVE = []
10308
+ include Aws::Structure
10309
+ end
10310
+
10311
+ # Update a product page.
10312
+ #
10313
+ # @!attribute [rw] display_content
10314
+ # The content of the product page.
10315
+ # @return [Types::DisplayContent]
10316
+ #
10317
+ class UpdateProductPageRequestContent < Struct.new(
10318
+ :display_content)
10319
+ SENSITIVE = []
10320
+ include Aws::Structure
10321
+ end
10322
+
10323
+ # @!attribute [rw] display_content
10324
+ # The content of the product page.
10325
+ # @return [Types::DisplayContent]
10326
+ #
10327
+ # @!attribute [rw] last_modified
10328
+ # @return [Time]
10329
+ #
10330
+ # @!attribute [rw] product_page_arn
10331
+ # @return [String]
10332
+ #
10333
+ # @!attribute [rw] product_page_id
10334
+ # @return [String]
10335
+ #
10336
+ class UpdateProductPageResponse < Struct.new(
10337
+ :display_content,
10338
+ :last_modified,
10339
+ :product_page_arn,
10340
+ :product_page_id)
10341
+ SENSITIVE = []
10342
+ include Aws::Structure
10343
+ end
10344
+
10345
+ # Updates a product page.
10346
+ #
10347
+ # @!attribute [rw] display_content
10348
+ # The content of the product page.
10349
+ # @return [Types::DisplayContent]
10350
+ #
10351
+ # @!attribute [rw] last_modified
10352
+ # The timestamp when the product page was last modified.
10353
+ # @return [Time]
10354
+ #
10355
+ # @!attribute [rw] product_page_arn
10356
+ # The ARN of the product page.
10357
+ # @return [String]
10358
+ #
10359
+ # @!attribute [rw] product_page_id
10360
+ # The product page identifier.
10361
+ # @return [String]
10362
+ #
10363
+ class UpdateProductPageResponseContent < Struct.new(
10364
+ :display_content,
10365
+ :last_modified,
10366
+ :product_page_arn,
10367
+ :product_page_id)
10368
+ SENSITIVE = []
10369
+ include Aws::Structure
10370
+ end
10371
+
10372
+ # @!attribute [rw] display_content
10373
+ # Represents the endpoint display content.
10374
+ # @return [Types::EndpointDisplayContent]
10375
+ #
10376
+ # @!attribute [rw] portal_product_id
10377
+ # @return [String]
10378
+ #
10379
+ # @!attribute [rw] product_rest_endpoint_page_id
10380
+ # @return [String]
10381
+ #
10382
+ # @!attribute [rw] try_it_state
10383
+ # Represents the try it state for a product REST endpoint page.
10384
+ # @return [String]
10385
+ #
10386
+ class UpdateProductRestEndpointPageRequest < Struct.new(
10387
+ :display_content,
10388
+ :portal_product_id,
10389
+ :product_rest_endpoint_page_id,
10390
+ :try_it_state)
10391
+ SENSITIVE = []
10392
+ include Aws::Structure
10393
+ end
10394
+
10395
+ # Updates a product REST endpoint page.
10396
+ #
10397
+ # @!attribute [rw] display_content
10398
+ # The display content.
10399
+ # @return [Types::EndpointDisplayContent]
10400
+ #
10401
+ # @!attribute [rw] try_it_state
10402
+ # The try it state of a product REST endpoint page.
10403
+ # @return [String]
10404
+ #
10405
+ class UpdateProductRestEndpointPageRequestContent < Struct.new(
10406
+ :display_content,
10407
+ :try_it_state)
10408
+ SENSITIVE = []
10409
+ include Aws::Structure
10410
+ end
10411
+
10412
+ # @!attribute [rw] display_content
10413
+ # The product REST endpoint page.
10414
+ # @return [Types::EndpointDisplayContentResponse]
10415
+ #
10416
+ # @!attribute [rw] last_modified
10417
+ # @return [Time]
10418
+ #
10419
+ # @!attribute [rw] product_rest_endpoint_page_arn
10420
+ # @return [String]
10421
+ #
10422
+ # @!attribute [rw] product_rest_endpoint_page_id
10423
+ # @return [String]
10424
+ #
10425
+ # @!attribute [rw] rest_endpoint_identifier
10426
+ # The REST API endpoint identifier.
10427
+ # @return [Types::RestEndpointIdentifier]
10428
+ #
10429
+ # @!attribute [rw] status
10430
+ # The status.
10431
+ # @return [String]
10432
+ #
10433
+ # @!attribute [rw] status_exception
10434
+ # Represents a StatusException.
10435
+ # @return [Types::StatusException]
10436
+ #
10437
+ # @!attribute [rw] try_it_state
10438
+ # Represents the try it state for a product REST endpoint page.
10439
+ # @return [String]
10440
+ #
10441
+ class UpdateProductRestEndpointPageResponse < Struct.new(
10442
+ :display_content,
10443
+ :last_modified,
10444
+ :product_rest_endpoint_page_arn,
10445
+ :product_rest_endpoint_page_id,
10446
+ :rest_endpoint_identifier,
10447
+ :status,
10448
+ :status_exception,
10449
+ :try_it_state)
10450
+ SENSITIVE = []
10451
+ include Aws::Structure
10452
+ end
10453
+
10454
+ # Update a product REST endpoint page.
10455
+ #
10456
+ # @!attribute [rw] display_content
10457
+ # The content of the product REST endpoint page.
10458
+ # @return [Types::EndpointDisplayContentResponse]
10459
+ #
10460
+ # @!attribute [rw] last_modified
10461
+ # The timestamp when the product REST endpoint page was last modified.
10462
+ # @return [Time]
10463
+ #
10464
+ # @!attribute [rw] product_rest_endpoint_page_arn
10465
+ # The ARN of the product REST endpoint page.
10466
+ # @return [String]
10467
+ #
10468
+ # @!attribute [rw] product_rest_endpoint_page_id
10469
+ # The product REST endpoint page identifier.
10470
+ # @return [String]
10471
+ #
10472
+ # @!attribute [rw] rest_endpoint_identifier
10473
+ # The REST endpoint identifier.
10474
+ # @return [Types::RestEndpointIdentifier]
10475
+ #
10476
+ # @!attribute [rw] status
10477
+ # The status.
10478
+ # @return [String]
10479
+ #
10480
+ # @!attribute [rw] status_exception
10481
+ # The status exception information.
10482
+ # @return [Types::StatusException]
10483
+ #
10484
+ # @!attribute [rw] try_it_state
10485
+ # The try it state of a product REST endpoint page.
10486
+ # @return [String]
10487
+ #
10488
+ class UpdateProductRestEndpointPageResponseContent < Struct.new(
10489
+ :display_content,
10490
+ :last_modified,
10491
+ :product_rest_endpoint_page_arn,
10492
+ :product_rest_endpoint_page_id,
10493
+ :rest_endpoint_identifier,
10494
+ :status,
10495
+ :status_exception,
10496
+ :try_it_state)
10497
+ SENSITIVE = []
10498
+ include Aws::Structure
10499
+ end
10500
+
7855
10501
  # Represents the input parameters for an UpdateRoute request.
7856
10502
  #
7857
10503
  # @!attribute [rw] api_key_required
@@ -7865,11 +10511,11 @@ module Aws::ApiGatewayV2
7865
10511
  #
7866
10512
  # @!attribute [rw] authorization_type
7867
10513
  # The authorization type for the route. For WebSocket APIs, valid
7868
- # values are NONE for open access, AWS\_IAM for using AWS IAM
7869
- # permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
7870
- # valid values are NONE for open access, JWT for using JSON Web
7871
- # Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
7872
- # a Lambda authorizer.
10514
+ # values are NONE for open access, AWS\_IAM for using Amazon Web
10515
+ # Services IAM permissions, and CUSTOM for using a Lambda authorizer.
10516
+ # For HTTP APIs, valid values are NONE for open access, JWT for using
10517
+ # JSON Web Tokens, AWS\_IAM for using Amazon Web Services IAM
10518
+ # permissions, and CUSTOM for using a Lambda authorizer.
7873
10519
  # @return [String]
7874
10520
  #
7875
10521
  # @!attribute [rw] authorizer_id
@@ -7897,7 +10543,9 @@ module Aws::ApiGatewayV2
7897
10543
  # @return [Hash<String,Types::ParameterConstraints>]
7898
10544
  #
7899
10545
  # @!attribute [rw] route_key
7900
- # The route key for the route.
10546
+ # The route key for the route. For HTTP APIs, the route key can be
10547
+ # either $default, or a combination of an HTTP method and resource
10548
+ # path, for example, GET /pets.
7901
10549
  # @return [String]
7902
10550
  #
7903
10551
  # @!attribute [rw] route_response_selection_expression
@@ -7945,10 +10593,11 @@ module Aws::ApiGatewayV2
7945
10593
  #
7946
10594
  # @!attribute [rw] authorization_type
7947
10595
  # The authorization type. For WebSocket APIs, valid values are NONE
7948
- # for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
7949
- # for using a Lambda authorizer. For HTTP APIs, valid values are NONE
7950
- # for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
7951
- # AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
10596
+ # for open access, AWS\_IAM for using Amazon Web Services IAM
10597
+ # permissions, and CUSTOM for using a Lambda authorizer. For HTTP
10598
+ # APIs, valid values are NONE for open access, JWT for using JSON Web
10599
+ # Tokens, AWS\_IAM for using Amazon Web Services IAM permissions, and
10600
+ # CUSTOM for using a Lambda authorizer.
7952
10601
  # @return [String]
7953
10602
  #
7954
10603
  # @!attribute [rw] authorizer_id
@@ -8041,10 +10690,11 @@ module Aws::ApiGatewayV2
8041
10690
  #
8042
10691
  # @!attribute [rw] authorization_type
8043
10692
  # The authorization type. For WebSocket APIs, valid values are NONE
8044
- # for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
8045
- # for using a Lambda authorizer. For HTTP APIs, valid values are NONE
8046
- # for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
8047
- # AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
10693
+ # for open access, AWS\_IAM for using Amazon Web Services IAM
10694
+ # permissions, and CUSTOM for using a Lambda authorizer. For HTTP
10695
+ # APIs, valid values are NONE for open access, JWT for using JSON Web
10696
+ # Tokens, AWS\_IAM for using Amazon Web Services IAM permissions, and
10697
+ # CUSTOM for using a Lambda authorizer.
8048
10698
  # @return [String]
8049
10699
  #
8050
10700
  # @!attribute [rw] authorizer_id