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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigatewayv2/client.rb +1373 -166
- data/lib/aws-sdk-apigatewayv2/client_api.rb +1103 -17
- data/lib/aws-sdk-apigatewayv2/types.rb +3087 -437
- data/lib/aws-sdk-apigatewayv2.rb +1 -1
- data/sig/client.rbs +480 -14
- data/sig/types.rbs +806 -0
- metadata +1 -1
|
@@ -841,6 +841,7 @@ module Aws::ApiGatewayV2
|
|
|
841
841
|
# access your API.
|
|
842
842
|
#
|
|
843
843
|
# @option params [String] :routing_mode
|
|
844
|
+
# The routing mode API Gateway uses to route traffic to your APIs.
|
|
844
845
|
#
|
|
845
846
|
# @option params [Hash<String,String>] :tags
|
|
846
847
|
# Represents a collection of tags associated with the resource.
|
|
@@ -970,18 +971,18 @@ module Aws::ApiGatewayV2
|
|
|
970
971
|
# parameters are a key-value map specifying parameters that are passed
|
|
971
972
|
# to AWS\_PROXY integrations. You can provide static values, or map
|
|
972
973
|
# request data, stage variables, or context variables that are evaluated
|
|
973
|
-
# at runtime. To learn more, see [Working with
|
|
974
|
-
# for HTTP APIs][1].
|
|
974
|
+
# at runtime. To learn more, see [Working with Amazon Web Services
|
|
975
|
+
# service integrations for HTTP APIs][1].
|
|
975
976
|
#
|
|
976
977
|
# For HTTP API integrations without a specified integrationSubtype
|
|
977
978
|
# request parameters are a key-value map specifying how to transform
|
|
978
979
|
# HTTP requests before sending them to the backend. The key should
|
|
979
980
|
# follow the pattern
|
|
980
|
-
# <action
|
|
981
|
-
#
|
|
982
|
-
#
|
|
983
|
-
#
|
|
984
|
-
#
|
|
981
|
+
# <action>:<header\|querystring\|path>.<location> where action
|
|
982
|
+
# can be append, overwrite or remove. For values, you can provide static
|
|
983
|
+
# values, or map request data, stage variables, or context variables
|
|
984
|
+
# that are evaluated at runtime. To learn more, see [Transforming API
|
|
985
|
+
# requests and responses][2].
|
|
985
986
|
#
|
|
986
987
|
#
|
|
987
988
|
#
|
|
@@ -1139,18 +1140,18 @@ module Aws::ApiGatewayV2
|
|
|
1139
1140
|
# parameters are a key-value map specifying parameters that are passed
|
|
1140
1141
|
# to AWS\_PROXY integrations. You can provide static values, or map
|
|
1141
1142
|
# request data, stage variables, or context variables that are evaluated
|
|
1142
|
-
# at runtime. To learn more, see [Working with
|
|
1143
|
-
# for HTTP APIs][1].
|
|
1143
|
+
# at runtime. To learn more, see [Working with Amazon Web Services
|
|
1144
|
+
# service integrations for HTTP APIs][1].
|
|
1144
1145
|
#
|
|
1145
1146
|
# For HTTP API integrations without a specified integrationSubtype
|
|
1146
1147
|
# request parameters are a key-value map specifying how to transform
|
|
1147
1148
|
# HTTP requests before sending them to the backend. The key should
|
|
1148
1149
|
# follow the pattern
|
|
1149
|
-
# <action
|
|
1150
|
-
#
|
|
1151
|
-
#
|
|
1152
|
-
#
|
|
1153
|
-
#
|
|
1150
|
+
# <action>:<header\|querystring\|path>.<location> where action
|
|
1151
|
+
# can be append, overwrite or remove. For values, you can provide static
|
|
1152
|
+
# values, or map request data, stage variables, or context variables
|
|
1153
|
+
# that are evaluated at runtime. To learn more, see [Transforming API
|
|
1154
|
+
# requests and responses][2].
|
|
1154
1155
|
#
|
|
1155
1156
|
#
|
|
1156
1157
|
#
|
|
@@ -1262,6 +1263,289 @@ module Aws::ApiGatewayV2
|
|
|
1262
1263
|
req.send_request(options)
|
|
1263
1264
|
end
|
|
1264
1265
|
|
|
1266
|
+
# Creates a portal.
|
|
1267
|
+
#
|
|
1268
|
+
# @option params [required, Types::Authorization] :authorization
|
|
1269
|
+
# Represents an authorization configuration for a portal.
|
|
1270
|
+
#
|
|
1271
|
+
# @option params [required, Types::EndpointConfigurationRequest] :endpoint_configuration
|
|
1272
|
+
# Represents an endpoint configuration.
|
|
1273
|
+
#
|
|
1274
|
+
# @option params [Array<String>] :included_portal_product_arns
|
|
1275
|
+
#
|
|
1276
|
+
# @option params [String] :logo_uri
|
|
1277
|
+
#
|
|
1278
|
+
# @option params [required, Types::PortalContent] :portal_content
|
|
1279
|
+
# Contains the content that is visible to portal consumers including the
|
|
1280
|
+
# themes, display names, and description.
|
|
1281
|
+
#
|
|
1282
|
+
# @option params [String] :rum_app_monitor_name
|
|
1283
|
+
#
|
|
1284
|
+
# @option params [Hash<String,String>] :tags
|
|
1285
|
+
# Represents a collection of tags associated with the resource.
|
|
1286
|
+
#
|
|
1287
|
+
# @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1288
|
+
#
|
|
1289
|
+
# * {Types::CreatePortalResponse#authorization #authorization} => Types::Authorization
|
|
1290
|
+
# * {Types::CreatePortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
|
|
1291
|
+
# * {Types::CreatePortalResponse#included_portal_product_arns #included_portal_product_arns} => Array<String>
|
|
1292
|
+
# * {Types::CreatePortalResponse#last_modified #last_modified} => Time
|
|
1293
|
+
# * {Types::CreatePortalResponse#last_published #last_published} => Time
|
|
1294
|
+
# * {Types::CreatePortalResponse#last_published_description #last_published_description} => String
|
|
1295
|
+
# * {Types::CreatePortalResponse#portal_arn #portal_arn} => String
|
|
1296
|
+
# * {Types::CreatePortalResponse#portal_content #portal_content} => Types::PortalContent
|
|
1297
|
+
# * {Types::CreatePortalResponse#portal_id #portal_id} => String
|
|
1298
|
+
# * {Types::CreatePortalResponse#publish_status #publish_status} => String
|
|
1299
|
+
# * {Types::CreatePortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
|
|
1300
|
+
# * {Types::CreatePortalResponse#status_exception #status_exception} => Types::StatusException
|
|
1301
|
+
# * {Types::CreatePortalResponse#tags #tags} => Hash<String,String>
|
|
1302
|
+
#
|
|
1303
|
+
# @example Request syntax with placeholder values
|
|
1304
|
+
#
|
|
1305
|
+
# resp = client.create_portal({
|
|
1306
|
+
# authorization: { # required
|
|
1307
|
+
# cognito_config: {
|
|
1308
|
+
# app_client_id: "__stringMin1Max256", # required
|
|
1309
|
+
# user_pool_arn: "__stringMin20Max2048", # required
|
|
1310
|
+
# user_pool_domain: "__stringMin20Max2048", # required
|
|
1311
|
+
# },
|
|
1312
|
+
# none: {
|
|
1313
|
+
# },
|
|
1314
|
+
# },
|
|
1315
|
+
# endpoint_configuration: { # required
|
|
1316
|
+
# acm_managed: {
|
|
1317
|
+
# certificate_arn: "__stringMin10Max2048", # required
|
|
1318
|
+
# domain_name: "__stringMin3Max256", # required
|
|
1319
|
+
# },
|
|
1320
|
+
# none: {
|
|
1321
|
+
# },
|
|
1322
|
+
# },
|
|
1323
|
+
# included_portal_product_arns: ["__stringMin20Max2048"],
|
|
1324
|
+
# logo_uri: "__stringMin0Max1092",
|
|
1325
|
+
# portal_content: { # required
|
|
1326
|
+
# description: "__stringMin0Max1024",
|
|
1327
|
+
# display_name: "__stringMin3Max255", # required
|
|
1328
|
+
# theme: { # required
|
|
1329
|
+
# custom_colors: { # required
|
|
1330
|
+
# accent_color: "__stringMin1Max16", # required
|
|
1331
|
+
# background_color: "__stringMin1Max16", # required
|
|
1332
|
+
# error_validation_color: "__stringMin1Max16", # required
|
|
1333
|
+
# header_color: "__stringMin1Max16", # required
|
|
1334
|
+
# navigation_color: "__stringMin1Max16", # required
|
|
1335
|
+
# text_color: "__stringMin1Max16", # required
|
|
1336
|
+
# },
|
|
1337
|
+
# logo_last_uploaded: Time.now,
|
|
1338
|
+
# },
|
|
1339
|
+
# },
|
|
1340
|
+
# rum_app_monitor_name: "__stringMin0Max255",
|
|
1341
|
+
# tags: {
|
|
1342
|
+
# "__string" => "StringWithLengthBetween1And1600",
|
|
1343
|
+
# },
|
|
1344
|
+
# })
|
|
1345
|
+
#
|
|
1346
|
+
# @example Response structure
|
|
1347
|
+
#
|
|
1348
|
+
# resp.authorization.cognito_config.app_client_id #=> String
|
|
1349
|
+
# resp.authorization.cognito_config.user_pool_arn #=> String
|
|
1350
|
+
# resp.authorization.cognito_config.user_pool_domain #=> String
|
|
1351
|
+
# resp.endpoint_configuration.certificate_arn #=> String
|
|
1352
|
+
# resp.endpoint_configuration.domain_name #=> String
|
|
1353
|
+
# resp.endpoint_configuration.portal_default_domain_name #=> String
|
|
1354
|
+
# resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
|
|
1355
|
+
# resp.included_portal_product_arns #=> Array
|
|
1356
|
+
# resp.included_portal_product_arns[0] #=> String
|
|
1357
|
+
# resp.last_modified #=> Time
|
|
1358
|
+
# resp.last_published #=> Time
|
|
1359
|
+
# resp.last_published_description #=> String
|
|
1360
|
+
# resp.portal_arn #=> String
|
|
1361
|
+
# resp.portal_content.description #=> String
|
|
1362
|
+
# resp.portal_content.display_name #=> String
|
|
1363
|
+
# resp.portal_content.theme.custom_colors.accent_color #=> String
|
|
1364
|
+
# resp.portal_content.theme.custom_colors.background_color #=> String
|
|
1365
|
+
# resp.portal_content.theme.custom_colors.error_validation_color #=> String
|
|
1366
|
+
# resp.portal_content.theme.custom_colors.header_color #=> String
|
|
1367
|
+
# resp.portal_content.theme.custom_colors.navigation_color #=> String
|
|
1368
|
+
# resp.portal_content.theme.custom_colors.text_color #=> String
|
|
1369
|
+
# resp.portal_content.theme.logo_last_uploaded #=> Time
|
|
1370
|
+
# resp.portal_id #=> String
|
|
1371
|
+
# resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLED"
|
|
1372
|
+
# resp.rum_app_monitor_name #=> String
|
|
1373
|
+
# resp.status_exception.exception #=> String
|
|
1374
|
+
# resp.status_exception.message #=> String
|
|
1375
|
+
# resp.tags #=> Hash
|
|
1376
|
+
# resp.tags["__string"] #=> String
|
|
1377
|
+
#
|
|
1378
|
+
# @overload create_portal(params = {})
|
|
1379
|
+
# @param [Hash] params ({})
|
|
1380
|
+
def create_portal(params = {}, options = {})
|
|
1381
|
+
req = build_request(:create_portal, params)
|
|
1382
|
+
req.send_request(options)
|
|
1383
|
+
end
|
|
1384
|
+
|
|
1385
|
+
# Creates a new portal product.
|
|
1386
|
+
#
|
|
1387
|
+
# @option params [String] :description
|
|
1388
|
+
#
|
|
1389
|
+
# @option params [required, String] :display_name
|
|
1390
|
+
#
|
|
1391
|
+
# @option params [Hash<String,String>] :tags
|
|
1392
|
+
# Represents a collection of tags associated with the resource.
|
|
1393
|
+
#
|
|
1394
|
+
# @return [Types::CreatePortalProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1395
|
+
#
|
|
1396
|
+
# * {Types::CreatePortalProductResponse#description #description} => String
|
|
1397
|
+
# * {Types::CreatePortalProductResponse#display_name #display_name} => String
|
|
1398
|
+
# * {Types::CreatePortalProductResponse#display_order #display_order} => Types::DisplayOrder
|
|
1399
|
+
# * {Types::CreatePortalProductResponse#last_modified #last_modified} => Time
|
|
1400
|
+
# * {Types::CreatePortalProductResponse#portal_product_arn #portal_product_arn} => String
|
|
1401
|
+
# * {Types::CreatePortalProductResponse#portal_product_id #portal_product_id} => String
|
|
1402
|
+
# * {Types::CreatePortalProductResponse#tags #tags} => Hash<String,String>
|
|
1403
|
+
#
|
|
1404
|
+
# @example Request syntax with placeholder values
|
|
1405
|
+
#
|
|
1406
|
+
# resp = client.create_portal_product({
|
|
1407
|
+
# description: "__stringMin0Max1024",
|
|
1408
|
+
# display_name: "__stringMin1Max255", # required
|
|
1409
|
+
# tags: {
|
|
1410
|
+
# "__string" => "StringWithLengthBetween1And1600",
|
|
1411
|
+
# },
|
|
1412
|
+
# })
|
|
1413
|
+
#
|
|
1414
|
+
# @example Response structure
|
|
1415
|
+
#
|
|
1416
|
+
# resp.description #=> String
|
|
1417
|
+
# resp.display_name #=> String
|
|
1418
|
+
# resp.display_order.contents #=> Array
|
|
1419
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
|
|
1420
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
|
|
1421
|
+
# resp.display_order.contents[0].section_name #=> String
|
|
1422
|
+
# resp.display_order.overview_page_arn #=> String
|
|
1423
|
+
# resp.display_order.product_page_arns #=> Array
|
|
1424
|
+
# resp.display_order.product_page_arns[0] #=> String
|
|
1425
|
+
# resp.last_modified #=> Time
|
|
1426
|
+
# resp.portal_product_arn #=> String
|
|
1427
|
+
# resp.portal_product_id #=> String
|
|
1428
|
+
# resp.tags #=> Hash
|
|
1429
|
+
# resp.tags["__string"] #=> String
|
|
1430
|
+
#
|
|
1431
|
+
# @overload create_portal_product(params = {})
|
|
1432
|
+
# @param [Hash] params ({})
|
|
1433
|
+
def create_portal_product(params = {}, options = {})
|
|
1434
|
+
req = build_request(:create_portal_product, params)
|
|
1435
|
+
req.send_request(options)
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
# Creates a new product page for a portal product.
|
|
1439
|
+
#
|
|
1440
|
+
# @option params [required, Types::DisplayContent] :display_content
|
|
1441
|
+
# The content of the product page.
|
|
1442
|
+
#
|
|
1443
|
+
# @option params [required, String] :portal_product_id
|
|
1444
|
+
#
|
|
1445
|
+
# @return [Types::CreateProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1446
|
+
#
|
|
1447
|
+
# * {Types::CreateProductPageResponse#display_content #display_content} => Types::DisplayContent
|
|
1448
|
+
# * {Types::CreateProductPageResponse#last_modified #last_modified} => Time
|
|
1449
|
+
# * {Types::CreateProductPageResponse#product_page_arn #product_page_arn} => String
|
|
1450
|
+
# * {Types::CreateProductPageResponse#product_page_id #product_page_id} => String
|
|
1451
|
+
#
|
|
1452
|
+
# @example Request syntax with placeholder values
|
|
1453
|
+
#
|
|
1454
|
+
# resp = client.create_product_page({
|
|
1455
|
+
# display_content: { # required
|
|
1456
|
+
# body: "__stringMin1Max32768", # required
|
|
1457
|
+
# title: "__stringMin1Max255", # required
|
|
1458
|
+
# },
|
|
1459
|
+
# portal_product_id: "__string", # required
|
|
1460
|
+
# })
|
|
1461
|
+
#
|
|
1462
|
+
# @example Response structure
|
|
1463
|
+
#
|
|
1464
|
+
# resp.display_content.body #=> String
|
|
1465
|
+
# resp.display_content.title #=> String
|
|
1466
|
+
# resp.last_modified #=> Time
|
|
1467
|
+
# resp.product_page_arn #=> String
|
|
1468
|
+
# resp.product_page_id #=> String
|
|
1469
|
+
#
|
|
1470
|
+
# @overload create_product_page(params = {})
|
|
1471
|
+
# @param [Hash] params ({})
|
|
1472
|
+
def create_product_page(params = {}, options = {})
|
|
1473
|
+
req = build_request(:create_product_page, params)
|
|
1474
|
+
req.send_request(options)
|
|
1475
|
+
end
|
|
1476
|
+
|
|
1477
|
+
# Creates a product REST endpoint page for a portal product.
|
|
1478
|
+
#
|
|
1479
|
+
# @option params [Types::EndpointDisplayContent] :display_content
|
|
1480
|
+
# Represents the endpoint display content.
|
|
1481
|
+
#
|
|
1482
|
+
# @option params [required, String] :portal_product_id
|
|
1483
|
+
#
|
|
1484
|
+
# @option params [required, Types::RestEndpointIdentifier] :rest_endpoint_identifier
|
|
1485
|
+
# The REST API endpoint identifier.
|
|
1486
|
+
#
|
|
1487
|
+
# @option params [String] :try_it_state
|
|
1488
|
+
# Represents the try it state for a product REST endpoint page.
|
|
1489
|
+
#
|
|
1490
|
+
# @return [Types::CreateProductRestEndpointPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1491
|
+
#
|
|
1492
|
+
# * {Types::CreateProductRestEndpointPageResponse#display_content #display_content} => Types::EndpointDisplayContentResponse
|
|
1493
|
+
# * {Types::CreateProductRestEndpointPageResponse#last_modified #last_modified} => Time
|
|
1494
|
+
# * {Types::CreateProductRestEndpointPageResponse#product_rest_endpoint_page_arn #product_rest_endpoint_page_arn} => String
|
|
1495
|
+
# * {Types::CreateProductRestEndpointPageResponse#product_rest_endpoint_page_id #product_rest_endpoint_page_id} => String
|
|
1496
|
+
# * {Types::CreateProductRestEndpointPageResponse#rest_endpoint_identifier #rest_endpoint_identifier} => Types::RestEndpointIdentifier
|
|
1497
|
+
# * {Types::CreateProductRestEndpointPageResponse#status #status} => String
|
|
1498
|
+
# * {Types::CreateProductRestEndpointPageResponse#status_exception #status_exception} => Types::StatusException
|
|
1499
|
+
# * {Types::CreateProductRestEndpointPageResponse#try_it_state #try_it_state} => String
|
|
1500
|
+
#
|
|
1501
|
+
# @example Request syntax with placeholder values
|
|
1502
|
+
#
|
|
1503
|
+
# resp = client.create_product_rest_endpoint_page({
|
|
1504
|
+
# display_content: {
|
|
1505
|
+
# none: {
|
|
1506
|
+
# },
|
|
1507
|
+
# overrides: {
|
|
1508
|
+
# body: "__stringMin1Max32768",
|
|
1509
|
+
# endpoint: "__stringMin1Max1024",
|
|
1510
|
+
# operation_name: "__stringMin1Max255",
|
|
1511
|
+
# },
|
|
1512
|
+
# },
|
|
1513
|
+
# portal_product_id: "__string", # required
|
|
1514
|
+
# rest_endpoint_identifier: { # required
|
|
1515
|
+
# identifier_parts: {
|
|
1516
|
+
# method: "__stringMin1Max20", # required
|
|
1517
|
+
# path: "__stringMin1Max4096", # required
|
|
1518
|
+
# rest_api_id: "__stringMin1Max50", # required
|
|
1519
|
+
# stage: "__stringMin1Max128", # required
|
|
1520
|
+
# },
|
|
1521
|
+
# },
|
|
1522
|
+
# try_it_state: "ENABLED", # accepts ENABLED, DISABLED
|
|
1523
|
+
# })
|
|
1524
|
+
#
|
|
1525
|
+
# @example Response structure
|
|
1526
|
+
#
|
|
1527
|
+
# resp.display_content.body #=> String
|
|
1528
|
+
# resp.display_content.endpoint #=> String
|
|
1529
|
+
# resp.display_content.operation_name #=> String
|
|
1530
|
+
# resp.last_modified #=> Time
|
|
1531
|
+
# resp.product_rest_endpoint_page_arn #=> String
|
|
1532
|
+
# resp.product_rest_endpoint_page_id #=> String
|
|
1533
|
+
# resp.rest_endpoint_identifier.identifier_parts.method #=> String
|
|
1534
|
+
# resp.rest_endpoint_identifier.identifier_parts.path #=> String
|
|
1535
|
+
# resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
|
|
1536
|
+
# resp.rest_endpoint_identifier.identifier_parts.stage #=> String
|
|
1537
|
+
# resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
|
|
1538
|
+
# resp.status_exception.exception #=> String
|
|
1539
|
+
# resp.status_exception.message #=> String
|
|
1540
|
+
# resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
|
|
1541
|
+
#
|
|
1542
|
+
# @overload create_product_rest_endpoint_page(params = {})
|
|
1543
|
+
# @param [Hash] params ({})
|
|
1544
|
+
def create_product_rest_endpoint_page(params = {}, options = {})
|
|
1545
|
+
req = build_request(:create_product_rest_endpoint_page, params)
|
|
1546
|
+
req.send_request(options)
|
|
1547
|
+
end
|
|
1548
|
+
|
|
1265
1549
|
# Creates a Route for an API.
|
|
1266
1550
|
#
|
|
1267
1551
|
# @option params [required, String] :api_id
|
|
@@ -1280,10 +1564,11 @@ module Aws::ApiGatewayV2
|
|
|
1280
1564
|
#
|
|
1281
1565
|
# @option params [String] :authorization_type
|
|
1282
1566
|
# The authorization type. For WebSocket APIs, valid values are NONE for
|
|
1283
|
-
# open access, AWS\_IAM for using
|
|
1284
|
-
# using a Lambda authorizer. For HTTP APIs, valid values
|
|
1285
|
-
# open access, JWT for using JSON Web Tokens, AWS\_IAM for
|
|
1286
|
-
# permissions, and CUSTOM for using a
|
|
1567
|
+
# open access, AWS\_IAM for using Amazon Web Services IAM permissions,
|
|
1568
|
+
# and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values
|
|
1569
|
+
# are NONE for open access, JWT for using JSON Web Tokens, AWS\_IAM for
|
|
1570
|
+
# using Amazon Web Services IAM permissions, and CUSTOM for using a
|
|
1571
|
+
# Lambda authorizer.
|
|
1287
1572
|
#
|
|
1288
1573
|
# @option params [String] :authorizer_id
|
|
1289
1574
|
# The identifier.
|
|
@@ -1474,7 +1759,9 @@ module Aws::ApiGatewayV2
|
|
|
1474
1759
|
# @option params [String] :domain_name_id
|
|
1475
1760
|
#
|
|
1476
1761
|
# @option params [required, Integer] :priority
|
|
1477
|
-
#
|
|
1762
|
+
# The order in which API Gateway evaluates a rule. Priority is evaluated
|
|
1763
|
+
# from the lowest value to the highest value. Rules can't have the same
|
|
1764
|
+
# priority. Priority values 1-1,000,000 are supported.
|
|
1478
1765
|
#
|
|
1479
1766
|
# @return [Types::CreateRoutingRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1480
1767
|
#
|
|
@@ -1936,6 +2223,107 @@ module Aws::ApiGatewayV2
|
|
|
1936
2223
|
req.send_request(options)
|
|
1937
2224
|
end
|
|
1938
2225
|
|
|
2226
|
+
# Deletes a portal.
|
|
2227
|
+
#
|
|
2228
|
+
# @option params [required, String] :portal_id
|
|
2229
|
+
#
|
|
2230
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2231
|
+
#
|
|
2232
|
+
# @example Request syntax with placeholder values
|
|
2233
|
+
#
|
|
2234
|
+
# resp = client.delete_portal({
|
|
2235
|
+
# portal_id: "__string", # required
|
|
2236
|
+
# })
|
|
2237
|
+
#
|
|
2238
|
+
# @overload delete_portal(params = {})
|
|
2239
|
+
# @param [Hash] params ({})
|
|
2240
|
+
def delete_portal(params = {}, options = {})
|
|
2241
|
+
req = build_request(:delete_portal, params)
|
|
2242
|
+
req.send_request(options)
|
|
2243
|
+
end
|
|
2244
|
+
|
|
2245
|
+
# Deletes a portal product.
|
|
2246
|
+
#
|
|
2247
|
+
# @option params [required, String] :portal_product_id
|
|
2248
|
+
#
|
|
2249
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2250
|
+
#
|
|
2251
|
+
# @example Request syntax with placeholder values
|
|
2252
|
+
#
|
|
2253
|
+
# resp = client.delete_portal_product({
|
|
2254
|
+
# portal_product_id: "__string", # required
|
|
2255
|
+
# })
|
|
2256
|
+
#
|
|
2257
|
+
# @overload delete_portal_product(params = {})
|
|
2258
|
+
# @param [Hash] params ({})
|
|
2259
|
+
def delete_portal_product(params = {}, options = {})
|
|
2260
|
+
req = build_request(:delete_portal_product, params)
|
|
2261
|
+
req.send_request(options)
|
|
2262
|
+
end
|
|
2263
|
+
|
|
2264
|
+
# Deletes the sharing policy for a portal product.
|
|
2265
|
+
#
|
|
2266
|
+
# @option params [required, String] :portal_product_id
|
|
2267
|
+
#
|
|
2268
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2269
|
+
#
|
|
2270
|
+
# @example Request syntax with placeholder values
|
|
2271
|
+
#
|
|
2272
|
+
# resp = client.delete_portal_product_sharing_policy({
|
|
2273
|
+
# portal_product_id: "__string", # required
|
|
2274
|
+
# })
|
|
2275
|
+
#
|
|
2276
|
+
# @overload delete_portal_product_sharing_policy(params = {})
|
|
2277
|
+
# @param [Hash] params ({})
|
|
2278
|
+
def delete_portal_product_sharing_policy(params = {}, options = {})
|
|
2279
|
+
req = build_request(:delete_portal_product_sharing_policy, params)
|
|
2280
|
+
req.send_request(options)
|
|
2281
|
+
end
|
|
2282
|
+
|
|
2283
|
+
# Deletes a product page of a portal product.
|
|
2284
|
+
#
|
|
2285
|
+
# @option params [required, String] :portal_product_id
|
|
2286
|
+
#
|
|
2287
|
+
# @option params [required, String] :product_page_id
|
|
2288
|
+
#
|
|
2289
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2290
|
+
#
|
|
2291
|
+
# @example Request syntax with placeholder values
|
|
2292
|
+
#
|
|
2293
|
+
# resp = client.delete_product_page({
|
|
2294
|
+
# portal_product_id: "__string", # required
|
|
2295
|
+
# product_page_id: "__string", # required
|
|
2296
|
+
# })
|
|
2297
|
+
#
|
|
2298
|
+
# @overload delete_product_page(params = {})
|
|
2299
|
+
# @param [Hash] params ({})
|
|
2300
|
+
def delete_product_page(params = {}, options = {})
|
|
2301
|
+
req = build_request(:delete_product_page, params)
|
|
2302
|
+
req.send_request(options)
|
|
2303
|
+
end
|
|
2304
|
+
|
|
2305
|
+
# Deletes a product REST endpoint page.
|
|
2306
|
+
#
|
|
2307
|
+
# @option params [required, String] :portal_product_id
|
|
2308
|
+
#
|
|
2309
|
+
# @option params [required, String] :product_rest_endpoint_page_id
|
|
2310
|
+
#
|
|
2311
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2312
|
+
#
|
|
2313
|
+
# @example Request syntax with placeholder values
|
|
2314
|
+
#
|
|
2315
|
+
# resp = client.delete_product_rest_endpoint_page({
|
|
2316
|
+
# portal_product_id: "__string", # required
|
|
2317
|
+
# product_rest_endpoint_page_id: "__string", # required
|
|
2318
|
+
# })
|
|
2319
|
+
#
|
|
2320
|
+
# @overload delete_product_rest_endpoint_page(params = {})
|
|
2321
|
+
# @param [Hash] params ({})
|
|
2322
|
+
def delete_product_rest_endpoint_page(params = {}, options = {})
|
|
2323
|
+
req = build_request(:delete_product_rest_endpoint_page, params)
|
|
2324
|
+
req.send_request(options)
|
|
2325
|
+
end
|
|
2326
|
+
|
|
1939
2327
|
# Deletes a Route.
|
|
1940
2328
|
#
|
|
1941
2329
|
# @option params [required, String] :api_id
|
|
@@ -1958,7 +2346,7 @@ module Aws::ApiGatewayV2
|
|
|
1958
2346
|
req.send_request(options)
|
|
1959
2347
|
end
|
|
1960
2348
|
|
|
1961
|
-
# Deletes a route request parameter.
|
|
2349
|
+
# Deletes a route request parameter. Supported only for WebSocket APIs.
|
|
1962
2350
|
#
|
|
1963
2351
|
# @option params [required, String] :api_id
|
|
1964
2352
|
#
|
|
@@ -2033,6 +2421,8 @@ module Aws::ApiGatewayV2
|
|
|
2033
2421
|
req.send_request(options)
|
|
2034
2422
|
end
|
|
2035
2423
|
|
|
2424
|
+
# Deletes a routing rule.
|
|
2425
|
+
#
|
|
2036
2426
|
# @option params [required, String] :domain_name
|
|
2037
2427
|
#
|
|
2038
2428
|
# @option params [String] :domain_name_id
|
|
@@ -2138,6 +2528,25 @@ module Aws::ApiGatewayV2
|
|
|
2138
2528
|
req.send_request(options)
|
|
2139
2529
|
end
|
|
2140
2530
|
|
|
2531
|
+
# Deletes the publication of a portal portal.
|
|
2532
|
+
#
|
|
2533
|
+
# @option params [required, String] :portal_id
|
|
2534
|
+
#
|
|
2535
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2536
|
+
#
|
|
2537
|
+
# @example Request syntax with placeholder values
|
|
2538
|
+
#
|
|
2539
|
+
# resp = client.disable_portal({
|
|
2540
|
+
# portal_id: "__string", # required
|
|
2541
|
+
# })
|
|
2542
|
+
#
|
|
2543
|
+
# @overload disable_portal(params = {})
|
|
2544
|
+
# @param [Hash] params ({})
|
|
2545
|
+
def disable_portal(params = {}, options = {})
|
|
2546
|
+
req = build_request(:disable_portal, params)
|
|
2547
|
+
req.send_request(options)
|
|
2548
|
+
end
|
|
2549
|
+
|
|
2141
2550
|
# Resets all authorizer cache entries for the specified stage. Supported
|
|
2142
2551
|
# only for HTTP API Lambda authorizers.
|
|
2143
2552
|
#
|
|
@@ -2587,7 +2996,7 @@ module Aws::ApiGatewayV2
|
|
|
2587
2996
|
req.send_request(options)
|
|
2588
2997
|
end
|
|
2589
2998
|
|
|
2590
|
-
# Gets the domain names for an
|
|
2999
|
+
# Gets the domain names for an Amazon Web Services account.
|
|
2591
3000
|
#
|
|
2592
3001
|
# @option params [String] :max_results
|
|
2593
3002
|
#
|
|
@@ -2955,113 +3364,351 @@ module Aws::ApiGatewayV2
|
|
|
2955
3364
|
req.send_request(options)
|
|
2956
3365
|
end
|
|
2957
3366
|
|
|
2958
|
-
# Gets a
|
|
2959
|
-
#
|
|
2960
|
-
# @option params [required, String] :
|
|
2961
|
-
#
|
|
2962
|
-
# @
|
|
2963
|
-
#
|
|
2964
|
-
#
|
|
2965
|
-
#
|
|
2966
|
-
# * {Types::
|
|
2967
|
-
# * {Types::
|
|
2968
|
-
# * {Types::
|
|
2969
|
-
# * {Types::
|
|
2970
|
-
# * {Types::
|
|
2971
|
-
# * {Types::
|
|
2972
|
-
# * {Types::
|
|
2973
|
-
# * {Types::
|
|
2974
|
-
# * {Types::
|
|
2975
|
-
# * {Types::
|
|
2976
|
-
# * {Types::
|
|
2977
|
-
# * {Types::
|
|
2978
|
-
# * {Types::GetRouteResult#target #target} => String
|
|
3367
|
+
# Gets a portal.
|
|
3368
|
+
#
|
|
3369
|
+
# @option params [required, String] :portal_id
|
|
3370
|
+
#
|
|
3371
|
+
# @return [Types::GetPortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3372
|
+
#
|
|
3373
|
+
# * {Types::GetPortalResponse#authorization #authorization} => Types::Authorization
|
|
3374
|
+
# * {Types::GetPortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
|
|
3375
|
+
# * {Types::GetPortalResponse#included_portal_product_arns #included_portal_product_arns} => Array<String>
|
|
3376
|
+
# * {Types::GetPortalResponse#last_modified #last_modified} => Time
|
|
3377
|
+
# * {Types::GetPortalResponse#last_published #last_published} => Time
|
|
3378
|
+
# * {Types::GetPortalResponse#last_published_description #last_published_description} => String
|
|
3379
|
+
# * {Types::GetPortalResponse#portal_arn #portal_arn} => String
|
|
3380
|
+
# * {Types::GetPortalResponse#portal_content #portal_content} => Types::PortalContent
|
|
3381
|
+
# * {Types::GetPortalResponse#portal_id #portal_id} => String
|
|
3382
|
+
# * {Types::GetPortalResponse#preview #preview} => Types::Preview
|
|
3383
|
+
# * {Types::GetPortalResponse#publish_status #publish_status} => String
|
|
3384
|
+
# * {Types::GetPortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
|
|
3385
|
+
# * {Types::GetPortalResponse#status_exception #status_exception} => Types::StatusException
|
|
3386
|
+
# * {Types::GetPortalResponse#tags #tags} => Hash<String,String>
|
|
2979
3387
|
#
|
|
2980
3388
|
# @example Request syntax with placeholder values
|
|
2981
3389
|
#
|
|
2982
|
-
# resp = client.
|
|
2983
|
-
#
|
|
2984
|
-
# route_id: "__string", # required
|
|
3390
|
+
# resp = client.get_portal({
|
|
3391
|
+
# portal_id: "__string", # required
|
|
2985
3392
|
# })
|
|
2986
3393
|
#
|
|
2987
3394
|
# @example Response structure
|
|
2988
3395
|
#
|
|
2989
|
-
# resp.
|
|
2990
|
-
# resp.
|
|
2991
|
-
# resp.
|
|
2992
|
-
# resp.
|
|
2993
|
-
# resp.
|
|
2994
|
-
# resp.
|
|
2995
|
-
# resp.
|
|
2996
|
-
# resp.
|
|
2997
|
-
# resp.
|
|
2998
|
-
# resp.
|
|
2999
|
-
# resp.
|
|
3000
|
-
# resp.
|
|
3001
|
-
# resp.
|
|
3002
|
-
# resp.
|
|
3003
|
-
# resp.
|
|
3004
|
-
# resp.
|
|
3396
|
+
# resp.authorization.cognito_config.app_client_id #=> String
|
|
3397
|
+
# resp.authorization.cognito_config.user_pool_arn #=> String
|
|
3398
|
+
# resp.authorization.cognito_config.user_pool_domain #=> String
|
|
3399
|
+
# resp.endpoint_configuration.certificate_arn #=> String
|
|
3400
|
+
# resp.endpoint_configuration.domain_name #=> String
|
|
3401
|
+
# resp.endpoint_configuration.portal_default_domain_name #=> String
|
|
3402
|
+
# resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
|
|
3403
|
+
# resp.included_portal_product_arns #=> Array
|
|
3404
|
+
# resp.included_portal_product_arns[0] #=> String
|
|
3405
|
+
# resp.last_modified #=> Time
|
|
3406
|
+
# resp.last_published #=> Time
|
|
3407
|
+
# resp.last_published_description #=> String
|
|
3408
|
+
# resp.portal_arn #=> String
|
|
3409
|
+
# resp.portal_content.description #=> String
|
|
3410
|
+
# resp.portal_content.display_name #=> String
|
|
3411
|
+
# resp.portal_content.theme.custom_colors.accent_color #=> String
|
|
3412
|
+
# resp.portal_content.theme.custom_colors.background_color #=> String
|
|
3413
|
+
# resp.portal_content.theme.custom_colors.error_validation_color #=> String
|
|
3414
|
+
# resp.portal_content.theme.custom_colors.header_color #=> String
|
|
3415
|
+
# resp.portal_content.theme.custom_colors.navigation_color #=> String
|
|
3416
|
+
# resp.portal_content.theme.custom_colors.text_color #=> String
|
|
3417
|
+
# resp.portal_content.theme.logo_last_uploaded #=> Time
|
|
3418
|
+
# resp.portal_id #=> String
|
|
3419
|
+
# resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
|
|
3420
|
+
# resp.preview.preview_url #=> String
|
|
3421
|
+
# resp.preview.status_exception.exception #=> String
|
|
3422
|
+
# resp.preview.status_exception.message #=> String
|
|
3423
|
+
# resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLED"
|
|
3424
|
+
# resp.rum_app_monitor_name #=> String
|
|
3425
|
+
# resp.status_exception.exception #=> String
|
|
3426
|
+
# resp.status_exception.message #=> String
|
|
3427
|
+
# resp.tags #=> Hash
|
|
3428
|
+
# resp.tags["__string"] #=> String
|
|
3005
3429
|
#
|
|
3006
|
-
# @overload
|
|
3430
|
+
# @overload get_portal(params = {})
|
|
3007
3431
|
# @param [Hash] params ({})
|
|
3008
|
-
def
|
|
3009
|
-
req = build_request(:
|
|
3432
|
+
def get_portal(params = {}, options = {})
|
|
3433
|
+
req = build_request(:get_portal, params)
|
|
3010
3434
|
req.send_request(options)
|
|
3011
3435
|
end
|
|
3012
3436
|
|
|
3013
|
-
# Gets a
|
|
3014
|
-
#
|
|
3015
|
-
# @option params [required, String] :api_id
|
|
3437
|
+
# Gets a portal product.
|
|
3016
3438
|
#
|
|
3017
|
-
# @option params [required, String] :
|
|
3439
|
+
# @option params [required, String] :portal_product_id
|
|
3018
3440
|
#
|
|
3019
|
-
# @option params [
|
|
3441
|
+
# @option params [String] :resource_owner_account_id
|
|
3020
3442
|
#
|
|
3021
|
-
# @return [Types::
|
|
3443
|
+
# @return [Types::GetPortalProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3022
3444
|
#
|
|
3023
|
-
# * {Types::
|
|
3024
|
-
# * {Types::
|
|
3025
|
-
# * {Types::
|
|
3026
|
-
# * {Types::
|
|
3027
|
-
# * {Types::
|
|
3445
|
+
# * {Types::GetPortalProductResponse#description #description} => String
|
|
3446
|
+
# * {Types::GetPortalProductResponse#display_name #display_name} => String
|
|
3447
|
+
# * {Types::GetPortalProductResponse#display_order #display_order} => Types::DisplayOrder
|
|
3448
|
+
# * {Types::GetPortalProductResponse#last_modified #last_modified} => Time
|
|
3449
|
+
# * {Types::GetPortalProductResponse#portal_product_arn #portal_product_arn} => String
|
|
3450
|
+
# * {Types::GetPortalProductResponse#portal_product_id #portal_product_id} => String
|
|
3451
|
+
# * {Types::GetPortalProductResponse#tags #tags} => Hash<String,String>
|
|
3028
3452
|
#
|
|
3029
3453
|
# @example Request syntax with placeholder values
|
|
3030
3454
|
#
|
|
3031
|
-
# resp = client.
|
|
3032
|
-
#
|
|
3033
|
-
#
|
|
3034
|
-
# route_response_id: "__string", # required
|
|
3455
|
+
# resp = client.get_portal_product({
|
|
3456
|
+
# portal_product_id: "__string", # required
|
|
3457
|
+
# resource_owner_account_id: "__string",
|
|
3035
3458
|
# })
|
|
3036
3459
|
#
|
|
3037
3460
|
# @example Response structure
|
|
3038
3461
|
#
|
|
3039
|
-
# resp.
|
|
3040
|
-
# resp.
|
|
3041
|
-
# resp.
|
|
3042
|
-
# resp.
|
|
3043
|
-
# resp.
|
|
3044
|
-
# resp.
|
|
3045
|
-
# resp.
|
|
3462
|
+
# resp.description #=> String
|
|
3463
|
+
# resp.display_name #=> String
|
|
3464
|
+
# resp.display_order.contents #=> Array
|
|
3465
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
|
|
3466
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
|
|
3467
|
+
# resp.display_order.contents[0].section_name #=> String
|
|
3468
|
+
# resp.display_order.overview_page_arn #=> String
|
|
3469
|
+
# resp.display_order.product_page_arns #=> Array
|
|
3470
|
+
# resp.display_order.product_page_arns[0] #=> String
|
|
3471
|
+
# resp.last_modified #=> Time
|
|
3472
|
+
# resp.portal_product_arn #=> String
|
|
3473
|
+
# resp.portal_product_id #=> String
|
|
3474
|
+
# resp.tags #=> Hash
|
|
3475
|
+
# resp.tags["__string"] #=> String
|
|
3046
3476
|
#
|
|
3047
|
-
# @overload
|
|
3477
|
+
# @overload get_portal_product(params = {})
|
|
3048
3478
|
# @param [Hash] params ({})
|
|
3049
|
-
def
|
|
3050
|
-
req = build_request(:
|
|
3479
|
+
def get_portal_product(params = {}, options = {})
|
|
3480
|
+
req = build_request(:get_portal_product, params)
|
|
3051
3481
|
req.send_request(options)
|
|
3052
3482
|
end
|
|
3053
3483
|
|
|
3054
|
-
# Gets the
|
|
3484
|
+
# Gets the sharing policy for a portal product.
|
|
3055
3485
|
#
|
|
3056
|
-
# @option params [required, String] :
|
|
3486
|
+
# @option params [required, String] :portal_product_id
|
|
3057
3487
|
#
|
|
3058
|
-
# @
|
|
3488
|
+
# @return [Types::GetPortalProductSharingPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3059
3489
|
#
|
|
3060
|
-
#
|
|
3490
|
+
# * {Types::GetPortalProductSharingPolicyResponse#policy_document #policy_document} => String
|
|
3491
|
+
# * {Types::GetPortalProductSharingPolicyResponse#portal_product_id #portal_product_id} => String
|
|
3061
3492
|
#
|
|
3062
|
-
# @
|
|
3493
|
+
# @example Request syntax with placeholder values
|
|
3063
3494
|
#
|
|
3064
|
-
#
|
|
3495
|
+
# resp = client.get_portal_product_sharing_policy({
|
|
3496
|
+
# portal_product_id: "__string", # required
|
|
3497
|
+
# })
|
|
3498
|
+
#
|
|
3499
|
+
# @example Response structure
|
|
3500
|
+
#
|
|
3501
|
+
# resp.policy_document #=> String
|
|
3502
|
+
# resp.portal_product_id #=> String
|
|
3503
|
+
#
|
|
3504
|
+
# @overload get_portal_product_sharing_policy(params = {})
|
|
3505
|
+
# @param [Hash] params ({})
|
|
3506
|
+
def get_portal_product_sharing_policy(params = {}, options = {})
|
|
3507
|
+
req = build_request(:get_portal_product_sharing_policy, params)
|
|
3508
|
+
req.send_request(options)
|
|
3509
|
+
end
|
|
3510
|
+
|
|
3511
|
+
# Gets a product page of a portal product.
|
|
3512
|
+
#
|
|
3513
|
+
# @option params [required, String] :portal_product_id
|
|
3514
|
+
#
|
|
3515
|
+
# @option params [required, String] :product_page_id
|
|
3516
|
+
#
|
|
3517
|
+
# @option params [String] :resource_owner_account_id
|
|
3518
|
+
#
|
|
3519
|
+
# @return [Types::GetProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3520
|
+
#
|
|
3521
|
+
# * {Types::GetProductPageResponse#display_content #display_content} => Types::DisplayContent
|
|
3522
|
+
# * {Types::GetProductPageResponse#last_modified #last_modified} => Time
|
|
3523
|
+
# * {Types::GetProductPageResponse#product_page_arn #product_page_arn} => String
|
|
3524
|
+
# * {Types::GetProductPageResponse#product_page_id #product_page_id} => String
|
|
3525
|
+
#
|
|
3526
|
+
# @example Request syntax with placeholder values
|
|
3527
|
+
#
|
|
3528
|
+
# resp = client.get_product_page({
|
|
3529
|
+
# portal_product_id: "__string", # required
|
|
3530
|
+
# product_page_id: "__string", # required
|
|
3531
|
+
# resource_owner_account_id: "__string",
|
|
3532
|
+
# })
|
|
3533
|
+
#
|
|
3534
|
+
# @example Response structure
|
|
3535
|
+
#
|
|
3536
|
+
# resp.display_content.body #=> String
|
|
3537
|
+
# resp.display_content.title #=> String
|
|
3538
|
+
# resp.last_modified #=> Time
|
|
3539
|
+
# resp.product_page_arn #=> String
|
|
3540
|
+
# resp.product_page_id #=> String
|
|
3541
|
+
#
|
|
3542
|
+
# @overload get_product_page(params = {})
|
|
3543
|
+
# @param [Hash] params ({})
|
|
3544
|
+
def get_product_page(params = {}, options = {})
|
|
3545
|
+
req = build_request(:get_product_page, params)
|
|
3546
|
+
req.send_request(options)
|
|
3547
|
+
end
|
|
3548
|
+
|
|
3549
|
+
# Gets a product REST endpoint page.
|
|
3550
|
+
#
|
|
3551
|
+
# @option params [String] :include_raw_display_content
|
|
3552
|
+
#
|
|
3553
|
+
# @option params [required, String] :portal_product_id
|
|
3554
|
+
#
|
|
3555
|
+
# @option params [required, String] :product_rest_endpoint_page_id
|
|
3556
|
+
#
|
|
3557
|
+
# @option params [String] :resource_owner_account_id
|
|
3558
|
+
#
|
|
3559
|
+
# @return [Types::GetProductRestEndpointPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3560
|
+
#
|
|
3561
|
+
# * {Types::GetProductRestEndpointPageResponse#display_content #display_content} => Types::EndpointDisplayContentResponse
|
|
3562
|
+
# * {Types::GetProductRestEndpointPageResponse#last_modified #last_modified} => Time
|
|
3563
|
+
# * {Types::GetProductRestEndpointPageResponse#product_rest_endpoint_page_arn #product_rest_endpoint_page_arn} => String
|
|
3564
|
+
# * {Types::GetProductRestEndpointPageResponse#product_rest_endpoint_page_id #product_rest_endpoint_page_id} => String
|
|
3565
|
+
# * {Types::GetProductRestEndpointPageResponse#raw_display_content #raw_display_content} => String
|
|
3566
|
+
# * {Types::GetProductRestEndpointPageResponse#rest_endpoint_identifier #rest_endpoint_identifier} => Types::RestEndpointIdentifier
|
|
3567
|
+
# * {Types::GetProductRestEndpointPageResponse#status #status} => String
|
|
3568
|
+
# * {Types::GetProductRestEndpointPageResponse#status_exception #status_exception} => Types::StatusException
|
|
3569
|
+
# * {Types::GetProductRestEndpointPageResponse#try_it_state #try_it_state} => String
|
|
3570
|
+
#
|
|
3571
|
+
# @example Request syntax with placeholder values
|
|
3572
|
+
#
|
|
3573
|
+
# resp = client.get_product_rest_endpoint_page({
|
|
3574
|
+
# include_raw_display_content: "__string",
|
|
3575
|
+
# portal_product_id: "__string", # required
|
|
3576
|
+
# product_rest_endpoint_page_id: "__string", # required
|
|
3577
|
+
# resource_owner_account_id: "__string",
|
|
3578
|
+
# })
|
|
3579
|
+
#
|
|
3580
|
+
# @example Response structure
|
|
3581
|
+
#
|
|
3582
|
+
# resp.display_content.body #=> String
|
|
3583
|
+
# resp.display_content.endpoint #=> String
|
|
3584
|
+
# resp.display_content.operation_name #=> String
|
|
3585
|
+
# resp.last_modified #=> Time
|
|
3586
|
+
# resp.product_rest_endpoint_page_arn #=> String
|
|
3587
|
+
# resp.product_rest_endpoint_page_id #=> String
|
|
3588
|
+
# resp.raw_display_content #=> String
|
|
3589
|
+
# resp.rest_endpoint_identifier.identifier_parts.method #=> String
|
|
3590
|
+
# resp.rest_endpoint_identifier.identifier_parts.path #=> String
|
|
3591
|
+
# resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
|
|
3592
|
+
# resp.rest_endpoint_identifier.identifier_parts.stage #=> String
|
|
3593
|
+
# resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
|
|
3594
|
+
# resp.status_exception.exception #=> String
|
|
3595
|
+
# resp.status_exception.message #=> String
|
|
3596
|
+
# resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
|
|
3597
|
+
#
|
|
3598
|
+
# @overload get_product_rest_endpoint_page(params = {})
|
|
3599
|
+
# @param [Hash] params ({})
|
|
3600
|
+
def get_product_rest_endpoint_page(params = {}, options = {})
|
|
3601
|
+
req = build_request(:get_product_rest_endpoint_page, params)
|
|
3602
|
+
req.send_request(options)
|
|
3603
|
+
end
|
|
3604
|
+
|
|
3605
|
+
# Gets a Route.
|
|
3606
|
+
#
|
|
3607
|
+
# @option params [required, String] :api_id
|
|
3608
|
+
#
|
|
3609
|
+
# @option params [required, String] :route_id
|
|
3610
|
+
#
|
|
3611
|
+
# @return [Types::GetRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3612
|
+
#
|
|
3613
|
+
# * {Types::GetRouteResult#api_gateway_managed #api_gateway_managed} => Boolean
|
|
3614
|
+
# * {Types::GetRouteResult#api_key_required #api_key_required} => Boolean
|
|
3615
|
+
# * {Types::GetRouteResult#authorization_scopes #authorization_scopes} => Array<String>
|
|
3616
|
+
# * {Types::GetRouteResult#authorization_type #authorization_type} => String
|
|
3617
|
+
# * {Types::GetRouteResult#authorizer_id #authorizer_id} => String
|
|
3618
|
+
# * {Types::GetRouteResult#model_selection_expression #model_selection_expression} => String
|
|
3619
|
+
# * {Types::GetRouteResult#operation_name #operation_name} => String
|
|
3620
|
+
# * {Types::GetRouteResult#request_models #request_models} => Hash<String,String>
|
|
3621
|
+
# * {Types::GetRouteResult#request_parameters #request_parameters} => Hash<String,Types::ParameterConstraints>
|
|
3622
|
+
# * {Types::GetRouteResult#route_id #route_id} => String
|
|
3623
|
+
# * {Types::GetRouteResult#route_key #route_key} => String
|
|
3624
|
+
# * {Types::GetRouteResult#route_response_selection_expression #route_response_selection_expression} => String
|
|
3625
|
+
# * {Types::GetRouteResult#target #target} => String
|
|
3626
|
+
#
|
|
3627
|
+
# @example Request syntax with placeholder values
|
|
3628
|
+
#
|
|
3629
|
+
# resp = client.get_route({
|
|
3630
|
+
# api_id: "__string", # required
|
|
3631
|
+
# route_id: "__string", # required
|
|
3632
|
+
# })
|
|
3633
|
+
#
|
|
3634
|
+
# @example Response structure
|
|
3635
|
+
#
|
|
3636
|
+
# resp.api_gateway_managed #=> Boolean
|
|
3637
|
+
# resp.api_key_required #=> Boolean
|
|
3638
|
+
# resp.authorization_scopes #=> Array
|
|
3639
|
+
# resp.authorization_scopes[0] #=> String
|
|
3640
|
+
# resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
|
|
3641
|
+
# resp.authorizer_id #=> String
|
|
3642
|
+
# resp.model_selection_expression #=> String
|
|
3643
|
+
# resp.operation_name #=> String
|
|
3644
|
+
# resp.request_models #=> Hash
|
|
3645
|
+
# resp.request_models["__string"] #=> String
|
|
3646
|
+
# resp.request_parameters #=> Hash
|
|
3647
|
+
# resp.request_parameters["__string"].required #=> Boolean
|
|
3648
|
+
# resp.route_id #=> String
|
|
3649
|
+
# resp.route_key #=> String
|
|
3650
|
+
# resp.route_response_selection_expression #=> String
|
|
3651
|
+
# resp.target #=> String
|
|
3652
|
+
#
|
|
3653
|
+
# @overload get_route(params = {})
|
|
3654
|
+
# @param [Hash] params ({})
|
|
3655
|
+
def get_route(params = {}, options = {})
|
|
3656
|
+
req = build_request(:get_route, params)
|
|
3657
|
+
req.send_request(options)
|
|
3658
|
+
end
|
|
3659
|
+
|
|
3660
|
+
# Gets a RouteResponse.
|
|
3661
|
+
#
|
|
3662
|
+
# @option params [required, String] :api_id
|
|
3663
|
+
#
|
|
3664
|
+
# @option params [required, String] :route_id
|
|
3665
|
+
#
|
|
3666
|
+
# @option params [required, String] :route_response_id
|
|
3667
|
+
#
|
|
3668
|
+
# @return [Types::GetRouteResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3669
|
+
#
|
|
3670
|
+
# * {Types::GetRouteResponseResponse#model_selection_expression #model_selection_expression} => String
|
|
3671
|
+
# * {Types::GetRouteResponseResponse#response_models #response_models} => Hash<String,String>
|
|
3672
|
+
# * {Types::GetRouteResponseResponse#response_parameters #response_parameters} => Hash<String,Types::ParameterConstraints>
|
|
3673
|
+
# * {Types::GetRouteResponseResponse#route_response_id #route_response_id} => String
|
|
3674
|
+
# * {Types::GetRouteResponseResponse#route_response_key #route_response_key} => String
|
|
3675
|
+
#
|
|
3676
|
+
# @example Request syntax with placeholder values
|
|
3677
|
+
#
|
|
3678
|
+
# resp = client.get_route_response({
|
|
3679
|
+
# api_id: "__string", # required
|
|
3680
|
+
# route_id: "__string", # required
|
|
3681
|
+
# route_response_id: "__string", # required
|
|
3682
|
+
# })
|
|
3683
|
+
#
|
|
3684
|
+
# @example Response structure
|
|
3685
|
+
#
|
|
3686
|
+
# resp.model_selection_expression #=> String
|
|
3687
|
+
# resp.response_models #=> Hash
|
|
3688
|
+
# resp.response_models["__string"] #=> String
|
|
3689
|
+
# resp.response_parameters #=> Hash
|
|
3690
|
+
# resp.response_parameters["__string"].required #=> Boolean
|
|
3691
|
+
# resp.route_response_id #=> String
|
|
3692
|
+
# resp.route_response_key #=> String
|
|
3693
|
+
#
|
|
3694
|
+
# @overload get_route_response(params = {})
|
|
3695
|
+
# @param [Hash] params ({})
|
|
3696
|
+
def get_route_response(params = {}, options = {})
|
|
3697
|
+
req = build_request(:get_route_response, params)
|
|
3698
|
+
req.send_request(options)
|
|
3699
|
+
end
|
|
3700
|
+
|
|
3701
|
+
# Gets the RouteResponses for a Route.
|
|
3702
|
+
#
|
|
3703
|
+
# @option params [required, String] :api_id
|
|
3704
|
+
#
|
|
3705
|
+
# @option params [String] :max_results
|
|
3706
|
+
#
|
|
3707
|
+
# @option params [String] :next_token
|
|
3708
|
+
#
|
|
3709
|
+
# @option params [required, String] :route_id
|
|
3710
|
+
#
|
|
3711
|
+
# @return [Types::GetRouteResponsesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3065
3712
|
#
|
|
3066
3713
|
# * {Types::GetRouteResponsesResponse#items #items} => Array<Types::RouteResponse>
|
|
3067
3714
|
# * {Types::GetRouteResponsesResponse#next_token #next_token} => String
|
|
@@ -3190,57 +3837,6 @@ module Aws::ApiGatewayV2
|
|
|
3190
3837
|
req.send_request(options)
|
|
3191
3838
|
end
|
|
3192
3839
|
|
|
3193
|
-
# Lists routing rules.
|
|
3194
|
-
#
|
|
3195
|
-
# @option params [required, String] :domain_name
|
|
3196
|
-
#
|
|
3197
|
-
# @option params [String] :domain_name_id
|
|
3198
|
-
#
|
|
3199
|
-
# @option params [Integer] :max_results
|
|
3200
|
-
#
|
|
3201
|
-
# @option params [String] :next_token
|
|
3202
|
-
#
|
|
3203
|
-
# @return [Types::ListRoutingRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3204
|
-
#
|
|
3205
|
-
# * {Types::ListRoutingRulesResponse#next_token #next_token} => String
|
|
3206
|
-
# * {Types::ListRoutingRulesResponse#routing_rules #routing_rules} => Array<Types::RoutingRule>
|
|
3207
|
-
#
|
|
3208
|
-
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3209
|
-
#
|
|
3210
|
-
# @example Request syntax with placeholder values
|
|
3211
|
-
#
|
|
3212
|
-
# resp = client.list_routing_rules({
|
|
3213
|
-
# domain_name: "__string", # required
|
|
3214
|
-
# domain_name_id: "__string",
|
|
3215
|
-
# max_results: 1,
|
|
3216
|
-
# next_token: "__string",
|
|
3217
|
-
# })
|
|
3218
|
-
#
|
|
3219
|
-
# @example Response structure
|
|
3220
|
-
#
|
|
3221
|
-
# resp.next_token #=> String
|
|
3222
|
-
# resp.routing_rules #=> Array
|
|
3223
|
-
# resp.routing_rules[0].actions #=> Array
|
|
3224
|
-
# resp.routing_rules[0].actions[0].invoke_api.api_id #=> String
|
|
3225
|
-
# resp.routing_rules[0].actions[0].invoke_api.stage #=> String
|
|
3226
|
-
# resp.routing_rules[0].actions[0].invoke_api.strip_base_path #=> Boolean
|
|
3227
|
-
# resp.routing_rules[0].conditions #=> Array
|
|
3228
|
-
# resp.routing_rules[0].conditions[0].match_base_paths.any_of #=> Array
|
|
3229
|
-
# resp.routing_rules[0].conditions[0].match_base_paths.any_of[0] #=> String
|
|
3230
|
-
# resp.routing_rules[0].conditions[0].match_headers.any_of #=> Array
|
|
3231
|
-
# resp.routing_rules[0].conditions[0].match_headers.any_of[0].header #=> String
|
|
3232
|
-
# resp.routing_rules[0].conditions[0].match_headers.any_of[0].value_glob #=> String
|
|
3233
|
-
# resp.routing_rules[0].priority #=> Integer
|
|
3234
|
-
# resp.routing_rules[0].routing_rule_arn #=> String
|
|
3235
|
-
# resp.routing_rules[0].routing_rule_id #=> String
|
|
3236
|
-
#
|
|
3237
|
-
# @overload list_routing_rules(params = {})
|
|
3238
|
-
# @param [Hash] params ({})
|
|
3239
|
-
def list_routing_rules(params = {}, options = {})
|
|
3240
|
-
req = build_request(:list_routing_rules, params)
|
|
3241
|
-
req.send_request(options)
|
|
3242
|
-
end
|
|
3243
|
-
|
|
3244
3840
|
# Gets a Stage.
|
|
3245
3841
|
#
|
|
3246
3842
|
# @option params [required, String] :api_id
|
|
@@ -3553,6 +4149,323 @@ module Aws::ApiGatewayV2
|
|
|
3553
4149
|
req.send_request(options)
|
|
3554
4150
|
end
|
|
3555
4151
|
|
|
4152
|
+
# Lists portal products.
|
|
4153
|
+
#
|
|
4154
|
+
# @option params [String] :max_results
|
|
4155
|
+
#
|
|
4156
|
+
# @option params [String] :next_token
|
|
4157
|
+
#
|
|
4158
|
+
# @option params [String] :resource_owner
|
|
4159
|
+
#
|
|
4160
|
+
# @return [Types::ListPortalProductsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4161
|
+
#
|
|
4162
|
+
# * {Types::ListPortalProductsResponse#items #items} => Array<Types::PortalProductSummary>
|
|
4163
|
+
# * {Types::ListPortalProductsResponse#next_token #next_token} => String
|
|
4164
|
+
#
|
|
4165
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4166
|
+
#
|
|
4167
|
+
# @example Request syntax with placeholder values
|
|
4168
|
+
#
|
|
4169
|
+
# resp = client.list_portal_products({
|
|
4170
|
+
# max_results: "__string",
|
|
4171
|
+
# next_token: "__string",
|
|
4172
|
+
# resource_owner: "__string",
|
|
4173
|
+
# })
|
|
4174
|
+
#
|
|
4175
|
+
# @example Response structure
|
|
4176
|
+
#
|
|
4177
|
+
# resp.items #=> Array
|
|
4178
|
+
# resp.items[0].description #=> String
|
|
4179
|
+
# resp.items[0].display_name #=> String
|
|
4180
|
+
# resp.items[0].last_modified #=> Time
|
|
4181
|
+
# resp.items[0].portal_product_arn #=> String
|
|
4182
|
+
# resp.items[0].portal_product_id #=> String
|
|
4183
|
+
# resp.items[0].tags #=> Hash
|
|
4184
|
+
# resp.items[0].tags["__string"] #=> String
|
|
4185
|
+
# resp.next_token #=> String
|
|
4186
|
+
#
|
|
4187
|
+
# @overload list_portal_products(params = {})
|
|
4188
|
+
# @param [Hash] params ({})
|
|
4189
|
+
def list_portal_products(params = {}, options = {})
|
|
4190
|
+
req = build_request(:list_portal_products, params)
|
|
4191
|
+
req.send_request(options)
|
|
4192
|
+
end
|
|
4193
|
+
|
|
4194
|
+
# Lists portals.
|
|
4195
|
+
#
|
|
4196
|
+
# @option params [String] :max_results
|
|
4197
|
+
#
|
|
4198
|
+
# @option params [String] :next_token
|
|
4199
|
+
#
|
|
4200
|
+
# @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4201
|
+
#
|
|
4202
|
+
# * {Types::ListPortalsResponse#items #items} => Array<Types::PortalSummary>
|
|
4203
|
+
# * {Types::ListPortalsResponse#next_token #next_token} => String
|
|
4204
|
+
#
|
|
4205
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4206
|
+
#
|
|
4207
|
+
# @example Request syntax with placeholder values
|
|
4208
|
+
#
|
|
4209
|
+
# resp = client.list_portals({
|
|
4210
|
+
# max_results: "__string",
|
|
4211
|
+
# next_token: "__string",
|
|
4212
|
+
# })
|
|
4213
|
+
#
|
|
4214
|
+
# @example Response structure
|
|
4215
|
+
#
|
|
4216
|
+
# resp.items #=> Array
|
|
4217
|
+
# resp.items[0].authorization.cognito_config.app_client_id #=> String
|
|
4218
|
+
# resp.items[0].authorization.cognito_config.user_pool_arn #=> String
|
|
4219
|
+
# resp.items[0].authorization.cognito_config.user_pool_domain #=> String
|
|
4220
|
+
# resp.items[0].endpoint_configuration.certificate_arn #=> String
|
|
4221
|
+
# resp.items[0].endpoint_configuration.domain_name #=> String
|
|
4222
|
+
# resp.items[0].endpoint_configuration.portal_default_domain_name #=> String
|
|
4223
|
+
# resp.items[0].endpoint_configuration.portal_domain_hosted_zone_id #=> String
|
|
4224
|
+
# resp.items[0].included_portal_product_arns #=> Array
|
|
4225
|
+
# resp.items[0].included_portal_product_arns[0] #=> String
|
|
4226
|
+
# resp.items[0].last_modified #=> Time
|
|
4227
|
+
# resp.items[0].last_published #=> Time
|
|
4228
|
+
# resp.items[0].last_published_description #=> String
|
|
4229
|
+
# resp.items[0].portal_arn #=> String
|
|
4230
|
+
# resp.items[0].portal_content.description #=> String
|
|
4231
|
+
# resp.items[0].portal_content.display_name #=> String
|
|
4232
|
+
# resp.items[0].portal_content.theme.custom_colors.accent_color #=> String
|
|
4233
|
+
# resp.items[0].portal_content.theme.custom_colors.background_color #=> String
|
|
4234
|
+
# resp.items[0].portal_content.theme.custom_colors.error_validation_color #=> String
|
|
4235
|
+
# resp.items[0].portal_content.theme.custom_colors.header_color #=> String
|
|
4236
|
+
# resp.items[0].portal_content.theme.custom_colors.navigation_color #=> String
|
|
4237
|
+
# resp.items[0].portal_content.theme.custom_colors.text_color #=> String
|
|
4238
|
+
# resp.items[0].portal_content.theme.logo_last_uploaded #=> Time
|
|
4239
|
+
# resp.items[0].portal_id #=> String
|
|
4240
|
+
# resp.items[0].preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
|
|
4241
|
+
# resp.items[0].preview.preview_url #=> String
|
|
4242
|
+
# resp.items[0].preview.status_exception.exception #=> String
|
|
4243
|
+
# resp.items[0].preview.status_exception.message #=> String
|
|
4244
|
+
# resp.items[0].publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLED"
|
|
4245
|
+
# resp.items[0].rum_app_monitor_name #=> String
|
|
4246
|
+
# resp.items[0].status_exception.exception #=> String
|
|
4247
|
+
# resp.items[0].status_exception.message #=> String
|
|
4248
|
+
# resp.items[0].tags #=> Hash
|
|
4249
|
+
# resp.items[0].tags["__string"] #=> String
|
|
4250
|
+
# resp.next_token #=> String
|
|
4251
|
+
#
|
|
4252
|
+
# @overload list_portals(params = {})
|
|
4253
|
+
# @param [Hash] params ({})
|
|
4254
|
+
def list_portals(params = {}, options = {})
|
|
4255
|
+
req = build_request(:list_portals, params)
|
|
4256
|
+
req.send_request(options)
|
|
4257
|
+
end
|
|
4258
|
+
|
|
4259
|
+
# Lists the product pages for a portal product.
|
|
4260
|
+
#
|
|
4261
|
+
# @option params [String] :max_results
|
|
4262
|
+
#
|
|
4263
|
+
# @option params [String] :next_token
|
|
4264
|
+
#
|
|
4265
|
+
# @option params [required, String] :portal_product_id
|
|
4266
|
+
#
|
|
4267
|
+
# @option params [String] :resource_owner_account_id
|
|
4268
|
+
#
|
|
4269
|
+
# @return [Types::ListProductPagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4270
|
+
#
|
|
4271
|
+
# * {Types::ListProductPagesResponse#items #items} => Array<Types::ProductPageSummaryNoBody>
|
|
4272
|
+
# * {Types::ListProductPagesResponse#next_token #next_token} => String
|
|
4273
|
+
#
|
|
4274
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4275
|
+
#
|
|
4276
|
+
# @example Request syntax with placeholder values
|
|
4277
|
+
#
|
|
4278
|
+
# resp = client.list_product_pages({
|
|
4279
|
+
# max_results: "__string",
|
|
4280
|
+
# next_token: "__string",
|
|
4281
|
+
# portal_product_id: "__string", # required
|
|
4282
|
+
# resource_owner_account_id: "__string",
|
|
4283
|
+
# })
|
|
4284
|
+
#
|
|
4285
|
+
# @example Response structure
|
|
4286
|
+
#
|
|
4287
|
+
# resp.items #=> Array
|
|
4288
|
+
# resp.items[0].last_modified #=> Time
|
|
4289
|
+
# resp.items[0].page_title #=> String
|
|
4290
|
+
# resp.items[0].product_page_arn #=> String
|
|
4291
|
+
# resp.items[0].product_page_id #=> String
|
|
4292
|
+
# resp.next_token #=> String
|
|
4293
|
+
#
|
|
4294
|
+
# @overload list_product_pages(params = {})
|
|
4295
|
+
# @param [Hash] params ({})
|
|
4296
|
+
def list_product_pages(params = {}, options = {})
|
|
4297
|
+
req = build_request(:list_product_pages, params)
|
|
4298
|
+
req.send_request(options)
|
|
4299
|
+
end
|
|
4300
|
+
|
|
4301
|
+
# Lists the product REST endpoint pages of a portal product.
|
|
4302
|
+
#
|
|
4303
|
+
# @option params [String] :max_results
|
|
4304
|
+
#
|
|
4305
|
+
# @option params [String] :next_token
|
|
4306
|
+
#
|
|
4307
|
+
# @option params [required, String] :portal_product_id
|
|
4308
|
+
#
|
|
4309
|
+
# @option params [String] :resource_owner_account_id
|
|
4310
|
+
#
|
|
4311
|
+
# @return [Types::ListProductRestEndpointPagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4312
|
+
#
|
|
4313
|
+
# * {Types::ListProductRestEndpointPagesResponse#items #items} => Array<Types::ProductRestEndpointPageSummaryNoBody>
|
|
4314
|
+
# * {Types::ListProductRestEndpointPagesResponse#next_token #next_token} => String
|
|
4315
|
+
#
|
|
4316
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4317
|
+
#
|
|
4318
|
+
# @example Request syntax with placeholder values
|
|
4319
|
+
#
|
|
4320
|
+
# resp = client.list_product_rest_endpoint_pages({
|
|
4321
|
+
# max_results: "__string",
|
|
4322
|
+
# next_token: "__string",
|
|
4323
|
+
# portal_product_id: "__string", # required
|
|
4324
|
+
# resource_owner_account_id: "__string",
|
|
4325
|
+
# })
|
|
4326
|
+
#
|
|
4327
|
+
# @example Response structure
|
|
4328
|
+
#
|
|
4329
|
+
# resp.items #=> Array
|
|
4330
|
+
# resp.items[0].endpoint #=> String
|
|
4331
|
+
# resp.items[0].last_modified #=> Time
|
|
4332
|
+
# resp.items[0].operation_name #=> String
|
|
4333
|
+
# resp.items[0].product_rest_endpoint_page_arn #=> String
|
|
4334
|
+
# resp.items[0].product_rest_endpoint_page_id #=> String
|
|
4335
|
+
# resp.items[0].rest_endpoint_identifier.identifier_parts.method #=> String
|
|
4336
|
+
# resp.items[0].rest_endpoint_identifier.identifier_parts.path #=> String
|
|
4337
|
+
# resp.items[0].rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
|
|
4338
|
+
# resp.items[0].rest_endpoint_identifier.identifier_parts.stage #=> String
|
|
4339
|
+
# resp.items[0].status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
|
|
4340
|
+
# resp.items[0].status_exception.exception #=> String
|
|
4341
|
+
# resp.items[0].status_exception.message #=> String
|
|
4342
|
+
# resp.items[0].try_it_state #=> String, one of "ENABLED", "DISABLED"
|
|
4343
|
+
# resp.next_token #=> String
|
|
4344
|
+
#
|
|
4345
|
+
# @overload list_product_rest_endpoint_pages(params = {})
|
|
4346
|
+
# @param [Hash] params ({})
|
|
4347
|
+
def list_product_rest_endpoint_pages(params = {}, options = {})
|
|
4348
|
+
req = build_request(:list_product_rest_endpoint_pages, params)
|
|
4349
|
+
req.send_request(options)
|
|
4350
|
+
end
|
|
4351
|
+
|
|
4352
|
+
# Lists routing rules.
|
|
4353
|
+
#
|
|
4354
|
+
# @option params [required, String] :domain_name
|
|
4355
|
+
#
|
|
4356
|
+
# @option params [String] :domain_name_id
|
|
4357
|
+
#
|
|
4358
|
+
# @option params [Integer] :max_results
|
|
4359
|
+
#
|
|
4360
|
+
# @option params [String] :next_token
|
|
4361
|
+
#
|
|
4362
|
+
# @return [Types::ListRoutingRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4363
|
+
#
|
|
4364
|
+
# * {Types::ListRoutingRulesResponse#next_token #next_token} => String
|
|
4365
|
+
# * {Types::ListRoutingRulesResponse#routing_rules #routing_rules} => Array<Types::RoutingRule>
|
|
4366
|
+
#
|
|
4367
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4368
|
+
#
|
|
4369
|
+
# @example Request syntax with placeholder values
|
|
4370
|
+
#
|
|
4371
|
+
# resp = client.list_routing_rules({
|
|
4372
|
+
# domain_name: "__string", # required
|
|
4373
|
+
# domain_name_id: "__string",
|
|
4374
|
+
# max_results: 1,
|
|
4375
|
+
# next_token: "__string",
|
|
4376
|
+
# })
|
|
4377
|
+
#
|
|
4378
|
+
# @example Response structure
|
|
4379
|
+
#
|
|
4380
|
+
# resp.next_token #=> String
|
|
4381
|
+
# resp.routing_rules #=> Array
|
|
4382
|
+
# resp.routing_rules[0].actions #=> Array
|
|
4383
|
+
# resp.routing_rules[0].actions[0].invoke_api.api_id #=> String
|
|
4384
|
+
# resp.routing_rules[0].actions[0].invoke_api.stage #=> String
|
|
4385
|
+
# resp.routing_rules[0].actions[0].invoke_api.strip_base_path #=> Boolean
|
|
4386
|
+
# resp.routing_rules[0].conditions #=> Array
|
|
4387
|
+
# resp.routing_rules[0].conditions[0].match_base_paths.any_of #=> Array
|
|
4388
|
+
# resp.routing_rules[0].conditions[0].match_base_paths.any_of[0] #=> String
|
|
4389
|
+
# resp.routing_rules[0].conditions[0].match_headers.any_of #=> Array
|
|
4390
|
+
# resp.routing_rules[0].conditions[0].match_headers.any_of[0].header #=> String
|
|
4391
|
+
# resp.routing_rules[0].conditions[0].match_headers.any_of[0].value_glob #=> String
|
|
4392
|
+
# resp.routing_rules[0].priority #=> Integer
|
|
4393
|
+
# resp.routing_rules[0].routing_rule_arn #=> String
|
|
4394
|
+
# resp.routing_rules[0].routing_rule_id #=> String
|
|
4395
|
+
#
|
|
4396
|
+
# @overload list_routing_rules(params = {})
|
|
4397
|
+
# @param [Hash] params ({})
|
|
4398
|
+
def list_routing_rules(params = {}, options = {})
|
|
4399
|
+
req = build_request(:list_routing_rules, params)
|
|
4400
|
+
req.send_request(options)
|
|
4401
|
+
end
|
|
4402
|
+
|
|
4403
|
+
# Creates a portal preview.
|
|
4404
|
+
#
|
|
4405
|
+
# @option params [required, String] :portal_id
|
|
4406
|
+
#
|
|
4407
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4408
|
+
#
|
|
4409
|
+
# @example Request syntax with placeholder values
|
|
4410
|
+
#
|
|
4411
|
+
# resp = client.preview_portal({
|
|
4412
|
+
# portal_id: "__string", # required
|
|
4413
|
+
# })
|
|
4414
|
+
#
|
|
4415
|
+
# @overload preview_portal(params = {})
|
|
4416
|
+
# @param [Hash] params ({})
|
|
4417
|
+
def preview_portal(params = {}, options = {})
|
|
4418
|
+
req = build_request(:preview_portal, params)
|
|
4419
|
+
req.send_request(options)
|
|
4420
|
+
end
|
|
4421
|
+
|
|
4422
|
+
# Publishes a portal.
|
|
4423
|
+
#
|
|
4424
|
+
# @option params [String] :description
|
|
4425
|
+
#
|
|
4426
|
+
# @option params [required, String] :portal_id
|
|
4427
|
+
#
|
|
4428
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4429
|
+
#
|
|
4430
|
+
# @example Request syntax with placeholder values
|
|
4431
|
+
#
|
|
4432
|
+
# resp = client.publish_portal({
|
|
4433
|
+
# description: "__stringMin0Max1024",
|
|
4434
|
+
# portal_id: "__string", # required
|
|
4435
|
+
# })
|
|
4436
|
+
#
|
|
4437
|
+
# @overload publish_portal(params = {})
|
|
4438
|
+
# @param [Hash] params ({})
|
|
4439
|
+
def publish_portal(params = {}, options = {})
|
|
4440
|
+
req = build_request(:publish_portal, params)
|
|
4441
|
+
req.send_request(options)
|
|
4442
|
+
end
|
|
4443
|
+
|
|
4444
|
+
# Updates the sharing policy for a portal product.
|
|
4445
|
+
#
|
|
4446
|
+
# @option params [required, String] :policy_document
|
|
4447
|
+
#
|
|
4448
|
+
# @option params [required, String] :portal_product_id
|
|
4449
|
+
#
|
|
4450
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4451
|
+
#
|
|
4452
|
+
# @example Request syntax with placeholder values
|
|
4453
|
+
#
|
|
4454
|
+
# resp = client.put_portal_product_sharing_policy({
|
|
4455
|
+
# policy_document: "__stringMin1Max307200", # required
|
|
4456
|
+
# portal_product_id: "__string", # required
|
|
4457
|
+
# })
|
|
4458
|
+
#
|
|
4459
|
+
# @overload put_portal_product_sharing_policy(params = {})
|
|
4460
|
+
# @param [Hash] params ({})
|
|
4461
|
+
def put_portal_product_sharing_policy(params = {}, options = {})
|
|
4462
|
+
req = build_request(:put_portal_product_sharing_policy, params)
|
|
4463
|
+
req.send_request(options)
|
|
4464
|
+
end
|
|
4465
|
+
|
|
4466
|
+
# Replaces an existing routing rule. When you replace an existing
|
|
4467
|
+
# routing rule, the RoutingRuleId isn't changed.
|
|
4468
|
+
#
|
|
3556
4469
|
# @option params [required, Array<Types::RoutingRuleAction>] :actions
|
|
3557
4470
|
#
|
|
3558
4471
|
# @option params [required, Array<Types::RoutingRuleCondition>] :conditions
|
|
@@ -3562,7 +4475,9 @@ module Aws::ApiGatewayV2
|
|
|
3562
4475
|
# @option params [String] :domain_name_id
|
|
3563
4476
|
#
|
|
3564
4477
|
# @option params [required, Integer] :priority
|
|
3565
|
-
#
|
|
4478
|
+
# The order in which API Gateway evaluates a rule. Priority is evaluated
|
|
4479
|
+
# from the lowest value to the highest value. Rules can't have the same
|
|
4480
|
+
# priority. Priority values 1-1,000,000 are supported.
|
|
3566
4481
|
#
|
|
3567
4482
|
# @option params [required, String] :routing_rule_id
|
|
3568
4483
|
#
|
|
@@ -4117,6 +5032,7 @@ module Aws::ApiGatewayV2
|
|
|
4117
5032
|
# access your API.
|
|
4118
5033
|
#
|
|
4119
5034
|
# @option params [String] :routing_mode
|
|
5035
|
+
# The routing mode API Gateway uses to route traffic to your APIs.
|
|
4120
5036
|
#
|
|
4121
5037
|
# @return [Types::UpdateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4122
5038
|
#
|
|
@@ -4242,18 +5158,18 @@ module Aws::ApiGatewayV2
|
|
|
4242
5158
|
# parameters are a key-value map specifying parameters that are passed
|
|
4243
5159
|
# to AWS\_PROXY integrations. You can provide static values, or map
|
|
4244
5160
|
# request data, stage variables, or context variables that are evaluated
|
|
4245
|
-
# at runtime. To learn more, see [Working with
|
|
4246
|
-
# for HTTP APIs][1].
|
|
5161
|
+
# at runtime. To learn more, see [Working with Amazon Web Services
|
|
5162
|
+
# service integrations for HTTP APIs][1].
|
|
4247
5163
|
#
|
|
4248
5164
|
# For HTTP API integrations without a specified integrationSubtype
|
|
4249
5165
|
# request parameters are a key-value map specifying how to transform
|
|
4250
5166
|
# HTTP requests before sending them to the backend. The key should
|
|
4251
5167
|
# follow the pattern
|
|
4252
|
-
# <action
|
|
4253
|
-
#
|
|
4254
|
-
#
|
|
4255
|
-
#
|
|
4256
|
-
#
|
|
5168
|
+
# <action>:<header\|querystring\|path>.<location> where action
|
|
5169
|
+
# can be append, overwrite or remove. For values, you can provide static
|
|
5170
|
+
# values, or map request data, stage variables, or context variables
|
|
5171
|
+
# that are evaluated at runtime. To learn more, see [Transforming API
|
|
5172
|
+
# requests and responses][2].
|
|
4257
5173
|
#
|
|
4258
5174
|
#
|
|
4259
5175
|
#
|
|
@@ -4414,18 +5330,18 @@ module Aws::ApiGatewayV2
|
|
|
4414
5330
|
# parameters are a key-value map specifying parameters that are passed
|
|
4415
5331
|
# to AWS\_PROXY integrations. You can provide static values, or map
|
|
4416
5332
|
# request data, stage variables, or context variables that are evaluated
|
|
4417
|
-
# at runtime. To learn more, see [Working with
|
|
4418
|
-
# for HTTP APIs][1].
|
|
5333
|
+
# at runtime. To learn more, see [Working with Amazon Web Services
|
|
5334
|
+
# service integrations for HTTP APIs][1].
|
|
4419
5335
|
#
|
|
4420
5336
|
# For HTTP API integrations without a specified integrationSubtype
|
|
4421
5337
|
# request parameters are a key-value map specifying how to transform
|
|
4422
5338
|
# HTTP requests before sending them to the backend. The key should
|
|
4423
5339
|
# follow the pattern
|
|
4424
|
-
# <action
|
|
4425
|
-
#
|
|
4426
|
-
#
|
|
4427
|
-
#
|
|
4428
|
-
#
|
|
5340
|
+
# <action>:<header\|querystring\|path>.<location> where action
|
|
5341
|
+
# can be append, overwrite or remove. For values, you can provide static
|
|
5342
|
+
# values, or map request data, stage variables, or context variables
|
|
5343
|
+
# that are evaluated at runtime. To learn more, see [Transforming API
|
|
5344
|
+
# requests and responses][2].
|
|
4429
5345
|
#
|
|
4430
5346
|
#
|
|
4431
5347
|
#
|
|
@@ -4541,6 +5457,296 @@ module Aws::ApiGatewayV2
|
|
|
4541
5457
|
req.send_request(options)
|
|
4542
5458
|
end
|
|
4543
5459
|
|
|
5460
|
+
# Updates a portal.
|
|
5461
|
+
#
|
|
5462
|
+
# @option params [Types::Authorization] :authorization
|
|
5463
|
+
# Represents an authorization configuration for a portal.
|
|
5464
|
+
#
|
|
5465
|
+
# @option params [Types::EndpointConfigurationRequest] :endpoint_configuration
|
|
5466
|
+
# Represents an endpoint configuration.
|
|
5467
|
+
#
|
|
5468
|
+
# @option params [Array<String>] :included_portal_product_arns
|
|
5469
|
+
#
|
|
5470
|
+
# @option params [String] :logo_uri
|
|
5471
|
+
#
|
|
5472
|
+
# @option params [Types::PortalContent] :portal_content
|
|
5473
|
+
# Contains the content that is visible to portal consumers including the
|
|
5474
|
+
# themes, display names, and description.
|
|
5475
|
+
#
|
|
5476
|
+
# @option params [required, String] :portal_id
|
|
5477
|
+
#
|
|
5478
|
+
# @option params [String] :rum_app_monitor_name
|
|
5479
|
+
#
|
|
5480
|
+
# @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5481
|
+
#
|
|
5482
|
+
# * {Types::UpdatePortalResponse#authorization #authorization} => Types::Authorization
|
|
5483
|
+
# * {Types::UpdatePortalResponse#endpoint_configuration #endpoint_configuration} => Types::EndpointConfigurationResponse
|
|
5484
|
+
# * {Types::UpdatePortalResponse#included_portal_product_arns #included_portal_product_arns} => Array<String>
|
|
5485
|
+
# * {Types::UpdatePortalResponse#last_modified #last_modified} => Time
|
|
5486
|
+
# * {Types::UpdatePortalResponse#last_published #last_published} => Time
|
|
5487
|
+
# * {Types::UpdatePortalResponse#last_published_description #last_published_description} => String
|
|
5488
|
+
# * {Types::UpdatePortalResponse#portal_arn #portal_arn} => String
|
|
5489
|
+
# * {Types::UpdatePortalResponse#portal_content #portal_content} => Types::PortalContent
|
|
5490
|
+
# * {Types::UpdatePortalResponse#portal_id #portal_id} => String
|
|
5491
|
+
# * {Types::UpdatePortalResponse#preview #preview} => Types::Preview
|
|
5492
|
+
# * {Types::UpdatePortalResponse#publish_status #publish_status} => String
|
|
5493
|
+
# * {Types::UpdatePortalResponse#rum_app_monitor_name #rum_app_monitor_name} => String
|
|
5494
|
+
# * {Types::UpdatePortalResponse#status_exception #status_exception} => Types::StatusException
|
|
5495
|
+
# * {Types::UpdatePortalResponse#tags #tags} => Hash<String,String>
|
|
5496
|
+
#
|
|
5497
|
+
# @example Request syntax with placeholder values
|
|
5498
|
+
#
|
|
5499
|
+
# resp = client.update_portal({
|
|
5500
|
+
# authorization: {
|
|
5501
|
+
# cognito_config: {
|
|
5502
|
+
# app_client_id: "__stringMin1Max256", # required
|
|
5503
|
+
# user_pool_arn: "__stringMin20Max2048", # required
|
|
5504
|
+
# user_pool_domain: "__stringMin20Max2048", # required
|
|
5505
|
+
# },
|
|
5506
|
+
# none: {
|
|
5507
|
+
# },
|
|
5508
|
+
# },
|
|
5509
|
+
# endpoint_configuration: {
|
|
5510
|
+
# acm_managed: {
|
|
5511
|
+
# certificate_arn: "__stringMin10Max2048", # required
|
|
5512
|
+
# domain_name: "__stringMin3Max256", # required
|
|
5513
|
+
# },
|
|
5514
|
+
# none: {
|
|
5515
|
+
# },
|
|
5516
|
+
# },
|
|
5517
|
+
# included_portal_product_arns: ["__stringMin20Max2048"],
|
|
5518
|
+
# logo_uri: "__stringMin0Max1092",
|
|
5519
|
+
# portal_content: {
|
|
5520
|
+
# description: "__stringMin0Max1024",
|
|
5521
|
+
# display_name: "__stringMin3Max255", # required
|
|
5522
|
+
# theme: { # required
|
|
5523
|
+
# custom_colors: { # required
|
|
5524
|
+
# accent_color: "__stringMin1Max16", # required
|
|
5525
|
+
# background_color: "__stringMin1Max16", # required
|
|
5526
|
+
# error_validation_color: "__stringMin1Max16", # required
|
|
5527
|
+
# header_color: "__stringMin1Max16", # required
|
|
5528
|
+
# navigation_color: "__stringMin1Max16", # required
|
|
5529
|
+
# text_color: "__stringMin1Max16", # required
|
|
5530
|
+
# },
|
|
5531
|
+
# logo_last_uploaded: Time.now,
|
|
5532
|
+
# },
|
|
5533
|
+
# },
|
|
5534
|
+
# portal_id: "__string", # required
|
|
5535
|
+
# rum_app_monitor_name: "__stringMin0Max255",
|
|
5536
|
+
# })
|
|
5537
|
+
#
|
|
5538
|
+
# @example Response structure
|
|
5539
|
+
#
|
|
5540
|
+
# resp.authorization.cognito_config.app_client_id #=> String
|
|
5541
|
+
# resp.authorization.cognito_config.user_pool_arn #=> String
|
|
5542
|
+
# resp.authorization.cognito_config.user_pool_domain #=> String
|
|
5543
|
+
# resp.endpoint_configuration.certificate_arn #=> String
|
|
5544
|
+
# resp.endpoint_configuration.domain_name #=> String
|
|
5545
|
+
# resp.endpoint_configuration.portal_default_domain_name #=> String
|
|
5546
|
+
# resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
|
|
5547
|
+
# resp.included_portal_product_arns #=> Array
|
|
5548
|
+
# resp.included_portal_product_arns[0] #=> String
|
|
5549
|
+
# resp.last_modified #=> Time
|
|
5550
|
+
# resp.last_published #=> Time
|
|
5551
|
+
# resp.last_published_description #=> String
|
|
5552
|
+
# resp.portal_arn #=> String
|
|
5553
|
+
# resp.portal_content.description #=> String
|
|
5554
|
+
# resp.portal_content.display_name #=> String
|
|
5555
|
+
# resp.portal_content.theme.custom_colors.accent_color #=> String
|
|
5556
|
+
# resp.portal_content.theme.custom_colors.background_color #=> String
|
|
5557
|
+
# resp.portal_content.theme.custom_colors.error_validation_color #=> String
|
|
5558
|
+
# resp.portal_content.theme.custom_colors.header_color #=> String
|
|
5559
|
+
# resp.portal_content.theme.custom_colors.navigation_color #=> String
|
|
5560
|
+
# resp.portal_content.theme.custom_colors.text_color #=> String
|
|
5561
|
+
# resp.portal_content.theme.logo_last_uploaded #=> Time
|
|
5562
|
+
# resp.portal_id #=> String
|
|
5563
|
+
# resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
|
|
5564
|
+
# resp.preview.preview_url #=> String
|
|
5565
|
+
# resp.preview.status_exception.exception #=> String
|
|
5566
|
+
# resp.preview.status_exception.message #=> String
|
|
5567
|
+
# resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLED"
|
|
5568
|
+
# resp.rum_app_monitor_name #=> String
|
|
5569
|
+
# resp.status_exception.exception #=> String
|
|
5570
|
+
# resp.status_exception.message #=> String
|
|
5571
|
+
# resp.tags #=> Hash
|
|
5572
|
+
# resp.tags["__string"] #=> String
|
|
5573
|
+
#
|
|
5574
|
+
# @overload update_portal(params = {})
|
|
5575
|
+
# @param [Hash] params ({})
|
|
5576
|
+
def update_portal(params = {}, options = {})
|
|
5577
|
+
req = build_request(:update_portal, params)
|
|
5578
|
+
req.send_request(options)
|
|
5579
|
+
end
|
|
5580
|
+
|
|
5581
|
+
# Updates the portal product.
|
|
5582
|
+
#
|
|
5583
|
+
# @option params [String] :description
|
|
5584
|
+
#
|
|
5585
|
+
# @option params [String] :display_name
|
|
5586
|
+
#
|
|
5587
|
+
# @option params [Types::DisplayOrder] :display_order
|
|
5588
|
+
# The display order.
|
|
5589
|
+
#
|
|
5590
|
+
# @option params [required, String] :portal_product_id
|
|
5591
|
+
#
|
|
5592
|
+
# @return [Types::UpdatePortalProductResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5593
|
+
#
|
|
5594
|
+
# * {Types::UpdatePortalProductResponse#description #description} => String
|
|
5595
|
+
# * {Types::UpdatePortalProductResponse#display_name #display_name} => String
|
|
5596
|
+
# * {Types::UpdatePortalProductResponse#display_order #display_order} => Types::DisplayOrder
|
|
5597
|
+
# * {Types::UpdatePortalProductResponse#last_modified #last_modified} => Time
|
|
5598
|
+
# * {Types::UpdatePortalProductResponse#portal_product_arn #portal_product_arn} => String
|
|
5599
|
+
# * {Types::UpdatePortalProductResponse#portal_product_id #portal_product_id} => String
|
|
5600
|
+
# * {Types::UpdatePortalProductResponse#tags #tags} => Hash<String,String>
|
|
5601
|
+
#
|
|
5602
|
+
# @example Request syntax with placeholder values
|
|
5603
|
+
#
|
|
5604
|
+
# resp = client.update_portal_product({
|
|
5605
|
+
# description: "__stringMin0Max1024",
|
|
5606
|
+
# display_name: "__stringMin1Max255",
|
|
5607
|
+
# display_order: {
|
|
5608
|
+
# contents: [
|
|
5609
|
+
# {
|
|
5610
|
+
# product_rest_endpoint_page_arns: ["__stringMin20Max2048"], # required
|
|
5611
|
+
# section_name: "__string", # required
|
|
5612
|
+
# },
|
|
5613
|
+
# ],
|
|
5614
|
+
# overview_page_arn: "__stringMin20Max2048",
|
|
5615
|
+
# product_page_arns: ["__stringMin20Max2048"],
|
|
5616
|
+
# },
|
|
5617
|
+
# portal_product_id: "__string", # required
|
|
5618
|
+
# })
|
|
5619
|
+
#
|
|
5620
|
+
# @example Response structure
|
|
5621
|
+
#
|
|
5622
|
+
# resp.description #=> String
|
|
5623
|
+
# resp.display_name #=> String
|
|
5624
|
+
# resp.display_order.contents #=> Array
|
|
5625
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
|
|
5626
|
+
# resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
|
|
5627
|
+
# resp.display_order.contents[0].section_name #=> String
|
|
5628
|
+
# resp.display_order.overview_page_arn #=> String
|
|
5629
|
+
# resp.display_order.product_page_arns #=> Array
|
|
5630
|
+
# resp.display_order.product_page_arns[0] #=> String
|
|
5631
|
+
# resp.last_modified #=> Time
|
|
5632
|
+
# resp.portal_product_arn #=> String
|
|
5633
|
+
# resp.portal_product_id #=> String
|
|
5634
|
+
# resp.tags #=> Hash
|
|
5635
|
+
# resp.tags["__string"] #=> String
|
|
5636
|
+
#
|
|
5637
|
+
# @overload update_portal_product(params = {})
|
|
5638
|
+
# @param [Hash] params ({})
|
|
5639
|
+
def update_portal_product(params = {}, options = {})
|
|
5640
|
+
req = build_request(:update_portal_product, params)
|
|
5641
|
+
req.send_request(options)
|
|
5642
|
+
end
|
|
5643
|
+
|
|
5644
|
+
# Updates a product page of a portal product.
|
|
5645
|
+
#
|
|
5646
|
+
# @option params [Types::DisplayContent] :display_content
|
|
5647
|
+
# The content of the product page.
|
|
5648
|
+
#
|
|
5649
|
+
# @option params [required, String] :portal_product_id
|
|
5650
|
+
#
|
|
5651
|
+
# @option params [required, String] :product_page_id
|
|
5652
|
+
#
|
|
5653
|
+
# @return [Types::UpdateProductPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5654
|
+
#
|
|
5655
|
+
# * {Types::UpdateProductPageResponse#display_content #display_content} => Types::DisplayContent
|
|
5656
|
+
# * {Types::UpdateProductPageResponse#last_modified #last_modified} => Time
|
|
5657
|
+
# * {Types::UpdateProductPageResponse#product_page_arn #product_page_arn} => String
|
|
5658
|
+
# * {Types::UpdateProductPageResponse#product_page_id #product_page_id} => String
|
|
5659
|
+
#
|
|
5660
|
+
# @example Request syntax with placeholder values
|
|
5661
|
+
#
|
|
5662
|
+
# resp = client.update_product_page({
|
|
5663
|
+
# display_content: {
|
|
5664
|
+
# body: "__stringMin1Max32768", # required
|
|
5665
|
+
# title: "__stringMin1Max255", # required
|
|
5666
|
+
# },
|
|
5667
|
+
# portal_product_id: "__string", # required
|
|
5668
|
+
# product_page_id: "__string", # required
|
|
5669
|
+
# })
|
|
5670
|
+
#
|
|
5671
|
+
# @example Response structure
|
|
5672
|
+
#
|
|
5673
|
+
# resp.display_content.body #=> String
|
|
5674
|
+
# resp.display_content.title #=> String
|
|
5675
|
+
# resp.last_modified #=> Time
|
|
5676
|
+
# resp.product_page_arn #=> String
|
|
5677
|
+
# resp.product_page_id #=> String
|
|
5678
|
+
#
|
|
5679
|
+
# @overload update_product_page(params = {})
|
|
5680
|
+
# @param [Hash] params ({})
|
|
5681
|
+
def update_product_page(params = {}, options = {})
|
|
5682
|
+
req = build_request(:update_product_page, params)
|
|
5683
|
+
req.send_request(options)
|
|
5684
|
+
end
|
|
5685
|
+
|
|
5686
|
+
# Updates a product REST endpoint page.
|
|
5687
|
+
#
|
|
5688
|
+
# @option params [Types::EndpointDisplayContent] :display_content
|
|
5689
|
+
# Represents the endpoint display content.
|
|
5690
|
+
#
|
|
5691
|
+
# @option params [required, String] :portal_product_id
|
|
5692
|
+
#
|
|
5693
|
+
# @option params [required, String] :product_rest_endpoint_page_id
|
|
5694
|
+
#
|
|
5695
|
+
# @option params [String] :try_it_state
|
|
5696
|
+
# Represents the try it state for a product REST endpoint page.
|
|
5697
|
+
#
|
|
5698
|
+
# @return [Types::UpdateProductRestEndpointPageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5699
|
+
#
|
|
5700
|
+
# * {Types::UpdateProductRestEndpointPageResponse#display_content #display_content} => Types::EndpointDisplayContentResponse
|
|
5701
|
+
# * {Types::UpdateProductRestEndpointPageResponse#last_modified #last_modified} => Time
|
|
5702
|
+
# * {Types::UpdateProductRestEndpointPageResponse#product_rest_endpoint_page_arn #product_rest_endpoint_page_arn} => String
|
|
5703
|
+
# * {Types::UpdateProductRestEndpointPageResponse#product_rest_endpoint_page_id #product_rest_endpoint_page_id} => String
|
|
5704
|
+
# * {Types::UpdateProductRestEndpointPageResponse#rest_endpoint_identifier #rest_endpoint_identifier} => Types::RestEndpointIdentifier
|
|
5705
|
+
# * {Types::UpdateProductRestEndpointPageResponse#status #status} => String
|
|
5706
|
+
# * {Types::UpdateProductRestEndpointPageResponse#status_exception #status_exception} => Types::StatusException
|
|
5707
|
+
# * {Types::UpdateProductRestEndpointPageResponse#try_it_state #try_it_state} => String
|
|
5708
|
+
#
|
|
5709
|
+
# @example Request syntax with placeholder values
|
|
5710
|
+
#
|
|
5711
|
+
# resp = client.update_product_rest_endpoint_page({
|
|
5712
|
+
# display_content: {
|
|
5713
|
+
# none: {
|
|
5714
|
+
# },
|
|
5715
|
+
# overrides: {
|
|
5716
|
+
# body: "__stringMin1Max32768",
|
|
5717
|
+
# endpoint: "__stringMin1Max1024",
|
|
5718
|
+
# operation_name: "__stringMin1Max255",
|
|
5719
|
+
# },
|
|
5720
|
+
# },
|
|
5721
|
+
# portal_product_id: "__string", # required
|
|
5722
|
+
# product_rest_endpoint_page_id: "__string", # required
|
|
5723
|
+
# try_it_state: "ENABLED", # accepts ENABLED, DISABLED
|
|
5724
|
+
# })
|
|
5725
|
+
#
|
|
5726
|
+
# @example Response structure
|
|
5727
|
+
#
|
|
5728
|
+
# resp.display_content.body #=> String
|
|
5729
|
+
# resp.display_content.endpoint #=> String
|
|
5730
|
+
# resp.display_content.operation_name #=> String
|
|
5731
|
+
# resp.last_modified #=> Time
|
|
5732
|
+
# resp.product_rest_endpoint_page_arn #=> String
|
|
5733
|
+
# resp.product_rest_endpoint_page_id #=> String
|
|
5734
|
+
# resp.rest_endpoint_identifier.identifier_parts.method #=> String
|
|
5735
|
+
# resp.rest_endpoint_identifier.identifier_parts.path #=> String
|
|
5736
|
+
# resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
|
|
5737
|
+
# resp.rest_endpoint_identifier.identifier_parts.stage #=> String
|
|
5738
|
+
# resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
|
|
5739
|
+
# resp.status_exception.exception #=> String
|
|
5740
|
+
# resp.status_exception.message #=> String
|
|
5741
|
+
# resp.try_it_state #=> String, one of "ENABLED", "DISABLED"
|
|
5742
|
+
#
|
|
5743
|
+
# @overload update_product_rest_endpoint_page(params = {})
|
|
5744
|
+
# @param [Hash] params ({})
|
|
5745
|
+
def update_product_rest_endpoint_page(params = {}, options = {})
|
|
5746
|
+
req = build_request(:update_product_rest_endpoint_page, params)
|
|
5747
|
+
req.send_request(options)
|
|
5748
|
+
end
|
|
5749
|
+
|
|
4544
5750
|
# Updates a Route.
|
|
4545
5751
|
#
|
|
4546
5752
|
# @option params [required, String] :api_id
|
|
@@ -4559,10 +5765,11 @@ module Aws::ApiGatewayV2
|
|
|
4559
5765
|
#
|
|
4560
5766
|
# @option params [String] :authorization_type
|
|
4561
5767
|
# The authorization type. For WebSocket APIs, valid values are NONE for
|
|
4562
|
-
# open access, AWS\_IAM for using
|
|
4563
|
-
# using a Lambda authorizer. For HTTP APIs, valid values
|
|
4564
|
-
# open access, JWT for using JSON Web Tokens, AWS\_IAM for
|
|
4565
|
-
# permissions, and CUSTOM for using a
|
|
5768
|
+
# open access, AWS\_IAM for using Amazon Web Services IAM permissions,
|
|
5769
|
+
# and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values
|
|
5770
|
+
# are NONE for open access, JWT for using JSON Web Tokens, AWS\_IAM for
|
|
5771
|
+
# using Amazon Web Services IAM permissions, and CUSTOM for using a
|
|
5772
|
+
# Lambda authorizer.
|
|
4566
5773
|
#
|
|
4567
5774
|
# @option params [String] :authorizer_id
|
|
4568
5775
|
# The identifier.
|
|
@@ -4930,7 +6137,7 @@ module Aws::ApiGatewayV2
|
|
|
4930
6137
|
tracer: tracer
|
|
4931
6138
|
)
|
|
4932
6139
|
context[:gem_name] = 'aws-sdk-apigatewayv2'
|
|
4933
|
-
context[:gem_version] = '1.
|
|
6140
|
+
context[:gem_version] = '1.86.0'
|
|
4934
6141
|
Seahorse::Client::Request.new(handlers, context)
|
|
4935
6142
|
end
|
|
4936
6143
|
|