aws-sdk-appsync 1.46.0 → 1.50.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.
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
30
31
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
32
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
33
 
@@ -73,6 +74,7 @@ module Aws::AppSync
73
74
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
75
  add_plugin(Aws::Plugins::TransferEncoding)
75
76
  add_plugin(Aws::Plugins::HttpChecksum)
77
+ add_plugin(Aws::Plugins::DefaultsMode)
76
78
  add_plugin(Aws::Plugins::SignatureV4)
77
79
  add_plugin(Aws::Plugins::Protocols::RestJson)
78
80
 
@@ -119,7 +121,9 @@ module Aws::AppSync
119
121
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
122
  # are very aggressive. Construct and pass an instance of
121
123
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
124
+ # enable retries and extended timeouts. Instance profile credential
125
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
126
+ # to true.
123
127
  #
124
128
  # @option options [required, String] :region
125
129
  # The AWS region to connect to. The configured `:region` is
@@ -173,6 +177,10 @@ module Aws::AppSync
173
177
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
178
  # a clock skew correction and retry requests with skewed client clocks.
175
179
  #
180
+ # @option options [String] :defaults_mode ("legacy")
181
+ # See {Aws::DefaultsModeConfiguration} for a list of the
182
+ # accepted modes and the configuration defaults that are included.
183
+ #
176
184
  # @option options [Boolean] :disable_host_prefix_injection (false)
177
185
  # Set to true to disable SDK automatically adding host prefix
178
186
  # to default service endpoint when available.
@@ -295,7 +303,7 @@ module Aws::AppSync
295
303
  # seconds to wait when opening a HTTP session before raising a
296
304
  # `Timeout::Error`.
297
305
  #
298
- # @option options [Integer] :http_read_timeout (60) The default
306
+ # @option options [Float] :http_read_timeout (60) The default
299
307
  # number of seconds to wait for response data. This value can
300
308
  # safely be set per-request on the session.
301
309
  #
@@ -311,6 +319,9 @@ module Aws::AppSync
311
319
  # disables this behaviour. This value can safely be set per
312
320
  # request on the session.
313
321
  #
322
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
323
+ # in seconds.
324
+ #
314
325
  # @option options [Boolean] :http_wire_trace (false) When `true`,
315
326
  # HTTP debug output will be sent to the `:logger`.
316
327
  #
@@ -336,22 +347,57 @@ module Aws::AppSync
336
347
 
337
348
  # @!group API Operations
338
349
 
350
+ # Maps an endpoint to your custom domain.
351
+ #
352
+ # @option params [required, String] :domain_name
353
+ # The domain name.
354
+ #
355
+ # @option params [required, String] :api_id
356
+ # The API ID.
357
+ #
358
+ # @return [Types::AssociateApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
359
+ #
360
+ # * {Types::AssociateApiResponse#api_association #api_association} => Types::ApiAssociation
361
+ #
362
+ # @example Request syntax with placeholder values
363
+ #
364
+ # resp = client.associate_api({
365
+ # domain_name: "DomainName", # required
366
+ # api_id: "String", # required
367
+ # })
368
+ #
369
+ # @example Response structure
370
+ #
371
+ # resp.api_association.domain_name #=> String
372
+ # resp.api_association.api_id #=> String
373
+ # resp.api_association.association_status #=> String, one of "PROCESSING", "FAILED", "SUCCESS"
374
+ # resp.api_association.deployment_detail #=> String
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/AssociateApi AWS API Documentation
377
+ #
378
+ # @overload associate_api(params = {})
379
+ # @param [Hash] params ({})
380
+ def associate_api(params = {}, options = {})
381
+ req = build_request(:associate_api, params)
382
+ req.send_request(options)
383
+ end
384
+
339
385
  # Creates a cache for the GraphQL API.
340
386
  #
341
387
  # @option params [required, String] :api_id
342
- # The GraphQL API Id.
388
+ # The GraphQL API ID.
343
389
  #
344
390
  # @option params [required, Integer] :ttl
345
391
  # TTL in seconds for cache entries.
346
392
  #
347
- # Valid values are between 1 and 3600 seconds.
393
+ # Valid values are 1–3,600 seconds.
348
394
  #
349
395
  # @option params [Boolean] :transit_encryption_enabled
350
- # Transit encryption flag when connecting to cache. This setting cannot
351
- # be updated after creation.
396
+ # Transit encryption flag when connecting to cache. You cannot update
397
+ # this setting after creation.
352
398
  #
353
399
  # @option params [Boolean] :at_rest_encryption_enabled
354
- # At rest encryption flag for cache. This setting cannot be updated
400
+ # At-rest encryption flag for cache. You cannot update this setting
355
401
  # after creation.
356
402
  #
357
403
  # @option params [required, String] :api_caching_behavior
@@ -435,8 +481,8 @@ module Aws::AppSync
435
481
  req.send_request(options)
436
482
  end
437
483
 
438
- # Creates a unique key that you can distribute to clients who are
439
- # executing your API.
484
+ # Creates a unique key that you can distribute to clients who invoke
485
+ # your API.
440
486
  #
441
487
  # @option params [required, String] :api_id
442
488
  # The ID for your GraphQL API.
