aws-sdk-appsync 1.21.0 → 1.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-appsync.rb +7 -4
- data/lib/aws-sdk-appsync/client.rb +393 -14
- data/lib/aws-sdk-appsync/client_api.rb +160 -0
- data/lib/aws-sdk-appsync/errors.rb +33 -11
- data/lib/aws-sdk-appsync/resource.rb +1 -0
- data/lib/aws-sdk-appsync/types.rb +561 -7
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: f39ab6fcedec91c356362cbc1cd98be536b1359dad129ceb31ae4f24db5272e3
|
4
|
+
data.tar.gz: 757523b32bae7899afcc207bfe5a0d9e8de20d37dc0ecfc9999006ae0cb6180c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1c6f01f16d2f1f50e9c074f896abddae31ac331eb6be6ab6c182ba51cf6d8666e2c7c013fdb4672d52938c785c913a30df2d957cde6d6e2942ac20bd5b2c318a
|
7
|
+
data.tar.gz: 48f1395df54769db264b66680a9f3bfa8f39e787bbd170ced086d35c140ee9f61db0d2f50f64c13cc16642aea5cbbf0dc795040891a069bf5abfc30f688f449a
|
data/lib/aws-sdk-appsync.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-appsync/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# app_sync = Aws::AppSync::Client.new
|
28
|
+
# resp = app_sync.create_api_cache(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS AppSync
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS AppSync are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::AppSync::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS AppSync API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-appsync/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::AppSync
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.26.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:appsync)
|
31
31
|
|
32
32
|
module Aws::AppSync
|
33
|
+
# An API client for AppSync. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::AppSync::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::AppSync
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::AppSync
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::AppSync
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::AppSync
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::AppSync
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::AppSync
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::AppSync
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::AppSync
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::AppSync
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -254,6 +308,82 @@ module Aws::AppSync
|
|
254
308
|
|
255
309
|
# @!group API Operations
|
256
310
|
|
311
|
+
# Creates a cache for the GraphQL API.
|
312
|
+
#
|
313
|
+
# @option params [required, String] :api_id
|
314
|
+
# The GraphQL API Id.
|
315
|
+
#
|
316
|
+
# @option params [required, Integer] :ttl
|
317
|
+
# TTL in seconds for cache entries.
|
318
|
+
#
|
319
|
+
# Valid values are between 1 and 3600 seconds.
|
320
|
+
#
|
321
|
+
# @option params [Boolean] :transit_encryption_enabled
|
322
|
+
# Transit encryption flag when connecting to cache. This setting cannot
|
323
|
+
# be updated after creation.
|
324
|
+
#
|
325
|
+
# @option params [Boolean] :at_rest_encryption_enabled
|
326
|
+
# At rest encryption flag for cache. This setting cannot be updated
|
327
|
+
# after creation.
|
328
|
+
#
|
329
|
+
# @option params [required, String] :api_caching_behavior
|
330
|
+
# Caching behavior.
|
331
|
+
#
|
332
|
+
# * **FULL\_REQUEST\_CACHING**\: All requests are fully cached.
|
333
|
+
#
|
334
|
+
# * **PER\_RESOLVER\_CACHING**\: Individual resovlers that you specify
|
335
|
+
# are cached.
|
336
|
+
#
|
337
|
+
# @option params [required, String] :type
|
338
|
+
# The cache instance type.
|
339
|
+
#
|
340
|
+
# * **T2\_SMALL**\: A t2.small instance type.
|
341
|
+
#
|
342
|
+
# * **T2\_MEDIUM**\: A t2.medium instance type.
|
343
|
+
#
|
344
|
+
# * **R4\_LARGE**\: A r4.large instance type.
|
345
|
+
#
|
346
|
+
# * **R4\_XLARGE**\: A r4.xlarge instance type.
|
347
|
+
#
|
348
|
+
# * **R4\_2XLARGE**\: A r4.2xlarge instance type.
|
349
|
+
#
|
350
|
+
# * **R4\_4XLARGE**\: A r4.4xlarge instance type.
|
351
|
+
#
|
352
|
+
# * **R4\_8XLARGE**\: A r4.8xlarge instance type.
|
353
|
+
#
|
354
|
+
# @return [Types::CreateApiCacheResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
355
|
+
#
|
356
|
+
# * {Types::CreateApiCacheResponse#api_cache #api_cache} => Types::ApiCache
|
357
|
+
#
|
358
|
+
# @example Request syntax with placeholder values
|
359
|
+
#
|
360
|
+
# resp = client.create_api_cache({
|
361
|
+
# api_id: "String", # required
|
362
|
+
# ttl: 1, # required
|
363
|
+
# transit_encryption_enabled: false,
|
364
|
+
# at_rest_encryption_enabled: false,
|
365
|
+
# api_caching_behavior: "FULL_REQUEST_CACHING", # required, accepts FULL_REQUEST_CACHING, PER_RESOLVER_CACHING
|
366
|
+
# type: "T2_SMALL", # required, accepts T2_SMALL, T2_MEDIUM, R4_LARGE, R4_XLARGE, R4_2XLARGE, R4_4XLARGE, R4_8XLARGE
|
367
|
+
# })
|
368
|
+
#
|
369
|
+
# @example Response structure
|
370
|
+
#
|
371
|
+
# resp.api_cache.ttl #=> Integer
|
372
|
+
# resp.api_cache.api_caching_behavior #=> String, one of "FULL_REQUEST_CACHING", "PER_RESOLVER_CACHING"
|
373
|
+
# resp.api_cache.transit_encryption_enabled #=> Boolean
|
374
|
+
# resp.api_cache.at_rest_encryption_enabled #=> Boolean
|
375
|
+
# resp.api_cache.type #=> String, one of "T2_SMALL", "T2_MEDIUM", "R4_LARGE", "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", "R4_8XLARGE"
|
376
|
+
# resp.api_cache.status #=> String, one of "AVAILABLE", "CREATING", "DELETING", "MODIFYING", "FAILED"
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateApiCache AWS API Documentation
|
379
|
+
#
|
380
|
+
# @overload create_api_cache(params = {})
|
381
|
+
# @param [Hash] params ({})
|
382
|
+
def create_api_cache(params = {}, options = {})
|
383
|
+
req = build_request(:create_api_cache, params)
|
384
|
+
req.send_request(options)
|
385
|
+
end
|
386
|
+
|
257
387
|
# Creates a unique key that you can distribute to clients who are
|
258
388
|
# executing your API.
|
259
389
|
#
|
@@ -345,6 +475,12 @@ module Aws::AppSync
|
|
345
475
|
# table_name: "String", # required
|
346
476
|
# aws_region: "String", # required
|
347
477
|
# use_caller_credentials: false,
|
478
|
+
# delta_sync_config: {
|
479
|
+
# base_table_ttl: 1,
|
480
|
+
# delta_sync_table_name: "String",
|
481
|
+
# delta_sync_table_ttl: 1,
|
482
|
+
# },
|
483
|
+
# versioned: false,
|
348
484
|
# },
|
349
485
|
# lambda_config: {
|
350
486
|
# lambda_function_arn: "String", # required
|
@@ -385,6 +521,10 @@ module Aws::AppSync
|
|
385
521
|
# resp.data_source.dynamodb_config.table_name #=> String
|
386
522
|
# resp.data_source.dynamodb_config.aws_region #=> String
|
387
523
|
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
524
|
+
# resp.data_source.dynamodb_config.delta_sync_config.base_table_ttl #=> Integer
|
525
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_name #=> String
|
526
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_ttl #=> Integer
|
527
|
+
# resp.data_source.dynamodb_config.versioned #=> Boolean
|
388
528
|
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
389
529
|
# resp.data_source.elasticsearch_config.endpoint #=> String
|
390
530
|
# resp.data_source.elasticsearch_config.aws_region #=> String
|
@@ -497,6 +637,10 @@ module Aws::AppSync
|
|
497
637
|
# A list of additional authentication providers for the `GraphqlApi`
|
498
638
|
# API.
|
499
639
|
#
|
640
|
+
# @option params [Boolean] :xray_enabled
|
641
|
+
# A flag indicating whether to enable X-Ray tracing for the
|
642
|
+
# `GraphqlApi`.
|
643
|
+
#
|
500
644
|
# @return [Types::CreateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
501
645
|
#
|
502
646
|
# * {Types::CreateGraphqlApiResponse#graphql_api #graphql_api} => Types::GraphqlApi
|
@@ -542,6 +686,7 @@ module Aws::AppSync
|
|
542
686
|
# },
|
543
687
|
# },
|
544
688
|
# ],
|
689
|
+
# xray_enabled: false,
|
545
690
|
# })
|
546
691
|
#
|
547
692
|
# @example Response structure
|
@@ -574,6 +719,7 @@ module Aws::AppSync
|
|
574
719
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.user_pool_id #=> String
|
575
720
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.aws_region #=> String
|
576
721
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.app_id_client_regex #=> String
|
722
|
+
# resp.graphql_api.xray_enabled #=> Boolean
|
577
723
|
#
|
578
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateGraphqlApi AWS API Documentation
|
579
725
|
#
|
@@ -626,6 +772,12 @@ module Aws::AppSync
|
|
626
772
|
# @option params [Types::PipelineConfig] :pipeline_config
|
627
773
|
# The `PipelineConfig`.
|
628
774
|
#
|
775
|
+
# @option params [Types::SyncConfig] :sync_config
|
776
|
+
# The `SyncConfig` for a resolver attached to a versioned datasource.
|
777
|
+
#
|
778
|
+
# @option params [Types::CachingConfig] :caching_config
|
779
|
+
# The caching configuration for the resolver.
|
780
|
+
#
|
629
781
|
# @return [Types::CreateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
630
782
|
#
|
631
783
|
# * {Types::CreateResolverResponse#resolver #resolver} => Types::Resolver
|
@@ -643,6 +795,17 @@ module Aws::AppSync
|
|
643
795
|
# pipeline_config: {
|
644
796
|
# functions: ["String"],
|
645
797
|
# },
|
798
|
+
# sync_config: {
|
799
|
+
# conflict_handler: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
|
800
|
+
# conflict_detection: "VERSION", # accepts VERSION, NONE
|
801
|
+
# lambda_conflict_handler_config: {
|
802
|
+
# lambda_conflict_handler_arn: "String",
|
803
|
+
# },
|
804
|
+
# },
|
805
|
+
# caching_config: {
|
806
|
+
# ttl: 1,
|
807
|
+
# caching_keys: ["String"],
|
808
|
+
# },
|
646
809
|
# })
|
647
810
|
#
|
648
811
|
# @example Response structure
|
@@ -656,6 +819,12 @@ module Aws::AppSync
|
|
656
819
|
# resp.resolver.kind #=> String, one of "UNIT", "PIPELINE"
|
657
820
|
# resp.resolver.pipeline_config.functions #=> Array
|
658
821
|
# resp.resolver.pipeline_config.functions[0] #=> String
|
822
|
+
# resp.resolver.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
|
823
|
+
# resp.resolver.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
|
824
|
+
# resp.resolver.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
|
825
|
+
# resp.resolver.caching_config.ttl #=> Integer
|
826
|
+
# resp.resolver.caching_config.caching_keys #=> Array
|
827
|
+
# resp.resolver.caching_config.caching_keys[0] #=> String
|
659
828
|
#
|
660
829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateResolver AWS API Documentation
|
661
830
|
#
|
@@ -713,6 +882,28 @@ module Aws::AppSync
|
|
713
882
|
req.send_request(options)
|
714
883
|
end
|
715
884
|
|
885
|
+
# Deletes an `ApiCache` object.
|
886
|
+
#
|
887
|
+
# @option params [required, String] :api_id
|
888
|
+
# The API ID.
|
889
|
+
#
|
890
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
891
|
+
#
|
892
|
+
# @example Request syntax with placeholder values
|
893
|
+
#
|
894
|
+
# resp = client.delete_api_cache({
|
895
|
+
# api_id: "String", # required
|
896
|
+
# })
|
897
|
+
#
|
898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteApiCache AWS API Documentation
|
899
|
+
#
|
900
|
+
# @overload delete_api_cache(params = {})
|
901
|
+
# @param [Hash] params ({})
|
902
|
+
def delete_api_cache(params = {}, options = {})
|
903
|
+
req = build_request(:delete_api_cache, params)
|
904
|
+
req.send_request(options)
|
905
|
+
end
|
906
|
+
|
716
907
|
# Deletes an API key.
|
717
908
|
#
|
718
909
|
# @option params [required, String] :api_id
|
@@ -869,6 +1060,61 @@ module Aws::AppSync
|
|
869
1060
|
req.send_request(options)
|
870
1061
|
end
|
871
1062
|
|
1063
|
+
# Flushes an `ApiCache` object.
|
1064
|
+
#
|
1065
|
+
# @option params [required, String] :api_id
|
1066
|
+
# The API ID.
|
1067
|
+
#
|
1068
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1069
|
+
#
|
1070
|
+
# @example Request syntax with placeholder values
|
1071
|
+
#
|
1072
|
+
# resp = client.flush_api_cache({
|
1073
|
+
# api_id: "String", # required
|
1074
|
+
# })
|
1075
|
+
#
|
1076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/FlushApiCache AWS API Documentation
|
1077
|
+
#
|
1078
|
+
# @overload flush_api_cache(params = {})
|
1079
|
+
# @param [Hash] params ({})
|
1080
|
+
def flush_api_cache(params = {}, options = {})
|
1081
|
+
req = build_request(:flush_api_cache, params)
|
1082
|
+
req.send_request(options)
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# Retrieves an `ApiCache` object.
|
1086
|
+
#
|
1087
|
+
# @option params [required, String] :api_id
|
1088
|
+
# The API ID.
|
1089
|
+
#
|
1090
|
+
# @return [Types::GetApiCacheResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1091
|
+
#
|
1092
|
+
# * {Types::GetApiCacheResponse#api_cache #api_cache} => Types::ApiCache
|
1093
|
+
#
|
1094
|
+
# @example Request syntax with placeholder values
|
1095
|
+
#
|
1096
|
+
# resp = client.get_api_cache({
|
1097
|
+
# api_id: "String", # required
|
1098
|
+
# })
|
1099
|
+
#
|
1100
|
+
# @example Response structure
|
1101
|
+
#
|
1102
|
+
# resp.api_cache.ttl #=> Integer
|
1103
|
+
# resp.api_cache.api_caching_behavior #=> String, one of "FULL_REQUEST_CACHING", "PER_RESOLVER_CACHING"
|
1104
|
+
# resp.api_cache.transit_encryption_enabled #=> Boolean
|
1105
|
+
# resp.api_cache.at_rest_encryption_enabled #=> Boolean
|
1106
|
+
# resp.api_cache.type #=> String, one of "T2_SMALL", "T2_MEDIUM", "R4_LARGE", "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", "R4_8XLARGE"
|
1107
|
+
# resp.api_cache.status #=> String, one of "AVAILABLE", "CREATING", "DELETING", "MODIFYING", "FAILED"
|
1108
|
+
#
|
1109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiCache AWS API Documentation
|
1110
|
+
#
|
1111
|
+
# @overload get_api_cache(params = {})
|
1112
|
+
# @param [Hash] params ({})
|
1113
|
+
def get_api_cache(params = {}, options = {})
|
1114
|
+
req = build_request(:get_api_cache, params)
|
1115
|
+
req.send_request(options)
|
1116
|
+
end
|
1117
|
+
|
872
1118
|
# Retrieves a `DataSource` object.
|
873
1119
|
#
|
874
1120
|
# @option params [required, String] :api_id
|
@@ -898,6 +1144,10 @@ module Aws::AppSync
|
|
898
1144
|
# resp.data_source.dynamodb_config.table_name #=> String
|
899
1145
|
# resp.data_source.dynamodb_config.aws_region #=> String
|
900
1146
|
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
1147
|
+
# resp.data_source.dynamodb_config.delta_sync_config.base_table_ttl #=> Integer
|
1148
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_name #=> String
|
1149
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_ttl #=> Integer
|
1150
|
+
# resp.data_source.dynamodb_config.versioned #=> Boolean
|
901
1151
|
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
902
1152
|
# resp.data_source.elasticsearch_config.endpoint #=> String
|
903
1153
|
# resp.data_source.elasticsearch_config.aws_region #=> String
|
@@ -1005,6 +1255,7 @@ module Aws::AppSync
|
|
1005
1255
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.user_pool_id #=> String
|
1006
1256
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.aws_region #=> String
|
1007
1257
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.app_id_client_regex #=> String
|
1258
|
+
# resp.graphql_api.xray_enabled #=> Boolean
|
1008
1259
|
#
|
1009
1260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetGraphqlApi AWS API Documentation
|
1010
1261
|
#
|
@@ -1086,6 +1337,12 @@ module Aws::AppSync
|
|
1086
1337
|
# resp.resolver.kind #=> String, one of "UNIT", "PIPELINE"
|
1087
1338
|
# resp.resolver.pipeline_config.functions #=> Array
|
1088
1339
|
# resp.resolver.pipeline_config.functions[0] #=> String
|
1340
|
+
# resp.resolver.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
|
1341
|
+
# resp.resolver.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
|
1342
|
+
# resp.resolver.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
|
1343
|
+
# resp.resolver.caching_config.ttl #=> Integer
|
1344
|
+
# resp.resolver.caching_config.caching_keys #=> Array
|
1345
|
+
# resp.resolver.caching_config.caching_keys[0] #=> String
|
1089
1346
|
#
|
1090
1347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetResolver AWS API Documentation
|
1091
1348
|
#
|
@@ -1253,6 +1510,10 @@ module Aws::AppSync
|
|
1253
1510
|
# resp.data_sources[0].dynamodb_config.table_name #=> String
|
1254
1511
|
# resp.data_sources[0].dynamodb_config.aws_region #=> String
|
1255
1512
|
# resp.data_sources[0].dynamodb_config.use_caller_credentials #=> Boolean
|
1513
|
+
# resp.data_sources[0].dynamodb_config.delta_sync_config.base_table_ttl #=> Integer
|
1514
|
+
# resp.data_sources[0].dynamodb_config.delta_sync_config.delta_sync_table_name #=> String
|
1515
|
+
# resp.data_sources[0].dynamodb_config.delta_sync_config.delta_sync_table_ttl #=> Integer
|
1516
|
+
# resp.data_sources[0].dynamodb_config.versioned #=> Boolean
|
1256
1517
|
# resp.data_sources[0].lambda_config.lambda_function_arn #=> String
|
1257
1518
|
# resp.data_sources[0].elasticsearch_config.endpoint #=> String
|
1258
1519
|
# resp.data_sources[0].elasticsearch_config.aws_region #=> String
|
@@ -1378,6 +1639,7 @@ module Aws::AppSync
|
|
1378
1639
|
# resp.graphql_apis[0].additional_authentication_providers[0].user_pool_config.user_pool_id #=> String
|
1379
1640
|
# resp.graphql_apis[0].additional_authentication_providers[0].user_pool_config.aws_region #=> String
|
1380
1641
|
# resp.graphql_apis[0].additional_authentication_providers[0].user_pool_config.app_id_client_regex #=> String
|
1642
|
+
# resp.graphql_apis[0].xray_enabled #=> Boolean
|
1381
1643
|
# resp.next_token #=> String
|
1382
1644
|
#
|
1383
1645
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListGraphqlApis AWS API Documentation
|
@@ -1431,6 +1693,12 @@ module Aws::AppSync
|
|
1431
1693
|
# resp.resolvers[0].kind #=> String, one of "UNIT", "PIPELINE"
|
1432
1694
|
# resp.resolvers[0].pipeline_config.functions #=> Array
|
1433
1695
|
# resp.resolvers[0].pipeline_config.functions[0] #=> String
|
1696
|
+
# resp.resolvers[0].sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
|
1697
|
+
# resp.resolvers[0].sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
|
1698
|
+
# resp.resolvers[0].sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
|
1699
|
+
# resp.resolvers[0].caching_config.ttl #=> Integer
|
1700
|
+
# resp.resolvers[0].caching_config.caching_keys #=> Array
|
1701
|
+
# resp.resolvers[0].caching_config.caching_keys[0] #=> String
|
1434
1702
|
# resp.next_token #=> String
|
1435
1703
|
#
|
1436
1704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListResolvers AWS API Documentation
|
@@ -1484,6 +1752,12 @@ module Aws::AppSync
|
|
1484
1752
|
# resp.resolvers[0].kind #=> String, one of "UNIT", "PIPELINE"
|
1485
1753
|
# resp.resolvers[0].pipeline_config.functions #=> Array
|
1486
1754
|
# resp.resolvers[0].pipeline_config.functions[0] #=> String
|
1755
|
+
# resp.resolvers[0].sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
|
1756
|
+
# resp.resolvers[0].sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
|
1757
|
+
# resp.resolvers[0].sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
|
1758
|
+
# resp.resolvers[0].caching_config.ttl #=> Integer
|
1759
|
+
# resp.resolvers[0].caching_config.caching_keys #=> Array
|
1760
|
+
# resp.resolvers[0].caching_config.caching_keys[0] #=> String
|
1487
1761
|
# resp.next_token #=> String
|
1488
1762
|
#
|
1489
1763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListResolversByFunction AWS API Documentation
|
@@ -1662,6 +1936,72 @@ module Aws::AppSync
|
|
1662
1936
|
req.send_request(options)
|
1663
1937
|
end
|
1664
1938
|
|
1939
|
+
# Updates the cache for the GraphQL API.
|
1940
|
+
#
|
1941
|
+
# @option params [required, String] :api_id
|
1942
|
+
# The GraphQL API Id.
|
1943
|
+
#
|
1944
|
+
# @option params [required, Integer] :ttl
|
1945
|
+
# TTL in seconds for cache entries.
|
1946
|
+
#
|
1947
|
+
# Valid values are between 1 and 3600 seconds.
|
1948
|
+
#
|
1949
|
+
# @option params [required, String] :api_caching_behavior
|
1950
|
+
# Caching behavior.
|
1951
|
+
#
|
1952
|
+
# * **FULL\_REQUEST\_CACHING**\: All requests are fully cached.
|
1953
|
+
#
|
1954
|
+
# * **PER\_RESOLVER\_CACHING**\: Individual resovlers that you specify
|
1955
|
+
# are cached.
|
1956
|
+
#
|
1957
|
+
# @option params [required, String] :type
|
1958
|
+
# The cache instance type.
|
1959
|
+
#
|
1960
|
+
# * **T2\_SMALL**\: A t2.small instance type.
|
1961
|
+
#
|
1962
|
+
# * **T2\_MEDIUM**\: A t2.medium instance type.
|
1963
|
+
#
|
1964
|
+
# * **R4\_LARGE**\: A r4.large instance type.
|
1965
|
+
#
|
1966
|
+
# * **R4\_XLARGE**\: A r4.xlarge instance type.
|
1967
|
+
#
|
1968
|
+
# * **R4\_2XLARGE**\: A r4.2xlarge instance type.
|
1969
|
+
#
|
1970
|
+
# * **R4\_4XLARGE**\: A r4.4xlarge instance type.
|
1971
|
+
#
|
1972
|
+
# * **R4\_8XLARGE**\: A r4.8xlarge instance type.
|
1973
|
+
#
|
1974
|
+
# @return [Types::UpdateApiCacheResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1975
|
+
#
|
1976
|
+
# * {Types::UpdateApiCacheResponse#api_cache #api_cache} => Types::ApiCache
|
1977
|
+
#
|
1978
|
+
# @example Request syntax with placeholder values
|
1979
|
+
#
|
1980
|
+
# resp = client.update_api_cache({
|
1981
|
+
# api_id: "String", # required
|
1982
|
+
# ttl: 1, # required
|
1983
|
+
# api_caching_behavior: "FULL_REQUEST_CACHING", # required, accepts FULL_REQUEST_CACHING, PER_RESOLVER_CACHING
|
1984
|
+
# type: "T2_SMALL", # required, accepts T2_SMALL, T2_MEDIUM, R4_LARGE, R4_XLARGE, R4_2XLARGE, R4_4XLARGE, R4_8XLARGE
|
1985
|
+
# })
|
1986
|
+
#
|
1987
|
+
# @example Response structure
|
1988
|
+
#
|
1989
|
+
# resp.api_cache.ttl #=> Integer
|
1990
|
+
# resp.api_cache.api_caching_behavior #=> String, one of "FULL_REQUEST_CACHING", "PER_RESOLVER_CACHING"
|
1991
|
+
# resp.api_cache.transit_encryption_enabled #=> Boolean
|
1992
|
+
# resp.api_cache.at_rest_encryption_enabled #=> Boolean
|
1993
|
+
# resp.api_cache.type #=> String, one of "T2_SMALL", "T2_MEDIUM", "R4_LARGE", "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", "R4_8XLARGE"
|
1994
|
+
# resp.api_cache.status #=> String, one of "AVAILABLE", "CREATING", "DELETING", "MODIFYING", "FAILED"
|
1995
|
+
#
|
1996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateApiCache AWS API Documentation
|
1997
|
+
#
|
1998
|
+
# @overload update_api_cache(params = {})
|
1999
|
+
# @param [Hash] params ({})
|
2000
|
+
def update_api_cache(params = {}, options = {})
|
2001
|
+
req = build_request(:update_api_cache, params)
|
2002
|
+
req.send_request(options)
|
2003
|
+
end
|
2004
|
+
|
1665
2005
|
# Updates an API key.
|
1666
2006
|
#
|
1667
2007
|
# @option params [required, String] :api_id
|
@@ -1753,6 +2093,12 @@ module Aws::AppSync
|
|
1753
2093
|
# table_name: "String", # required
|
1754
2094
|
# aws_region: "String", # required
|
1755
2095
|
# use_caller_credentials: false,
|
2096
|
+
# delta_sync_config: {
|
2097
|
+
# base_table_ttl: 1,
|
2098
|
+
# delta_sync_table_name: "String",
|
2099
|
+
# delta_sync_table_ttl: 1,
|
2100
|
+
# },
|
2101
|
+
# versioned: false,
|
1756
2102
|
# },
|
1757
2103
|
# lambda_config: {
|
1758
2104
|
# lambda_function_arn: "String", # required
|
@@ -1793,6 +2139,10 @@ module Aws::AppSync
|
|
1793
2139
|
# resp.data_source.dynamodb_config.table_name #=> String
|
1794
2140
|
# resp.data_source.dynamodb_config.aws_region #=> String
|
1795
2141
|
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
2142
|
+
# resp.data_source.dynamodb_config.delta_sync_config.base_table_ttl #=> Integer
|
2143
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_name #=> String
|
2144
|
+
# resp.data_source.dynamodb_config.delta_sync_config.delta_sync_table_ttl #=> Integer
|
2145
|
+
# resp.data_source.dynamodb_config.versioned #=> Boolean
|
1796
2146
|
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
1797
2147
|
# resp.data_source.elasticsearch_config.endpoint #=> String
|
1798
2148
|
# resp.data_source.elasticsearch_config.aws_region #=> String
|
@@ -1906,6 +2256,10 @@ module Aws::AppSync
|
|
1906
2256
|
# A list of additional authentication providers for the `GraphqlApi`
|
1907
2257
|
# API.
|
1908
2258
|
#
|
2259
|
+
# @option params [Boolean] :xray_enabled
|
2260
|
+
# A flag indicating whether to enable X-Ray tracing for the
|
2261
|
+
# `GraphqlApi`.
|
2262
|
+
#
|
1909
2263
|
# @return [Types::UpdateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1910
2264
|
#
|
1911
2265
|
# * {Types::UpdateGraphqlApiResponse#graphql_api #graphql_api} => Types::GraphqlApi
|
@@ -1949,6 +2303,7 @@ module Aws::AppSync
|
|
1949
2303
|
# },
|
1950
2304
|
# },
|
1951
2305
|
# ],
|
2306
|
+
# xray_enabled: false,
|
1952
2307
|
# })
|
1953
2308
|
#
|
1954
2309
|
# @example Response structure
|
@@ -1981,6 +2336,7 @@ module Aws::AppSync
|
|
1981
2336
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.user_pool_id #=> String
|
1982
2337
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.aws_region #=> String
|
1983
2338
|
# resp.graphql_api.additional_authentication_providers[0].user_pool_config.app_id_client_regex #=> String
|
2339
|
+
# resp.graphql_api.xray_enabled #=> Boolean
|
1984
2340
|
#
|
1985
2341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateGraphqlApi AWS API Documentation
|
1986
2342
|
#
|
@@ -2026,6 +2382,12 @@ module Aws::AppSync
|
|
2026
2382
|
# @option params [Types::PipelineConfig] :pipeline_config
|
2027
2383
|
# The `PipelineConfig`.
|
2028
2384
|
#
|
2385
|
+
# @option params [Types::SyncConfig] :sync_config
|
2386
|
+
# The `SyncConfig` for a resolver attached to a versioned datasource.
|
2387
|
+
#
|
2388
|
+
# @option params [Types::CachingConfig] :caching_config
|
2389
|
+
# The caching configuration for the resolver.
|
2390
|
+
#
|
2029
2391
|
# @return [Types::UpdateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2030
2392
|
#
|
2031
2393
|
# * {Types::UpdateResolverResponse#resolver #resolver} => Types::Resolver
|
@@ -2043,6 +2405,17 @@ module Aws::AppSync
|
|
2043
2405
|
# pipeline_config: {
|
2044
2406
|
# functions: ["String"],
|
2045
2407
|
# },
|
2408
|
+
# sync_config: {
|
2409
|
+
# conflict_handler: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
|
2410
|
+
# conflict_detection: "VERSION", # accepts VERSION, NONE
|
2411
|
+
# lambda_conflict_handler_config: {
|
2412
|
+
# lambda_conflict_handler_arn: "String",
|
2413
|
+
# },
|
2414
|
+
# },
|
2415
|
+
# caching_config: {
|
2416
|
+
# ttl: 1,
|
2417
|
+
# caching_keys: ["String"],
|
2418
|
+
# },
|
2046
2419
|
# })
|
2047
2420
|
#
|
2048
2421
|
# @example Response structure
|
@@ -2056,6 +2429,12 @@ module Aws::AppSync
|
|
2056
2429
|
# resp.resolver.kind #=> String, one of "UNIT", "PIPELINE"
|
2057
2430
|
# resp.resolver.pipeline_config.functions #=> Array
|
2058
2431
|
# resp.resolver.pipeline_config.functions[0] #=> String
|
2432
|
+
# resp.resolver.sync_config.conflict_handler #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
|
2433
|
+
# resp.resolver.sync_config.conflict_detection #=> String, one of "VERSION", "NONE"
|
2434
|
+
# resp.resolver.sync_config.lambda_conflict_handler_config.lambda_conflict_handler_arn #=> String
|
2435
|
+
# resp.resolver.caching_config.ttl #=> Integer
|
2436
|
+
# resp.resolver.caching_config.caching_keys #=> Array
|
2437
|
+
# resp.resolver.caching_config.caching_keys[0] #=> String
|
2059
2438
|
#
|
2060
2439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateResolver AWS API Documentation
|
2061
2440
|
#
|
@@ -2123,7 +2502,7 @@ module Aws::AppSync
|
|
2123
2502
|
params: params,
|
2124
2503
|
config: config)
|
2125
2504
|
context[:gem_name] = 'aws-sdk-appsync'
|
2126
|
-
context[:gem_version] = '1.
|
2505
|
+
context[:gem_version] = '1.26.0'
|
2127
2506
|
Seahorse::Client::Request.new(handlers, context)
|
2128
2507
|
end
|
2129
2508
|
|