aws-sdk-appsync 1.47.0 → 1.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-appsync/client.rb +338 -77
- data/lib/aws-sdk-appsync/client_api.rb +187 -0
- data/lib/aws-sdk-appsync/types.rb +537 -195
- data/lib/aws-sdk-appsync.rb +2 -2
- metadata +2 -2
@@ -338,22 +338,57 @@ module Aws::AppSync
|
|
338
338
|
|
339
339
|
# @!group API Operations
|
340
340
|
|
341
|
+
# Maps an endpoint to your custom domain.
|
342
|
+
#
|
343
|
+
# @option params [required, String] :domain_name
|
344
|
+
# The domain name.
|
345
|
+
#
|
346
|
+
# @option params [required, String] :api_id
|
347
|
+
# The API ID.
|
348
|
+
#
|
349
|
+
# @return [Types::AssociateApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
350
|
+
#
|
351
|
+
# * {Types::AssociateApiResponse#api_association #api_association} => Types::ApiAssociation
|
352
|
+
#
|
353
|
+
# @example Request syntax with placeholder values
|
354
|
+
#
|
355
|
+
# resp = client.associate_api({
|
356
|
+
# domain_name: "DomainName", # required
|
357
|
+
# api_id: "String", # required
|
358
|
+
# })
|
359
|
+
#
|
360
|
+
# @example Response structure
|
361
|
+
#
|
362
|
+
# resp.api_association.domain_name #=> String
|
363
|
+
# resp.api_association.api_id #=> String
|
364
|
+
# resp.api_association.association_status #=> String, one of "PROCESSING", "FAILED", "SUCCESS"
|
365
|
+
# resp.api_association.deployment_detail #=> String
|
366
|
+
#
|
367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/AssociateApi AWS API Documentation
|
368
|
+
#
|
369
|
+
# @overload associate_api(params = {})
|
370
|
+
# @param [Hash] params ({})
|
371
|
+
def associate_api(params = {}, options = {})
|
372
|
+
req = build_request(:associate_api, params)
|
373
|
+
req.send_request(options)
|
374
|
+
end
|
375
|
+
|
341
376
|
# Creates a cache for the GraphQL API.
|
342
377
|
#
|
343
378
|
# @option params [required, String] :api_id
|
344
|
-
# The GraphQL API
|
379
|
+
# The GraphQL API ID.
|
345
380
|
#
|
346
381
|
# @option params [required, Integer] :ttl
|
347
382
|
# TTL in seconds for cache entries.
|
348
383
|
#
|
349
|
-
# Valid values are
|
384
|
+
# Valid values are 1–3,600 seconds.
|
350
385
|
#
|
351
386
|
# @option params [Boolean] :transit_encryption_enabled
|
352
|
-
# Transit encryption flag when connecting to cache.
|
353
|
-
#
|
387
|
+
# Transit encryption flag when connecting to cache. You cannot update
|
388
|
+
# this setting after creation.
|
354
389
|
#
|
355
390
|
# @option params [Boolean] :at_rest_encryption_enabled
|
356
|
-
# At
|
391
|
+
# At-rest encryption flag for cache. You cannot update this setting
|
357
392
|
# after creation.
|
358
393
|
#
|
359
394
|
# @option params [required, String] :api_caching_behavior
|
@@ -437,8 +472,8 @@ module Aws::AppSync
|
|
437
472
|
req.send_request(options)
|
438
473
|
end
|
439
474
|
|
440
|
-
# Creates a unique key that you can distribute to clients who
|
441
|
-
#
|
475
|
+
# Creates a unique key that you can distribute to clients who invoke
|
476
|
+
# your API.
|
442
477
|
#
|
443
478
|
# @option params [required, String] :api_id
|
444
479
|
# The ID for your GraphQL API.
|
@@ -447,10 +482,10 @@ module Aws::AppSync
|
|
447
482
|
# A description of the purpose of the API key.
|
448
483
|
#
|
449
484
|
# @option params [Integer] :expires
|
450
|
-
#
|
451
|
-
# is represented as seconds since the epoch, rounded down to the
|
452
|
-
# hour. The default value for this parameter is 7 days from
|
453
|
-
# time. For more information, see .
|
485
|
+
# From the creation time, the time after which the API key expires. The
|
486
|
+
# date is represented as seconds since the epoch, rounded down to the
|
487
|
+
# nearest hour. The default value for this parameter is 7 days from
|
488
|
+
# creation time. For more information, see .
|
454
489
|
#
|
455
490
|
# @return [Types::CreateApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
456
491
|
#
|
@@ -495,14 +530,15 @@ module Aws::AppSync
|
|
495
530
|
# The type of the `DataSource`.
|
496
531
|
#
|
497
532
|
# @option params [String] :service_role_arn
|
498
|
-
# The Identity and Access Management service role
|
499
|
-
# source. The system assumes this role when
|
533
|
+
# The Identity and Access Management (IAM) service role Amazon Resource
|
534
|
+
# Name (ARN) for the data source. The system assumes this role when
|
535
|
+
# accessing the data source.
|
500
536
|
#
|
501
537
|
# @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
|
502
538
|
# Amazon DynamoDB settings.
|
503
539
|
#
|
504
540
|
# @option params [Types::LambdaDataSourceConfig] :lambda_config
|
505
|
-
#
|
541
|
+
# Lambda settings.
|
506
542
|
#
|
507
543
|
# @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
|
508
544
|
# Amazon OpenSearch Service settings.
|
@@ -616,9 +652,51 @@ module Aws::AppSync
|
|
616
652
|
req.send_request(options)
|
617
653
|
end
|
618
654
|
|
655
|
+
# Creates a custom `DomainName` object.
|
656
|
+
#
|
657
|
+
# @option params [required, String] :domain_name
|
658
|
+
# The domain name.
|
659
|
+
#
|
660
|
+
# @option params [required, String] :certificate_arn
|
661
|
+
# The Amazon Resource Name (ARN) of the certificate. This can be an
|
662
|
+
# Certificate Manager (ACM) certificate or an Identity and Access
|
663
|
+
# Management (IAM) server certificate.
|
664
|
+
#
|
665
|
+
# @option params [String] :description
|
666
|
+
# A description of the `DomainName`.
|
667
|
+
#
|
668
|
+
# @return [Types::CreateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
669
|
+
#
|
670
|
+
# * {Types::CreateDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
|
671
|
+
#
|
672
|
+
# @example Request syntax with placeholder values
|
673
|
+
#
|
674
|
+
# resp = client.create_domain_name({
|
675
|
+
# domain_name: "DomainName", # required
|
676
|
+
# certificate_arn: "CertificateArn", # required
|
677
|
+
# description: "Description",
|
678
|
+
# })
|
679
|
+
#
|
680
|
+
# @example Response structure
|
681
|
+
#
|
682
|
+
# resp.domain_name_config.domain_name #=> String
|
683
|
+
# resp.domain_name_config.description #=> String
|
684
|
+
# resp.domain_name_config.certificate_arn #=> String
|
685
|
+
# resp.domain_name_config.appsync_domain_name #=> String
|
686
|
+
# resp.domain_name_config.hosted_zone_id #=> String
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateDomainName AWS API Documentation
|
689
|
+
#
|
690
|
+
# @overload create_domain_name(params = {})
|
691
|
+
# @param [Hash] params ({})
|
692
|
+
def create_domain_name(params = {}, options = {})
|
693
|
+
req = build_request(:create_domain_name, params)
|
694
|
+
req.send_request(options)
|
695
|
+
end
|
696
|
+
|
619
697
|
# Creates a `Function` object.
|
620
698
|
#
|
621
|
-
# A function is a reusable entity.
|
699
|
+
# A function is a reusable entity. You can use multiple functions to
|
622
700
|
# compose the resolver logic.
|
623
701
|
#
|
624
702
|
# @option params [required, String] :api_id
|
@@ -641,14 +719,14 @@ module Aws::AppSync
|
|
641
719
|
# The `Function` response mapping template.
|
642
720
|
#
|
643
721
|
# @option params [required, String] :function_version
|
644
|
-
# The `version` of the request mapping template. Currently the
|
645
|
-
# value is 2018-05-29.
|
722
|
+
# The `version` of the request mapping template. Currently, the
|
723
|
+
# supported value is 2018-05-29.
|
646
724
|
#
|
647
725
|
# @option params [Types::SyncConfig] :sync_config
|
648
726
|
# Describes a Sync configuration for a resolver.
|
649
727
|
#
|
650
|
-
#
|
651
|
-
#
|
728
|
+
# Specifies which Conflict Detection strategy and Resolution strategy to
|
729
|
+
# use when the resolver is invoked.
|
652
730
|
#
|
653
731
|
# @return [Types::CreateFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
654
732
|
#
|
@@ -705,14 +783,14 @@ module Aws::AppSync
|
|
705
783
|
# The Amazon CloudWatch Logs configuration.
|
706
784
|
#
|
707
785
|
# @option params [required, String] :authentication_type
|
708
|
-
# The authentication type: API key, Identity and Access Management
|
709
|
-
# OIDC, Amazon Cognito user pools, or
|
786
|
+
# The authentication type: API key, Identity and Access Management
|
787
|
+
# (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
|
710
788
|
#
|
711
789
|
# @option params [Types::UserPoolConfig] :user_pool_config
|
712
790
|
# The Amazon Cognito user pool configuration.
|
713
791
|
#
|
714
792
|
# @option params [Types::OpenIDConnectConfig] :open_id_connect_config
|
715
|
-
# The
|
793
|
+
# The OIDC configuration.
|
716
794
|
#
|
717
795
|
# @option params [Hash<String,String>] :tags
|
718
796
|
# A `TagMap` object.
|
@@ -722,11 +800,10 @@ module Aws::AppSync
|
|
722
800
|
# API.
|
723
801
|
#
|
724
802
|
# @option params [Boolean] :xray_enabled
|
725
|
-
# A flag indicating whether to
|
726
|
-
# `GraphqlApi`.
|
803
|
+
# A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.
|
727
804
|
#
|
728
805
|
# @option params [Types::LambdaAuthorizerConfig] :lambda_authorizer_config
|
729
|
-
# Configuration for
|
806
|
+
# Configuration for Lambda function authorization.
|
730
807
|
#
|
731
808
|
# @return [Types::CreateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
732
809
|
#
|
@@ -837,7 +914,8 @@ module Aws::AppSync
|
|
837
914
|
# Creates a `Resolver` object.
|
838
915
|
#
|
839
916
|
# A resolver converts incoming requests into a format that a data source
|
840
|
-
# can understand and converts the data source's responses into
|
917
|
+
# can understand, and converts the data source's responses into
|
918
|
+
# GraphQL.
|
841
919
|
#
|
842
920
|
# @option params [required, String] :api_id
|
843
921
|
# The ID for the GraphQL API for which the resolver is being created.
|
@@ -852,36 +930,36 @@ module Aws::AppSync
|
|
852
930
|
# The name of the data source for which the resolver is being created.
|
853
931
|
#
|
854
932
|
# @option params [String] :request_mapping_template
|
855
|
-
# The mapping template to
|
933
|
+
# The mapping template to use for requests.
|
856
934
|
#
|
857
935
|
# A resolver uses a request mapping template to convert a GraphQL
|
858
936
|
# expression into a format that a data source can understand. Mapping
|
859
937
|
# templates are written in Apache Velocity Template Language (VTL).
|
860
938
|
#
|
861
|
-
# VTL request mapping templates are optional when using
|
939
|
+
# VTL request mapping templates are optional when using an Lambda data
|
862
940
|
# source. For all other data sources, VTL request and response mapping
|
863
941
|
# templates are required.
|
864
942
|
#
|
865
943
|
# @option params [String] :response_mapping_template
|
866
|
-
# The mapping template to
|
944
|
+
# The mapping template to use for responses from the data source.
|
867
945
|
#
|
868
946
|
# @option params [String] :kind
|
869
947
|
# The resolver type.
|
870
948
|
#
|
871
949
|
# * **UNIT**\: A UNIT resolver type. A UNIT resolver is the default
|
872
|
-
# resolver type.
|
873
|
-
#
|
950
|
+
# resolver type. You can use a UNIT resolver to run a GraphQL query
|
951
|
+
# against a single data source.
|
874
952
|
#
|
875
|
-
# * **PIPELINE**\: A PIPELINE resolver type.
|
876
|
-
#
|
877
|
-
# use a pipeline resolver to
|
878
|
-
# data sources.
|
953
|
+
# * **PIPELINE**\: A PIPELINE resolver type. You can use a PIPELINE
|
954
|
+
# resolver to invoke a series of `Function` objects in a serial
|
955
|
+
# manner. You can use a pipeline resolver to run a GraphQL query
|
956
|
+
# against multiple data sources.
|
879
957
|
#
|
880
958
|
# @option params [Types::PipelineConfig] :pipeline_config
|
881
959
|
# The `PipelineConfig`.
|
882
960
|
#
|
883
961
|
# @option params [Types::SyncConfig] :sync_config
|
884
|
-
# The `SyncConfig` for a resolver attached to a versioned
|
962
|
+
# The `SyncConfig` for a resolver attached to a versioned data source.
|
885
963
|
#
|
886
964
|
# @option params [Types::CachingConfig] :caching_config
|
887
965
|
# The caching configuration for the resolver.
|
@@ -1064,6 +1142,28 @@ module Aws::AppSync
|
|
1064
1142
|
req.send_request(options)
|
1065
1143
|
end
|
1066
1144
|
|
1145
|
+
# Deletes a custom `DomainName` object.
|
1146
|
+
#
|
1147
|
+
# @option params [required, String] :domain_name
|
1148
|
+
# The domain name.
|
1149
|
+
#
|
1150
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1151
|
+
#
|
1152
|
+
# @example Request syntax with placeholder values
|
1153
|
+
#
|
1154
|
+
# resp = client.delete_domain_name({
|
1155
|
+
# domain_name: "DomainName", # required
|
1156
|
+
# })
|
1157
|
+
#
|
1158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteDomainName AWS API Documentation
|
1159
|
+
#
|
1160
|
+
# @overload delete_domain_name(params = {})
|
1161
|
+
# @param [Hash] params ({})
|
1162
|
+
def delete_domain_name(params = {}, options = {})
|
1163
|
+
req = build_request(:delete_domain_name, params)
|
1164
|
+
req.send_request(options)
|
1165
|
+
end
|
1166
|
+
|
1067
1167
|
# Deletes a `Function`.
|
1068
1168
|
#
|
1069
1169
|
# @option params [required, String] :api_id
|
@@ -1168,6 +1268,28 @@ module Aws::AppSync
|
|
1168
1268
|
req.send_request(options)
|
1169
1269
|
end
|
1170
1270
|
|
1271
|
+
# Removes an `ApiAssociation` object from a custom domain.
|
1272
|
+
#
|
1273
|
+
# @option params [required, String] :domain_name
|
1274
|
+
# The domain name.
|
1275
|
+
#
|
1276
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1277
|
+
#
|
1278
|
+
# @example Request syntax with placeholder values
|
1279
|
+
#
|
1280
|
+
# resp = client.disassociate_api({
|
1281
|
+
# domain_name: "DomainName", # required
|
1282
|
+
# })
|
1283
|
+
#
|
1284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DisassociateApi AWS API Documentation
|
1285
|
+
#
|
1286
|
+
# @overload disassociate_api(params = {})
|
1287
|
+
# @param [Hash] params ({})
|
1288
|
+
def disassociate_api(params = {}, options = {})
|
1289
|
+
req = build_request(:disassociate_api, params)
|
1290
|
+
req.send_request(options)
|
1291
|
+
end
|
1292
|
+
|
1171
1293
|
# Flushes an `ApiCache` object.
|
1172
1294
|
#
|
1173
1295
|
# @option params [required, String] :api_id
|
@@ -1190,6 +1312,37 @@ module Aws::AppSync
|
|
1190
1312
|
req.send_request(options)
|
1191
1313
|
end
|
1192
1314
|
|
1315
|
+
# Retrieves an `ApiAssociation` object.
|
1316
|
+
#
|
1317
|
+
# @option params [required, String] :domain_name
|
1318
|
+
# The domain name.
|
1319
|
+
#
|
1320
|
+
# @return [Types::GetApiAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
|
+
#
|
1322
|
+
# * {Types::GetApiAssociationResponse#api_association #api_association} => Types::ApiAssociation
|
1323
|
+
#
|
1324
|
+
# @example Request syntax with placeholder values
|
1325
|
+
#
|
1326
|
+
# resp = client.get_api_association({
|
1327
|
+
# domain_name: "DomainName", # required
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
#
|
1332
|
+
# resp.api_association.domain_name #=> String
|
1333
|
+
# resp.api_association.api_id #=> String
|
1334
|
+
# resp.api_association.association_status #=> String, one of "PROCESSING", "FAILED", "SUCCESS"
|
1335
|
+
# resp.api_association.deployment_detail #=> String
|
1336
|
+
#
|
1337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiAssociation AWS API Documentation
|
1338
|
+
#
|
1339
|
+
# @overload get_api_association(params = {})
|
1340
|
+
# @param [Hash] params ({})
|
1341
|
+
def get_api_association(params = {}, options = {})
|
1342
|
+
req = build_request(:get_api_association, params)
|
1343
|
+
req.send_request(options)
|
1344
|
+
end
|
1345
|
+
|
1193
1346
|
# Retrieves an `ApiCache` object.
|
1194
1347
|
#
|
1195
1348
|
# @option params [required, String] :api_id
|
@@ -1281,6 +1434,38 @@ module Aws::AppSync
|
|
1281
1434
|
req.send_request(options)
|
1282
1435
|
end
|
1283
1436
|
|
1437
|
+
# Retrieves a custom `DomainName` object.
|
1438
|
+
#
|
1439
|
+
# @option params [required, String] :domain_name
|
1440
|
+
# The domain name.
|
1441
|
+
#
|
1442
|
+
# @return [Types::GetDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1443
|
+
#
|
1444
|
+
# * {Types::GetDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
|
1445
|
+
#
|
1446
|
+
# @example Request syntax with placeholder values
|
1447
|
+
#
|
1448
|
+
# resp = client.get_domain_name({
|
1449
|
+
# domain_name: "DomainName", # required
|
1450
|
+
# })
|
1451
|
+
#
|
1452
|
+
# @example Response structure
|
1453
|
+
#
|
1454
|
+
# resp.domain_name_config.domain_name #=> String
|
1455
|
+
# resp.domain_name_config.description #=> String
|
1456
|
+
# resp.domain_name_config.certificate_arn #=> String
|
1457
|
+
# resp.domain_name_config.appsync_domain_name #=> String
|
1458
|
+
# resp.domain_name_config.hosted_zone_id #=> String
|
1459
|
+
#
|
1460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetDomainName AWS API Documentation
|
1461
|
+
#
|
1462
|
+
# @overload get_domain_name(params = {})
|
1463
|
+
# @param [Hash] params ({})
|
1464
|
+
def get_domain_name(params = {}, options = {})
|
1465
|
+
req = build_request(:get_domain_name, params)
|
1466
|
+
req.send_request(options)
|
1467
|
+
end
|
1468
|
+
|
1284
1469
|
# Get a `Function`.
|
1285
1470
|
#
|
1286
1471
|
# @option params [required, String] :api_id
|
@@ -1557,11 +1742,11 @@ module Aws::AppSync
|
|
1557
1742
|
#
|
1558
1743
|
# @option params [String] :next_token
|
1559
1744
|
# An identifier that was returned from the previous call to this
|
1560
|
-
# operation, which can
|
1745
|
+
# operation, which you can use to return the next set of items in the
|
1561
1746
|
# list.
|
1562
1747
|
#
|
1563
1748
|
# @option params [Integer] :max_results
|
1564
|
-
# The maximum number of results you want the request to return.
|
1749
|
+
# The maximum number of results that you want the request to return.
|
1565
1750
|
#
|
1566
1751
|
# @return [Types::ListApiKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1567
1752
|
#
|
@@ -1601,11 +1786,11 @@ module Aws::AppSync
|
|
1601
1786
|
#
|
1602
1787
|
# @option params [String] :next_token
|
1603
1788
|
# An identifier that was returned from the previous call to this
|
1604
|
-
# operation, which can
|
1789
|
+
# operation, which you can use to return the next set of items in the
|
1605
1790
|
# list.
|
1606
1791
|
#
|
1607
1792
|
# @option params [Integer] :max_results
|
1608
|
-
# The maximum number of results you want the request to return.
|
1793
|
+
# The maximum number of results that you want the request to return.
|
1609
1794
|
#
|
1610
1795
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1611
1796
|
#
|
@@ -1661,6 +1846,45 @@ module Aws::AppSync
|
|
1661
1846
|
req.send_request(options)
|
1662
1847
|
end
|
1663
1848
|
|
1849
|
+
# Lists multiple custom domain names.
|
1850
|
+
#
|
1851
|
+
# @option params [String] :next_token
|
1852
|
+
# The API token.
|
1853
|
+
#
|
1854
|
+
# @option params [Integer] :max_results
|
1855
|
+
# The maximum number of results that you want the request to return.
|
1856
|
+
#
|
1857
|
+
# @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1858
|
+
#
|
1859
|
+
# * {Types::ListDomainNamesResponse#domain_name_configs #domain_name_configs} => Array<Types::DomainNameConfig>
|
1860
|
+
# * {Types::ListDomainNamesResponse#next_token #next_token} => String
|
1861
|
+
#
|
1862
|
+
# @example Request syntax with placeholder values
|
1863
|
+
#
|
1864
|
+
# resp = client.list_domain_names({
|
1865
|
+
# next_token: "PaginationToken",
|
1866
|
+
# max_results: 1,
|
1867
|
+
# })
|
1868
|
+
#
|
1869
|
+
# @example Response structure
|
1870
|
+
#
|
1871
|
+
# resp.domain_name_configs #=> Array
|
1872
|
+
# resp.domain_name_configs[0].domain_name #=> String
|
1873
|
+
# resp.domain_name_configs[0].description #=> String
|
1874
|
+
# resp.domain_name_configs[0].certificate_arn #=> String
|
1875
|
+
# resp.domain_name_configs[0].appsync_domain_name #=> String
|
1876
|
+
# resp.domain_name_configs[0].hosted_zone_id #=> String
|
1877
|
+
# resp.next_token #=> String
|
1878
|
+
#
|
1879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListDomainNames AWS API Documentation
|
1880
|
+
#
|
1881
|
+
# @overload list_domain_names(params = {})
|
1882
|
+
# @param [Hash] params ({})
|
1883
|
+
def list_domain_names(params = {}, options = {})
|
1884
|
+
req = build_request(:list_domain_names, params)
|
1885
|
+
req.send_request(options)
|
1886
|
+
end
|
1887
|
+
|
1664
1888
|
# List multiple functions.
|
1665
1889
|
#
|
1666
1890
|
# @option params [required, String] :api_id
|
@@ -1668,11 +1892,11 @@ module Aws::AppSync
|
|
1668
1892
|
#
|
1669
1893
|
# @option params [String] :next_token
|
1670
1894
|
# An identifier that was returned from the previous call to this
|
1671
|
-
# operation, which can
|
1895
|
+
# operation, which you can use to return the next set of items in the
|
1672
1896
|
# list.
|
1673
1897
|
#
|
1674
1898
|
# @option params [Integer] :max_results
|
1675
|
-
# The maximum number of results you want the request to return.
|
1899
|
+
# The maximum number of results that you want the request to return.
|
1676
1900
|
#
|
1677
1901
|
# @return [Types::ListFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1678
1902
|
#
|
@@ -1716,11 +1940,11 @@ module Aws::AppSync
|
|
1716
1940
|
#
|
1717
1941
|
# @option params [String] :next_token
|
1718
1942
|
# An identifier that was returned from the previous call to this
|
1719
|
-
# operation, which can
|
1943
|
+
# operation, which you can use to return the next set of items in the
|
1720
1944
|
# list.
|
1721
1945
|
#
|
1722
1946
|
# @option params [Integer] :max_results
|
1723
|
-
# The maximum number of results you want the request to return.
|
1947
|
+
# The maximum number of results that you want the request to return.
|
1724
1948
|
#
|
1725
1949
|
# @return [Types::ListGraphqlApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1726
1950
|
#
|
@@ -1794,11 +2018,11 @@ module Aws::AppSync
|
|
1794
2018
|
#
|
1795
2019
|
# @option params [String] :next_token
|
1796
2020
|
# An identifier that was returned from the previous call to this
|
1797
|
-
# operation, which can
|
2021
|
+
# operation, which you can use to return the next set of items in the
|
1798
2022
|
# list.
|
1799
2023
|
#
|
1800
2024
|
# @option params [Integer] :max_results
|
1801
|
-
# The maximum number of results you want the request to return.
|
2025
|
+
# The maximum number of results that you want the request to return.
|
1802
2026
|
#
|
1803
2027
|
# @return [Types::ListResolversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1804
2028
|
#
|
@@ -1849,7 +2073,7 @@ module Aws::AppSync
|
|
1849
2073
|
# The API ID.
|
1850
2074
|
#
|
1851
2075
|
# @option params [required, String] :function_id
|
1852
|
-
# The
|
2076
|
+
# The function ID.
|
1853
2077
|
#
|
1854
2078
|
# @option params [String] :next_token
|
1855
2079
|
# An identifier that was returned from the previous call to this
|
@@ -1857,7 +2081,7 @@ module Aws::AppSync
|
|
1857
2081
|
# list.
|
1858
2082
|
#
|
1859
2083
|
# @option params [Integer] :max_results
|
1860
|
-
# The maximum number of results you want the request to return.
|
2084
|
+
# The maximum number of results that you want the request to return.
|
1861
2085
|
#
|
1862
2086
|
# @return [Types::ListResolversByFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1863
2087
|
#
|
@@ -1905,7 +2129,7 @@ module Aws::AppSync
|
|
1905
2129
|
# Lists the tags for a resource.
|
1906
2130
|
#
|
1907
2131
|
# @option params [required, String] :resource_arn
|
1908
|
-
# The `GraphqlApi` ARN.
|
2132
|
+
# The `GraphqlApi` Amazon Resource Name (ARN).
|
1909
2133
|
#
|
1910
2134
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1911
2135
|
#
|
@@ -1941,11 +2165,11 @@ module Aws::AppSync
|
|
1941
2165
|
#
|
1942
2166
|
# @option params [String] :next_token
|
1943
2167
|
# An identifier that was returned from the previous call to this
|
1944
|
-
# operation, which can
|
2168
|
+
# operation, which you can use to return the next set of items in the
|
1945
2169
|
# list.
|
1946
2170
|
#
|
1947
2171
|
# @option params [Integer] :max_results
|
1948
|
-
# The maximum number of results you want the request to return.
|
2172
|
+
# The maximum number of results that you want the request to return.
|
1949
2173
|
#
|
1950
2174
|
# @return [Types::ListTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1951
2175
|
#
|
@@ -2018,7 +2242,7 @@ module Aws::AppSync
|
|
2018
2242
|
# Tags a resource with user-supplied tags.
|
2019
2243
|
#
|
2020
2244
|
# @option params [required, String] :resource_arn
|
2021
|
-
# The `GraphqlApi` ARN.
|
2245
|
+
# The `GraphqlApi` Amazon Resource Name (ARN).
|
2022
2246
|
#
|
2023
2247
|
# @option params [required, Hash<String,String>] :tags
|
2024
2248
|
# A `TagMap` object.
|
@@ -2046,7 +2270,7 @@ module Aws::AppSync
|
|
2046
2270
|
# Untags a resource.
|
2047
2271
|
#
|
2048
2272
|
# @option params [required, String] :resource_arn
|
2049
|
-
# The `GraphqlApi` ARN.
|
2273
|
+
# The `GraphqlApi` Amazon Resource Name (ARN).
|
2050
2274
|
#
|
2051
2275
|
# @option params [required, Array<String>] :tag_keys
|
2052
2276
|
# A list of `TagKey` objects.
|
@@ -2072,12 +2296,12 @@ module Aws::AppSync
|
|
2072
2296
|
# Updates the cache for the GraphQL API.
|
2073
2297
|
#
|
2074
2298
|
# @option params [required, String] :api_id
|
2075
|
-
# The GraphQL API
|
2299
|
+
# The GraphQL API ID.
|
2076
2300
|
#
|
2077
2301
|
# @option params [required, Integer] :ttl
|
2078
2302
|
# TTL in seconds for cache entries.
|
2079
2303
|
#
|
2080
|
-
# Valid values are
|
2304
|
+
# Valid values are 1–3,600 seconds.
|
2081
2305
|
#
|
2082
2306
|
# @option params [required, String] :api_caching_behavior
|
2083
2307
|
# Caching behavior.
|
@@ -2158,7 +2382,8 @@ module Aws::AppSync
|
|
2158
2382
|
req.send_request(options)
|
2159
2383
|
end
|
2160
2384
|
|
2161
|
-
# Updates an API key.
|
2385
|
+
# Updates an API key. You can update the key as long as it's not
|
2386
|
+
# deleted.
|
2162
2387
|
#
|
2163
2388
|
# @option params [required, String] :api_id
|
2164
2389
|
# The ID for the GraphQL API.
|
@@ -2170,8 +2395,9 @@ module Aws::AppSync
|
|
2170
2395
|
# A description of the purpose of the API key.
|
2171
2396
|
#
|
2172
2397
|
# @option params [Integer] :expires
|
2173
|
-
#
|
2174
|
-
# represented as seconds since the epoch. For more information,
|
2398
|
+
# From the update time, the time after which the API key expires. The
|
2399
|
+
# date is represented as seconds since the epoch. For more information,
|
2400
|
+
# see .
|
2175
2401
|
#
|
2176
2402
|
# @return [Types::UpdateApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2177
2403
|
#
|
@@ -2217,13 +2443,13 @@ module Aws::AppSync
|
|
2217
2443
|
# The new data source type.
|
2218
2444
|
#
|
2219
2445
|
# @option params [String] :service_role_arn
|
2220
|
-
# The new service role ARN for the data source.
|
2446
|
+
# The new service role Amazon Resource Name (ARN) for the data source.
|
2221
2447
|
#
|
2222
2448
|
# @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
|
2223
2449
|
# The new Amazon DynamoDB configuration.
|
2224
2450
|
#
|
2225
2451
|
# @option params [Types::LambdaDataSourceConfig] :lambda_config
|
2226
|
-
# The new
|
2452
|
+
# The new Lambda configuration.
|
2227
2453
|
#
|
2228
2454
|
# @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
|
2229
2455
|
# The new OpenSearch configuration.
|
@@ -2337,6 +2563,42 @@ module Aws::AppSync
|
|
2337
2563
|
req.send_request(options)
|
2338
2564
|
end
|
2339
2565
|
|
2566
|
+
# Updates a custom `DomainName` object.
|
2567
|
+
#
|
2568
|
+
# @option params [required, String] :domain_name
|
2569
|
+
# The domain name.
|
2570
|
+
#
|
2571
|
+
# @option params [String] :description
|
2572
|
+
# A description of the `DomainName`.
|
2573
|
+
#
|
2574
|
+
# @return [Types::UpdateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2575
|
+
#
|
2576
|
+
# * {Types::UpdateDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
|
2577
|
+
#
|
2578
|
+
# @example Request syntax with placeholder values
|
2579
|
+
#
|
2580
|
+
# resp = client.update_domain_name({
|
2581
|
+
# domain_name: "DomainName", # required
|
2582
|
+
# description: "Description",
|
2583
|
+
# })
|
2584
|
+
#
|
2585
|
+
# @example Response structure
|
2586
|
+
#
|
2587
|
+
# resp.domain_name_config.domain_name #=> String
|
2588
|
+
# resp.domain_name_config.description #=> String
|
2589
|
+
# resp.domain_name_config.certificate_arn #=> String
|
2590
|
+
# resp.domain_name_config.appsync_domain_name #=> String
|
2591
|
+
# resp.domain_name_config.hosted_zone_id #=> String
|
2592
|
+
#
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateDomainName AWS API Documentation
|
2594
|
+
#
|
2595
|
+
# @overload update_domain_name(params = {})
|
2596
|
+
# @param [Hash] params ({})
|
2597
|
+
def update_domain_name(params = {}, options = {})
|
2598
|
+
req = build_request(:update_domain_name, params)
|
2599
|
+
req.send_request(options)
|
2600
|
+
end
|
2601
|
+
|
2340
2602
|
# Updates a `Function` object.
|
2341
2603
|
#
|
2342
2604
|
# @option params [required, String] :api_id
|
@@ -2362,14 +2624,14 @@ module Aws::AppSync
|
|
2362
2624
|
# The `Function` request mapping template.
|
2363
2625
|
#
|
2364
2626
|
# @option params [required, String] :function_version
|
2365
|
-
# The `version` of the request mapping template. Currently the
|
2366
|
-
# value is 2018-05-29.
|
2627
|
+
# The `version` of the request mapping template. Currently, the
|
2628
|
+
# supported value is 2018-05-29.
|
2367
2629
|
#
|
2368
2630
|
# @option params [Types::SyncConfig] :sync_config
|
2369
2631
|
# Describes a Sync configuration for a resolver.
|
2370
2632
|
#
|
2371
|
-
#
|
2372
|
-
#
|
2633
|
+
# Specifies which Conflict Detection strategy and Resolution strategy to
|
2634
|
+
# use when the resolver is invoked.
|
2373
2635
|
#
|
2374
2636
|
# @return [Types::UpdateFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2375
2637
|
#
|
@@ -2433,7 +2695,7 @@ module Aws::AppSync
|
|
2433
2695
|
# The new authentication type for the `GraphqlApi` object.
|
2434
2696
|
#
|
2435
2697
|
# @option params [Types::UserPoolConfig] :user_pool_config
|
2436
|
-
# The new Amazon Cognito user pool configuration for the
|
2698
|
+
# The new Amazon Cognito user pool configuration for the `~GraphqlApi`
|
2437
2699
|
# object.
|
2438
2700
|
#
|
2439
2701
|
# @option params [Types::OpenIDConnectConfig] :open_id_connect_config
|
@@ -2444,11 +2706,10 @@ module Aws::AppSync
|
|
2444
2706
|
# API.
|
2445
2707
|
#
|
2446
2708
|
# @option params [Boolean] :xray_enabled
|
2447
|
-
# A flag indicating whether to
|
2448
|
-
# `GraphqlApi`.
|
2709
|
+
# A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.
|
2449
2710
|
#
|
2450
2711
|
# @option params [Types::LambdaAuthorizerConfig] :lambda_authorizer_config
|
2451
|
-
# Configuration for
|
2712
|
+
# Configuration for Lambda function authorization.
|
2452
2713
|
#
|
2453
2714
|
# @return [Types::UpdateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2454
2715
|
#
|
@@ -2575,7 +2836,7 @@ module Aws::AppSync
|
|
2575
2836
|
# expression into a format that a data source can understand. Mapping
|
2576
2837
|
# templates are written in Apache Velocity Template Language (VTL).
|
2577
2838
|
#
|
2578
|
-
# VTL request mapping templates are optional when using
|
2839
|
+
# VTL request mapping templates are optional when using an Lambda data
|
2579
2840
|
# source. For all other data sources, VTL request and response mapping
|
2580
2841
|
# templates are required.
|
2581
2842
|
#
|
@@ -2586,19 +2847,19 @@ module Aws::AppSync
|
|
2586
2847
|
# The resolver type.
|
2587
2848
|
#
|
2588
2849
|
# * **UNIT**\: A UNIT resolver type. A UNIT resolver is the default
|
2589
|
-
# resolver type.
|
2590
|
-
#
|
2850
|
+
# resolver type. You can use a UNIT resolver to run a GraphQL query
|
2851
|
+
# against a single data source.
|
2591
2852
|
#
|
2592
|
-
# * **PIPELINE**\: A PIPELINE resolver type.
|
2593
|
-
#
|
2594
|
-
# use a pipeline resolver to
|
2595
|
-
# data sources.
|
2853
|
+
# * **PIPELINE**\: A PIPELINE resolver type. You can use a PIPELINE
|
2854
|
+
# resolver to invoke a series of `Function` objects in a serial
|
2855
|
+
# manner. You can use a pipeline resolver to run a GraphQL query
|
2856
|
+
# against multiple data sources.
|
2596
2857
|
#
|
2597
2858
|
# @option params [Types::PipelineConfig] :pipeline_config
|
2598
2859
|
# The `PipelineConfig`.
|
2599
2860
|
#
|
2600
2861
|
# @option params [Types::SyncConfig] :sync_config
|
2601
|
-
# The `SyncConfig` for a resolver attached to a versioned
|
2862
|
+
# The `SyncConfig` for a resolver attached to a versioned data source.
|
2602
2863
|
#
|
2603
2864
|
# @option params [Types::CachingConfig] :caching_config
|
2604
2865
|
# The caching configuration for the resolver.
|
@@ -2717,7 +2978,7 @@ module Aws::AppSync
|
|
2717
2978
|
params: params,
|
2718
2979
|
config: config)
|
2719
2980
|
context[:gem_name] = 'aws-sdk-appsync'
|
2720
|
-
context[:gem_version] = '1.
|
2981
|
+
context[:gem_version] = '1.48.0'
|
2721
2982
|
Seahorse::Client::Request.new(handlers, context)
|
2722
2983
|
end
|
2723
2984
|
|