@@ -445,10 +491,10 @@ module Aws::AppSync
445
491
  # A description of the purpose of the API key.
446
492
  #
447
493
  # @option params [Integer] :expires
448
- # The time from creation time after which the API key expires. The date
449
- # is represented as seconds since the epoch, rounded down to the nearest
450
- # hour. The default value for this parameter is 7 days from creation
451
- # time. For more information, see .
494
+ # From the creation time, the time after which the API key expires. The
495
+ # date is represented as seconds since the epoch, rounded down to the
496
+ # nearest hour. The default value for this parameter is 7 days from
497
+ # creation time. For more information, see .
452
498
  #
453
499
  # @return [Types::CreateApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
454
500
  #
@@ -493,14 +539,15 @@ module Aws::AppSync
493
539
  # The type of the `DataSource`.
494
540
  #
495
541
  # @option params [String] :service_role_arn
496
- # The Identity and Access Management service role ARN for the data
497
- # source. The system assumes this role when accessing the data source.
542
+ # The Identity and Access Management (IAM) service role Amazon Resource
543
+ # Name (ARN) for the data source. The system assumes this role when
544
+ # accessing the data source.
498
545
  #
499
546
  # @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
500
547
  # Amazon DynamoDB settings.
501
548
  #
502
549
  # @option params [Types::LambdaDataSourceConfig] :lambda_config
503
- # Amazon Web Services Lambda settings.
550
+ # Lambda settings.
504
551
  #
505
552
  # @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
506
553
  # Amazon OpenSearch Service settings.
@@ -614,9 +661,51 @@ module Aws::AppSync
614
661
  req.send_request(options)
615
662
  end
616
663
 
664
+ # Creates a custom `DomainName` object.
665
+ #
666
+ # @option params [required, String] :domain_name
667
+ # The domain name.
668
+ #
669
+ # @option params [required, String] :certificate_arn
670
+ # The Amazon Resource Name (ARN) of the certificate. This can be an
671
+ # Certificate Manager (ACM) certificate or an Identity and Access
672
+ # Management (IAM) server certificate.
673
+ #
674
+ # @option params [String] :description
675
+ # A description of the `DomainName`.
676
+ #
677
+ # @return [Types::CreateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
678
+ #
679
+ # * {Types::CreateDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
680
+ #
681
+ # @example Request syntax with placeholder values
682
+ #
683
+ # resp = client.create_domain_name({
684
+ # domain_name: "DomainName", # required
685
+ # certificate_arn: "CertificateArn", # required
686
+ # description: "Description",
687
+ # })
688
+ #
689
+ # @example Response structure
690
+ #
691
+ # resp.domain_name_config.domain_name #=> String
692
+ # resp.domain_name_config.description #=> String
693
+ # resp.domain_name_config.certificate_arn #=> String
694
+ # resp.domain_name_config.appsync_domain_name #=> String
695
+ # resp.domain_name_config.hosted_zone_id #=> String
696
+ #
697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateDomainName AWS API Documentation
698
+ #
699
+ # @overload create_domain_name(params = {})
700
+ # @param [Hash] params ({})
701
+ def create_domain_name(params = {}, options = {})
702
+ req = build_request(:create_domain_name, params)
703
+ req.send_request(options)
704
+ end
705
+
617
706
  # Creates a `Function` object.
618
707
  #
619
- # A function is a reusable entity. Multiple functions can be used to
708
+ # A function is a reusable entity. You can use multiple functions to
620
709
  # compose the resolver logic.
621
710
  #
622
711
  # @option params [required, String] :api_id
@@ -639,14 +728,17 @@ module Aws::AppSync
639
728
  # The `Function` response mapping template.
640
729
  #
641
730
  # @option params [required, String] :function_version
642
- # The `version` of the request mapping template. Currently the supported
643
- # value is 2018-05-29.
731
+ # The `version` of the request mapping template. Currently, the
732
+ # supported value is 2018-05-29.
644
733
  #
645
734
  # @option params [Types::SyncConfig] :sync_config
646
735
  # Describes a Sync configuration for a resolver.
647
736
  #
648
- # Contains information on which Conflict Detection as well as Resolution
649
- # strategy should be performed when the resolver is invoked.
737
+ # Specifies which Conflict Detection strategy and Resolution strategy to
738
+ # use when the resolver is invoked.
739
+ #
740
+ # @option params [Integer] :max_batch_size
741
+ # The maximum batching size for a resolver.
650
742
  #
651
743
  # @return [Types::CreateFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
652
744
  #
@@ -669,6 +761,7 @@ module Aws::AppSync
669
761
  # lambda_conflict_handler_arn: "String",
670
762
  # },
671
763
  # },
764
+ # max_batch_size: 1,
672
765
  # })
673
766
  #
674
767
  # @example Response structure
@@ -684,6 +777,7 @@ module Aws::AppSync
684
777
  # resp.function_configuration.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
685
778
  # resp.function_configuration.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
686
779
  # resp.function_configuration.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
780
+ # resp.function_configuration.max_batch_size #=> Integer
687
781
  #
688
782
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateFunction AWS API Documentation
689
783
  #
