aws-sdk-appsync 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-appsync.rb +47 -0
- data/lib/aws-sdk-appsync/client.rb +1304 -0
- data/lib/aws-sdk-appsync/client_api.rb +737 -0
- data/lib/aws-sdk-appsync/customizations.rb +0 -0
- data/lib/aws-sdk-appsync/errors.rb +14 -0
- data/lib/aws-sdk-appsync/resource.rb +23 -0
- data/lib/aws-sdk-appsync/types.rb +1474 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: e1a295d185b031048d428e910e8dc1f6c9b9673d
|
4
|
+
data.tar.gz: 1607069ee16464e60642cb2efa3c4ad3eefe1754
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7c06293c3b79ac958578ac64417ddeca9fe0696e4f0bcbf08dfc59d747b59dc2b9dec8733790889adebf0619fcd002dcb1b8476b20dd8fd1330ec2685f3867f0
|
7
|
+
data.tar.gz: b55252c460d81fb7bb75776c10279216ecc05c057593184e5829509ea0f636db88f7957e256f7d359e7a828c23d5c1c56690abb5c2ee369cc9ccbf4b082ea7b7
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-appsync/types'
|
12
|
+
require_relative 'aws-sdk-appsync/client_api'
|
13
|
+
require_relative 'aws-sdk-appsync/client'
|
14
|
+
require_relative 'aws-sdk-appsync/errors'
|
15
|
+
require_relative 'aws-sdk-appsync/resource'
|
16
|
+
require_relative 'aws-sdk-appsync/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS AppSync. This module is available in the
|
19
|
+
# `aws-sdk-appsync` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS AppSync all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::AppSync::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::AppSync
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1304 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:appsync)
|
26
|
+
|
27
|
+
module Aws::AppSync
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :appsync
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
52
|
+
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
55
|
+
# following classes:
|
56
|
+
#
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
58
|
+
# credentials.
|
59
|
+
#
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
62
|
+
#
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
64
|
+
# shared file, such as `~/.aws/config`.
|
65
|
+
#
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
67
|
+
#
|
68
|
+
# When `:credentials` are not configured directly, the following
|
69
|
+
# locations will be searched for credentials:
|
70
|
+
#
|
71
|
+
# * `Aws.config[:credentials]`
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
74
|
+
# * `~/.aws/credentials`
|
75
|
+
# * `~/.aws/config`
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
77
|
+
# very aggressive. Construct and pass an instance of
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
79
|
+
# timeouts.
|
80
|
+
#
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
#
|
93
|
+
# @option options [String] :access_key_id
|
94
|
+
#
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
97
|
+
# the required types.
|
98
|
+
#
|
99
|
+
# @option options [String] :endpoint
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
|
+
#
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
105
|
+
# The log formatter.
|
106
|
+
#
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
108
|
+
# The log level to send messages to the `:logger` at.
|
109
|
+
#
|
110
|
+
# @option options [Logger] :logger
|
111
|
+
# The Logger instance to send log messages to. If this option
|
112
|
+
# is not set, logging will be disabled.
|
113
|
+
#
|
114
|
+
# @option options [String] :profile ("default")
|
115
|
+
# Used when loading credentials from the shared credentials file
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
117
|
+
#
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
123
|
+
# errors from expired credentials.
|
124
|
+
#
|
125
|
+
# @option options [String] :secret_access_key
|
126
|
+
#
|
127
|
+
# @option options [String] :session_token
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :stub_responses (false)
|
130
|
+
# Causes the client to return stubbed responses. By default
|
131
|
+
# fake responses are generated and returned. You can specify
|
132
|
+
# the response data to return or errors to raise by calling
|
133
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
134
|
+
#
|
135
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
136
|
+
# requests are made, and retries are disabled.
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :validate_params (true)
|
139
|
+
# When `true`, request parameters are validated before
|
140
|
+
# sending the request.
|
141
|
+
#
|
142
|
+
def initialize(*args)
|
143
|
+
super
|
144
|
+
end
|
145
|
+
|
146
|
+
# @!group API Operations
|
147
|
+
|
148
|
+
# Creates a unique key that you can distribute to clients who are
|
149
|
+
# executing your API.
|
150
|
+
#
|
151
|
+
# @option params [required, String] :api_id
|
152
|
+
# The ID for your GraphQL API.
|
153
|
+
#
|
154
|
+
# @option params [String] :description
|
155
|
+
# A description of the purpose of the API key.
|
156
|
+
#
|
157
|
+
# @return [Types::CreateApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
158
|
+
#
|
159
|
+
# * {Types::CreateApiKeyResponse#api_key #api_key} => Types::ApiKey
|
160
|
+
#
|
161
|
+
# @example Request syntax with placeholder values
|
162
|
+
#
|
163
|
+
# resp = client.create_api_key({
|
164
|
+
# api_id: "String", # required
|
165
|
+
# description: "String",
|
166
|
+
# })
|
167
|
+
#
|
168
|
+
# @example Response structure
|
169
|
+
#
|
170
|
+
# resp.api_key.id #=> String
|
171
|
+
# resp.api_key.description #=> String
|
172
|
+
# resp.api_key.expires #=> Integer
|
173
|
+
#
|
174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateApiKey AWS API Documentation
|
175
|
+
#
|
176
|
+
# @overload create_api_key(params = {})
|
177
|
+
# @param [Hash] params ({})
|
178
|
+
def create_api_key(params = {}, options = {})
|
179
|
+
req = build_request(:create_api_key, params)
|
180
|
+
req.send_request(options)
|
181
|
+
end
|
182
|
+
|
183
|
+
# Creates a `DataSource` object.
|
184
|
+
#
|
185
|
+
# @option params [required, String] :api_id
|
186
|
+
# The API ID for the GraphQL API for the `DataSource`.
|
187
|
+
#
|
188
|
+
# @option params [required, String] :name
|
189
|
+
# A user-supplied name for the `DataSource`.
|
190
|
+
#
|
191
|
+
# @option params [String] :description
|
192
|
+
# A description of the `DataSource`.
|
193
|
+
#
|
194
|
+
# @option params [required, String] :type
|
195
|
+
# The type of the `DataSource`.
|
196
|
+
#
|
197
|
+
# @option params [String] :service_role_arn
|
198
|
+
# The IAM service role ARN for the data source. The system assumes this
|
199
|
+
# role when accessing the data source.
|
200
|
+
#
|
201
|
+
# @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
|
202
|
+
# DynamoDB settings.
|
203
|
+
#
|
204
|
+
# @option params [Types::LambdaDataSourceConfig] :lambda_config
|
205
|
+
# AWS Lambda settings.
|
206
|
+
#
|
207
|
+
# @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
|
208
|
+
# Amazon Elasticsearch settings.
|
209
|
+
#
|
210
|
+
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
211
|
+
#
|
212
|
+
# * {Types::CreateDataSourceResponse#data_source #data_source} => Types::DataSource
|
213
|
+
#
|
214
|
+
# @example Request syntax with placeholder values
|
215
|
+
#
|
216
|
+
# resp = client.create_data_source({
|
217
|
+
# api_id: "String", # required
|
218
|
+
# name: "ResourceName", # required
|
219
|
+
# description: "String",
|
220
|
+
# type: "AWS_LAMBDA", # required, accepts AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH
|
221
|
+
# service_role_arn: "String",
|
222
|
+
# dynamodb_config: {
|
223
|
+
# table_name: "String", # required
|
224
|
+
# aws_region: "String", # required
|
225
|
+
# use_caller_credentials: false,
|
226
|
+
# },
|
227
|
+
# lambda_config: {
|
228
|
+
# lambda_function_arn: "String", # required
|
229
|
+
# },
|
230
|
+
# elasticsearch_config: {
|
231
|
+
# endpoint: "String", # required
|
232
|
+
# aws_region: "String", # required
|
233
|
+
# },
|
234
|
+
# })
|
235
|
+
#
|
236
|
+
# @example Response structure
|
237
|
+
#
|
238
|
+
# resp.data_source.data_source_arn #=> String
|
239
|
+
# resp.data_source.name #=> String
|
240
|
+
# resp.data_source.description #=> String
|
241
|
+
# resp.data_source.type #=> String, one of "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH"
|
242
|
+
# resp.data_source.service_role_arn #=> String
|
243
|
+
# resp.data_source.dynamodb_config.table_name #=> String
|
244
|
+
# resp.data_source.dynamodb_config.aws_region #=> String
|
245
|
+
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
246
|
+
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
247
|
+
# resp.data_source.elasticsearch_config.endpoint #=> String
|
248
|
+
# resp.data_source.elasticsearch_config.aws_region #=> String
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateDataSource AWS API Documentation
|
251
|
+
#
|
252
|
+
# @overload create_data_source(params = {})
|
253
|
+
# @param [Hash] params ({})
|
254
|
+
def create_data_source(params = {}, options = {})
|
255
|
+
req = build_request(:create_data_source, params)
|
256
|
+
req.send_request(options)
|
257
|
+
end
|
258
|
+
|
259
|
+
# Creates a `GraphqlApi` object.
|
260
|
+
#
|
261
|
+
# @option params [required, String] :name
|
262
|
+
# A user-supplied name for the `GraphqlApi`.
|
263
|
+
#
|
264
|
+
# @option params [required, String] :authentication_type
|
265
|
+
# The authentication type: API key, IAM, or Amazon Cognito User Pools.
|
266
|
+
#
|
267
|
+
# @option params [Types::UserPoolConfig] :user_pool_config
|
268
|
+
# The Amazon Cognito User Pool configuration.
|
269
|
+
#
|
270
|
+
# @return [Types::CreateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
271
|
+
#
|
272
|
+
# * {Types::CreateGraphqlApiResponse#graphql_api #graphql_api} => Types::GraphqlApi
|
273
|
+
#
|
274
|
+
# @example Request syntax with placeholder values
|
275
|
+
#
|
276
|
+
# resp = client.create_graphql_api({
|
277
|
+
# name: "ResourceName", # required
|
278
|
+
# authentication_type: "API_KEY", # required, accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS
|
279
|
+
# user_pool_config: {
|
280
|
+
# user_pool_id: "String", # required
|
281
|
+
# aws_region: "String", # required
|
282
|
+
# default_action: "ALLOW", # required, accepts ALLOW, DENY
|
283
|
+
# app_id_client_regex: "String",
|
284
|
+
# },
|
285
|
+
# })
|
286
|
+
#
|
287
|
+
# @example Response structure
|
288
|
+
#
|
289
|
+
# resp.graphql_api.name #=> String
|
290
|
+
# resp.graphql_api.api_id #=> String
|
291
|
+
# resp.graphql_api.authentication_type #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS"
|
292
|
+
# resp.graphql_api.user_pool_config.user_pool_id #=> String
|
293
|
+
# resp.graphql_api.user_pool_config.aws_region #=> String
|
294
|
+
# resp.graphql_api.user_pool_config.default_action #=> String, one of "ALLOW", "DENY"
|
295
|
+
# resp.graphql_api.user_pool_config.app_id_client_regex #=> String
|
296
|
+
# resp.graphql_api.arn #=> String
|
297
|
+
# resp.graphql_api.uris #=> Hash
|
298
|
+
# resp.graphql_api.uris["String"] #=> String
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateGraphqlApi AWS API Documentation
|
301
|
+
#
|
302
|
+
# @overload create_graphql_api(params = {})
|
303
|
+
# @param [Hash] params ({})
|
304
|
+
def create_graphql_api(params = {}, options = {})
|
305
|
+
req = build_request(:create_graphql_api, params)
|
306
|
+
req.send_request(options)
|
307
|
+
end
|
308
|
+
|
309
|
+
# Creates a `Resolver` object.
|
310
|
+
#
|
311
|
+
# A resolver converts incoming requests into a format that a data source
|
312
|
+
# can understand and converts the data source's responses into GraphQL.
|
313
|
+
#
|
314
|
+
# @option params [required, String] :api_id
|
315
|
+
# The ID for the GraphQL API for which the resolver is being created.
|
316
|
+
#
|
317
|
+
# @option params [required, String] :type_name
|
318
|
+
# The name of the `Type`.
|
319
|
+
#
|
320
|
+
# @option params [required, String] :field_name
|
321
|
+
# The name of the field to attach the resolver to.
|
322
|
+
#
|
323
|
+
# @option params [required, String] :data_source_name
|
324
|
+
# The name of the data source for which the resolver is being created.
|
325
|
+
#
|
326
|
+
# @option params [required, String] :request_mapping_template
|
327
|
+
# The mapping template to be used for requests.
|
328
|
+
#
|
329
|
+
# A resolver use a request mapping template to convert a GraphQL
|
330
|
+
# expression into a format that a data source can understand. Mapping
|
331
|
+
# templates are written in Apache Velocity Template Language (VTL).
|
332
|
+
#
|
333
|
+
# @option params [String] :response_mapping_template
|
334
|
+
# The mapping template to be used for responses from the data source.
|
335
|
+
#
|
336
|
+
# @return [Types::CreateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
337
|
+
#
|
338
|
+
# * {Types::CreateResolverResponse#resolver #resolver} => Types::Resolver
|
339
|
+
#
|
340
|
+
# @example Request syntax with placeholder values
|
341
|
+
#
|
342
|
+
# resp = client.create_resolver({
|
343
|
+
# api_id: "String", # required
|
344
|
+
# type_name: "ResourceName", # required
|
345
|
+
# field_name: "ResourceName", # required
|
346
|
+
# data_source_name: "ResourceName", # required
|
347
|
+
# request_mapping_template: "MappingTemplate", # required
|
348
|
+
# response_mapping_template: "MappingTemplate",
|
349
|
+
# })
|
350
|
+
#
|
351
|
+
# @example Response structure
|
352
|
+
#
|
353
|
+
# resp.resolver.type_name #=> String
|
354
|
+
# resp.resolver.field_name #=> String
|
355
|
+
# resp.resolver.data_source_name #=> String
|
356
|
+
# resp.resolver.resolver_arn #=> String
|
357
|
+
# resp.resolver.request_mapping_template #=> String
|
358
|
+
# resp.resolver.response_mapping_template #=> String
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateResolver AWS API Documentation
|
361
|
+
#
|
362
|
+
# @overload create_resolver(params = {})
|
363
|
+
# @param [Hash] params ({})
|
364
|
+
def create_resolver(params = {}, options = {})
|
365
|
+
req = build_request(:create_resolver, params)
|
366
|
+
req.send_request(options)
|
367
|
+
end
|
368
|
+
|
369
|
+
# Creates a `Type` object.
|
370
|
+
#
|
371
|
+
# @option params [required, String] :api_id
|
372
|
+
# The API ID.
|
373
|
+
#
|
374
|
+
# @option params [required, String] :definition
|
375
|
+
# The type definition, in GraphQL Schema Definition Language (SDL)
|
376
|
+
# format.
|
377
|
+
#
|
378
|
+
# For more information, see the [GraphQL SDL documentation][1].
|
379
|
+
#
|
380
|
+
#
|
381
|
+
#
|
382
|
+
# [1]: http://graphql.org/learn/schema/
|
383
|
+
#
|
384
|
+
# @option params [required, String] :format
|
385
|
+
# The type format: SDL or JSON.
|
386
|
+
#
|
387
|
+
# @return [Types::CreateTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
388
|
+
#
|
389
|
+
# * {Types::CreateTypeResponse#type #type} => Types::Type
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
#
|
393
|
+
# resp = client.create_type({
|
394
|
+
# api_id: "String", # required
|
395
|
+
# definition: "String", # required
|
396
|
+
# format: "SDL", # required, accepts SDL, JSON
|
397
|
+
# })
|
398
|
+
#
|
399
|
+
# @example Response structure
|
400
|
+
#
|
401
|
+
# resp.type.name #=> String
|
402
|
+
# resp.type.description #=> String
|
403
|
+
# resp.type.arn #=> String
|
404
|
+
# resp.type.definition #=> String
|
405
|
+
# resp.type.format #=> String, one of "SDL", "JSON"
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateType AWS API Documentation
|
408
|
+
#
|
409
|
+
# @overload create_type(params = {})
|
410
|
+
# @param [Hash] params ({})
|
411
|
+
def create_type(params = {}, options = {})
|
412
|
+
req = build_request(:create_type, params)
|
413
|
+
req.send_request(options)
|
414
|
+
end
|
415
|
+
|
416
|
+
# Deletes an API key.
|
417
|
+
#
|
418
|
+
# @option params [required, String] :api_id
|
419
|
+
# The API ID.
|
420
|
+
#
|
421
|
+
# @option params [required, String] :id
|
422
|
+
# The ID for the API key.
|
423
|
+
#
|
424
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
425
|
+
#
|
426
|
+
# @example Request syntax with placeholder values
|
427
|
+
#
|
428
|
+
# resp = client.delete_api_key({
|
429
|
+
# api_id: "String", # required
|
430
|
+
# id: "String", # required
|
431
|
+
# })
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteApiKey AWS API Documentation
|
434
|
+
#
|
435
|
+
# @overload delete_api_key(params = {})
|
436
|
+
# @param [Hash] params ({})
|
437
|
+
def delete_api_key(params = {}, options = {})
|
438
|
+
req = build_request(:delete_api_key, params)
|
439
|
+
req.send_request(options)
|
440
|
+
end
|
441
|
+
|
442
|
+
# Deletes a `DataSource` object.
|
443
|
+
#
|
444
|
+
# @option params [required, String] :api_id
|
445
|
+
# The API ID.
|
446
|
+
#
|
447
|
+
# @option params [required, String] :name
|
448
|
+
# The name of the data source.
|
449
|
+
#
|
450
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
451
|
+
#
|
452
|
+
# @example Request syntax with placeholder values
|
453
|
+
#
|
454
|
+
# resp = client.delete_data_source({
|
455
|
+
# api_id: "String", # required
|
456
|
+
# name: "ResourceName", # required
|
457
|
+
# })
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteDataSource AWS API Documentation
|
460
|
+
#
|
461
|
+
# @overload delete_data_source(params = {})
|
462
|
+
# @param [Hash] params ({})
|
463
|
+
def delete_data_source(params = {}, options = {})
|
464
|
+
req = build_request(:delete_data_source, params)
|
465
|
+
req.send_request(options)
|
466
|
+
end
|
467
|
+
|
468
|
+
# Deletes a `GraphqlApi` object.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :api_id
|
471
|
+
# The API ID.
|
472
|
+
#
|
473
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
474
|
+
#
|
475
|
+
# @example Request syntax with placeholder values
|
476
|
+
#
|
477
|
+
# resp = client.delete_graphql_api({
|
478
|
+
# api_id: "String", # required
|
479
|
+
# })
|
480
|
+
#
|
481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteGraphqlApi AWS API Documentation
|
482
|
+
#
|
483
|
+
# @overload delete_graphql_api(params = {})
|
484
|
+
# @param [Hash] params ({})
|
485
|
+
def delete_graphql_api(params = {}, options = {})
|
486
|
+
req = build_request(:delete_graphql_api, params)
|
487
|
+
req.send_request(options)
|
488
|
+
end
|
489
|
+
|
490
|
+
# Deletes a `Resolver` object.
|
491
|
+
#
|
492
|
+
# @option params [required, String] :api_id
|
493
|
+
# The API ID.
|
494
|
+
#
|
495
|
+
# @option params [required, String] :type_name
|
496
|
+
# The name of the resolver type.
|
497
|
+
#
|
498
|
+
# @option params [required, String] :field_name
|
499
|
+
# The resolver field name.
|
500
|
+
#
|
501
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
502
|
+
#
|
503
|
+
# @example Request syntax with placeholder values
|
504
|
+
#
|
505
|
+
# resp = client.delete_resolver({
|
506
|
+
# api_id: "String", # required
|
507
|
+
# type_name: "ResourceName", # required
|
508
|
+
# field_name: "ResourceName", # required
|
509
|
+
# })
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteResolver AWS API Documentation
|
512
|
+
#
|
513
|
+
# @overload delete_resolver(params = {})
|
514
|
+
# @param [Hash] params ({})
|
515
|
+
def delete_resolver(params = {}, options = {})
|
516
|
+
req = build_request(:delete_resolver, params)
|
517
|
+
req.send_request(options)
|
518
|
+
end
|
519
|
+
|
520
|
+
# Deletes a `Type` object.
|
521
|
+
#
|
522
|
+
# @option params [required, String] :api_id
|
523
|
+
# The API ID.
|
524
|
+
#
|
525
|
+
# @option params [required, String] :type_name
|
526
|
+
# The type name.
|
527
|
+
#
|
528
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
529
|
+
#
|
530
|
+
# @example Request syntax with placeholder values
|
531
|
+
#
|
532
|
+
# resp = client.delete_type({
|
533
|
+
# api_id: "String", # required
|
534
|
+
# type_name: "ResourceName", # required
|
535
|
+
# })
|
536
|
+
#
|
537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteType AWS API Documentation
|
538
|
+
#
|
539
|
+
# @overload delete_type(params = {})
|
540
|
+
# @param [Hash] params ({})
|
541
|
+
def delete_type(params = {}, options = {})
|
542
|
+
req = build_request(:delete_type, params)
|
543
|
+
req.send_request(options)
|
544
|
+
end
|
545
|
+
|
546
|
+
# Retrieves a `DataSource` object.
|
547
|
+
#
|
548
|
+
# @option params [required, String] :api_id
|
549
|
+
# The API ID.
|
550
|
+
#
|
551
|
+
# @option params [required, String] :name
|
552
|
+
# The name of the data source.
|
553
|
+
#
|
554
|
+
# @return [Types::GetDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
555
|
+
#
|
556
|
+
# * {Types::GetDataSourceResponse#data_source #data_source} => Types::DataSource
|
557
|
+
#
|
558
|
+
# @example Request syntax with placeholder values
|
559
|
+
#
|
560
|
+
# resp = client.get_data_source({
|
561
|
+
# api_id: "String", # required
|
562
|
+
# name: "ResourceName", # required
|
563
|
+
# })
|
564
|
+
#
|
565
|
+
# @example Response structure
|
566
|
+
#
|
567
|
+
# resp.data_source.data_source_arn #=> String
|
568
|
+
# resp.data_source.name #=> String
|
569
|
+
# resp.data_source.description #=> String
|
570
|
+
# resp.data_source.type #=> String, one of "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH"
|
571
|
+
# resp.data_source.service_role_arn #=> String
|
572
|
+
# resp.data_source.dynamodb_config.table_name #=> String
|
573
|
+
# resp.data_source.dynamodb_config.aws_region #=> String
|
574
|
+
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
575
|
+
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
576
|
+
# resp.data_source.elasticsearch_config.endpoint #=> String
|
577
|
+
# resp.data_source.elasticsearch_config.aws_region #=> String
|
578
|
+
#
|
579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetDataSource AWS API Documentation
|
580
|
+
#
|
581
|
+
# @overload get_data_source(params = {})
|
582
|
+
# @param [Hash] params ({})
|
583
|
+
def get_data_source(params = {}, options = {})
|
584
|
+
req = build_request(:get_data_source, params)
|
585
|
+
req.send_request(options)
|
586
|
+
end
|
587
|
+
|
588
|
+
# Retrieves a `GraphqlApi` object.
|
589
|
+
#
|
590
|
+
# @option params [required, String] :api_id
|
591
|
+
# The API ID for the GraphQL API.
|
592
|
+
#
|
593
|
+
# @return [Types::GetGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
594
|
+
#
|
595
|
+
# * {Types::GetGraphqlApiResponse#graphql_api #graphql_api} => Types::GraphqlApi
|
596
|
+
#
|
597
|
+
# @example Request syntax with placeholder values
|
598
|
+
#
|
599
|
+
# resp = client.get_graphql_api({
|
600
|
+
# api_id: "String", # required
|
601
|
+
# })
|
602
|
+
#
|
603
|
+
# @example Response structure
|
604
|
+
#
|
605
|
+
# resp.graphql_api.name #=> String
|
606
|
+
# resp.graphql_api.api_id #=> String
|
607
|
+
# resp.graphql_api.authentication_type #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS"
|
608
|
+
# resp.graphql_api.user_pool_config.user_pool_id #=> String
|
609
|
+
# resp.graphql_api.user_pool_config.aws_region #=> String
|
610
|
+
# resp.graphql_api.user_pool_config.default_action #=> String, one of "ALLOW", "DENY"
|
611
|
+
# resp.graphql_api.user_pool_config.app_id_client_regex #=> String
|
612
|
+
# resp.graphql_api.arn #=> String
|
613
|
+
# resp.graphql_api.uris #=> Hash
|
614
|
+
# resp.graphql_api.uris["String"] #=> String
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetGraphqlApi AWS API Documentation
|
617
|
+
#
|
618
|
+
# @overload get_graphql_api(params = {})
|
619
|
+
# @param [Hash] params ({})
|
620
|
+
def get_graphql_api(params = {}, options = {})
|
621
|
+
req = build_request(:get_graphql_api, params)
|
622
|
+
req.send_request(options)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Retrieves the introspection schema for a GraphQL API.
|
626
|
+
#
|
627
|
+
# @option params [required, String] :api_id
|
628
|
+
# The API ID.
|
629
|
+
#
|
630
|
+
# @option params [required, String] :format
|
631
|
+
# The schema format: SDL or JSON.
|
632
|
+
#
|
633
|
+
# @return [Types::GetIntrospectionSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
634
|
+
#
|
635
|
+
# * {Types::GetIntrospectionSchemaResponse#schema #schema} => String
|
636
|
+
#
|
637
|
+
# @example Request syntax with placeholder values
|
638
|
+
#
|
639
|
+
# resp = client.get_introspection_schema({
|
640
|
+
# api_id: "String", # required
|
641
|
+
# format: "SDL", # required, accepts SDL, JSON
|
642
|
+
# })
|
643
|
+
#
|
644
|
+
# @example Response structure
|
645
|
+
#
|
646
|
+
# resp.schema #=> String
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetIntrospectionSchema AWS API Documentation
|
649
|
+
#
|
650
|
+
# @overload get_introspection_schema(params = {})
|
651
|
+
# @param [Hash] params ({})
|
652
|
+
def get_introspection_schema(params = {}, options = {})
|
653
|
+
req = build_request(:get_introspection_schema, params)
|
654
|
+
req.send_request(options)
|
655
|
+
end
|
656
|
+
|
657
|
+
# Retrieves a `Resolver` object.
|
658
|
+
#
|
659
|
+
# @option params [required, String] :api_id
|
660
|
+
# The API ID.
|
661
|
+
#
|
662
|
+
# @option params [required, String] :type_name
|
663
|
+
# The resolver type name.
|
664
|
+
#
|
665
|
+
# @option params [required, String] :field_name
|
666
|
+
# The resolver field name.
|
667
|
+
#
|
668
|
+
# @return [Types::GetResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
669
|
+
#
|
670
|
+
# * {Types::GetResolverResponse#resolver #resolver} => Types::Resolver
|
671
|
+
#
|
672
|
+
# @example Request syntax with placeholder values
|
673
|
+
#
|
674
|
+
# resp = client.get_resolver({
|
675
|
+
# api_id: "String", # required
|
676
|
+
# type_name: "ResourceName", # required
|
677
|
+
# field_name: "ResourceName", # required
|
678
|
+
# })
|
679
|
+
#
|
680
|
+
# @example Response structure
|
681
|
+
#
|
682
|
+
# resp.resolver.type_name #=> String
|
683
|
+
# resp.resolver.field_name #=> String
|
684
|
+
# resp.resolver.data_source_name #=> String
|
685
|
+
# resp.resolver.resolver_arn #=> String
|
686
|
+
# resp.resolver.request_mapping_template #=> String
|
687
|
+
# resp.resolver.response_mapping_template #=> String
|
688
|
+
#
|
689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetResolver AWS API Documentation
|
690
|
+
#
|
691
|
+
# @overload get_resolver(params = {})
|
692
|
+
# @param [Hash] params ({})
|
693
|
+
def get_resolver(params = {}, options = {})
|
694
|
+
req = build_request(:get_resolver, params)
|
695
|
+
req.send_request(options)
|
696
|
+
end
|
697
|
+
|
698
|
+
# Retrieves the current status of a schema creation operation.
|
699
|
+
#
|
700
|
+
# @option params [required, String] :api_id
|
701
|
+
# The API ID.
|
702
|
+
#
|
703
|
+
# @return [Types::GetSchemaCreationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
|
+
#
|
705
|
+
# * {Types::GetSchemaCreationStatusResponse#status #status} => String
|
706
|
+
# * {Types::GetSchemaCreationStatusResponse#details #details} => String
|
707
|
+
#
|
708
|
+
# @example Request syntax with placeholder values
|
709
|
+
#
|
710
|
+
# resp = client.get_schema_creation_status({
|
711
|
+
# api_id: "String", # required
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# @example Response structure
|
715
|
+
#
|
716
|
+
# resp.status #=> String, one of "PROCESSING", "ACTIVE", "DELETING"
|
717
|
+
# resp.details #=> String
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetSchemaCreationStatus AWS API Documentation
|
720
|
+
#
|
721
|
+
# @overload get_schema_creation_status(params = {})
|
722
|
+
# @param [Hash] params ({})
|
723
|
+
def get_schema_creation_status(params = {}, options = {})
|
724
|
+
req = build_request(:get_schema_creation_status, params)
|
725
|
+
req.send_request(options)
|
726
|
+
end
|
727
|
+
|
728
|
+
# Retrieves a `Type` object.
|
729
|
+
#
|
730
|
+
# @option params [required, String] :api_id
|
731
|
+
# The API ID.
|
732
|
+
#
|
733
|
+
# @option params [required, String] :type_name
|
734
|
+
# The type name.
|
735
|
+
#
|
736
|
+
# @option params [required, String] :format
|
737
|
+
# The type format: SDL or JSON.
|
738
|
+
#
|
739
|
+
# @return [Types::GetTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
740
|
+
#
|
741
|
+
# * {Types::GetTypeResponse#type #type} => Types::Type
|
742
|
+
#
|
743
|
+
# @example Request syntax with placeholder values
|
744
|
+
#
|
745
|
+
# resp = client.get_type({
|
746
|
+
# api_id: "String", # required
|
747
|
+
# type_name: "ResourceName", # required
|
748
|
+
# format: "SDL", # required, accepts SDL, JSON
|
749
|
+
# })
|
750
|
+
#
|
751
|
+
# @example Response structure
|
752
|
+
#
|
753
|
+
# resp.type.name #=> String
|
754
|
+
# resp.type.description #=> String
|
755
|
+
# resp.type.arn #=> String
|
756
|
+
# resp.type.definition #=> String
|
757
|
+
# resp.type.format #=> String, one of "SDL", "JSON"
|
758
|
+
#
|
759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetType AWS API Documentation
|
760
|
+
#
|
761
|
+
# @overload get_type(params = {})
|
762
|
+
# @param [Hash] params ({})
|
763
|
+
def get_type(params = {}, options = {})
|
764
|
+
req = build_request(:get_type, params)
|
765
|
+
req.send_request(options)
|
766
|
+
end
|
767
|
+
|
768
|
+
# Lists the API keys for a given API.
|
769
|
+
#
|
770
|
+
# @option params [required, String] :api_id
|
771
|
+
# The API ID.
|
772
|
+
#
|
773
|
+
# @option params [String] :next_token
|
774
|
+
# An identifier that was returned from the previous call to this
|
775
|
+
# operation, which can be used to return the next set of items in the
|
776
|
+
# list.
|
777
|
+
#
|
778
|
+
# @option params [Integer] :max_results
|
779
|
+
# The maximum number of results you want the request to return.
|
780
|
+
#
|
781
|
+
# @return [Types::ListApiKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
782
|
+
#
|
783
|
+
# * {Types::ListApiKeysResponse#api_keys #api_keys} => Array<Types::ApiKey>
|
784
|
+
# * {Types::ListApiKeysResponse#next_token #next_token} => String
|
785
|
+
#
|
786
|
+
# @example Request syntax with placeholder values
|
787
|
+
#
|
788
|
+
# resp = client.list_api_keys({
|
789
|
+
# api_id: "String", # required
|
790
|
+
# next_token: "PaginationToken",
|
791
|
+
# max_results: 1,
|
792
|
+
# })
|
793
|
+
#
|
794
|
+
# @example Response structure
|
795
|
+
#
|
796
|
+
# resp.api_keys #=> Array
|
797
|
+
# resp.api_keys[0].id #=> String
|
798
|
+
# resp.api_keys[0].description #=> String
|
799
|
+
# resp.api_keys[0].expires #=> Integer
|
800
|
+
# resp.next_token #=> String
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListApiKeys AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload list_api_keys(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def list_api_keys(params = {}, options = {})
|
807
|
+
req = build_request(:list_api_keys, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
811
|
+
# Lists the data sources for a given API.
|
812
|
+
#
|
813
|
+
# @option params [required, String] :api_id
|
814
|
+
# The API ID.
|
815
|
+
#
|
816
|
+
# @option params [String] :next_token
|
817
|
+
# An identifier that was returned from the previous call to this
|
818
|
+
# operation, which can be used to return the next set of items in the
|
819
|
+
# list.
|
820
|
+
#
|
821
|
+
# @option params [Integer] :max_results
|
822
|
+
# The maximum number of results you want the request to return.
|
823
|
+
#
|
824
|
+
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
825
|
+
#
|
826
|
+
# * {Types::ListDataSourcesResponse#data_sources #data_sources} => Array<Types::DataSource>
|
827
|
+
# * {Types::ListDataSourcesResponse#next_token #next_token} => String
|
828
|
+
#
|
829
|
+
# @example Request syntax with placeholder values
|
830
|
+
#
|
831
|
+
# resp = client.list_data_sources({
|
832
|
+
# api_id: "String", # required
|
833
|
+
# next_token: "PaginationToken",
|
834
|
+
# max_results: 1,
|
835
|
+
# })
|
836
|
+
#
|
837
|
+
# @example Response structure
|
838
|
+
#
|
839
|
+
# resp.data_sources #=> Array
|
840
|
+
# resp.data_sources[0].data_source_arn #=> String
|
841
|
+
# resp.data_sources[0].name #=> String
|
842
|
+
# resp.data_sources[0].description #=> String
|
843
|
+
# resp.data_sources[0].type #=> String, one of "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH"
|
844
|
+
# resp.data_sources[0].service_role_arn #=> String
|
845
|
+
# resp.data_sources[0].dynamodb_config.table_name #=> String
|
846
|
+
# resp.data_sources[0].dynamodb_config.aws_region #=> String
|
847
|
+
# resp.data_sources[0].dynamodb_config.use_caller_credentials #=> Boolean
|
848
|
+
# resp.data_sources[0].lambda_config.lambda_function_arn #=> String
|
849
|
+
# resp.data_sources[0].elasticsearch_config.endpoint #=> String
|
850
|
+
# resp.data_sources[0].elasticsearch_config.aws_region #=> String
|
851
|
+
# resp.next_token #=> String
|
852
|
+
#
|
853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListDataSources AWS API Documentation
|
854
|
+
#
|
855
|
+
# @overload list_data_sources(params = {})
|
856
|
+
# @param [Hash] params ({})
|
857
|
+
def list_data_sources(params = {}, options = {})
|
858
|
+
req = build_request(:list_data_sources, params)
|
859
|
+
req.send_request(options)
|
860
|
+
end
|
861
|
+
|
862
|
+
# Lists your GraphQL APIs.
|
863
|
+
#
|
864
|
+
# @option params [String] :next_token
|
865
|
+
# An identifier that was returned from the previous call to this
|
866
|
+
# operation, which can be used to return the next set of items in the
|
867
|
+
# list.
|
868
|
+
#
|
869
|
+
# @option params [Integer] :max_results
|
870
|
+
# The maximum number of results you want the request to return.
|
871
|
+
#
|
872
|
+
# @return [Types::ListGraphqlApisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
873
|
+
#
|
874
|
+
# * {Types::ListGraphqlApisResponse#graphql_apis #graphql_apis} => Array<Types::GraphqlApi>
|
875
|
+
# * {Types::ListGraphqlApisResponse#next_token #next_token} => String
|
876
|
+
#
|
877
|
+
# @example Request syntax with placeholder values
|
878
|
+
#
|
879
|
+
# resp = client.list_graphql_apis({
|
880
|
+
# next_token: "PaginationToken",
|
881
|
+
# max_results: 1,
|
882
|
+
# })
|
883
|
+
#
|
884
|
+
# @example Response structure
|
885
|
+
#
|
886
|
+
# resp.graphql_apis #=> Array
|
887
|
+
# resp.graphql_apis[0].name #=> String
|
888
|
+
# resp.graphql_apis[0].api_id #=> String
|
889
|
+
# resp.graphql_apis[0].authentication_type #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS"
|
890
|
+
# resp.graphql_apis[0].user_pool_config.user_pool_id #=> String
|
891
|
+
# resp.graphql_apis[0].user_pool_config.aws_region #=> String
|
892
|
+
# resp.graphql_apis[0].user_pool_config.default_action #=> String, one of "ALLOW", "DENY"
|
893
|
+
# resp.graphql_apis[0].user_pool_config.app_id_client_regex #=> String
|
894
|
+
# resp.graphql_apis[0].arn #=> String
|
895
|
+
# resp.graphql_apis[0].uris #=> Hash
|
896
|
+
# resp.graphql_apis[0].uris["String"] #=> String
|
897
|
+
# resp.next_token #=> String
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListGraphqlApis AWS API Documentation
|
900
|
+
#
|
901
|
+
# @overload list_graphql_apis(params = {})
|
902
|
+
# @param [Hash] params ({})
|
903
|
+
def list_graphql_apis(params = {}, options = {})
|
904
|
+
req = build_request(:list_graphql_apis, params)
|
905
|
+
req.send_request(options)
|
906
|
+
end
|
907
|
+
|
908
|
+
# Lists the resolvers for a given API and type.
|
909
|
+
#
|
910
|
+
# @option params [required, String] :api_id
|
911
|
+
# The API ID.
|
912
|
+
#
|
913
|
+
# @option params [required, String] :type_name
|
914
|
+
# The type name.
|
915
|
+
#
|
916
|
+
# @option params [String] :next_token
|
917
|
+
# An identifier that was returned from the previous call to this
|
918
|
+
# operation, which can be used to return the next set of items in the
|
919
|
+
# list.
|
920
|
+
#
|
921
|
+
# @option params [Integer] :max_results
|
922
|
+
# The maximum number of results you want the request to return.
|
923
|
+
#
|
924
|
+
# @return [Types::ListResolversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
925
|
+
#
|
926
|
+
# * {Types::ListResolversResponse#resolvers #resolvers} => Array<Types::Resolver>
|
927
|
+
# * {Types::ListResolversResponse#next_token #next_token} => String
|
928
|
+
#
|
929
|
+
# @example Request syntax with placeholder values
|
930
|
+
#
|
931
|
+
# resp = client.list_resolvers({
|
932
|
+
# api_id: "String", # required
|
933
|
+
# type_name: "String", # required
|
934
|
+
# next_token: "PaginationToken",
|
935
|
+
# max_results: 1,
|
936
|
+
# })
|
937
|
+
#
|
938
|
+
# @example Response structure
|
939
|
+
#
|
940
|
+
# resp.resolvers #=> Array
|
941
|
+
# resp.resolvers[0].type_name #=> String
|
942
|
+
# resp.resolvers[0].field_name #=> String
|
943
|
+
# resp.resolvers[0].data_source_name #=> String
|
944
|
+
# resp.resolvers[0].resolver_arn #=> String
|
945
|
+
# resp.resolvers[0].request_mapping_template #=> String
|
946
|
+
# resp.resolvers[0].response_mapping_template #=> String
|
947
|
+
# resp.next_token #=> String
|
948
|
+
#
|
949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListResolvers AWS API Documentation
|
950
|
+
#
|
951
|
+
# @overload list_resolvers(params = {})
|
952
|
+
# @param [Hash] params ({})
|
953
|
+
def list_resolvers(params = {}, options = {})
|
954
|
+
req = build_request(:list_resolvers, params)
|
955
|
+
req.send_request(options)
|
956
|
+
end
|
957
|
+
|
958
|
+
# Lists the types for a given API.
|
959
|
+
#
|
960
|
+
# @option params [required, String] :api_id
|
961
|
+
# The API ID.
|
962
|
+
#
|
963
|
+
# @option params [required, String] :format
|
964
|
+
# The type format: SDL or JSON.
|
965
|
+
#
|
966
|
+
# @option params [String] :next_token
|
967
|
+
# An identifier that was returned from the previous call to this
|
968
|
+
# operation, which can be used to return the next set of items in the
|
969
|
+
# list.
|
970
|
+
#
|
971
|
+
# @option params [Integer] :max_results
|
972
|
+
# The maximum number of results you want the request to return.
|
973
|
+
#
|
974
|
+
# @return [Types::ListTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
975
|
+
#
|
976
|
+
# * {Types::ListTypesResponse#types #types} => Array<Types::Type>
|
977
|
+
# * {Types::ListTypesResponse#next_token #next_token} => String
|
978
|
+
#
|
979
|
+
# @example Request syntax with placeholder values
|
980
|
+
#
|
981
|
+
# resp = client.list_types({
|
982
|
+
# api_id: "String", # required
|
983
|
+
# format: "SDL", # required, accepts SDL, JSON
|
984
|
+
# next_token: "PaginationToken",
|
985
|
+
# max_results: 1,
|
986
|
+
# })
|
987
|
+
#
|
988
|
+
# @example Response structure
|
989
|
+
#
|
990
|
+
# resp.types #=> Array
|
991
|
+
# resp.types[0].name #=> String
|
992
|
+
# resp.types[0].description #=> String
|
993
|
+
# resp.types[0].arn #=> String
|
994
|
+
# resp.types[0].definition #=> String
|
995
|
+
# resp.types[0].format #=> String, one of "SDL", "JSON"
|
996
|
+
# resp.next_token #=> String
|
997
|
+
#
|
998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListTypes AWS API Documentation
|
999
|
+
#
|
1000
|
+
# @overload list_types(params = {})
|
1001
|
+
# @param [Hash] params ({})
|
1002
|
+
def list_types(params = {}, options = {})
|
1003
|
+
req = build_request(:list_types, params)
|
1004
|
+
req.send_request(options)
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# Adds a new schema to your GraphQL API.
|
1008
|
+
#
|
1009
|
+
# This operation is asynchronous. Use to determine when it has
|
1010
|
+
# completed.
|
1011
|
+
#
|
1012
|
+
# @option params [required, String] :api_id
|
1013
|
+
# The API ID.
|
1014
|
+
#
|
1015
|
+
# @option params [required, String, IO] :definition
|
1016
|
+
# The schema definition, in GraphQL schema language format.
|
1017
|
+
#
|
1018
|
+
# @return [Types::StartSchemaCreationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1019
|
+
#
|
1020
|
+
# * {Types::StartSchemaCreationResponse#status #status} => String
|
1021
|
+
#
|
1022
|
+
# @example Request syntax with placeholder values
|
1023
|
+
#
|
1024
|
+
# resp = client.start_schema_creation({
|
1025
|
+
# api_id: "String", # required
|
1026
|
+
# definition: "data", # required
|
1027
|
+
# })
|
1028
|
+
#
|
1029
|
+
# @example Response structure
|
1030
|
+
#
|
1031
|
+
# resp.status #=> String, one of "PROCESSING", "ACTIVE", "DELETING"
|
1032
|
+
#
|
1033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/StartSchemaCreation AWS API Documentation
|
1034
|
+
#
|
1035
|
+
# @overload start_schema_creation(params = {})
|
1036
|
+
# @param [Hash] params ({})
|
1037
|
+
def start_schema_creation(params = {}, options = {})
|
1038
|
+
req = build_request(:start_schema_creation, params)
|
1039
|
+
req.send_request(options)
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# Updates a `DataSource` object.
|
1043
|
+
#
|
1044
|
+
# @option params [required, String] :api_id
|
1045
|
+
# The API ID.
|
1046
|
+
#
|
1047
|
+
# @option params [required, String] :name
|
1048
|
+
# The new name for the data source.
|
1049
|
+
#
|
1050
|
+
# @option params [String] :description
|
1051
|
+
# The new description for the data source.
|
1052
|
+
#
|
1053
|
+
# @option params [required, String] :type
|
1054
|
+
# The new data source type.
|
1055
|
+
#
|
1056
|
+
# @option params [String] :service_role_arn
|
1057
|
+
# The new service role ARN for the data source.
|
1058
|
+
#
|
1059
|
+
# @option params [Types::DynamodbDataSourceConfig] :dynamodb_config
|
1060
|
+
# The new DynamoDB configuration.
|
1061
|
+
#
|
1062
|
+
# @option params [Types::LambdaDataSourceConfig] :lambda_config
|
1063
|
+
# The new Lambda configuration.
|
1064
|
+
#
|
1065
|
+
# @option params [Types::ElasticsearchDataSourceConfig] :elasticsearch_config
|
1066
|
+
# The new Elasticsearch configuration.
|
1067
|
+
#
|
1068
|
+
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1069
|
+
#
|
1070
|
+
# * {Types::UpdateDataSourceResponse#data_source #data_source} => Types::DataSource
|
1071
|
+
#
|
1072
|
+
# @example Request syntax with placeholder values
|
1073
|
+
#
|
1074
|
+
# resp = client.update_data_source({
|
1075
|
+
# api_id: "String", # required
|
1076
|
+
# name: "ResourceName", # required
|
1077
|
+
# description: "String",
|
1078
|
+
# type: "AWS_LAMBDA", # required, accepts AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH
|
1079
|
+
# service_role_arn: "String",
|
1080
|
+
# dynamodb_config: {
|
1081
|
+
# table_name: "String", # required
|
1082
|
+
# aws_region: "String", # required
|
1083
|
+
# use_caller_credentials: false,
|
1084
|
+
# },
|
1085
|
+
# lambda_config: {
|
1086
|
+
# lambda_function_arn: "String", # required
|
1087
|
+
# },
|
1088
|
+
# elasticsearch_config: {
|
1089
|
+
# endpoint: "String", # required
|
1090
|
+
# aws_region: "String", # required
|
1091
|
+
# },
|
1092
|
+
# })
|
1093
|
+
#
|
1094
|
+
# @example Response structure
|
1095
|
+
#
|
1096
|
+
# resp.data_source.data_source_arn #=> String
|
1097
|
+
# resp.data_source.name #=> String
|
1098
|
+
# resp.data_source.description #=> String
|
1099
|
+
# resp.data_source.type #=> String, one of "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH"
|
1100
|
+
# resp.data_source.service_role_arn #=> String
|
1101
|
+
# resp.data_source.dynamodb_config.table_name #=> String
|
1102
|
+
# resp.data_source.dynamodb_config.aws_region #=> String
|
1103
|
+
# resp.data_source.dynamodb_config.use_caller_credentials #=> Boolean
|
1104
|
+
# resp.data_source.lambda_config.lambda_function_arn #=> String
|
1105
|
+
# resp.data_source.elasticsearch_config.endpoint #=> String
|
1106
|
+
# resp.data_source.elasticsearch_config.aws_region #=> String
|
1107
|
+
#
|
1108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateDataSource AWS API Documentation
|
1109
|
+
#
|
1110
|
+
# @overload update_data_source(params = {})
|
1111
|
+
# @param [Hash] params ({})
|
1112
|
+
def update_data_source(params = {}, options = {})
|
1113
|
+
req = build_request(:update_data_source, params)
|
1114
|
+
req.send_request(options)
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# Updates a `GraphqlApi` object.
|
1118
|
+
#
|
1119
|
+
# @option params [required, String] :api_id
|
1120
|
+
# The API ID.
|
1121
|
+
#
|
1122
|
+
# @option params [required, String] :name
|
1123
|
+
# The new name for the `GraphqlApi` object.
|
1124
|
+
#
|
1125
|
+
# @option params [String] :authentication_type
|
1126
|
+
# The new authentication type for the `GraphqlApi` object.
|
1127
|
+
#
|
1128
|
+
# @option params [Types::UserPoolConfig] :user_pool_config
|
1129
|
+
# The new Amazon Cognito User Pool configuration for the `GraphqlApi`
|
1130
|
+
# object.
|
1131
|
+
#
|
1132
|
+
# @return [Types::UpdateGraphqlApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1133
|
+
#
|
1134
|
+
# * {Types::UpdateGraphqlApiResponse#graphql_api #graphql_api} => Types::GraphqlApi
|
1135
|
+
#
|
1136
|
+
# @example Request syntax with placeholder values
|
1137
|
+
#
|
1138
|
+
# resp = client.update_graphql_api({
|
1139
|
+
# api_id: "String", # required
|
1140
|
+
# name: "ResourceName", # required
|
1141
|
+
# authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS
|
1142
|
+
# user_pool_config: {
|
1143
|
+
# user_pool_id: "String", # required
|
1144
|
+
# aws_region: "String", # required
|
1145
|
+
# default_action: "ALLOW", # required, accepts ALLOW, DENY
|
1146
|
+
# app_id_client_regex: "String",
|
1147
|
+
# },
|
1148
|
+
# })
|
1149
|
+
#
|
1150
|
+
# @example Response structure
|
1151
|
+
#
|
1152
|
+
# resp.graphql_api.name #=> String
|
1153
|
+
# resp.graphql_api.api_id #=> String
|
1154
|
+
# resp.graphql_api.authentication_type #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS"
|
1155
|
+
# resp.graphql_api.user_pool_config.user_pool_id #=> String
|
1156
|
+
# resp.graphql_api.user_pool_config.aws_region #=> String
|
1157
|
+
# resp.graphql_api.user_pool_config.default_action #=> String, one of "ALLOW", "DENY"
|
1158
|
+
# resp.graphql_api.user_pool_config.app_id_client_regex #=> String
|
1159
|
+
# resp.graphql_api.arn #=> String
|
1160
|
+
# resp.graphql_api.uris #=> Hash
|
1161
|
+
# resp.graphql_api.uris["String"] #=> String
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateGraphqlApi AWS API Documentation
|
1164
|
+
#
|
1165
|
+
# @overload update_graphql_api(params = {})
|
1166
|
+
# @param [Hash] params ({})
|
1167
|
+
def update_graphql_api(params = {}, options = {})
|
1168
|
+
req = build_request(:update_graphql_api, params)
|
1169
|
+
req.send_request(options)
|
1170
|
+
end
|
1171
|
+
|
1172
|
+
# Updates a `Resolver` object.
|
1173
|
+
#
|
1174
|
+
# @option params [required, String] :api_id
|
1175
|
+
# The API ID.
|
1176
|
+
#
|
1177
|
+
# @option params [required, String] :type_name
|
1178
|
+
# The new type name.
|
1179
|
+
#
|
1180
|
+
# @option params [required, String] :field_name
|
1181
|
+
# The new field name.
|
1182
|
+
#
|
1183
|
+
# @option params [required, String] :data_source_name
|
1184
|
+
# The new data source name.
|
1185
|
+
#
|
1186
|
+
# @option params [required, String] :request_mapping_template
|
1187
|
+
# The new request mapping template.
|
1188
|
+
#
|
1189
|
+
# @option params [String] :response_mapping_template
|
1190
|
+
# The new response mapping template.
|
1191
|
+
#
|
1192
|
+
# @return [Types::UpdateResolverResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1193
|
+
#
|
1194
|
+
# * {Types::UpdateResolverResponse#resolver #resolver} => Types::Resolver
|
1195
|
+
#
|
1196
|
+
# @example Request syntax with placeholder values
|
1197
|
+
#
|
1198
|
+
# resp = client.update_resolver({
|
1199
|
+
# api_id: "String", # required
|
1200
|
+
# type_name: "ResourceName", # required
|
1201
|
+
# field_name: "ResourceName", # required
|
1202
|
+
# data_source_name: "ResourceName", # required
|
1203
|
+
# request_mapping_template: "MappingTemplate", # required
|
1204
|
+
# response_mapping_template: "MappingTemplate",
|
1205
|
+
# })
|
1206
|
+
#
|
1207
|
+
# @example Response structure
|
1208
|
+
#
|
1209
|
+
# resp.resolver.type_name #=> String
|
1210
|
+
# resp.resolver.field_name #=> String
|
1211
|
+
# resp.resolver.data_source_name #=> String
|
1212
|
+
# resp.resolver.resolver_arn #=> String
|
1213
|
+
# resp.resolver.request_mapping_template #=> String
|
1214
|
+
# resp.resolver.response_mapping_template #=> String
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateResolver AWS API Documentation
|
1217
|
+
#
|
1218
|
+
# @overload update_resolver(params = {})
|
1219
|
+
# @param [Hash] params ({})
|
1220
|
+
def update_resolver(params = {}, options = {})
|
1221
|
+
req = build_request(:update_resolver, params)
|
1222
|
+
req.send_request(options)
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Updates a `Type` object.
|
1226
|
+
#
|
1227
|
+
# @option params [required, String] :api_id
|
1228
|
+
# The API ID.
|
1229
|
+
#
|
1230
|
+
# @option params [required, String] :type_name
|
1231
|
+
# The new type name.
|
1232
|
+
#
|
1233
|
+
# @option params [String] :definition
|
1234
|
+
# The new definition.
|
1235
|
+
#
|
1236
|
+
# @option params [required, String] :format
|
1237
|
+
# The new type format: SDL or JSON.
|
1238
|
+
#
|
1239
|
+
# @return [Types::UpdateTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1240
|
+
#
|
1241
|
+
# * {Types::UpdateTypeResponse#type #type} => Types::Type
|
1242
|
+
#
|
1243
|
+
# @example Request syntax with placeholder values
|
1244
|
+
#
|
1245
|
+
# resp = client.update_type({
|
1246
|
+
# api_id: "String", # required
|
1247
|
+
# type_name: "ResourceName", # required
|
1248
|
+
# definition: "String",
|
1249
|
+
# format: "SDL", # required, accepts SDL, JSON
|
1250
|
+
# })
|
1251
|
+
#
|
1252
|
+
# @example Response structure
|
1253
|
+
#
|
1254
|
+
# resp.type.name #=> String
|
1255
|
+
# resp.type.description #=> String
|
1256
|
+
# resp.type.arn #=> String
|
1257
|
+
# resp.type.definition #=> String
|
1258
|
+
# resp.type.format #=> String, one of "SDL", "JSON"
|
1259
|
+
#
|
1260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateType AWS API Documentation
|
1261
|
+
#
|
1262
|
+
# @overload update_type(params = {})
|
1263
|
+
# @param [Hash] params ({})
|
1264
|
+
def update_type(params = {}, options = {})
|
1265
|
+
req = build_request(:update_type, params)
|
1266
|
+
req.send_request(options)
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# @!endgroup
|
1270
|
+
|
1271
|
+
# @param params ({})
|
1272
|
+
# @api private
|
1273
|
+
def build_request(operation_name, params = {})
|
1274
|
+
handlers = @handlers.for(operation_name)
|
1275
|
+
context = Seahorse::Client::RequestContext.new(
|
1276
|
+
operation_name: operation_name,
|
1277
|
+
operation: config.api.operation(operation_name),
|
1278
|
+
client: self,
|
1279
|
+
params: params,
|
1280
|
+
config: config)
|
1281
|
+
context[:gem_name] = 'aws-sdk-appsync'
|
1282
|
+
context[:gem_version] = '1.0.0'
|
1283
|
+
Seahorse::Client::Request.new(handlers, context)
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
# @api private
|
1287
|
+
# @deprecated
|
1288
|
+
def waiter_names
|
1289
|
+
[]
|
1290
|
+
end
|
1291
|
+
|
1292
|
+
class << self
|
1293
|
+
|
1294
|
+
# @api private
|
1295
|
+
attr_reader :identifier
|
1296
|
+
|
1297
|
+
# @api private
|
1298
|
+
def errors_module
|
1299
|
+
Errors
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
end
|
1303
|
+
end
|
1304
|
+
end
|