@@ -703,14 +797,14 @@ module Aws::AppSync
703
797
  # The Amazon CloudWatch Logs configuration.
704
798
  #
705
799
  # @option params [required, String] :authentication_type
706
- # The authentication type: API key, Identity and Access Management,
707
- # OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.
800
+ # The authentication type: API key, Identity and Access Management
801
+ # (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
708
802
  #
709
803
  # @option params [Types::UserPoolConfig] :user_pool_config
710
804
  # The Amazon Cognito user pool configuration.
711
805
  #
712
806
  # @option params [Types::OpenIDConnectConfig] :open_id_connect_config
713
- # The OpenID Connect configuration.
807
+ # The OIDC configuration.
714
808
  #
715
809
  # @option params [Hash<String,String>] :tags
716
810
  # A `TagMap` object.
@@ -720,11 +814,10 @@ module Aws::AppSync
720
814
  # API.
721
815
  #
722
816
  # @option params [Boolean] :xray_enabled
723
- # A flag indicating whether to enable X-Ray tracing for the
724
- # `GraphqlApi`.
817
+ # A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.
725
818
  #
726
819
  # @option params [Types::LambdaAuthorizerConfig] :lambda_authorizer_config
727
- # Configuration for Amazon Web Services Lambda function authorization.
820
+ # Configuration for Lambda function authorization.
728
821
  #
729
822
  # @return [Types::CreateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
730
823
  #
@@ -835,7 +928,8 @@ module Aws::AppSync
835
928
  # Creates a `Resolver` object.
836
929
  #
837
930
  # A resolver converts incoming requests into a format that a data source
838
- # can understand and converts the data source's responses into GraphQL.
931
+ # can understand, and converts the data source's responses into
932
+ # GraphQL.
839
933
  #
840
934
  # @option params [required, String] :api_id
841
935
  # The ID for the GraphQL API for which the resolver is being created.
@@ -850,40 +944,43 @@ module Aws::AppSync
850
944
  # The name of the data source for which the resolver is being created.
851
945
  #
852
946
  # @option params [String] :request_mapping_template
853
- # The mapping template to be used for requests.
947
+ # The mapping template to use for requests.
854
948
  #
855
949
  # A resolver uses a request mapping template to convert a GraphQL
856
950
  # expression into a format that a data source can understand. Mapping
857
951
  # templates are written in Apache Velocity Template Language (VTL).
858
952
  #
859
- # VTL request mapping templates are optional when using a Lambda data
953
+ # VTL request mapping templates are optional when using an Lambda data
860
954
  # source. For all other data sources, VTL request and response mapping
861
955
  # templates are required.
862
956
  #
863
957
  # @option params [String] :response_mapping_template
864
- # The mapping template to be used for responses from the data source.
958
+ # The mapping template to use for responses from the data source.
865
959
  #
866
960
  # @option params [String] :kind
867
961
  # The resolver type.
868
962
  #
869
963
  # * **UNIT**\: A UNIT resolver type. A UNIT resolver is the default
870
- # resolver type. A UNIT resolver enables you to execute a GraphQL
871
- # query against a single data source.
964
+ # resolver type. You can use a UNIT resolver to run a GraphQL query
965
+ # against a single data source.
872
966
  #
873
- # * **PIPELINE**\: A PIPELINE resolver type. A PIPELINE resolver enables
874
- # you to execute a series of `Function` in a serial manner. You can
875
- # use a pipeline resolver to execute a GraphQL query against multiple
876
- # data sources.
967
+ # * **PIPELINE**\: A PIPELINE resolver type. You can use a PIPELINE
968
+ # resolver to invoke a series of `Function` objects in a serial
969
+ # manner. You can use a pipeline resolver to run a GraphQL query
970
+ # against multiple data sources.
877
971
  #
878
972
  # @option params [Types::PipelineConfig] :pipeline_config
879
973
  # The `PipelineConfig`.
880
974
  #
881
975
  # @option params [Types::SyncConfig] :sync_config
882
- # The `SyncConfig` for a resolver attached to a versioned datasource.
976
+ # The `SyncConfig` for a resolver attached to a versioned data source.
883
977
  #
884
978
  # @option params [Types::CachingConfig] :caching_config
885
979
  # The caching configuration for the resolver.
886
980
  #
981
+ # @option params [Integer] :max_batch_size
982
+ # The maximum batching size for a resolver.
983
+ #
887
984
  # @return [Types::CreateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
888
985
  #
889
986
  # * {Types::CreateResolverResponse#resolver #resolver} => Types::Resolver
@@ -912,6 +1009,7 @@ module Aws::AppSync
912
1009
  # ttl: 1,
913
1010
  # caching_keys: ["String"],
914
1011
  # },
1012
+ # max_batch_size: 1,
915
1013
  # })
916
1014
  #
917
1015
  # @example Response structure
@@ -931,6 +1029,7 @@ module Aws::AppSync
931
1029
  # resp.resolver.caching_config.ttl #=> Integer
932
1030
  # resp.resolver.caching_config.caching_keys #=> Array
933
1031
  # resp.resolver.caching_config.caching_keys[0] #=> String
1032
+ # resp.resolver.max_batch_size #=> Integer
934
1033
  #
935
1034
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateResolver AWS API Documentation
936
1035
  #
@@ -1062,6 +1161,28 @@ module Aws::AppSync
1062
1161
  req.send_request(options)
1063
1162
  end
1064
1163
 
1164
+ # Deletes a custom `DomainName` object.
1165
+ #
1166
+ # @option params [required, String] :domain_name
1167
+ # The domain name.
1168
+ #
1169
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1170
+ #
1171
+ # @example Request syntax with placeholder values
1172
+ #
1173
+ # resp = client.delete_domain_name({
1174
+ # domain_name: "DomainName", # required
1175
+ # })
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteDomainName AWS API Documentation
1178
+ #
1179
+ # @overload delete_domain_name(params = {})
1180
+ # @param [Hash] params ({})
1181
+ def delete_domain_name(params = {}, options = {})
1182
+ req = build_request(:delete_domain_name, params)
1183
+ req.send_request(options)
1184
+ end
1185
+
1065
1186
  # Deletes a `Function`.
1066
1187
  #
1067
1188
  # @option params [required, String] :api_id
@@ -1166,6 +1287,28 @@ module Aws::AppSync
1166
1287
  req.send_request(options)
1167
1288
  end
1168
1289
 
1290
+ # Removes an `ApiAssociation` object from a custom domain.
1291
+ #
1292
+ # @option params [required, String] :domain_name
1293
+ # The domain name.
1294
+ #
1295
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1296
+ #
1297
+ # @example Request syntax with placeholder values
1298
+ #
1299
+ # resp = client.disassociate_api({
1300
+ # domain_name: "DomainName", # required
1301
+ # })
1302
+ #
1303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DisassociateApi AWS API Documentation
1304
+ #
1305
+ # @overload disassociate_api(params = {})
1306
+ # @param [Hash] params ({})
1307
+ def disassociate_api(params = {}, options = {})
1308
+ req = build_request(:disassociate_api, params)
1309
+ req.send_request(options)
1310
+ end
1311
+
1169
1312
  # Flushes an `ApiCache` object.
1170
1313
  #
1171
1314
  # @option params [required, String] :api_id
@@ -1188,6 +1331,37 @@ module Aws::AppSync
1188
1331
  req.send_request(options)
1189
1332
  end
1190
1333
 
1334
+ # Retrieves an `ApiAssociation` object.
1335
+ #
1336
+ # @option params [required, String] :domain_name
1337
+ # The domain name.
1338
+ #
1339
+ # @return [Types::GetApiAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1340
+ #
1341
+ # * {Types::GetApiAssociationResponse#api_association #api_association} => Types::ApiAssociation
1342
+ #
1343
+ # @example Request syntax with placeholder values
1344
+ #
1345
+ # resp = client.get_api_association({
1346
+ # domain_name: "DomainName", # required
1347
+ # })
1348
+ #
1349
+ # @example Response structure
1350
+ #
1351
+ # resp.api_association.domain_name #=> String
1352
+ # resp.api_association.api_id #=> String
1353
+ # resp.api_association.association_status #=> String, one of "PROCESSING", "FAILED", "SUCCESS"
1354
+ # resp.api_association.deployment_detail #=> String
1355
+ #
1356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiAssociation AWS API Documentation
1357
+ #
1358
+ # @overload get_api_association(params = {})
1359
+ # @param [Hash] params ({})
1360
+ def get_api_association(params = {}, options = {})
1361
+ req = build_request(:get_api_association, params)
1362
+ req.send_request(options)
1363
+ end
1364
+
1191
1365
  # Retrieves an `ApiCache` object.
1192
1366
  #
1193
1367
  # @option params [required, String] :api_id
@@ -1279,6 +1453,38 @@ module Aws::AppSync
1279
1453
  req.send_request(options)
1280
1454
  end
1281
1455
 
1456
+ # Retrieves a custom `DomainName` object.
1457
+ #
1458
+ # @option params [required, String] :domain_name
1459
+ # The domain name.
1460
+ #
1461
+ # @return [Types::GetDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1462
+ #
1463
+ # * {Types::GetDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
1464
+ #
1465
+ # @example Request syntax with placeholder values
1466
+ #
1467
+ # resp = client.get_domain_name({
1468
+ # domain_name: "DomainName", # required
1469
+ # })
1470
+ #
1471
+ # @example Response structure
1472
+ #
1473
+ # resp.domain_name_config.domain_name #=> String
1474
+ # resp.domain_name_config.description #=> String
1475
+ # resp.domain_name_config.certificate_arn #=> String
1476
+ # resp.domain_name_config.appsync_domain_name #=> String
1477
+ # resp.domain_name_config.hosted_zone_id #=> String
1478
+ #
1479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetDomainName AWS API Documentation
1480
+ #
1481
+ # @overload get_domain_name(params = {})
1482
+ # @param [Hash] params ({})
1483
+ def get_domain_name(params = {}, options = {})
1484
+ req = build_request(:get_domain_name, params)
1485
+ req.send_request(options)
1486
+ end
1487
+
1282
1488
  # Get a `Function`.
1283
1489
  #
1284
1490
  # @option params [required, String] :api_id
@@ -1311,6 +1517,7 @@ module Aws::AppSync
1311
1517
  # resp.function_configuration.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
1312
1518
  # resp.function_configuration.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
1313
1519
  # resp.function_configuration.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
1520
+ # resp.function_configuration.max_batch_size #=> Integer
1314
1521
  #
1315
1522
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetFunction AWS API Documentation
1316
1523
  #
@@ -1461,6 +1668,7 @@ module Aws::AppSync
1461
1668
  # resp.resolver.caching_config.ttl #=> Integer
1462
1669
  # resp.resolver.caching_config.caching_keys #=> Array
1463
1670
  # resp.resolver.caching_config.caching_keys[0] #=> String
1671
+ # resp.resolver.max_batch_size #=> Integer
1464
1672
  #
1465
1673
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetResolver AWS API Documentation
1466
1674
  #
@@ -1555,11 +1763,11 @@ module Aws::AppSync
1555
1763
  #
1556
1764
  # @option params [String] :next_token
1557
1765
  # An identifier that was returned from the previous call to this
1558
- # operation, which can be used to return the next set of items in the
1766
+ # operation, which you can use to return the next set of items in the
1559
1767
  # list.
1560
1768
  #
1561
1769
  # @option params [Integer] :max_results
1562
- # The maximum number of results you want the request to return.
1770
+ # The maximum number of results that you want the request to return.
1563
1771
  #
1564
1772
  # @return [Types::ListApiKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1565
1773
  #
@@ -1599,11 +1807,11 @@ module Aws::AppSync
1599
1807
  #
1600
1808
  # @option params [String] :next_token
1601
1809
  # An identifier that was returned from the previous call to this
1602
- # operation, which can be used to return the next set of items in the
1810
+ # operation, which you can use to return the next set of items in the
1603
1811
  # list.
1604
1812
  #
1605
1813
  # @option params [Integer] :max_results
1606
- # The maximum number of results you want the request to return.
1814
+ # The maximum number of results that you want the request to return.
1607
1815
  #
1608
1816
  # @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1609
1817
  #
@@ -1659,6 +1867,45 @@ module Aws::AppSync
1659
1867
  req.send_request(options)
1660
1868
  end
1661
1869
 
1870
+ # Lists multiple custom domain names.
1871
+ #
1872
+ # @option params [String] :next_token
1873
+ # The API token.
1874
+ #
1875
+ # @option params [Integer] :max_results
1876
+ # The maximum number of results that you want the request to return.
1877
+ #
1878
+ # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1879
+ #
1880
+ # * {Types::ListDomainNamesResponse#domain_name_configs #domain_name_configs} => Array&lt;Types::DomainNameConfig&gt;
1881
+ # * {Types::ListDomainNamesResponse#next_token #next_token} => String
1882
+ #
1883
+ # @example Request syntax with placeholder values
1884
+ #
1885
+ # resp = client.list_domain_names({
1886
+ # next_token: "PaginationToken",
1887
+ # max_results: 1,
1888
+ # })
1889
+ #
1890
+ # @example Response structure
1891
+ #
1892
+ # resp.domain_name_configs #=> Array
1893
+ # resp.domain_name_configs[0].domain_name #=> String
1894
+ # resp.domain_name_configs[0].description #=> String
1895
+ # resp.domain_name_configs[0].certificate_arn #=> String
1896
+ # resp.domain_name_configs[0].appsync_domain_name #=> String
1897
+ # resp.domain_name_configs[0].hosted_zone_id #=> String
1898
+ # resp.next_token #=> String
1899
+ #
1900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListDomainNames AWS API Documentation
1901
+ #
1902
+ # @overload list_domain_names(params = {})
1903
+ # @param [Hash] params ({})
1904
+ def list_domain_names(params = {}, options = {})
1905
+ req = build_request(:list_domain_names, params)
1906
+ req.send_request(options)
1907
+ end
1908
+
1662
1909
  # List multiple functions.
1663
1910
  #
1664
1911
  # @option params [required, String] :api_id
@@ -1666,11 +1913,11 @@ module Aws::AppSync
1666
1913
  #
1667
1914
  # @option params [String] :next_token
1668
1915
  # An identifier that was returned from the previous call to this
1669
- # operation, which can be used to return the next set of items in the
1916
+ # operation, which you can use to return the next set of items in the
1670
1917
  # list.
1671
1918
  #
1672
1919
  # @option params [Integer] :max_results
1673
- # The maximum number of results you want the request to return.
1920
+ # The maximum number of results that you want the request to return.
1674
1921
  #
1675
1922
  # @return [Types::ListFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1676
1923
  #
@@ -1699,6 +1946,7 @@ module Aws::AppSync
1699
1946
  # resp.functions[0].sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
1700
1947
  # resp.functions[0].sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
1701
1948
  # resp.functions[0].sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
1949
+ # resp.functions[0].max_batch_size #=> Integer
1702
1950
  # resp.next_token #=> String
1703
1951
  #
1704
1952
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListFunctions AWS API Documentation
@@ -1714,11 +1962,11 @@ module Aws::AppSync
1714
1962
  #
1715
1963
  # @option params [String] :next_token
1716
1964
  # An identifier that was returned from the previous call to this
1717
- # operation, which can be used to return the next set of items in the
1965
+ # operation, which you can use to return the next set of items in the
1718
1966
  # list.
1719
1967
  #
1720
1968
  # @option params [Integer] :max_results
1721
- # The maximum number of results you want the request to return.
1969
+ # The maximum number of results that you want the request to return.
1722
1970
  #
1723
1971
  # @return [Types::ListGraphqlApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1724
1972
  #
@@ -1792,11 +2040,11 @@ module Aws::AppSync
1792
2040
  #
1793
2041
  # @option params [String] :next_token
1794
2042
  # An identifier that was returned from the previous call to this
1795
- # operation, which can be used to return the next set of items in the
2043
+ # operation, which you can use to return the next set of items in the
1796
2044
  # list.
1797
2045
  #
1798
2046
  # @option params [Integer] :max_results
1799
- # The maximum number of results you want the request to return.
2047
+ # The maximum number of results that you want the request to return.
1800
2048
  #
1801
2049
  # @return [Types::ListResolversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1802
2050
  #
@@ -1830,6 +2078,7 @@ module Aws::AppSync
1830
2078
  # resp.resolvers[0].caching_config.ttl #=> Integer
1831
2079
  # resp.resolvers[0].caching_config.caching_keys #=> Array
1832
2080
  # resp.resolvers[0].caching_config.caching_keys[0] #=> String
2081
+ # resp.resolvers[0].max_batch_size #=> Integer
1833
2082
  # resp.next_token #=> String
1834
2083
  #
1835
2084
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListResolvers AWS API Documentation
@@ -1847,7 +2096,7 @@ module Aws::AppSync
1847
2096
  # The API ID.
1848
2097
  #
1849
2098
  # @option params [required, String] :function_id
1850
- # The Function ID.
2099
+ # The function ID.
1851
2100
  #
1852
2101
  # @option params [String] :next_token
1853
2102
  # An identifier that was returned from the previous call to this
@@ -1855,7 +2104,7 @@ module Aws::AppSync
1855
2104
  # list.
1856
2105
  #
1857
2106
  # @option params [Integer] :max_results
1858
- # The maximum number of results you want the request to return.
2107
+ # The maximum number of results that you want the request to return.
1859
2108
  #
1860
2109
  # @return [Types::ListResolversByFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1861
2110
  #
@@ -1889,6 +2138,7 @@ module Aws::AppSync
1889
2138
  # resp.resolvers[0].caching_config.ttl #=> Integer
1890
2139
  # resp.resolvers[0].caching_config.caching_keys #=> Array
1891
2140
  # resp.resolvers[0].caching_config.caching_keys[0] #=> String
2141
+ # resp.resolvers[0].max_batch_size #=> Integer
1892
2142
  # resp.next_token #=> String
1893
2143
  #
1894
2144
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListResolversByFunction AWS API Documentation
@@ -1903,7 +2153,7 @@ module Aws::AppSync
1903
2153
  # Lists the tags for a resource.
1904
2154
  #
1905
2155
  # @option params [required, String] :resource_arn
1906
- # The `GraphqlApi` ARN.
2156
+ # The `GraphqlApi` Amazon Resource Name (ARN).
1907
2157
  #
1908
2158
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1909
2159
  #
@@ -1939,11 +2189,11 @@ module Aws::AppSync
1939
2189
  #
1940
2190
  # @option params [String] :next_token
1941
2191
  # An identifier that was returned from the previous call to this
1942
- # operation, which can be used to return the next set of items in the
2192
+ # operation, which you can use to return the next set of items in the
1943
2193
  # list.
1944
2194
  #
1945
2195
  # @option params [Integer] :max_results
1946
- # The maximum number of results you want the request to return.
2196
+ # The maximum number of results that you want the request to return.
1947
2197
  #
1948
2198
  # @return [Types::ListTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1949
2199
  #
@@ -2016,7 +2266,7 @@ module Aws::AppSync
2016
2266
  # Tags a resource with user-supplied tags.
2017
2267
  #
2018
2268
  # @option params [required, String] :resource_arn
2019
- # The `GraphqlApi` ARN.
2269
+ # The `GraphqlApi` Amazon Resource Name (ARN).
2020
2270
  #
2021
2271
  # @option params [required, Hash<String,String>] :tags
2022
2272
  # A `TagMap` object.
@@ -2044,7 +2294,7 @@ module Aws::AppSync
2044
2294
  # Untags a resource.
2045
2295
  #
2046
2296
  # @option params [required, String] :resource_arn
2047
- # The `GraphqlApi` ARN.
2297
+ # The `GraphqlApi` Amazon Resource Name (ARN).
2048
2298
  #
2049
2299
  # @option params [required, Array<String>] :tag_keys
2050
2300
  # A list of `TagKey` objects.
@@ -2070,12 +2320,12 @@ module Aws::AppSync
2070
2320
  # Updates the cache for the GraphQL API.
2071
2321
  #
2072
2322
  # @option params [required, String] :api_id
2073
- # The GraphQL API Id.
2323
+ # The GraphQL API ID.
2074
2324
  #
2075
2325
  # @option params [required, Integer] :ttl
2076
2326
  # TTL in seconds for cache entries.
2077
2327
  #
2078
- # Valid values are between 1 and 3600 seconds.
2328
+ # Valid values are 1–3,600 seconds.
2079
2329
  #
2080
2330
  # @option params [required, String] :api_caching_behavior
2081
2331
  # Caching behavior.
@@ -2156,7 +2406,8 @@ module Aws::AppSync
2156
2406
  req.send_request(options)
2157
2407
  end
2158
2408
 
2159
- # Updates an API key. The key can be updated while it is not deleted.
2409
+ # Updates an API key. You can update the key as long as it's not
2410
+ # deleted.
2160
2411
  #
2161
2412
  # @option params [required, String] :api_id
2162
2413
  # The ID for the GraphQL API.
@@ -2168,8 +2419,9 @@ module Aws::AppSync
2168
2419
  # A description of the purpose of the API key.
2169
2420
  #
2170
2421
  # @option params [Integer] :expires
2171
- # The time from update time after which the API key expires. The date is
2172
- # represented as seconds since the epoch. For more information, see .
2422
+ # From the update time, the time after which the API key expires. The
2423
+ # date is represented as seconds since the epoch. For more information,
2424
+ # see .
2173
2425
  #
2174
2426
  # @return [Types::UpdateApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2175
2427
  #
@@ -2215,13 +2467,13 @@ module Aws::AppSync
2215
2467
  # The new data source type.
2216
2468
  #
2217
2469
  # @option params [String] :service_role_arn
2218
- # The new service role ARN for the data source.
2470
+ # The new service role Amazon Resource Name (ARN) for the data source.
2219
2471
  #
2220
2472
  # @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
2221
2473
  # The new Amazon DynamoDB configuration.
2222
2474
  #
2223
2475
  # @option params [Types::LambdaDataSourceConfig] :lambda_config
2224
- # The new Amazon Web Services Lambda configuration.
2476
+ # The new Lambda configuration.
2225
2477
  #
2226
2478
  # @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
2227
2479
  # The new OpenSearch configuration.
@@ -2335,6 +2587,42 @@ module Aws::AppSync
2335
2587
  req.send_request(options)
2336
2588
  end
2337
2589
 
2590
+ # Updates a custom `DomainName` object.
2591
+ #
2592
+ # @option params [required, String] :domain_name
2593
+ # The domain name.
2594
+ #
2595
+ # @option params [String] :description
2596
+ # A description of the `DomainName`.
2597
+ #
2598
+ # @return [Types::UpdateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2599
+ #
2600
+ # * {Types::UpdateDomainNameResponse#domain_name_config #domain_name_config} => Types::DomainNameConfig
2601
+ #
2602
+ # @example Request syntax with placeholder values
2603
+ #
2604
+ # resp = client.update_domain_name({
2605
+ # domain_name: "DomainName", # required
2606
+ # description: "Description",
2607
+ # })
2608
+ #
2609
+ # @example Response structure
2610
+ #
2611
+ # resp.domain_name_config.domain_name #=> String
2612
+ # resp.domain_name_config.description #=> String
2613
+ # resp.domain_name_config.certificate_arn #=> String
2614
+ # resp.domain_name_config.appsync_domain_name #=> String
2615
+ # resp.domain_name_config.hosted_zone_id #=> String
2616
+ #
2617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateDomainName AWS API Documentation
2618
+ #
2619
+ # @overload update_domain_name(params = {})
2620
+ # @param [Hash] params ({})
2621
+ def update_domain_name(params = {}, options = {})
2622
+ req = build_request(:update_domain_name, params)
2623
+ req.send_request(options)
2624
+ end
2625
+
2338
2626
  # Updates a `Function` object.
2339
2627
  #
2340
2628
  # @option params [required, String] :api_id
@@ -2360,14 +2648,17 @@ module Aws::AppSync
2360
2648
  # The `Function` request mapping template.
2361
2649
  #
2362
2650
  # @option params [required, String] :function_version
2363
- # The `version` of the request mapping template. Currently the supported
2364
- # value is 2018-05-29.
2651
+ # The `version` of the request mapping template. Currently, the
2652
+ # supported value is 2018-05-29.
2365
2653
  #
2366
2654
  # @option params [Types::SyncConfig] :sync_config
2367
2655
  # Describes a Sync configuration for a resolver.
2368
2656
  #
2369
- # Contains information on which Conflict Detection as well as Resolution
2370
- # strategy should be performed when the resolver is invoked.
2657
+ # Specifies which Conflict Detection strategy and Resolution strategy to
2658
+ # use when the resolver is invoked.
2659
+ #
2660
+ # @option params [Integer] :max_batch_size
2661
+ # The maximum batching size for a resolver.
2371
2662
  #
2372
2663
  # @return [Types::UpdateFunctionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2373
2664
  #
@@ -2391,6 +2682,7 @@ module Aws::AppSync
2391
2682
  # lambda_conflict_handler_arn: "String",
2392
2683
  # },
2393
2684
  # },
2685
+ # max_batch_size: 1,
2394
2686
  # })
2395
2687
  #
2396
2688
  # @example Response structure
@@ -2406,6 +2698,7 @@ module Aws::AppSync
2406
2698
  # resp.function_configuration.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
2407
2699
  # resp.function_configuration.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
2408
2700
  # resp.function_configuration.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
2701
+ # resp.function_configuration.max_batch_size #=> Integer
2409
2702
  #
2410
2703
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateFunction AWS API Documentation
2411
2704
  #
@@ -2431,7 +2724,7 @@ module Aws::AppSync
2431
2724
  # The new authentication type for the `GraphqlApi` object.
2432
2725
  #
2433
2726
  # @option params [Types::UserPoolConfig] :user_pool_config
2434
- # The new Amazon Cognito user pool configuration for the `GraphqlApi`
2727
+ # The new Amazon Cognito user pool configuration for the `~GraphqlApi`
2435
2728
  # object.
2436
2729
  #
2437
2730
  # @option params [Types::OpenIDConnectConfig] :open_id_connect_config
@@ -2442,11 +2735,10 @@ module Aws::AppSync
2442
2735
  # API.
2443
2736
  #
2444
2737
  # @option params [Boolean] :xray_enabled
2445
- # A flag indicating whether to enable X-Ray tracing for the
2446
- # `GraphqlApi`.
2738
+ # A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.
2447
2739
  #
2448
2740
  # @option params [Types::LambdaAuthorizerConfig] :lambda_authorizer_config
2449
- # Configuration for Amazon Web Services Lambda function authorization.
2741
+ # Configuration for Lambda function authorization.
2450
2742
  #
2451
2743
  # @return [Types::UpdateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2452
2744
  #
@@ -2573,7 +2865,7 @@ module Aws::AppSync
2573
2865
  # expression into a format that a data source can understand. Mapping
2574
2866
  # templates are written in Apache Velocity Template Language (VTL).
2575
2867
  #
2576
- # VTL request mapping templates are optional when using a Lambda data
2868
+ # VTL request mapping templates are optional when using an Lambda data
2577
2869
  # source. For all other data sources, VTL request and response mapping
2578
2870
  # templates are required.
2579
2871
  #
@@ -2584,23 +2876,26 @@ module Aws::AppSync
2584
2876
  # The resolver type.
2585
2877
  #
2586
2878
  # * **UNIT**\: A UNIT resolver type. A UNIT resolver is the default
2587
- # resolver type. A UNIT resolver enables you to execute a GraphQL
2588
- # query against a single data source.
2879
+ # resolver type. You can use a UNIT resolver to run a GraphQL query
2880
+ # against a single data source.
2589
2881
  #
2590
- # * **PIPELINE**\: A PIPELINE resolver type. A PIPELINE resolver enables
2591
- # you to execute a series of `Function` in a serial manner. You can
2592
- # use a pipeline resolver to execute a GraphQL query against multiple
2593
- # data sources.
2882
+ # * **PIPELINE**\: A PIPELINE resolver type. You can use a PIPELINE
2883
+ # resolver to invoke a series of `Function` objects in a serial
2884
+ # manner. You can use a pipeline resolver to run a GraphQL query
2885
+ # against multiple data sources.
2594
2886
  #
2595
2887
  # @option params [Types::PipelineConfig] :pipeline_config
2596
2888
  # The `PipelineConfig`.
2597
2889
  #
2598
2890
  # @option params [Types::SyncConfig] :sync_config
2599
- # The `SyncConfig` for a resolver attached to a versioned datasource.
2891
+ # The `SyncConfig` for a resolver attached to a versioned data source.
2600
2892
  #
2601
2893
  # @option params [Types::CachingConfig] :caching_config
2602
2894
  # The caching configuration for the resolver.
2603
2895
  #
2896
+ # @option params [Integer] :max_batch_size
2897
+ # The maximum batching size for a resolver.
2898
+ #
2604
2899
  # @return [Types::UpdateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2605
2900
  #
2606
2901
  # * {Types::UpdateResolverResponse#resolver #resolver} => Types::Resolver
@@ -2629,6 +2924,7 @@ module Aws::AppSync
2629
2924
  # ttl: 1,
2630
2925
  # caching_keys: ["String"],
2631
2926
  # },
2927
+ # max_batch_size: 1,
2632
2928
  # })
2633
2929
  #
2634
2930
  # @example Response structure
@@ -2648,6 +2944,7 @@ module Aws::AppSync
2648
2944
  # resp.resolver.caching_config.ttl #=> Integer
2649
2945
  # resp.resolver.caching_config.caching_keys #=> Array
2650
2946
  # resp.resolver.caching_config.caching_keys[0] #=> String
2947
+ # resp.resolver.max_batch_size #=> Integer
2651
2948
  #
2652
2949
  # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateResolver AWS API Documentation
2653
2950
  #
@@ -2715,7 +3012,7 @@ module Aws::AppSync
2715
3012
  params: params,
2716
3013
  config: config)
2717
3014
  context[:gem_name] = 'aws-sdk-appsync'
2718
- context[:gem_version] = '1.46.0'
3015
+ context[:gem_version] = '1.50.0'
2719
3016
  Seahorse::Client::Request.new(handlers, context)
2720
3017
  end
2721
3018