aws-sdk-apigateway 1.0.0.rc1
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-apigateway.rb +47 -0
- data/lib/aws-sdk-apigateway/client.rb +4081 -0
- data/lib/aws-sdk-apigateway/client_api.rb +2199 -0
- data/lib/aws-sdk-apigateway/customizations.rb +7 -0
- data/lib/aws-sdk-apigateway/errors.rb +23 -0
- data/lib/aws-sdk-apigateway/plugins/apply_content_type_header.rb +21 -0
- data/lib/aws-sdk-apigateway/resource.rb +25 -0
- data/lib/aws-sdk-apigateway/types.rb +4985 -0
- metadata +81 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 0de75dc06071be09fcc4b424238b3bf56b75be7c
|
4
|
+
data.tar.gz: 309044620ca4974f83f8980c59fdb85e2be003be
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3a47c094b686fb736db993f8da42f4536b7f040a0e26f8f3995c403b1e2f3bd2baba6d6bc360a534f1e02ef7b7f2c07c8a3945a5110f3f6a5bc0ff9abffe53e3
|
7
|
+
data.tar.gz: 97bd16c9b4090a994b0bbd178464ade60d90c32dd11642a2ff15dd445b3695b4c5180ecd83252804c42266c4f151e1a57ef962c0cbd9ded56e565b05dd2bf74d
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
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-apigateway/types'
|
12
|
+
require_relative 'aws-sdk-apigateway/client_api'
|
13
|
+
require_relative 'aws-sdk-apigateway/client'
|
14
|
+
require_relative 'aws-sdk-apigateway/errors'
|
15
|
+
require_relative 'aws-sdk-apigateway/resource'
|
16
|
+
require_relative 'aws-sdk-apigateway/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon API Gateway. This module is available in the
|
19
|
+
# `aws-sdk-apigateway` 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 Amazon API Gateway all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::APIGateway::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::APIGateway
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,4081 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
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/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
23
|
+
require 'aws-sdk-apigateway/plugins/apply_content_type_header.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:apigateway)
|
26
|
+
|
27
|
+
module Aws
|
28
|
+
module APIGateway
|
29
|
+
class Client < Seahorse::Client::Base
|
30
|
+
|
31
|
+
include Aws::ClientStubs
|
32
|
+
|
33
|
+
@identifier = :apigateway
|
34
|
+
|
35
|
+
set_api(ClientApi::API)
|
36
|
+
|
37
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
38
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
39
|
+
add_plugin(Aws::Plugins::Logging)
|
40
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
41
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
42
|
+
add_plugin(Aws::Plugins::UserAgent)
|
43
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
44
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
45
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
46
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
47
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
48
|
+
add_plugin(Aws::Plugins::StubResponses)
|
49
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
52
|
+
add_plugin(Aws::APIGateway::Plugins::ApplyContentTypeHeader)
|
53
|
+
|
54
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
55
|
+
# Your AWS credentials. This can be an instance of any one of the
|
56
|
+
# following classes:
|
57
|
+
#
|
58
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
59
|
+
# credentials.
|
60
|
+
#
|
61
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
62
|
+
# from an EC2 IMDS on an EC2 instance.
|
63
|
+
#
|
64
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
65
|
+
# shared file, such as `~/.aws/config`.
|
66
|
+
#
|
67
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
68
|
+
#
|
69
|
+
# When `:credentials` are not configured directly, the following
|
70
|
+
# locations will be searched for credentials:
|
71
|
+
#
|
72
|
+
# * `Aws.config[:credentials]`
|
73
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
74
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
75
|
+
# * `~/.aws/credentials`
|
76
|
+
# * `~/.aws/config`
|
77
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
78
|
+
# very aggressive. Construct and pass an instance of
|
79
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
80
|
+
# timeouts.
|
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
|
+
# @option options [String] :access_key_id
|
93
|
+
# @option options [Boolean] :convert_params (true)
|
94
|
+
# When `true`, an attempt is made to coerce request parameters into
|
95
|
+
# the required types.
|
96
|
+
# @option options [String] :endpoint
|
97
|
+
# The client endpoint is normally constructed from the `:region`
|
98
|
+
# option. You should only configure an `:endpoint` when connecting
|
99
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
100
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
101
|
+
# The log formatter.
|
102
|
+
# @option options [Symbol] :log_level (:info)
|
103
|
+
# The log level to send messages to the `:logger` at.
|
104
|
+
# @option options [Logger] :logger
|
105
|
+
# The Logger instance to send log messages to. If this option
|
106
|
+
# is not set, logging will be disabled.
|
107
|
+
# @option options [String] :profile ("default")
|
108
|
+
# Used when loading credentials from the shared credentials file
|
109
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
110
|
+
# @option options [Integer] :retry_limit (3)
|
111
|
+
# The maximum number of times to retry failed requests. Only
|
112
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
113
|
+
# are retried. Generally, these are throttling errors, data
|
114
|
+
# checksum errors, networking errors, timeout errors and auth
|
115
|
+
# errors from expired credentials.
|
116
|
+
# @option options [String] :secret_access_key
|
117
|
+
# @option options [String] :session_token
|
118
|
+
# @option options [Boolean] :stub_responses (false)
|
119
|
+
# Causes the client to return stubbed responses. By default
|
120
|
+
# fake responses are generated and returned. You can specify
|
121
|
+
# the response data to return or errors to raise by calling
|
122
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
123
|
+
#
|
124
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
125
|
+
# requests are made, and retries are disabled.
|
126
|
+
# @option options [Boolean] :validate_params (true)
|
127
|
+
# When `true`, request parameters are validated before
|
128
|
+
# sending the request.
|
129
|
+
def initialize(*args)
|
130
|
+
super
|
131
|
+
end
|
132
|
+
|
133
|
+
# @!group API Operations
|
134
|
+
|
135
|
+
# Create an ApiKey resource.
|
136
|
+
#
|
137
|
+
# <div class="seeAlso">
|
138
|
+
# [AWS CLI][1]
|
139
|
+
# </div>
|
140
|
+
#
|
141
|
+
#
|
142
|
+
#
|
143
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html
|
144
|
+
# @option params [String] :name
|
145
|
+
# The name of the ApiKey.
|
146
|
+
# @option params [String] :description
|
147
|
+
# The description of the ApiKey.
|
148
|
+
# @option params [Boolean] :enabled
|
149
|
+
# Specifies whether the ApiKey can be used by callers.
|
150
|
+
# @option params [Boolean] :generate_distinct_id
|
151
|
+
# Specifies whether (`true`) or not (`false`) the key identifier is
|
152
|
+
# distinct from the created API key value.
|
153
|
+
# @option params [String] :value
|
154
|
+
# Specifies a value of the API key.
|
155
|
+
# @option params [Array<Types::StageKey>] :stage_keys
|
156
|
+
# DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API
|
157
|
+
# key.
|
158
|
+
# @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
159
|
+
#
|
160
|
+
# * {Types::ApiKey#id #id} => String
|
161
|
+
# * {Types::ApiKey#value #value} => String
|
162
|
+
# * {Types::ApiKey#name #name} => String
|
163
|
+
# * {Types::ApiKey#description #description} => String
|
164
|
+
# * {Types::ApiKey#enabled #enabled} => Boolean
|
165
|
+
# * {Types::ApiKey#created_date #createdDate} => Time
|
166
|
+
# * {Types::ApiKey#last_updated_date #lastUpdatedDate} => Time
|
167
|
+
# * {Types::ApiKey#stage_keys #stageKeys} => Array<String>
|
168
|
+
#
|
169
|
+
# @example Request syntax with placeholder values
|
170
|
+
# resp = client.create_api_key({
|
171
|
+
# name: "String",
|
172
|
+
# description: "String",
|
173
|
+
# enabled: false,
|
174
|
+
# generate_distinct_id: false,
|
175
|
+
# value: "String",
|
176
|
+
# stage_keys: [
|
177
|
+
# {
|
178
|
+
# rest_api_id: "String",
|
179
|
+
# stage_name: "String",
|
180
|
+
# },
|
181
|
+
# ],
|
182
|
+
# })
|
183
|
+
#
|
184
|
+
# @example Response structure
|
185
|
+
# resp.id #=> String
|
186
|
+
# resp.value #=> String
|
187
|
+
# resp.name #=> String
|
188
|
+
# resp.description #=> String
|
189
|
+
# resp.enabled #=> Boolean
|
190
|
+
# resp.created_date #=> Time
|
191
|
+
# resp.last_updated_date #=> Time
|
192
|
+
# resp.stage_keys #=> Array
|
193
|
+
# resp.stage_keys[0] #=> String
|
194
|
+
# @overload create_api_key(params = {})
|
195
|
+
# @param [Hash] params ({})
|
196
|
+
def create_api_key(params = {}, options = {})
|
197
|
+
req = build_request(:create_api_key, params)
|
198
|
+
req.send_request(options)
|
199
|
+
end
|
200
|
+
|
201
|
+
# Adds a new Authorizer resource to an existing RestApi resource.
|
202
|
+
#
|
203
|
+
# <div class="seeAlso">
|
204
|
+
# [AWS CLI][1]
|
205
|
+
# </div>
|
206
|
+
#
|
207
|
+
#
|
208
|
+
#
|
209
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
|
210
|
+
# @option params [required, String] :rest_api_id
|
211
|
+
# The RestApi identifier under which the Authorizer will be created.
|
212
|
+
# @option params [required, String] :name
|
213
|
+
# \[Required\] The name of the authorizer.
|
214
|
+
# @option params [required, String] :type
|
215
|
+
# \[Required\] The type of the authorizer.
|
216
|
+
# @option params [Array<String>] :provider_arns
|
217
|
+
# A list of the Cognito Your User Pool authorizer's provider ARNs.
|
218
|
+
# @option params [String] :auth_type
|
219
|
+
# Optional customer-defined field, used in Swagger imports/exports. Has
|
220
|
+
# no functional impact.
|
221
|
+
# @option params [String] :authorizer_uri
|
222
|
+
# \[Required\] Specifies the authorizer's Uniform Resource Identifier
|
223
|
+
# (URI).
|
224
|
+
# @option params [String] :authorizer_credentials
|
225
|
+
# Specifies the credentials required for the authorizer, if any.
|
226
|
+
# @option params [required, String] :identity_source
|
227
|
+
# \[Required\] The source of the identity in an incoming request.
|
228
|
+
# @option params [String] :identity_validation_expression
|
229
|
+
# A validation expression for the incoming identity.
|
230
|
+
# @option params [Integer] :authorizer_result_ttl_in_seconds
|
231
|
+
# The TTL of cached authorizer results.
|
232
|
+
# @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
233
|
+
#
|
234
|
+
# * {Types::Authorizer#id #id} => String
|
235
|
+
# * {Types::Authorizer#name #name} => String
|
236
|
+
# * {Types::Authorizer#type #type} => String
|
237
|
+
# * {Types::Authorizer#provider_arns #providerARNs} => Array<String>
|
238
|
+
# * {Types::Authorizer#auth_type #authType} => String
|
239
|
+
# * {Types::Authorizer#authorizer_uri #authorizerUri} => String
|
240
|
+
# * {Types::Authorizer#authorizer_credentials #authorizerCredentials} => String
|
241
|
+
# * {Types::Authorizer#identity_source #identitySource} => String
|
242
|
+
# * {Types::Authorizer#identity_validation_expression #identityValidationExpression} => String
|
243
|
+
# * {Types::Authorizer#authorizer_result_ttl_in_seconds #authorizerResultTtlInSeconds} => Integer
|
244
|
+
#
|
245
|
+
# @example Request syntax with placeholder values
|
246
|
+
# resp = client.create_authorizer({
|
247
|
+
# rest_api_id: "String", # required
|
248
|
+
# name: "String", # required
|
249
|
+
# type: "TOKEN", # required, accepts TOKEN, COGNITO_USER_POOLS
|
250
|
+
# provider_arns: ["ProviderARN"],
|
251
|
+
# auth_type: "String",
|
252
|
+
# authorizer_uri: "String",
|
253
|
+
# authorizer_credentials: "String",
|
254
|
+
# identity_source: "String", # required
|
255
|
+
# identity_validation_expression: "String",
|
256
|
+
# authorizer_result_ttl_in_seconds: 1,
|
257
|
+
# })
|
258
|
+
#
|
259
|
+
# @example Response structure
|
260
|
+
# resp.id #=> String
|
261
|
+
# resp.name #=> String
|
262
|
+
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
263
|
+
# resp.provider_arns #=> Array
|
264
|
+
# resp.provider_arns[0] #=> String
|
265
|
+
# resp.auth_type #=> String
|
266
|
+
# resp.authorizer_uri #=> String
|
267
|
+
# resp.authorizer_credentials #=> String
|
268
|
+
# resp.identity_source #=> String
|
269
|
+
# resp.identity_validation_expression #=> String
|
270
|
+
# resp.authorizer_result_ttl_in_seconds #=> Integer
|
271
|
+
# @overload create_authorizer(params = {})
|
272
|
+
# @param [Hash] params ({})
|
273
|
+
def create_authorizer(params = {}, options = {})
|
274
|
+
req = build_request(:create_authorizer, params)
|
275
|
+
req.send_request(options)
|
276
|
+
end
|
277
|
+
|
278
|
+
# Creates a new BasePathMapping resource.
|
279
|
+
# @option params [required, String] :domain_name
|
280
|
+
# The domain name of the BasePathMapping resource to create.
|
281
|
+
# @option params [String] :base_path
|
282
|
+
# The base path name that callers of the API must provide as part of the
|
283
|
+
# URL after the domain name. This value must be unique for all of the
|
284
|
+
# mappings across a single API. Leave this blank if you do not want
|
285
|
+
# callers to specify a base path name after the domain name.
|
286
|
+
# @option params [required, String] :rest_api_id
|
287
|
+
# The name of the API that you want to apply this mapping to.
|
288
|
+
# @option params [String] :stage
|
289
|
+
# The name of the API's stage that you want to use for this mapping.
|
290
|
+
# Leave this blank if you do not want callers to explicitly specify the
|
291
|
+
# stage name after any base path name.
|
292
|
+
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
293
|
+
#
|
294
|
+
# * {Types::BasePathMapping#base_path #basePath} => String
|
295
|
+
# * {Types::BasePathMapping#rest_api_id #restApiId} => String
|
296
|
+
# * {Types::BasePathMapping#stage #stage} => String
|
297
|
+
#
|
298
|
+
# @example Request syntax with placeholder values
|
299
|
+
# resp = client.create_base_path_mapping({
|
300
|
+
# domain_name: "String", # required
|
301
|
+
# base_path: "String",
|
302
|
+
# rest_api_id: "String", # required
|
303
|
+
# stage: "String",
|
304
|
+
# })
|
305
|
+
#
|
306
|
+
# @example Response structure
|
307
|
+
# resp.base_path #=> String
|
308
|
+
# resp.rest_api_id #=> String
|
309
|
+
# resp.stage #=> String
|
310
|
+
# @overload create_base_path_mapping(params = {})
|
311
|
+
# @param [Hash] params ({})
|
312
|
+
def create_base_path_mapping(params = {}, options = {})
|
313
|
+
req = build_request(:create_base_path_mapping, params)
|
314
|
+
req.send_request(options)
|
315
|
+
end
|
316
|
+
|
317
|
+
# Creates a Deployment resource, which makes a specified RestApi
|
318
|
+
# callable over the internet.
|
319
|
+
# @option params [required, String] :rest_api_id
|
320
|
+
# The RestApi resource identifier for the Deployment resource to create.
|
321
|
+
# @option params [String] :stage_name
|
322
|
+
# The name of the Stage resource for the Deployment resource to create.
|
323
|
+
# @option params [String] :stage_description
|
324
|
+
# The description of the Stage resource for the Deployment resource to
|
325
|
+
# create.
|
326
|
+
# @option params [String] :description
|
327
|
+
# The description for the Deployment resource to create.
|
328
|
+
# @option params [Boolean] :cache_cluster_enabled
|
329
|
+
# Enables a cache cluster for the Stage resource specified in the input.
|
330
|
+
# @option params [String] :cache_cluster_size
|
331
|
+
# Specifies the cache cluster size for the Stage resource specified in
|
332
|
+
# the input, if a cache cluster is enabled.
|
333
|
+
# @option params [Hash<String,String>] :variables
|
334
|
+
# A map that defines the stage variables for the Stage resource that is
|
335
|
+
# associated with the new deployment. Variable names can have
|
336
|
+
# alphanumeric and underscore characters, and the values must match
|
337
|
+
# `[A-Za-z0-9-._~:/?#&=,]+`.
|
338
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
|
+
#
|
340
|
+
# * {Types::Deployment#id #id} => String
|
341
|
+
# * {Types::Deployment#description #description} => String
|
342
|
+
# * {Types::Deployment#created_date #createdDate} => Time
|
343
|
+
# * {Types::Deployment#api_summary #apiSummary} => Hash<String,Hash<String,Types::MethodSnapshot>>
|
344
|
+
#
|
345
|
+
# @example Request syntax with placeholder values
|
346
|
+
# resp = client.create_deployment({
|
347
|
+
# rest_api_id: "String", # required
|
348
|
+
# stage_name: "String",
|
349
|
+
# stage_description: "String",
|
350
|
+
# description: "String",
|
351
|
+
# cache_cluster_enabled: false,
|
352
|
+
# cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
|
353
|
+
# variables: {
|
354
|
+
# "String" => "String",
|
355
|
+
# },
|
356
|
+
# })
|
357
|
+
#
|
358
|
+
# @example Response structure
|
359
|
+
# resp.id #=> String
|
360
|
+
# resp.description #=> String
|
361
|
+
# resp.created_date #=> Time
|
362
|
+
# resp.api_summary #=> Hash
|
363
|
+
# resp.api_summary["String"] #=> Hash
|
364
|
+
# resp.api_summary["String"]["String"].authorization_type #=> String
|
365
|
+
# resp.api_summary["String"]["String"].api_key_required #=> Boolean
|
366
|
+
# @overload create_deployment(params = {})
|
367
|
+
# @param [Hash] params ({})
|
368
|
+
def create_deployment(params = {}, options = {})
|
369
|
+
req = build_request(:create_deployment, params)
|
370
|
+
req.send_request(options)
|
371
|
+
end
|
372
|
+
|
373
|
+
# Creates a new domain name.
|
374
|
+
# @option params [required, String] :domain_name
|
375
|
+
# The name of the DomainName resource.
|
376
|
+
# @option params [required, String] :certificate_name
|
377
|
+
# The name of the certificate.
|
378
|
+
# @option params [required, String] :certificate_body
|
379
|
+
# The body of the server certificate provided by your certificate
|
380
|
+
# authority.
|
381
|
+
# @option params [required, String] :certificate_private_key
|
382
|
+
# Your certificate's private key.
|
383
|
+
# @option params [required, String] :certificate_chain
|
384
|
+
# The intermediate certificates and optionally the root certificate, one
|
385
|
+
# after the other without any blank lines. If you include the root
|
386
|
+
# certificate, your certificate chain must start with intermediate
|
387
|
+
# certificates and end with the root certificate. Use the intermediate
|
388
|
+
# certificates that were provided by your certificate authority. Do not
|
389
|
+
# include any intermediaries that are not in the chain of trust path.
|
390
|
+
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
391
|
+
#
|
392
|
+
# * {Types::DomainName#domain_name #domainName} => String
|
393
|
+
# * {Types::DomainName#certificate_name #certificateName} => String
|
394
|
+
# * {Types::DomainName#certificate_upload_date #certificateUploadDate} => Time
|
395
|
+
# * {Types::DomainName#distribution_domain_name #distributionDomainName} => String
|
396
|
+
#
|
397
|
+
# @example Request syntax with placeholder values
|
398
|
+
# resp = client.create_domain_name({
|
399
|
+
# domain_name: "String", # required
|
400
|
+
# certificate_name: "String", # required
|
401
|
+
# certificate_body: "String", # required
|
402
|
+
# certificate_private_key: "String", # required
|
403
|
+
# certificate_chain: "String", # required
|
404
|
+
# })
|
405
|
+
#
|
406
|
+
# @example Response structure
|
407
|
+
# resp.domain_name #=> String
|
408
|
+
# resp.certificate_name #=> String
|
409
|
+
# resp.certificate_upload_date #=> Time
|
410
|
+
# resp.distribution_domain_name #=> String
|
411
|
+
# @overload create_domain_name(params = {})
|
412
|
+
# @param [Hash] params ({})
|
413
|
+
def create_domain_name(params = {}, options = {})
|
414
|
+
req = build_request(:create_domain_name, params)
|
415
|
+
req.send_request(options)
|
416
|
+
end
|
417
|
+
|
418
|
+
# Adds a new Model resource to an existing RestApi resource.
|
419
|
+
# @option params [required, String] :rest_api_id
|
420
|
+
# The RestApi identifier under which the Model will be created.
|
421
|
+
# @option params [required, String] :name
|
422
|
+
# The name of the model.
|
423
|
+
# @option params [String] :description
|
424
|
+
# The description of the model.
|
425
|
+
# @option params [String] :schema
|
426
|
+
# The schema for the model. For `application/json` models, this should
|
427
|
+
# be [JSON-schema draft v4][1] model.
|
428
|
+
#
|
429
|
+
#
|
430
|
+
#
|
431
|
+
# [1]: http://json-schema.org/documentation.html
|
432
|
+
# @option params [required, String] :content_type
|
433
|
+
# The content-type for the model.
|
434
|
+
# @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
435
|
+
#
|
436
|
+
# * {Types::Model#id #id} => String
|
437
|
+
# * {Types::Model#name #name} => String
|
438
|
+
# * {Types::Model#description #description} => String
|
439
|
+
# * {Types::Model#schema #schema} => String
|
440
|
+
# * {Types::Model#content_type #contentType} => String
|
441
|
+
#
|
442
|
+
# @example Request syntax with placeholder values
|
443
|
+
# resp = client.create_model({
|
444
|
+
# rest_api_id: "String", # required
|
445
|
+
# name: "String", # required
|
446
|
+
# description: "String",
|
447
|
+
# schema: "String",
|
448
|
+
# content_type: "String", # required
|
449
|
+
# })
|
450
|
+
#
|
451
|
+
# @example Response structure
|
452
|
+
# resp.id #=> String
|
453
|
+
# resp.name #=> String
|
454
|
+
# resp.description #=> String
|
455
|
+
# resp.schema #=> String
|
456
|
+
# resp.content_type #=> String
|
457
|
+
# @overload create_model(params = {})
|
458
|
+
# @param [Hash] params ({})
|
459
|
+
def create_model(params = {}, options = {})
|
460
|
+
req = build_request(:create_model, params)
|
461
|
+
req.send_request(options)
|
462
|
+
end
|
463
|
+
|
464
|
+
# Creates a Resource resource.
|
465
|
+
# @option params [required, String] :rest_api_id
|
466
|
+
# The identifier of the RestApi for the resource.
|
467
|
+
# @option params [required, String] :parent_id
|
468
|
+
# The parent resource's identifier.
|
469
|
+
# @option params [required, String] :path_part
|
470
|
+
# The last path segment for this resource.
|
471
|
+
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
472
|
+
#
|
473
|
+
# * {Types::Resource#id #id} => String
|
474
|
+
# * {Types::Resource#parent_id #parentId} => String
|
475
|
+
# * {Types::Resource#path_part #pathPart} => String
|
476
|
+
# * {Types::Resource#path #path} => String
|
477
|
+
# * {Types::Resource#resource_methods #resourceMethods} => Hash<String,Types::Method>
|
478
|
+
#
|
479
|
+
# @example Request syntax with placeholder values
|
480
|
+
# resp = client.create_resource({
|
481
|
+
# rest_api_id: "String", # required
|
482
|
+
# parent_id: "String", # required
|
483
|
+
# path_part: "String", # required
|
484
|
+
# })
|
485
|
+
#
|
486
|
+
# @example Response structure
|
487
|
+
# resp.id #=> String
|
488
|
+
# resp.parent_id #=> String
|
489
|
+
# resp.path_part #=> String
|
490
|
+
# resp.path #=> String
|
491
|
+
# resp.resource_methods #=> Hash
|
492
|
+
# resp.resource_methods["String"].http_method #=> String
|
493
|
+
# resp.resource_methods["String"].authorization_type #=> String
|
494
|
+
# resp.resource_methods["String"].authorizer_id #=> String
|
495
|
+
# resp.resource_methods["String"].api_key_required #=> Boolean
|
496
|
+
# resp.resource_methods["String"].request_parameters #=> Hash
|
497
|
+
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
498
|
+
# resp.resource_methods["String"].request_models #=> Hash
|
499
|
+
# resp.resource_methods["String"].request_models["String"] #=> String
|
500
|
+
# resp.resource_methods["String"].method_responses #=> Hash
|
501
|
+
# resp.resource_methods["String"].method_responses["String"].status_code #=> String
|
502
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
|
503
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
|
504
|
+
# resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
|
505
|
+
# resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
|
506
|
+
# resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
507
|
+
# resp.resource_methods["String"].method_integration.http_method #=> String
|
508
|
+
# resp.resource_methods["String"].method_integration.uri #=> String
|
509
|
+
# resp.resource_methods["String"].method_integration.credentials #=> String
|
510
|
+
# resp.resource_methods["String"].method_integration.request_parameters #=> Hash
|
511
|
+
# resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
|
512
|
+
# resp.resource_methods["String"].method_integration.request_templates #=> Hash
|
513
|
+
# resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
|
514
|
+
# resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
|
515
|
+
# resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
516
|
+
# resp.resource_methods["String"].method_integration.cache_namespace #=> String
|
517
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
|
518
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
|
519
|
+
# resp.resource_methods["String"].method_integration.integration_responses #=> Hash
|
520
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
|
521
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
|
522
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
|
523
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
524
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
|
525
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
|
526
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
527
|
+
# @overload create_resource(params = {})
|
528
|
+
# @param [Hash] params ({})
|
529
|
+
def create_resource(params = {}, options = {})
|
530
|
+
req = build_request(:create_resource, params)
|
531
|
+
req.send_request(options)
|
532
|
+
end
|
533
|
+
|
534
|
+
# Creates a new RestApi resource.
|
535
|
+
# @option params [required, String] :name
|
536
|
+
# The name of the RestApi.
|
537
|
+
# @option params [String] :description
|
538
|
+
# The description of the RestApi.
|
539
|
+
# @option params [String] :clone_from
|
540
|
+
# The ID of the RestApi that you want to clone from.
|
541
|
+
# @option params [Array<String>] :binary_media_types
|
542
|
+
# The list of binary media types supported by the RestApi. By default,
|
543
|
+
# the RestApi supports only UTF-8-encoded text payloads.
|
544
|
+
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
545
|
+
#
|
546
|
+
# * {Types::RestApi#id #id} => String
|
547
|
+
# * {Types::RestApi#name #name} => String
|
548
|
+
# * {Types::RestApi#description #description} => String
|
549
|
+
# * {Types::RestApi#created_date #createdDate} => Time
|
550
|
+
# * {Types::RestApi#warnings #warnings} => Array<String>
|
551
|
+
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
552
|
+
#
|
553
|
+
# @example Request syntax with placeholder values
|
554
|
+
# resp = client.create_rest_api({
|
555
|
+
# name: "String", # required
|
556
|
+
# description: "String",
|
557
|
+
# clone_from: "String",
|
558
|
+
# binary_media_types: ["String"],
|
559
|
+
# })
|
560
|
+
#
|
561
|
+
# @example Response structure
|
562
|
+
# resp.id #=> String
|
563
|
+
# resp.name #=> String
|
564
|
+
# resp.description #=> String
|
565
|
+
# resp.created_date #=> Time
|
566
|
+
# resp.warnings #=> Array
|
567
|
+
# resp.warnings[0] #=> String
|
568
|
+
# resp.binary_media_types #=> Array
|
569
|
+
# resp.binary_media_types[0] #=> String
|
570
|
+
# @overload create_rest_api(params = {})
|
571
|
+
# @param [Hash] params ({})
|
572
|
+
def create_rest_api(params = {}, options = {})
|
573
|
+
req = build_request(:create_rest_api, params)
|
574
|
+
req.send_request(options)
|
575
|
+
end
|
576
|
+
|
577
|
+
# Creates a new Stage resource that references a pre-existing Deployment
|
578
|
+
# for the API.
|
579
|
+
# @option params [required, String] :rest_api_id
|
580
|
+
# The identifier of the RestApi resource for the Stage resource to
|
581
|
+
# create.
|
582
|
+
# @option params [required, String] :stage_name
|
583
|
+
# The name for the Stage resource.
|
584
|
+
# @option params [required, String] :deployment_id
|
585
|
+
# The identifier of the Deployment resource for the Stage resource.
|
586
|
+
# @option params [String] :description
|
587
|
+
# The description of the Stage resource.
|
588
|
+
# @option params [Boolean] :cache_cluster_enabled
|
589
|
+
# Whether cache clustering is enabled for the stage.
|
590
|
+
# @option params [String] :cache_cluster_size
|
591
|
+
# The stage's cache cluster size.
|
592
|
+
# @option params [Hash<String,String>] :variables
|
593
|
+
# A map that defines the stage variables for the new Stage resource.
|
594
|
+
# Variable names can have alphanumeric and underscore characters, and
|
595
|
+
# the values must match `[A-Za-z0-9-._~:/?#&=,]+`.
|
596
|
+
# @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
597
|
+
#
|
598
|
+
# * {Types::Stage#deployment_id #deploymentId} => String
|
599
|
+
# * {Types::Stage#client_certificate_id #clientCertificateId} => String
|
600
|
+
# * {Types::Stage#stage_name #stageName} => String
|
601
|
+
# * {Types::Stage#description #description} => String
|
602
|
+
# * {Types::Stage#cache_cluster_enabled #cacheClusterEnabled} => Boolean
|
603
|
+
# * {Types::Stage#cache_cluster_size #cacheClusterSize} => String
|
604
|
+
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
605
|
+
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
606
|
+
# * {Types::Stage#variables #variables} => Hash<String,String>
|
607
|
+
# * {Types::Stage#created_date #createdDate} => Time
|
608
|
+
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
609
|
+
#
|
610
|
+
# @example Request syntax with placeholder values
|
611
|
+
# resp = client.create_stage({
|
612
|
+
# rest_api_id: "String", # required
|
613
|
+
# stage_name: "String", # required
|
614
|
+
# deployment_id: "String", # required
|
615
|
+
# description: "String",
|
616
|
+
# cache_cluster_enabled: false,
|
617
|
+
# cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
|
618
|
+
# variables: {
|
619
|
+
# "String" => "String",
|
620
|
+
# },
|
621
|
+
# })
|
622
|
+
#
|
623
|
+
# @example Response structure
|
624
|
+
# resp.deployment_id #=> String
|
625
|
+
# resp.client_certificate_id #=> String
|
626
|
+
# resp.stage_name #=> String
|
627
|
+
# resp.description #=> String
|
628
|
+
# resp.cache_cluster_enabled #=> Boolean
|
629
|
+
# resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
|
630
|
+
# resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
|
631
|
+
# resp.method_settings #=> Hash
|
632
|
+
# resp.method_settings["String"].metrics_enabled #=> Boolean
|
633
|
+
# resp.method_settings["String"].logging_level #=> String
|
634
|
+
# resp.method_settings["String"].data_trace_enabled #=> Boolean
|
635
|
+
# resp.method_settings["String"].throttling_burst_limit #=> Integer
|
636
|
+
# resp.method_settings["String"].throttling_rate_limit #=> Float
|
637
|
+
# resp.method_settings["String"].caching_enabled #=> Boolean
|
638
|
+
# resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
|
639
|
+
# resp.method_settings["String"].cache_data_encrypted #=> Boolean
|
640
|
+
# resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
|
641
|
+
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
642
|
+
# resp.variables #=> Hash
|
643
|
+
# resp.variables["String"] #=> String
|
644
|
+
# resp.created_date #=> Time
|
645
|
+
# resp.last_updated_date #=> Time
|
646
|
+
# @overload create_stage(params = {})
|
647
|
+
# @param [Hash] params ({})
|
648
|
+
def create_stage(params = {}, options = {})
|
649
|
+
req = build_request(:create_stage, params)
|
650
|
+
req.send_request(options)
|
651
|
+
end
|
652
|
+
|
653
|
+
# Creates a usage plan with the throttle and quota limits, as well as
|
654
|
+
# the associated API stages, specified in the payload.
|
655
|
+
# @option params [required, String] :name
|
656
|
+
# The name of the usage plan.
|
657
|
+
# @option params [String] :description
|
658
|
+
# The description of the usage plan.
|
659
|
+
# @option params [Array<Types::ApiStage>] :api_stages
|
660
|
+
# The associated API stages of the usage plan.
|
661
|
+
# @option params [Types::ThrottleSettings] :throttle
|
662
|
+
# The throttling limits of the usage plan.
|
663
|
+
# @option params [Types::QuotaSettings] :quota
|
664
|
+
# The quota of the usage plan.
|
665
|
+
# @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
666
|
+
#
|
667
|
+
# * {Types::UsagePlan#id #id} => String
|
668
|
+
# * {Types::UsagePlan#name #name} => String
|
669
|
+
# * {Types::UsagePlan#description #description} => String
|
670
|
+
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
671
|
+
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
672
|
+
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
673
|
+
#
|
674
|
+
# @example Request syntax with placeholder values
|
675
|
+
# resp = client.create_usage_plan({
|
676
|
+
# name: "String", # required
|
677
|
+
# description: "String",
|
678
|
+
# api_stages: [
|
679
|
+
# {
|
680
|
+
# api_id: "String",
|
681
|
+
# stage: "String",
|
682
|
+
# },
|
683
|
+
# ],
|
684
|
+
# throttle: {
|
685
|
+
# burst_limit: 1,
|
686
|
+
# rate_limit: 1.0,
|
687
|
+
# },
|
688
|
+
# quota: {
|
689
|
+
# limit: 1,
|
690
|
+
# offset: 1,
|
691
|
+
# period: "DAY", # accepts DAY, WEEK, MONTH
|
692
|
+
# },
|
693
|
+
# })
|
694
|
+
#
|
695
|
+
# @example Response structure
|
696
|
+
# resp.id #=> String
|
697
|
+
# resp.name #=> String
|
698
|
+
# resp.description #=> String
|
699
|
+
# resp.api_stages #=> Array
|
700
|
+
# resp.api_stages[0].api_id #=> String
|
701
|
+
# resp.api_stages[0].stage #=> String
|
702
|
+
# resp.throttle.burst_limit #=> Integer
|
703
|
+
# resp.throttle.rate_limit #=> Float
|
704
|
+
# resp.quota.limit #=> Integer
|
705
|
+
# resp.quota.offset #=> Integer
|
706
|
+
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
707
|
+
# @overload create_usage_plan(params = {})
|
708
|
+
# @param [Hash] params ({})
|
709
|
+
def create_usage_plan(params = {}, options = {})
|
710
|
+
req = build_request(:create_usage_plan, params)
|
711
|
+
req.send_request(options)
|
712
|
+
end
|
713
|
+
|
714
|
+
# Creates a usage plan key for adding an existing API key to a usage
|
715
|
+
# plan.
|
716
|
+
# @option params [required, String] :usage_plan_id
|
717
|
+
# The Id of the UsagePlan resource representing the usage plan
|
718
|
+
# containing the to-be-created UsagePlanKey resource representing a plan
|
719
|
+
# customer.
|
720
|
+
# @option params [required, String] :key_id
|
721
|
+
# The identifier of a UsagePlanKey resource for a plan customer.
|
722
|
+
# @option params [required, String] :key_type
|
723
|
+
# The type of a UsagePlanKey resource for a plan customer.
|
724
|
+
# @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
725
|
+
#
|
726
|
+
# * {Types::UsagePlanKey#id #id} => String
|
727
|
+
# * {Types::UsagePlanKey#type #type} => String
|
728
|
+
# * {Types::UsagePlanKey#value #value} => String
|
729
|
+
# * {Types::UsagePlanKey#name #name} => String
|
730
|
+
#
|
731
|
+
# @example Request syntax with placeholder values
|
732
|
+
# resp = client.create_usage_plan_key({
|
733
|
+
# usage_plan_id: "String", # required
|
734
|
+
# key_id: "String", # required
|
735
|
+
# key_type: "String", # required
|
736
|
+
# })
|
737
|
+
#
|
738
|
+
# @example Response structure
|
739
|
+
# resp.id #=> String
|
740
|
+
# resp.type #=> String
|
741
|
+
# resp.value #=> String
|
742
|
+
# resp.name #=> String
|
743
|
+
# @overload create_usage_plan_key(params = {})
|
744
|
+
# @param [Hash] params ({})
|
745
|
+
def create_usage_plan_key(params = {}, options = {})
|
746
|
+
req = build_request(:create_usage_plan_key, params)
|
747
|
+
req.send_request(options)
|
748
|
+
end
|
749
|
+
|
750
|
+
# Deletes the ApiKey resource.
|
751
|
+
# @option params [required, String] :api_key
|
752
|
+
# The identifier of the ApiKey resource to be deleted.
|
753
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
754
|
+
#
|
755
|
+
# @example Request syntax with placeholder values
|
756
|
+
# resp = client.delete_api_key({
|
757
|
+
# api_key: "String", # required
|
758
|
+
# })
|
759
|
+
# @overload delete_api_key(params = {})
|
760
|
+
# @param [Hash] params ({})
|
761
|
+
def delete_api_key(params = {}, options = {})
|
762
|
+
req = build_request(:delete_api_key, params)
|
763
|
+
req.send_request(options)
|
764
|
+
end
|
765
|
+
|
766
|
+
# Deletes an existing Authorizer resource.
|
767
|
+
#
|
768
|
+
# <div class="seeAlso">
|
769
|
+
# [AWS CLI][1]
|
770
|
+
# </div>
|
771
|
+
#
|
772
|
+
#
|
773
|
+
#
|
774
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
|
775
|
+
# @option params [required, String] :rest_api_id
|
776
|
+
# The RestApi identifier for the Authorizer resource.
|
777
|
+
# @option params [required, String] :authorizer_id
|
778
|
+
# The identifier of the Authorizer resource.
|
779
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
780
|
+
#
|
781
|
+
# @example Request syntax with placeholder values
|
782
|
+
# resp = client.delete_authorizer({
|
783
|
+
# rest_api_id: "String", # required
|
784
|
+
# authorizer_id: "String", # required
|
785
|
+
# })
|
786
|
+
# @overload delete_authorizer(params = {})
|
787
|
+
# @param [Hash] params ({})
|
788
|
+
def delete_authorizer(params = {}, options = {})
|
789
|
+
req = build_request(:delete_authorizer, params)
|
790
|
+
req.send_request(options)
|
791
|
+
end
|
792
|
+
|
793
|
+
# Deletes the BasePathMapping resource.
|
794
|
+
# @option params [required, String] :domain_name
|
795
|
+
# The domain name of the BasePathMapping resource to delete.
|
796
|
+
# @option params [required, String] :base_path
|
797
|
+
# The base path name of the BasePathMapping resource to delete.
|
798
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
799
|
+
#
|
800
|
+
# @example Request syntax with placeholder values
|
801
|
+
# resp = client.delete_base_path_mapping({
|
802
|
+
# domain_name: "String", # required
|
803
|
+
# base_path: "String", # required
|
804
|
+
# })
|
805
|
+
# @overload delete_base_path_mapping(params = {})
|
806
|
+
# @param [Hash] params ({})
|
807
|
+
def delete_base_path_mapping(params = {}, options = {})
|
808
|
+
req = build_request(:delete_base_path_mapping, params)
|
809
|
+
req.send_request(options)
|
810
|
+
end
|
811
|
+
|
812
|
+
# Deletes the ClientCertificate resource.
|
813
|
+
# @option params [required, String] :client_certificate_id
|
814
|
+
# The identifier of the ClientCertificate resource to be deleted.
|
815
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
816
|
+
#
|
817
|
+
# @example Request syntax with placeholder values
|
818
|
+
# resp = client.delete_client_certificate({
|
819
|
+
# client_certificate_id: "String", # required
|
820
|
+
# })
|
821
|
+
# @overload delete_client_certificate(params = {})
|
822
|
+
# @param [Hash] params ({})
|
823
|
+
def delete_client_certificate(params = {}, options = {})
|
824
|
+
req = build_request(:delete_client_certificate, params)
|
825
|
+
req.send_request(options)
|
826
|
+
end
|
827
|
+
|
828
|
+
# Deletes a Deployment resource. Deleting a deployment will only succeed
|
829
|
+
# if there are no Stage resources associated with it.
|
830
|
+
# @option params [required, String] :rest_api_id
|
831
|
+
# The identifier of the RestApi resource for the Deployment resource to
|
832
|
+
# delete.
|
833
|
+
# @option params [required, String] :deployment_id
|
834
|
+
# The identifier of the Deployment resource to delete.
|
835
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
836
|
+
#
|
837
|
+
# @example Request syntax with placeholder values
|
838
|
+
# resp = client.delete_deployment({
|
839
|
+
# rest_api_id: "String", # required
|
840
|
+
# deployment_id: "String", # required
|
841
|
+
# })
|
842
|
+
# @overload delete_deployment(params = {})
|
843
|
+
# @param [Hash] params ({})
|
844
|
+
def delete_deployment(params = {}, options = {})
|
845
|
+
req = build_request(:delete_deployment, params)
|
846
|
+
req.send_request(options)
|
847
|
+
end
|
848
|
+
|
849
|
+
# Deletes the DomainName resource.
|
850
|
+
# @option params [required, String] :domain_name
|
851
|
+
# The name of the DomainName resource to be deleted.
|
852
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
853
|
+
#
|
854
|
+
# @example Request syntax with placeholder values
|
855
|
+
# resp = client.delete_domain_name({
|
856
|
+
# domain_name: "String", # required
|
857
|
+
# })
|
858
|
+
# @overload delete_domain_name(params = {})
|
859
|
+
# @param [Hash] params ({})
|
860
|
+
def delete_domain_name(params = {}, options = {})
|
861
|
+
req = build_request(:delete_domain_name, params)
|
862
|
+
req.send_request(options)
|
863
|
+
end
|
864
|
+
|
865
|
+
# Represents a delete integration.
|
866
|
+
# @option params [required, String] :rest_api_id
|
867
|
+
# Specifies a delete integration request's API identifier.
|
868
|
+
# @option params [required, String] :resource_id
|
869
|
+
# Specifies a delete integration request's resource identifier.
|
870
|
+
# @option params [required, String] :http_method
|
871
|
+
# Specifies a delete integration request's HTTP method.
|
872
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
873
|
+
#
|
874
|
+
# @example Request syntax with placeholder values
|
875
|
+
# resp = client.delete_integration({
|
876
|
+
# rest_api_id: "String", # required
|
877
|
+
# resource_id: "String", # required
|
878
|
+
# http_method: "String", # required
|
879
|
+
# })
|
880
|
+
# @overload delete_integration(params = {})
|
881
|
+
# @param [Hash] params ({})
|
882
|
+
def delete_integration(params = {}, options = {})
|
883
|
+
req = build_request(:delete_integration, params)
|
884
|
+
req.send_request(options)
|
885
|
+
end
|
886
|
+
|
887
|
+
# Represents a delete integration response.
|
888
|
+
# @option params [required, String] :rest_api_id
|
889
|
+
# Specifies a delete integration response request's API identifier.
|
890
|
+
# @option params [required, String] :resource_id
|
891
|
+
# Specifies a delete integration response request's resource
|
892
|
+
# identifier.
|
893
|
+
# @option params [required, String] :http_method
|
894
|
+
# Specifies a delete integration response request's HTTP method.
|
895
|
+
# @option params [required, String] :status_code
|
896
|
+
# Specifies a delete integration response request's status code.
|
897
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
898
|
+
#
|
899
|
+
# @example Request syntax with placeholder values
|
900
|
+
# resp = client.delete_integration_response({
|
901
|
+
# rest_api_id: "String", # required
|
902
|
+
# resource_id: "String", # required
|
903
|
+
# http_method: "String", # required
|
904
|
+
# status_code: "StatusCode", # required
|
905
|
+
# })
|
906
|
+
# @overload delete_integration_response(params = {})
|
907
|
+
# @param [Hash] params ({})
|
908
|
+
def delete_integration_response(params = {}, options = {})
|
909
|
+
req = build_request(:delete_integration_response, params)
|
910
|
+
req.send_request(options)
|
911
|
+
end
|
912
|
+
|
913
|
+
# Deletes an existing Method resource.
|
914
|
+
# @option params [required, String] :rest_api_id
|
915
|
+
# The RestApi identifier for the Method resource.
|
916
|
+
# @option params [required, String] :resource_id
|
917
|
+
# The Resource identifier for the Method resource.
|
918
|
+
# @option params [required, String] :http_method
|
919
|
+
# The HTTP verb of the Method resource.
|
920
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
921
|
+
#
|
922
|
+
# @example Request syntax with placeholder values
|
923
|
+
# resp = client.delete_method({
|
924
|
+
# rest_api_id: "String", # required
|
925
|
+
# resource_id: "String", # required
|
926
|
+
# http_method: "String", # required
|
927
|
+
# })
|
928
|
+
# @overload delete_method(params = {})
|
929
|
+
# @param [Hash] params ({})
|
930
|
+
def delete_method(params = {}, options = {})
|
931
|
+
req = build_request(:delete_method, params)
|
932
|
+
req.send_request(options)
|
933
|
+
end
|
934
|
+
|
935
|
+
# Deletes an existing MethodResponse resource.
|
936
|
+
# @option params [required, String] :rest_api_id
|
937
|
+
# The RestApi identifier for the MethodResponse resource.
|
938
|
+
# @option params [required, String] :resource_id
|
939
|
+
# The Resource identifier for the MethodResponse resource.
|
940
|
+
# @option params [required, String] :http_method
|
941
|
+
# The HTTP verb of the Method resource.
|
942
|
+
# @option params [required, String] :status_code
|
943
|
+
# The status code identifier for the MethodResponse resource.
|
944
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
945
|
+
#
|
946
|
+
# @example Request syntax with placeholder values
|
947
|
+
# resp = client.delete_method_response({
|
948
|
+
# rest_api_id: "String", # required
|
949
|
+
# resource_id: "String", # required
|
950
|
+
# http_method: "String", # required
|
951
|
+
# status_code: "StatusCode", # required
|
952
|
+
# })
|
953
|
+
# @overload delete_method_response(params = {})
|
954
|
+
# @param [Hash] params ({})
|
955
|
+
def delete_method_response(params = {}, options = {})
|
956
|
+
req = build_request(:delete_method_response, params)
|
957
|
+
req.send_request(options)
|
958
|
+
end
|
959
|
+
|
960
|
+
# Deletes a model.
|
961
|
+
# @option params [required, String] :rest_api_id
|
962
|
+
# The RestApi under which the model will be deleted.
|
963
|
+
# @option params [required, String] :model_name
|
964
|
+
# The name of the model to delete.
|
965
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
966
|
+
#
|
967
|
+
# @example Request syntax with placeholder values
|
968
|
+
# resp = client.delete_model({
|
969
|
+
# rest_api_id: "String", # required
|
970
|
+
# model_name: "String", # required
|
971
|
+
# })
|
972
|
+
# @overload delete_model(params = {})
|
973
|
+
# @param [Hash] params ({})
|
974
|
+
def delete_model(params = {}, options = {})
|
975
|
+
req = build_request(:delete_model, params)
|
976
|
+
req.send_request(options)
|
977
|
+
end
|
978
|
+
|
979
|
+
# Deletes a Resource resource.
|
980
|
+
# @option params [required, String] :rest_api_id
|
981
|
+
# The RestApi identifier for the Resource resource.
|
982
|
+
# @option params [required, String] :resource_id
|
983
|
+
# The identifier of the Resource resource.
|
984
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
985
|
+
#
|
986
|
+
# @example Request syntax with placeholder values
|
987
|
+
# resp = client.delete_resource({
|
988
|
+
# rest_api_id: "String", # required
|
989
|
+
# resource_id: "String", # required
|
990
|
+
# })
|
991
|
+
# @overload delete_resource(params = {})
|
992
|
+
# @param [Hash] params ({})
|
993
|
+
def delete_resource(params = {}, options = {})
|
994
|
+
req = build_request(:delete_resource, params)
|
995
|
+
req.send_request(options)
|
996
|
+
end
|
997
|
+
|
998
|
+
# Deletes the specified API.
|
999
|
+
# @option params [required, String] :rest_api_id
|
1000
|
+
# The ID of the RestApi you want to delete.
|
1001
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1002
|
+
#
|
1003
|
+
# @example Request syntax with placeholder values
|
1004
|
+
# resp = client.delete_rest_api({
|
1005
|
+
# rest_api_id: "String", # required
|
1006
|
+
# })
|
1007
|
+
# @overload delete_rest_api(params = {})
|
1008
|
+
# @param [Hash] params ({})
|
1009
|
+
def delete_rest_api(params = {}, options = {})
|
1010
|
+
req = build_request(:delete_rest_api, params)
|
1011
|
+
req.send_request(options)
|
1012
|
+
end
|
1013
|
+
|
1014
|
+
# Deletes a Stage resource.
|
1015
|
+
# @option params [required, String] :rest_api_id
|
1016
|
+
# The identifier of the RestApi resource for the Stage resource to
|
1017
|
+
# delete.
|
1018
|
+
# @option params [required, String] :stage_name
|
1019
|
+
# The name of the Stage resource to delete.
|
1020
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1021
|
+
#
|
1022
|
+
# @example Request syntax with placeholder values
|
1023
|
+
# resp = client.delete_stage({
|
1024
|
+
# rest_api_id: "String", # required
|
1025
|
+
# stage_name: "String", # required
|
1026
|
+
# })
|
1027
|
+
# @overload delete_stage(params = {})
|
1028
|
+
# @param [Hash] params ({})
|
1029
|
+
def delete_stage(params = {}, options = {})
|
1030
|
+
req = build_request(:delete_stage, params)
|
1031
|
+
req.send_request(options)
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Deletes a usage plan of a given plan Id.
|
1035
|
+
# @option params [required, String] :usage_plan_id
|
1036
|
+
# The Id of the to-be-deleted usage plan.
|
1037
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1038
|
+
#
|
1039
|
+
# @example Request syntax with placeholder values
|
1040
|
+
# resp = client.delete_usage_plan({
|
1041
|
+
# usage_plan_id: "String", # required
|
1042
|
+
# })
|
1043
|
+
# @overload delete_usage_plan(params = {})
|
1044
|
+
# @param [Hash] params ({})
|
1045
|
+
def delete_usage_plan(params = {}, options = {})
|
1046
|
+
req = build_request(:delete_usage_plan, params)
|
1047
|
+
req.send_request(options)
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# Deletes a usage plan key and remove the underlying API key from the
|
1051
|
+
# associated usage plan.
|
1052
|
+
# @option params [required, String] :usage_plan_id
|
1053
|
+
# The Id of the UsagePlan resource representing the usage plan
|
1054
|
+
# containing the to-be-deleted UsagePlanKey resource representing a plan
|
1055
|
+
# customer.
|
1056
|
+
# @option params [required, String] :key_id
|
1057
|
+
# The Id of the UsagePlanKey resource to be deleted.
|
1058
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1059
|
+
#
|
1060
|
+
# @example Request syntax with placeholder values
|
1061
|
+
# resp = client.delete_usage_plan_key({
|
1062
|
+
# usage_plan_id: "String", # required
|
1063
|
+
# key_id: "String", # required
|
1064
|
+
# })
|
1065
|
+
# @overload delete_usage_plan_key(params = {})
|
1066
|
+
# @param [Hash] params ({})
|
1067
|
+
def delete_usage_plan_key(params = {}, options = {})
|
1068
|
+
req = build_request(:delete_usage_plan_key, params)
|
1069
|
+
req.send_request(options)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Flushes all authorizer cache entries on a stage.
|
1073
|
+
# @option params [required, String] :rest_api_id
|
1074
|
+
# The API identifier of the stage to flush.
|
1075
|
+
# @option params [required, String] :stage_name
|
1076
|
+
# The name of the stage to flush.
|
1077
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1078
|
+
#
|
1079
|
+
# @example Request syntax with placeholder values
|
1080
|
+
# resp = client.flush_stage_authorizers_cache({
|
1081
|
+
# rest_api_id: "String", # required
|
1082
|
+
# stage_name: "String", # required
|
1083
|
+
# })
|
1084
|
+
# @overload flush_stage_authorizers_cache(params = {})
|
1085
|
+
# @param [Hash] params ({})
|
1086
|
+
def flush_stage_authorizers_cache(params = {}, options = {})
|
1087
|
+
req = build_request(:flush_stage_authorizers_cache, params)
|
1088
|
+
req.send_request(options)
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
# Flushes a stage's cache.
|
1092
|
+
# @option params [required, String] :rest_api_id
|
1093
|
+
# The API identifier of the stage to flush its cache.
|
1094
|
+
# @option params [required, String] :stage_name
|
1095
|
+
# The name of the stage to flush its cache.
|
1096
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1097
|
+
#
|
1098
|
+
# @example Request syntax with placeholder values
|
1099
|
+
# resp = client.flush_stage_cache({
|
1100
|
+
# rest_api_id: "String", # required
|
1101
|
+
# stage_name: "String", # required
|
1102
|
+
# })
|
1103
|
+
# @overload flush_stage_cache(params = {})
|
1104
|
+
# @param [Hash] params ({})
|
1105
|
+
def flush_stage_cache(params = {}, options = {})
|
1106
|
+
req = build_request(:flush_stage_cache, params)
|
1107
|
+
req.send_request(options)
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
# Generates a ClientCertificate resource.
|
1111
|
+
# @option params [String] :description
|
1112
|
+
# The description of the ClientCertificate.
|
1113
|
+
# @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1114
|
+
#
|
1115
|
+
# * {Types::ClientCertificate#client_certificate_id #clientCertificateId} => String
|
1116
|
+
# * {Types::ClientCertificate#description #description} => String
|
1117
|
+
# * {Types::ClientCertificate#pem_encoded_certificate #pemEncodedCertificate} => String
|
1118
|
+
# * {Types::ClientCertificate#created_date #createdDate} => Time
|
1119
|
+
# * {Types::ClientCertificate#expiration_date #expirationDate} => Time
|
1120
|
+
#
|
1121
|
+
# @example Request syntax with placeholder values
|
1122
|
+
# resp = client.generate_client_certificate({
|
1123
|
+
# description: "String",
|
1124
|
+
# })
|
1125
|
+
#
|
1126
|
+
# @example Response structure
|
1127
|
+
# resp.client_certificate_id #=> String
|
1128
|
+
# resp.description #=> String
|
1129
|
+
# resp.pem_encoded_certificate #=> String
|
1130
|
+
# resp.created_date #=> Time
|
1131
|
+
# resp.expiration_date #=> Time
|
1132
|
+
# @overload generate_client_certificate(params = {})
|
1133
|
+
# @param [Hash] params ({})
|
1134
|
+
def generate_client_certificate(params = {}, options = {})
|
1135
|
+
req = build_request(:generate_client_certificate, params)
|
1136
|
+
req.send_request(options)
|
1137
|
+
end
|
1138
|
+
|
1139
|
+
# Gets information about the current Account resource.
|
1140
|
+
# @return [Types::Account] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1141
|
+
#
|
1142
|
+
# * {Types::Account#cloudwatch_role_arn #cloudwatchRoleArn} => String
|
1143
|
+
# * {Types::Account#throttle_settings #throttleSettings} => Types::ThrottleSettings
|
1144
|
+
# * {Types::Account#features #features} => Array<String>
|
1145
|
+
# * {Types::Account#api_key_version #apiKeyVersion} => String
|
1146
|
+
#
|
1147
|
+
# @example Request syntax with placeholder values
|
1148
|
+
# resp = client.get_account()
|
1149
|
+
#
|
1150
|
+
# @example Response structure
|
1151
|
+
# resp.cloudwatch_role_arn #=> String
|
1152
|
+
# resp.throttle_settings.burst_limit #=> Integer
|
1153
|
+
# resp.throttle_settings.rate_limit #=> Float
|
1154
|
+
# resp.features #=> Array
|
1155
|
+
# resp.features[0] #=> String
|
1156
|
+
# resp.api_key_version #=> String
|
1157
|
+
# @overload get_account(params = {})
|
1158
|
+
# @param [Hash] params ({})
|
1159
|
+
def get_account(params = {}, options = {})
|
1160
|
+
req = build_request(:get_account, params)
|
1161
|
+
req.send_request(options)
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# Gets information about the current ApiKey resource.
|
1165
|
+
# @option params [required, String] :api_key
|
1166
|
+
# The identifier of the ApiKey resource.
|
1167
|
+
# @option params [Boolean] :include_value
|
1168
|
+
# A boolean flag to specify whether (`true`) or not (`false`) the result
|
1169
|
+
# contains the key value.
|
1170
|
+
# @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1171
|
+
#
|
1172
|
+
# * {Types::ApiKey#id #id} => String
|
1173
|
+
# * {Types::ApiKey#value #value} => String
|
1174
|
+
# * {Types::ApiKey#name #name} => String
|
1175
|
+
# * {Types::ApiKey#description #description} => String
|
1176
|
+
# * {Types::ApiKey#enabled #enabled} => Boolean
|
1177
|
+
# * {Types::ApiKey#created_date #createdDate} => Time
|
1178
|
+
# * {Types::ApiKey#last_updated_date #lastUpdatedDate} => Time
|
1179
|
+
# * {Types::ApiKey#stage_keys #stageKeys} => Array<String>
|
1180
|
+
#
|
1181
|
+
# @example Request syntax with placeholder values
|
1182
|
+
# resp = client.get_api_key({
|
1183
|
+
# api_key: "String", # required
|
1184
|
+
# include_value: false,
|
1185
|
+
# })
|
1186
|
+
#
|
1187
|
+
# @example Response structure
|
1188
|
+
# resp.id #=> String
|
1189
|
+
# resp.value #=> String
|
1190
|
+
# resp.name #=> String
|
1191
|
+
# resp.description #=> String
|
1192
|
+
# resp.enabled #=> Boolean
|
1193
|
+
# resp.created_date #=> Time
|
1194
|
+
# resp.last_updated_date #=> Time
|
1195
|
+
# resp.stage_keys #=> Array
|
1196
|
+
# resp.stage_keys[0] #=> String
|
1197
|
+
# @overload get_api_key(params = {})
|
1198
|
+
# @param [Hash] params ({})
|
1199
|
+
def get_api_key(params = {}, options = {})
|
1200
|
+
req = build_request(:get_api_key, params)
|
1201
|
+
req.send_request(options)
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
# Gets information about the current ApiKeys resource.
|
1205
|
+
# @option params [String] :position
|
1206
|
+
# The position of the current ApiKeys resource to get information about.
|
1207
|
+
# @option params [Integer] :limit
|
1208
|
+
# The maximum number of ApiKeys to get information about.
|
1209
|
+
# @option params [String] :name_query
|
1210
|
+
# The name of queried API keys.
|
1211
|
+
# @option params [String] :customer_id
|
1212
|
+
# @option params [Boolean] :include_values
|
1213
|
+
# A boolean flag to specify whether (`true`) or not (`false`) the result
|
1214
|
+
# contains key values.
|
1215
|
+
# @return [Types::ApiKeys] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1216
|
+
#
|
1217
|
+
# * {Types::ApiKeys#warnings #warnings} => Array<String>
|
1218
|
+
# * {Types::ApiKeys#position #position} => String
|
1219
|
+
# * {Types::ApiKeys#items #items} => Array<Types::ApiKey>
|
1220
|
+
#
|
1221
|
+
# @example Request syntax with placeholder values
|
1222
|
+
# resp = client.get_api_keys({
|
1223
|
+
# position: "String",
|
1224
|
+
# limit: 1,
|
1225
|
+
# name_query: "String",
|
1226
|
+
# customer_id: "String",
|
1227
|
+
# include_values: false,
|
1228
|
+
# })
|
1229
|
+
#
|
1230
|
+
# @example Response structure
|
1231
|
+
# resp.warnings #=> Array
|
1232
|
+
# resp.warnings[0] #=> String
|
1233
|
+
# resp.position #=> String
|
1234
|
+
# resp.items #=> Array
|
1235
|
+
# resp.items[0].id #=> String
|
1236
|
+
# resp.items[0].value #=> String
|
1237
|
+
# resp.items[0].name #=> String
|
1238
|
+
# resp.items[0].description #=> String
|
1239
|
+
# resp.items[0].enabled #=> Boolean
|
1240
|
+
# resp.items[0].created_date #=> Time
|
1241
|
+
# resp.items[0].last_updated_date #=> Time
|
1242
|
+
# resp.items[0].stage_keys #=> Array
|
1243
|
+
# resp.items[0].stage_keys[0] #=> String
|
1244
|
+
# @overload get_api_keys(params = {})
|
1245
|
+
# @param [Hash] params ({})
|
1246
|
+
def get_api_keys(params = {}, options = {})
|
1247
|
+
req = build_request(:get_api_keys, params)
|
1248
|
+
req.send_request(options)
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
# Describe an existing Authorizer resource.
|
1252
|
+
#
|
1253
|
+
# <div class="seeAlso">
|
1254
|
+
# [AWS CLI][1]
|
1255
|
+
# </div>
|
1256
|
+
#
|
1257
|
+
#
|
1258
|
+
#
|
1259
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
|
1260
|
+
# @option params [required, String] :rest_api_id
|
1261
|
+
# The RestApi identifier for the Authorizer resource.
|
1262
|
+
# @option params [required, String] :authorizer_id
|
1263
|
+
# The identifier of the Authorizer resource.
|
1264
|
+
# @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1265
|
+
#
|
1266
|
+
# * {Types::Authorizer#id #id} => String
|
1267
|
+
# * {Types::Authorizer#name #name} => String
|
1268
|
+
# * {Types::Authorizer#type #type} => String
|
1269
|
+
# * {Types::Authorizer#provider_arns #providerARNs} => Array<String>
|
1270
|
+
# * {Types::Authorizer#auth_type #authType} => String
|
1271
|
+
# * {Types::Authorizer#authorizer_uri #authorizerUri} => String
|
1272
|
+
# * {Types::Authorizer#authorizer_credentials #authorizerCredentials} => String
|
1273
|
+
# * {Types::Authorizer#identity_source #identitySource} => String
|
1274
|
+
# * {Types::Authorizer#identity_validation_expression #identityValidationExpression} => String
|
1275
|
+
# * {Types::Authorizer#authorizer_result_ttl_in_seconds #authorizerResultTtlInSeconds} => Integer
|
1276
|
+
#
|
1277
|
+
# @example Request syntax with placeholder values
|
1278
|
+
# resp = client.get_authorizer({
|
1279
|
+
# rest_api_id: "String", # required
|
1280
|
+
# authorizer_id: "String", # required
|
1281
|
+
# })
|
1282
|
+
#
|
1283
|
+
# @example Response structure
|
1284
|
+
# resp.id #=> String
|
1285
|
+
# resp.name #=> String
|
1286
|
+
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
1287
|
+
# resp.provider_arns #=> Array
|
1288
|
+
# resp.provider_arns[0] #=> String
|
1289
|
+
# resp.auth_type #=> String
|
1290
|
+
# resp.authorizer_uri #=> String
|
1291
|
+
# resp.authorizer_credentials #=> String
|
1292
|
+
# resp.identity_source #=> String
|
1293
|
+
# resp.identity_validation_expression #=> String
|
1294
|
+
# resp.authorizer_result_ttl_in_seconds #=> Integer
|
1295
|
+
# @overload get_authorizer(params = {})
|
1296
|
+
# @param [Hash] params ({})
|
1297
|
+
def get_authorizer(params = {}, options = {})
|
1298
|
+
req = build_request(:get_authorizer, params)
|
1299
|
+
req.send_request(options)
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# Describe an existing Authorizers resource.
|
1303
|
+
#
|
1304
|
+
# <div class="seeAlso">
|
1305
|
+
# [AWS CLI][1]
|
1306
|
+
# </div>
|
1307
|
+
#
|
1308
|
+
#
|
1309
|
+
#
|
1310
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
|
1311
|
+
# @option params [required, String] :rest_api_id
|
1312
|
+
# The RestApi identifier for the Authorizers resource.
|
1313
|
+
# @option params [String] :position
|
1314
|
+
# If not all Authorizer resources in the response were present, the
|
1315
|
+
# position will specify where to start the next page of results.
|
1316
|
+
# @option params [Integer] :limit
|
1317
|
+
# Limit the number of Authorizer resources in the response.
|
1318
|
+
# @return [Types::Authorizers] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1319
|
+
#
|
1320
|
+
# * {Types::Authorizers#position #position} => String
|
1321
|
+
# * {Types::Authorizers#items #items} => Array<Types::Authorizer>
|
1322
|
+
#
|
1323
|
+
# @example Request syntax with placeholder values
|
1324
|
+
# resp = client.get_authorizers({
|
1325
|
+
# rest_api_id: "String", # required
|
1326
|
+
# position: "String",
|
1327
|
+
# limit: 1,
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
# resp.position #=> String
|
1332
|
+
# resp.items #=> Array
|
1333
|
+
# resp.items[0].id #=> String
|
1334
|
+
# resp.items[0].name #=> String
|
1335
|
+
# resp.items[0].type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
1336
|
+
# resp.items[0].provider_arns #=> Array
|
1337
|
+
# resp.items[0].provider_arns[0] #=> String
|
1338
|
+
# resp.items[0].auth_type #=> String
|
1339
|
+
# resp.items[0].authorizer_uri #=> String
|
1340
|
+
# resp.items[0].authorizer_credentials #=> String
|
1341
|
+
# resp.items[0].identity_source #=> String
|
1342
|
+
# resp.items[0].identity_validation_expression #=> String
|
1343
|
+
# resp.items[0].authorizer_result_ttl_in_seconds #=> Integer
|
1344
|
+
# @overload get_authorizers(params = {})
|
1345
|
+
# @param [Hash] params ({})
|
1346
|
+
def get_authorizers(params = {}, options = {})
|
1347
|
+
req = build_request(:get_authorizers, params)
|
1348
|
+
req.send_request(options)
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
# Describe a BasePathMapping resource.
|
1352
|
+
# @option params [required, String] :domain_name
|
1353
|
+
# The domain name of the BasePathMapping resource to be described.
|
1354
|
+
# @option params [required, String] :base_path
|
1355
|
+
# The base path name that callers of the API must provide as part of the
|
1356
|
+
# URL after the domain name. This value must be unique for all of the
|
1357
|
+
# mappings across a single API. Leave this blank if you do not want
|
1358
|
+
# callers to specify any base path name after the domain name.
|
1359
|
+
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1360
|
+
#
|
1361
|
+
# * {Types::BasePathMapping#base_path #basePath} => String
|
1362
|
+
# * {Types::BasePathMapping#rest_api_id #restApiId} => String
|
1363
|
+
# * {Types::BasePathMapping#stage #stage} => String
|
1364
|
+
#
|
1365
|
+
# @example Request syntax with placeholder values
|
1366
|
+
# resp = client.get_base_path_mapping({
|
1367
|
+
# domain_name: "String", # required
|
1368
|
+
# base_path: "String", # required
|
1369
|
+
# })
|
1370
|
+
#
|
1371
|
+
# @example Response structure
|
1372
|
+
# resp.base_path #=> String
|
1373
|
+
# resp.rest_api_id #=> String
|
1374
|
+
# resp.stage #=> String
|
1375
|
+
# @overload get_base_path_mapping(params = {})
|
1376
|
+
# @param [Hash] params ({})
|
1377
|
+
def get_base_path_mapping(params = {}, options = {})
|
1378
|
+
req = build_request(:get_base_path_mapping, params)
|
1379
|
+
req.send_request(options)
|
1380
|
+
end
|
1381
|
+
|
1382
|
+
# Represents a collection of BasePathMapping resources.
|
1383
|
+
# @option params [required, String] :domain_name
|
1384
|
+
# The domain name of a BasePathMapping resource.
|
1385
|
+
# @option params [String] :position
|
1386
|
+
# The position of the current BasePathMapping resource in the collection
|
1387
|
+
# to get information about.
|
1388
|
+
# @option params [Integer] :limit
|
1389
|
+
# The maximum number of BasePathMapping resources in the collection to
|
1390
|
+
# get information about. The default limit is 25. It should be an
|
1391
|
+
# integer between 1 - 500.
|
1392
|
+
# @return [Types::BasePathMappings] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
|
+
#
|
1394
|
+
# * {Types::BasePathMappings#position #position} => String
|
1395
|
+
# * {Types::BasePathMappings#items #items} => Array<Types::BasePathMapping>
|
1396
|
+
#
|
1397
|
+
# @example Request syntax with placeholder values
|
1398
|
+
# resp = client.get_base_path_mappings({
|
1399
|
+
# domain_name: "String", # required
|
1400
|
+
# position: "String",
|
1401
|
+
# limit: 1,
|
1402
|
+
# })
|
1403
|
+
#
|
1404
|
+
# @example Response structure
|
1405
|
+
# resp.position #=> String
|
1406
|
+
# resp.items #=> Array
|
1407
|
+
# resp.items[0].base_path #=> String
|
1408
|
+
# resp.items[0].rest_api_id #=> String
|
1409
|
+
# resp.items[0].stage #=> String
|
1410
|
+
# @overload get_base_path_mappings(params = {})
|
1411
|
+
# @param [Hash] params ({})
|
1412
|
+
def get_base_path_mappings(params = {}, options = {})
|
1413
|
+
req = build_request(:get_base_path_mappings, params)
|
1414
|
+
req.send_request(options)
|
1415
|
+
end
|
1416
|
+
|
1417
|
+
# Gets information about the current ClientCertificate resource.
|
1418
|
+
# @option params [required, String] :client_certificate_id
|
1419
|
+
# The identifier of the ClientCertificate resource to be described.
|
1420
|
+
# @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1421
|
+
#
|
1422
|
+
# * {Types::ClientCertificate#client_certificate_id #clientCertificateId} => String
|
1423
|
+
# * {Types::ClientCertificate#description #description} => String
|
1424
|
+
# * {Types::ClientCertificate#pem_encoded_certificate #pemEncodedCertificate} => String
|
1425
|
+
# * {Types::ClientCertificate#created_date #createdDate} => Time
|
1426
|
+
# * {Types::ClientCertificate#expiration_date #expirationDate} => Time
|
1427
|
+
#
|
1428
|
+
# @example Request syntax with placeholder values
|
1429
|
+
# resp = client.get_client_certificate({
|
1430
|
+
# client_certificate_id: "String", # required
|
1431
|
+
# })
|
1432
|
+
#
|
1433
|
+
# @example Response structure
|
1434
|
+
# resp.client_certificate_id #=> String
|
1435
|
+
# resp.description #=> String
|
1436
|
+
# resp.pem_encoded_certificate #=> String
|
1437
|
+
# resp.created_date #=> Time
|
1438
|
+
# resp.expiration_date #=> Time
|
1439
|
+
# @overload get_client_certificate(params = {})
|
1440
|
+
# @param [Hash] params ({})
|
1441
|
+
def get_client_certificate(params = {}, options = {})
|
1442
|
+
req = build_request(:get_client_certificate, params)
|
1443
|
+
req.send_request(options)
|
1444
|
+
end
|
1445
|
+
|
1446
|
+
# Gets a collection of ClientCertificate resources.
|
1447
|
+
# @option params [String] :position
|
1448
|
+
# The position of the current ClientCertificate resource in the
|
1449
|
+
# collection to get information about.
|
1450
|
+
# @option params [Integer] :limit
|
1451
|
+
# The maximum number of ClientCertificate resources in the collection to
|
1452
|
+
# get information about. The default limit is 25. It should be an
|
1453
|
+
# integer between 1 - 500.
|
1454
|
+
# @return [Types::ClientCertificates] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1455
|
+
#
|
1456
|
+
# * {Types::ClientCertificates#position #position} => String
|
1457
|
+
# * {Types::ClientCertificates#items #items} => Array<Types::ClientCertificate>
|
1458
|
+
#
|
1459
|
+
# @example Request syntax with placeholder values
|
1460
|
+
# resp = client.get_client_certificates({
|
1461
|
+
# position: "String",
|
1462
|
+
# limit: 1,
|
1463
|
+
# })
|
1464
|
+
#
|
1465
|
+
# @example Response structure
|
1466
|
+
# resp.position #=> String
|
1467
|
+
# resp.items #=> Array
|
1468
|
+
# resp.items[0].client_certificate_id #=> String
|
1469
|
+
# resp.items[0].description #=> String
|
1470
|
+
# resp.items[0].pem_encoded_certificate #=> String
|
1471
|
+
# resp.items[0].created_date #=> Time
|
1472
|
+
# resp.items[0].expiration_date #=> Time
|
1473
|
+
# @overload get_client_certificates(params = {})
|
1474
|
+
# @param [Hash] params ({})
|
1475
|
+
def get_client_certificates(params = {}, options = {})
|
1476
|
+
req = build_request(:get_client_certificates, params)
|
1477
|
+
req.send_request(options)
|
1478
|
+
end
|
1479
|
+
|
1480
|
+
# Gets information about a Deployment resource.
|
1481
|
+
# @option params [required, String] :rest_api_id
|
1482
|
+
# The identifier of the RestApi resource for the Deployment resource to
|
1483
|
+
# get information about.
|
1484
|
+
# @option params [required, String] :deployment_id
|
1485
|
+
# The identifier of the Deployment resource to get information about.
|
1486
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1487
|
+
#
|
1488
|
+
# * {Types::Deployment#id #id} => String
|
1489
|
+
# * {Types::Deployment#description #description} => String
|
1490
|
+
# * {Types::Deployment#created_date #createdDate} => Time
|
1491
|
+
# * {Types::Deployment#api_summary #apiSummary} => Hash<String,Hash<String,Types::MethodSnapshot>>
|
1492
|
+
#
|
1493
|
+
# @example Request syntax with placeholder values
|
1494
|
+
# resp = client.get_deployment({
|
1495
|
+
# rest_api_id: "String", # required
|
1496
|
+
# deployment_id: "String", # required
|
1497
|
+
# })
|
1498
|
+
#
|
1499
|
+
# @example Response structure
|
1500
|
+
# resp.id #=> String
|
1501
|
+
# resp.description #=> String
|
1502
|
+
# resp.created_date #=> Time
|
1503
|
+
# resp.api_summary #=> Hash
|
1504
|
+
# resp.api_summary["String"] #=> Hash
|
1505
|
+
# resp.api_summary["String"]["String"].authorization_type #=> String
|
1506
|
+
# resp.api_summary["String"]["String"].api_key_required #=> Boolean
|
1507
|
+
# @overload get_deployment(params = {})
|
1508
|
+
# @param [Hash] params ({})
|
1509
|
+
def get_deployment(params = {}, options = {})
|
1510
|
+
req = build_request(:get_deployment, params)
|
1511
|
+
req.send_request(options)
|
1512
|
+
end
|
1513
|
+
|
1514
|
+
# Gets information about a Deployments collection.
|
1515
|
+
# @option params [required, String] :rest_api_id
|
1516
|
+
# The identifier of the RestApi resource for the collection of
|
1517
|
+
# Deployment resources to get information about.
|
1518
|
+
# @option params [String] :position
|
1519
|
+
# The position of the current Deployment resource in the collection to
|
1520
|
+
# get information about.
|
1521
|
+
# @option params [Integer] :limit
|
1522
|
+
# The maximum number of Deployment resources in the collection to get
|
1523
|
+
# information about. The default limit is 25. It should be an integer
|
1524
|
+
# between 1 - 500.
|
1525
|
+
# @return [Types::Deployments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1526
|
+
#
|
1527
|
+
# * {Types::Deployments#position #position} => String
|
1528
|
+
# * {Types::Deployments#items #items} => Array<Types::Deployment>
|
1529
|
+
#
|
1530
|
+
# @example Request syntax with placeholder values
|
1531
|
+
# resp = client.get_deployments({
|
1532
|
+
# rest_api_id: "String", # required
|
1533
|
+
# position: "String",
|
1534
|
+
# limit: 1,
|
1535
|
+
# })
|
1536
|
+
#
|
1537
|
+
# @example Response structure
|
1538
|
+
# resp.position #=> String
|
1539
|
+
# resp.items #=> Array
|
1540
|
+
# resp.items[0].id #=> String
|
1541
|
+
# resp.items[0].description #=> String
|
1542
|
+
# resp.items[0].created_date #=> Time
|
1543
|
+
# resp.items[0].api_summary #=> Hash
|
1544
|
+
# resp.items[0].api_summary["String"] #=> Hash
|
1545
|
+
# resp.items[0].api_summary["String"]["String"].authorization_type #=> String
|
1546
|
+
# resp.items[0].api_summary["String"]["String"].api_key_required #=> Boolean
|
1547
|
+
# @overload get_deployments(params = {})
|
1548
|
+
# @param [Hash] params ({})
|
1549
|
+
def get_deployments(params = {}, options = {})
|
1550
|
+
req = build_request(:get_deployments, params)
|
1551
|
+
req.send_request(options)
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# Represents a domain name that is contained in a simpler, more
|
1555
|
+
# intuitive URL that can be called.
|
1556
|
+
# @option params [required, String] :domain_name
|
1557
|
+
# The name of the DomainName resource.
|
1558
|
+
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1559
|
+
#
|
1560
|
+
# * {Types::DomainName#domain_name #domainName} => String
|
1561
|
+
# * {Types::DomainName#certificate_name #certificateName} => String
|
1562
|
+
# * {Types::DomainName#certificate_upload_date #certificateUploadDate} => Time
|
1563
|
+
# * {Types::DomainName#distribution_domain_name #distributionDomainName} => String
|
1564
|
+
#
|
1565
|
+
# @example Request syntax with placeholder values
|
1566
|
+
# resp = client.get_domain_name({
|
1567
|
+
# domain_name: "String", # required
|
1568
|
+
# })
|
1569
|
+
#
|
1570
|
+
# @example Response structure
|
1571
|
+
# resp.domain_name #=> String
|
1572
|
+
# resp.certificate_name #=> String
|
1573
|
+
# resp.certificate_upload_date #=> Time
|
1574
|
+
# resp.distribution_domain_name #=> String
|
1575
|
+
# @overload get_domain_name(params = {})
|
1576
|
+
# @param [Hash] params ({})
|
1577
|
+
def get_domain_name(params = {}, options = {})
|
1578
|
+
req = build_request(:get_domain_name, params)
|
1579
|
+
req.send_request(options)
|
1580
|
+
end
|
1581
|
+
|
1582
|
+
# Represents a collection of DomainName resources.
|
1583
|
+
# @option params [String] :position
|
1584
|
+
# The position of the current domain names to get information about.
|
1585
|
+
# @option params [Integer] :limit
|
1586
|
+
# The maximum number of DomainName resources in the collection to get
|
1587
|
+
# information about. The default limit is 25. It should be an integer
|
1588
|
+
# between 1 - 500.
|
1589
|
+
# @return [Types::DomainNames] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1590
|
+
#
|
1591
|
+
# * {Types::DomainNames#position #position} => String
|
1592
|
+
# * {Types::DomainNames#items #items} => Array<Types::DomainName>
|
1593
|
+
#
|
1594
|
+
# @example Request syntax with placeholder values
|
1595
|
+
# resp = client.get_domain_names({
|
1596
|
+
# position: "String",
|
1597
|
+
# limit: 1,
|
1598
|
+
# })
|
1599
|
+
#
|
1600
|
+
# @example Response structure
|
1601
|
+
# resp.position #=> String
|
1602
|
+
# resp.items #=> Array
|
1603
|
+
# resp.items[0].domain_name #=> String
|
1604
|
+
# resp.items[0].certificate_name #=> String
|
1605
|
+
# resp.items[0].certificate_upload_date #=> Time
|
1606
|
+
# resp.items[0].distribution_domain_name #=> String
|
1607
|
+
# @overload get_domain_names(params = {})
|
1608
|
+
# @param [Hash] params ({})
|
1609
|
+
def get_domain_names(params = {}, options = {})
|
1610
|
+
req = build_request(:get_domain_names, params)
|
1611
|
+
req.send_request(options)
|
1612
|
+
end
|
1613
|
+
|
1614
|
+
# Exports a deployed version of a RestApi in a specified format.
|
1615
|
+
# @option params [required, String] :rest_api_id
|
1616
|
+
# The identifier of the RestApi to be exported.
|
1617
|
+
# @option params [required, String] :stage_name
|
1618
|
+
# The name of the Stage that will be exported.
|
1619
|
+
# @option params [required, String] :export_type
|
1620
|
+
# The type of export. Currently only 'swagger' is supported.
|
1621
|
+
# @option params [Hash<String,String>] :parameters
|
1622
|
+
# A key-value map of query string parameters that specify properties of
|
1623
|
+
# the export, depending on the requested `exportType`. For `exportType`
|
1624
|
+
# `swagger`, any combination of the following parameters are supported:
|
1625
|
+
# `integrations` will export the API with
|
1626
|
+
# x-amazon-apigateway-integration extensions. `authorizers` will export
|
1627
|
+
# the API with x-amazon-apigateway-authorizer extensions. `postman` will
|
1628
|
+
# export the API with Postman extensions, allowing for import to the
|
1629
|
+
# Postman tool
|
1630
|
+
# @option params [String] :accepts
|
1631
|
+
# The content-type of the export, for example `application/json`.
|
1632
|
+
# Currently `application/json` and `application/yaml` are supported for
|
1633
|
+
# `exportType` of `swagger`. This should be specified in the `Accept`
|
1634
|
+
# header for direct API requests.
|
1635
|
+
# @return [Types::ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1636
|
+
#
|
1637
|
+
# * {Types::ExportResponse#content_type #contentType} => String
|
1638
|
+
# * {Types::ExportResponse#content_disposition #contentDisposition} => String
|
1639
|
+
# * {Types::ExportResponse#body #body} => String
|
1640
|
+
#
|
1641
|
+
# @example Request syntax with placeholder values
|
1642
|
+
# resp = client.get_export({
|
1643
|
+
# rest_api_id: "String", # required
|
1644
|
+
# stage_name: "String", # required
|
1645
|
+
# export_type: "String", # required
|
1646
|
+
# parameters: {
|
1647
|
+
# "String" => "String",
|
1648
|
+
# },
|
1649
|
+
# accepts: "String",
|
1650
|
+
# })
|
1651
|
+
#
|
1652
|
+
# @example Response structure
|
1653
|
+
# resp.content_type #=> String
|
1654
|
+
# resp.content_disposition #=> String
|
1655
|
+
# resp.body #=> String
|
1656
|
+
# @overload get_export(params = {})
|
1657
|
+
# @param [Hash] params ({})
|
1658
|
+
def get_export(params = {}, options = {})
|
1659
|
+
req = build_request(:get_export, params)
|
1660
|
+
req.send_request(options)
|
1661
|
+
end
|
1662
|
+
|
1663
|
+
# Represents a get integration.
|
1664
|
+
# @option params [required, String] :rest_api_id
|
1665
|
+
# Specifies a get integration request's API identifier.
|
1666
|
+
# @option params [required, String] :resource_id
|
1667
|
+
# Specifies a get integration request's resource identifier
|
1668
|
+
# @option params [required, String] :http_method
|
1669
|
+
# Specifies a get integration request's HTTP method.
|
1670
|
+
# @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1671
|
+
#
|
1672
|
+
# * {Types::Integration#type #type} => String
|
1673
|
+
# * {Types::Integration#http_method #httpMethod} => String
|
1674
|
+
# * {Types::Integration#uri #uri} => String
|
1675
|
+
# * {Types::Integration#credentials #credentials} => String
|
1676
|
+
# * {Types::Integration#request_parameters #requestParameters} => Hash<String,String>
|
1677
|
+
# * {Types::Integration#request_templates #requestTemplates} => Hash<String,String>
|
1678
|
+
# * {Types::Integration#passthrough_behavior #passthroughBehavior} => String
|
1679
|
+
# * {Types::Integration#content_handling #contentHandling} => String
|
1680
|
+
# * {Types::Integration#cache_namespace #cacheNamespace} => String
|
1681
|
+
# * {Types::Integration#cache_key_parameters #cacheKeyParameters} => Array<String>
|
1682
|
+
# * {Types::Integration#integration_responses #integrationResponses} => Hash<String,Types::IntegrationResponse>
|
1683
|
+
#
|
1684
|
+
# @example Request syntax with placeholder values
|
1685
|
+
# resp = client.get_integration({
|
1686
|
+
# rest_api_id: "String", # required
|
1687
|
+
# resource_id: "String", # required
|
1688
|
+
# http_method: "String", # required
|
1689
|
+
# })
|
1690
|
+
#
|
1691
|
+
# @example Response structure
|
1692
|
+
# resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
1693
|
+
# resp.http_method #=> String
|
1694
|
+
# resp.uri #=> String
|
1695
|
+
# resp.credentials #=> String
|
1696
|
+
# resp.request_parameters #=> Hash
|
1697
|
+
# resp.request_parameters["String"] #=> String
|
1698
|
+
# resp.request_templates #=> Hash
|
1699
|
+
# resp.request_templates["String"] #=> String
|
1700
|
+
# resp.passthrough_behavior #=> String
|
1701
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
1702
|
+
# resp.cache_namespace #=> String
|
1703
|
+
# resp.cache_key_parameters #=> Array
|
1704
|
+
# resp.cache_key_parameters[0] #=> String
|
1705
|
+
# resp.integration_responses #=> Hash
|
1706
|
+
# resp.integration_responses["String"].status_code #=> String
|
1707
|
+
# resp.integration_responses["String"].selection_pattern #=> String
|
1708
|
+
# resp.integration_responses["String"].response_parameters #=> Hash
|
1709
|
+
# resp.integration_responses["String"].response_parameters["String"] #=> String
|
1710
|
+
# resp.integration_responses["String"].response_templates #=> Hash
|
1711
|
+
# resp.integration_responses["String"].response_templates["String"] #=> String
|
1712
|
+
# resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
1713
|
+
# @overload get_integration(params = {})
|
1714
|
+
# @param [Hash] params ({})
|
1715
|
+
def get_integration(params = {}, options = {})
|
1716
|
+
req = build_request(:get_integration, params)
|
1717
|
+
req.send_request(options)
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# Represents a get integration response.
|
1721
|
+
# @option params [required, String] :rest_api_id
|
1722
|
+
# Specifies a get integration response request's API identifier.
|
1723
|
+
# @option params [required, String] :resource_id
|
1724
|
+
# Specifies a get integration response request's resource identifier.
|
1725
|
+
# @option params [required, String] :http_method
|
1726
|
+
# Specifies a get integration response request's HTTP method.
|
1727
|
+
# @option params [required, String] :status_code
|
1728
|
+
# Specifies a get integration response request's status code.
|
1729
|
+
# @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1730
|
+
#
|
1731
|
+
# * {Types::IntegrationResponse#status_code #statusCode} => String
|
1732
|
+
# * {Types::IntegrationResponse#selection_pattern #selectionPattern} => String
|
1733
|
+
# * {Types::IntegrationResponse#response_parameters #responseParameters} => Hash<String,String>
|
1734
|
+
# * {Types::IntegrationResponse#response_templates #responseTemplates} => Hash<String,String>
|
1735
|
+
# * {Types::IntegrationResponse#content_handling #contentHandling} => String
|
1736
|
+
#
|
1737
|
+
# @example Request syntax with placeholder values
|
1738
|
+
# resp = client.get_integration_response({
|
1739
|
+
# rest_api_id: "String", # required
|
1740
|
+
# resource_id: "String", # required
|
1741
|
+
# http_method: "String", # required
|
1742
|
+
# status_code: "StatusCode", # required
|
1743
|
+
# })
|
1744
|
+
#
|
1745
|
+
# @example Response structure
|
1746
|
+
# resp.status_code #=> String
|
1747
|
+
# resp.selection_pattern #=> String
|
1748
|
+
# resp.response_parameters #=> Hash
|
1749
|
+
# resp.response_parameters["String"] #=> String
|
1750
|
+
# resp.response_templates #=> Hash
|
1751
|
+
# resp.response_templates["String"] #=> String
|
1752
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
1753
|
+
# @overload get_integration_response(params = {})
|
1754
|
+
# @param [Hash] params ({})
|
1755
|
+
def get_integration_response(params = {}, options = {})
|
1756
|
+
req = build_request(:get_integration_response, params)
|
1757
|
+
req.send_request(options)
|
1758
|
+
end
|
1759
|
+
|
1760
|
+
# Describe an existing Method resource.
|
1761
|
+
# @option params [required, String] :rest_api_id
|
1762
|
+
# The RestApi identifier for the Method resource.
|
1763
|
+
# @option params [required, String] :resource_id
|
1764
|
+
# The Resource identifier for the Method resource.
|
1765
|
+
# @option params [required, String] :http_method
|
1766
|
+
# Specifies the method request's HTTP method type.
|
1767
|
+
# @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1768
|
+
#
|
1769
|
+
# * {Types::Method#http_method #httpMethod} => String
|
1770
|
+
# * {Types::Method#authorization_type #authorizationType} => String
|
1771
|
+
# * {Types::Method#authorizer_id #authorizerId} => String
|
1772
|
+
# * {Types::Method#api_key_required #apiKeyRequired} => Boolean
|
1773
|
+
# * {Types::Method#request_parameters #requestParameters} => Hash<String,Boolean>
|
1774
|
+
# * {Types::Method#request_models #requestModels} => Hash<String,String>
|
1775
|
+
# * {Types::Method#method_responses #methodResponses} => Hash<String,Types::MethodResponse>
|
1776
|
+
# * {Types::Method#method_integration #methodIntegration} => Types::Integration
|
1777
|
+
#
|
1778
|
+
# @example Request syntax with placeholder values
|
1779
|
+
# resp = client.get_method({
|
1780
|
+
# rest_api_id: "String", # required
|
1781
|
+
# resource_id: "String", # required
|
1782
|
+
# http_method: "String", # required
|
1783
|
+
# })
|
1784
|
+
#
|
1785
|
+
# @example Response structure
|
1786
|
+
# resp.http_method #=> String
|
1787
|
+
# resp.authorization_type #=> String
|
1788
|
+
# resp.authorizer_id #=> String
|
1789
|
+
# resp.api_key_required #=> Boolean
|
1790
|
+
# resp.request_parameters #=> Hash
|
1791
|
+
# resp.request_parameters["String"] #=> Boolean
|
1792
|
+
# resp.request_models #=> Hash
|
1793
|
+
# resp.request_models["String"] #=> String
|
1794
|
+
# resp.method_responses #=> Hash
|
1795
|
+
# resp.method_responses["String"].status_code #=> String
|
1796
|
+
# resp.method_responses["String"].response_parameters #=> Hash
|
1797
|
+
# resp.method_responses["String"].response_parameters["String"] #=> Boolean
|
1798
|
+
# resp.method_responses["String"].response_models #=> Hash
|
1799
|
+
# resp.method_responses["String"].response_models["String"] #=> String
|
1800
|
+
# resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
1801
|
+
# resp.method_integration.http_method #=> String
|
1802
|
+
# resp.method_integration.uri #=> String
|
1803
|
+
# resp.method_integration.credentials #=> String
|
1804
|
+
# resp.method_integration.request_parameters #=> Hash
|
1805
|
+
# resp.method_integration.request_parameters["String"] #=> String
|
1806
|
+
# resp.method_integration.request_templates #=> Hash
|
1807
|
+
# resp.method_integration.request_templates["String"] #=> String
|
1808
|
+
# resp.method_integration.passthrough_behavior #=> String
|
1809
|
+
# resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
1810
|
+
# resp.method_integration.cache_namespace #=> String
|
1811
|
+
# resp.method_integration.cache_key_parameters #=> Array
|
1812
|
+
# resp.method_integration.cache_key_parameters[0] #=> String
|
1813
|
+
# resp.method_integration.integration_responses #=> Hash
|
1814
|
+
# resp.method_integration.integration_responses["String"].status_code #=> String
|
1815
|
+
# resp.method_integration.integration_responses["String"].selection_pattern #=> String
|
1816
|
+
# resp.method_integration.integration_responses["String"].response_parameters #=> Hash
|
1817
|
+
# resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
1818
|
+
# resp.method_integration.integration_responses["String"].response_templates #=> Hash
|
1819
|
+
# resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
|
1820
|
+
# resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
1821
|
+
# @overload get_method(params = {})
|
1822
|
+
# @param [Hash] params ({})
|
1823
|
+
def get_method(params = {}, options = {})
|
1824
|
+
req = build_request(:get_method, params)
|
1825
|
+
req.send_request(options)
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# Describes a MethodResponse resource.
|
1829
|
+
# @option params [required, String] :rest_api_id
|
1830
|
+
# The RestApi identifier for the MethodResponse resource.
|
1831
|
+
# @option params [required, String] :resource_id
|
1832
|
+
# The Resource identifier for the MethodResponse resource.
|
1833
|
+
# @option params [required, String] :http_method
|
1834
|
+
# The HTTP verb of the Method resource.
|
1835
|
+
# @option params [required, String] :status_code
|
1836
|
+
# The status code for the MethodResponse resource.
|
1837
|
+
# @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1838
|
+
#
|
1839
|
+
# * {Types::MethodResponse#status_code #statusCode} => String
|
1840
|
+
# * {Types::MethodResponse#response_parameters #responseParameters} => Hash<String,Boolean>
|
1841
|
+
# * {Types::MethodResponse#response_models #responseModels} => Hash<String,String>
|
1842
|
+
#
|
1843
|
+
# @example Request syntax with placeholder values
|
1844
|
+
# resp = client.get_method_response({
|
1845
|
+
# rest_api_id: "String", # required
|
1846
|
+
# resource_id: "String", # required
|
1847
|
+
# http_method: "String", # required
|
1848
|
+
# status_code: "StatusCode", # required
|
1849
|
+
# })
|
1850
|
+
#
|
1851
|
+
# @example Response structure
|
1852
|
+
# resp.status_code #=> String
|
1853
|
+
# resp.response_parameters #=> Hash
|
1854
|
+
# resp.response_parameters["String"] #=> Boolean
|
1855
|
+
# resp.response_models #=> Hash
|
1856
|
+
# resp.response_models["String"] #=> String
|
1857
|
+
# @overload get_method_response(params = {})
|
1858
|
+
# @param [Hash] params ({})
|
1859
|
+
def get_method_response(params = {}, options = {})
|
1860
|
+
req = build_request(:get_method_response, params)
|
1861
|
+
req.send_request(options)
|
1862
|
+
end
|
1863
|
+
|
1864
|
+
# Describes an existing model defined for a RestApi resource.
|
1865
|
+
# @option params [required, String] :rest_api_id
|
1866
|
+
# The RestApi identifier under which the Model exists.
|
1867
|
+
# @option params [required, String] :model_name
|
1868
|
+
# The name of the model as an identifier.
|
1869
|
+
# @option params [Boolean] :flatten
|
1870
|
+
# A query parameter of a Boolean value to resolve (`true`) all external
|
1871
|
+
# model references and returns a flattened model schema or not (`false`)
|
1872
|
+
# The default is `false`.
|
1873
|
+
# @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1874
|
+
#
|
1875
|
+
# * {Types::Model#id #id} => String
|
1876
|
+
# * {Types::Model#name #name} => String
|
1877
|
+
# * {Types::Model#description #description} => String
|
1878
|
+
# * {Types::Model#schema #schema} => String
|
1879
|
+
# * {Types::Model#content_type #contentType} => String
|
1880
|
+
#
|
1881
|
+
# @example Request syntax with placeholder values
|
1882
|
+
# resp = client.get_model({
|
1883
|
+
# rest_api_id: "String", # required
|
1884
|
+
# model_name: "String", # required
|
1885
|
+
# flatten: false,
|
1886
|
+
# })
|
1887
|
+
#
|
1888
|
+
# @example Response structure
|
1889
|
+
# resp.id #=> String
|
1890
|
+
# resp.name #=> String
|
1891
|
+
# resp.description #=> String
|
1892
|
+
# resp.schema #=> String
|
1893
|
+
# resp.content_type #=> String
|
1894
|
+
# @overload get_model(params = {})
|
1895
|
+
# @param [Hash] params ({})
|
1896
|
+
def get_model(params = {}, options = {})
|
1897
|
+
req = build_request(:get_model, params)
|
1898
|
+
req.send_request(options)
|
1899
|
+
end
|
1900
|
+
|
1901
|
+
# Generates a sample mapping template that can be used to transform a
|
1902
|
+
# payload into the structure of a model.
|
1903
|
+
# @option params [required, String] :rest_api_id
|
1904
|
+
# The ID of the RestApi under which the model exists.
|
1905
|
+
# @option params [required, String] :model_name
|
1906
|
+
# The name of the model for which to generate a template.
|
1907
|
+
# @return [Types::Template] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1908
|
+
#
|
1909
|
+
# * {Types::Template#value #value} => String
|
1910
|
+
#
|
1911
|
+
# @example Request syntax with placeholder values
|
1912
|
+
# resp = client.get_model_template({
|
1913
|
+
# rest_api_id: "String", # required
|
1914
|
+
# model_name: "String", # required
|
1915
|
+
# })
|
1916
|
+
#
|
1917
|
+
# @example Response structure
|
1918
|
+
# resp.value #=> String
|
1919
|
+
# @overload get_model_template(params = {})
|
1920
|
+
# @param [Hash] params ({})
|
1921
|
+
def get_model_template(params = {}, options = {})
|
1922
|
+
req = build_request(:get_model_template, params)
|
1923
|
+
req.send_request(options)
|
1924
|
+
end
|
1925
|
+
|
1926
|
+
# Describes existing Models defined for a RestApi resource.
|
1927
|
+
# @option params [required, String] :rest_api_id
|
1928
|
+
# The RestApi identifier.
|
1929
|
+
# @option params [String] :position
|
1930
|
+
# The position of the next set of results in the Models resource to get
|
1931
|
+
# information about.
|
1932
|
+
# @option params [Integer] :limit
|
1933
|
+
# The maximum number of models in the collection to get information
|
1934
|
+
# about. The default limit is 25. It should be an integer between 1 -
|
1935
|
+
# 500.
|
1936
|
+
# @return [Types::Models] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1937
|
+
#
|
1938
|
+
# * {Types::Models#position #position} => String
|
1939
|
+
# * {Types::Models#items #items} => Array<Types::Model>
|
1940
|
+
#
|
1941
|
+
# @example Request syntax with placeholder values
|
1942
|
+
# resp = client.get_models({
|
1943
|
+
# rest_api_id: "String", # required
|
1944
|
+
# position: "String",
|
1945
|
+
# limit: 1,
|
1946
|
+
# })
|
1947
|
+
#
|
1948
|
+
# @example Response structure
|
1949
|
+
# resp.position #=> String
|
1950
|
+
# resp.items #=> Array
|
1951
|
+
# resp.items[0].id #=> String
|
1952
|
+
# resp.items[0].name #=> String
|
1953
|
+
# resp.items[0].description #=> String
|
1954
|
+
# resp.items[0].schema #=> String
|
1955
|
+
# resp.items[0].content_type #=> String
|
1956
|
+
# @overload get_models(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def get_models(params = {}, options = {})
|
1959
|
+
req = build_request(:get_models, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1963
|
+
# Lists information about a resource.
|
1964
|
+
# @option params [required, String] :rest_api_id
|
1965
|
+
# The RestApi identifier for the resource.
|
1966
|
+
# @option params [required, String] :resource_id
|
1967
|
+
# The identifier for the Resource resource.
|
1968
|
+
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1969
|
+
#
|
1970
|
+
# * {Types::Resource#id #id} => String
|
1971
|
+
# * {Types::Resource#parent_id #parentId} => String
|
1972
|
+
# * {Types::Resource#path_part #pathPart} => String
|
1973
|
+
# * {Types::Resource#path #path} => String
|
1974
|
+
# * {Types::Resource#resource_methods #resourceMethods} => Hash<String,Types::Method>
|
1975
|
+
#
|
1976
|
+
# @example Request syntax with placeholder values
|
1977
|
+
# resp = client.get_resource({
|
1978
|
+
# rest_api_id: "String", # required
|
1979
|
+
# resource_id: "String", # required
|
1980
|
+
# })
|
1981
|
+
#
|
1982
|
+
# @example Response structure
|
1983
|
+
# resp.id #=> String
|
1984
|
+
# resp.parent_id #=> String
|
1985
|
+
# resp.path_part #=> String
|
1986
|
+
# resp.path #=> String
|
1987
|
+
# resp.resource_methods #=> Hash
|
1988
|
+
# resp.resource_methods["String"].http_method #=> String
|
1989
|
+
# resp.resource_methods["String"].authorization_type #=> String
|
1990
|
+
# resp.resource_methods["String"].authorizer_id #=> String
|
1991
|
+
# resp.resource_methods["String"].api_key_required #=> Boolean
|
1992
|
+
# resp.resource_methods["String"].request_parameters #=> Hash
|
1993
|
+
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
1994
|
+
# resp.resource_methods["String"].request_models #=> Hash
|
1995
|
+
# resp.resource_methods["String"].request_models["String"] #=> String
|
1996
|
+
# resp.resource_methods["String"].method_responses #=> Hash
|
1997
|
+
# resp.resource_methods["String"].method_responses["String"].status_code #=> String
|
1998
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
|
1999
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
|
2000
|
+
# resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
|
2001
|
+
# resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
|
2002
|
+
# resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
2003
|
+
# resp.resource_methods["String"].method_integration.http_method #=> String
|
2004
|
+
# resp.resource_methods["String"].method_integration.uri #=> String
|
2005
|
+
# resp.resource_methods["String"].method_integration.credentials #=> String
|
2006
|
+
# resp.resource_methods["String"].method_integration.request_parameters #=> Hash
|
2007
|
+
# resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
|
2008
|
+
# resp.resource_methods["String"].method_integration.request_templates #=> Hash
|
2009
|
+
# resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
|
2010
|
+
# resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
|
2011
|
+
# resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2012
|
+
# resp.resource_methods["String"].method_integration.cache_namespace #=> String
|
2013
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
|
2014
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
|
2015
|
+
# resp.resource_methods["String"].method_integration.integration_responses #=> Hash
|
2016
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
|
2017
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
|
2018
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
|
2019
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
2020
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
|
2021
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
|
2022
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2023
|
+
# @overload get_resource(params = {})
|
2024
|
+
# @param [Hash] params ({})
|
2025
|
+
def get_resource(params = {}, options = {})
|
2026
|
+
req = build_request(:get_resource, params)
|
2027
|
+
req.send_request(options)
|
2028
|
+
end
|
2029
|
+
|
2030
|
+
# Lists information about a collection of Resource resources.
|
2031
|
+
# @option params [required, String] :rest_api_id
|
2032
|
+
# The RestApi identifier for the Resource.
|
2033
|
+
# @option params [String] :position
|
2034
|
+
# The position of the next set of results in the current Resources
|
2035
|
+
# resource to get information about.
|
2036
|
+
# @option params [Integer] :limit
|
2037
|
+
# The maximum number of Resource resources in the collection to get
|
2038
|
+
# information about. The default limit is 25. It should be an integer
|
2039
|
+
# between 1 - 500.
|
2040
|
+
# @return [Types::Resources] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2041
|
+
#
|
2042
|
+
# * {Types::Resources#position #position} => String
|
2043
|
+
# * {Types::Resources#items #items} => Array<Types::Resource>
|
2044
|
+
#
|
2045
|
+
# @example Request syntax with placeholder values
|
2046
|
+
# resp = client.get_resources({
|
2047
|
+
# rest_api_id: "String", # required
|
2048
|
+
# position: "String",
|
2049
|
+
# limit: 1,
|
2050
|
+
# })
|
2051
|
+
#
|
2052
|
+
# @example Response structure
|
2053
|
+
# resp.position #=> String
|
2054
|
+
# resp.items #=> Array
|
2055
|
+
# resp.items[0].id #=> String
|
2056
|
+
# resp.items[0].parent_id #=> String
|
2057
|
+
# resp.items[0].path_part #=> String
|
2058
|
+
# resp.items[0].path #=> String
|
2059
|
+
# resp.items[0].resource_methods #=> Hash
|
2060
|
+
# resp.items[0].resource_methods["String"].http_method #=> String
|
2061
|
+
# resp.items[0].resource_methods["String"].authorization_type #=> String
|
2062
|
+
# resp.items[0].resource_methods["String"].authorizer_id #=> String
|
2063
|
+
# resp.items[0].resource_methods["String"].api_key_required #=> Boolean
|
2064
|
+
# resp.items[0].resource_methods["String"].request_parameters #=> Hash
|
2065
|
+
# resp.items[0].resource_methods["String"].request_parameters["String"] #=> Boolean
|
2066
|
+
# resp.items[0].resource_methods["String"].request_models #=> Hash
|
2067
|
+
# resp.items[0].resource_methods["String"].request_models["String"] #=> String
|
2068
|
+
# resp.items[0].resource_methods["String"].method_responses #=> Hash
|
2069
|
+
# resp.items[0].resource_methods["String"].method_responses["String"].status_code #=> String
|
2070
|
+
# resp.items[0].resource_methods["String"].method_responses["String"].response_parameters #=> Hash
|
2071
|
+
# resp.items[0].resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
|
2072
|
+
# resp.items[0].resource_methods["String"].method_responses["String"].response_models #=> Hash
|
2073
|
+
# resp.items[0].resource_methods["String"].method_responses["String"].response_models["String"] #=> String
|
2074
|
+
# resp.items[0].resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
2075
|
+
# resp.items[0].resource_methods["String"].method_integration.http_method #=> String
|
2076
|
+
# resp.items[0].resource_methods["String"].method_integration.uri #=> String
|
2077
|
+
# resp.items[0].resource_methods["String"].method_integration.credentials #=> String
|
2078
|
+
# resp.items[0].resource_methods["String"].method_integration.request_parameters #=> Hash
|
2079
|
+
# resp.items[0].resource_methods["String"].method_integration.request_parameters["String"] #=> String
|
2080
|
+
# resp.items[0].resource_methods["String"].method_integration.request_templates #=> Hash
|
2081
|
+
# resp.items[0].resource_methods["String"].method_integration.request_templates["String"] #=> String
|
2082
|
+
# resp.items[0].resource_methods["String"].method_integration.passthrough_behavior #=> String
|
2083
|
+
# resp.items[0].resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2084
|
+
# resp.items[0].resource_methods["String"].method_integration.cache_namespace #=> String
|
2085
|
+
# resp.items[0].resource_methods["String"].method_integration.cache_key_parameters #=> Array
|
2086
|
+
# resp.items[0].resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
|
2087
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses #=> Hash
|
2088
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
|
2089
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
|
2090
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
|
2091
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
2092
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
|
2093
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
|
2094
|
+
# resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2095
|
+
# @overload get_resources(params = {})
|
2096
|
+
# @param [Hash] params ({})
|
2097
|
+
def get_resources(params = {}, options = {})
|
2098
|
+
req = build_request(:get_resources, params)
|
2099
|
+
req.send_request(options)
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Lists the RestApi resource in the collection.
|
2103
|
+
# @option params [required, String] :rest_api_id
|
2104
|
+
# The identifier of the RestApi resource.
|
2105
|
+
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2106
|
+
#
|
2107
|
+
# * {Types::RestApi#id #id} => String
|
2108
|
+
# * {Types::RestApi#name #name} => String
|
2109
|
+
# * {Types::RestApi#description #description} => String
|
2110
|
+
# * {Types::RestApi#created_date #createdDate} => Time
|
2111
|
+
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2112
|
+
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2113
|
+
#
|
2114
|
+
# @example Request syntax with placeholder values
|
2115
|
+
# resp = client.get_rest_api({
|
2116
|
+
# rest_api_id: "String", # required
|
2117
|
+
# })
|
2118
|
+
#
|
2119
|
+
# @example Response structure
|
2120
|
+
# resp.id #=> String
|
2121
|
+
# resp.name #=> String
|
2122
|
+
# resp.description #=> String
|
2123
|
+
# resp.created_date #=> Time
|
2124
|
+
# resp.warnings #=> Array
|
2125
|
+
# resp.warnings[0] #=> String
|
2126
|
+
# resp.binary_media_types #=> Array
|
2127
|
+
# resp.binary_media_types[0] #=> String
|
2128
|
+
# @overload get_rest_api(params = {})
|
2129
|
+
# @param [Hash] params ({})
|
2130
|
+
def get_rest_api(params = {}, options = {})
|
2131
|
+
req = build_request(:get_rest_api, params)
|
2132
|
+
req.send_request(options)
|
2133
|
+
end
|
2134
|
+
|
2135
|
+
# Lists the RestApis resources for your collection.
|
2136
|
+
# @option params [String] :position
|
2137
|
+
# The position of the current RestApis resource in the collection to get
|
2138
|
+
# information about.
|
2139
|
+
# @option params [Integer] :limit
|
2140
|
+
# The maximum number of RestApi resources in the collection to get
|
2141
|
+
# information about. The default limit is 25. It should be an integer
|
2142
|
+
# between 1 - 500.
|
2143
|
+
# @return [Types::RestApis] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2144
|
+
#
|
2145
|
+
# * {Types::RestApis#position #position} => String
|
2146
|
+
# * {Types::RestApis#items #items} => Array<Types::RestApi>
|
2147
|
+
#
|
2148
|
+
# @example Request syntax with placeholder values
|
2149
|
+
# resp = client.get_rest_apis({
|
2150
|
+
# position: "String",
|
2151
|
+
# limit: 1,
|
2152
|
+
# })
|
2153
|
+
#
|
2154
|
+
# @example Response structure
|
2155
|
+
# resp.position #=> String
|
2156
|
+
# resp.items #=> Array
|
2157
|
+
# resp.items[0].id #=> String
|
2158
|
+
# resp.items[0].name #=> String
|
2159
|
+
# resp.items[0].description #=> String
|
2160
|
+
# resp.items[0].created_date #=> Time
|
2161
|
+
# resp.items[0].warnings #=> Array
|
2162
|
+
# resp.items[0].warnings[0] #=> String
|
2163
|
+
# resp.items[0].binary_media_types #=> Array
|
2164
|
+
# resp.items[0].binary_media_types[0] #=> String
|
2165
|
+
# @overload get_rest_apis(params = {})
|
2166
|
+
# @param [Hash] params ({})
|
2167
|
+
def get_rest_apis(params = {}, options = {})
|
2168
|
+
req = build_request(:get_rest_apis, params)
|
2169
|
+
req.send_request(options)
|
2170
|
+
end
|
2171
|
+
|
2172
|
+
# Generates a client SDK for a RestApi and Stage.
|
2173
|
+
# @option params [required, String] :rest_api_id
|
2174
|
+
# The identifier of the RestApi that the SDK will use.
|
2175
|
+
# @option params [required, String] :stage_name
|
2176
|
+
# The name of the Stage that the SDK will use.
|
2177
|
+
# @option params [required, String] :sdk_type
|
2178
|
+
# The language for the generated SDK. Currently `javascript`, `android`,
|
2179
|
+
# and `objectivec` (for iOS) are supported.
|
2180
|
+
# @option params [Hash<String,String>] :parameters
|
2181
|
+
# A key-value map of query string parameters that specify properties of
|
2182
|
+
# the SDK, depending on the requested `sdkType`. For `sdkType` of
|
2183
|
+
# `objectivec`, a parameter named `classPrefix` is required. For
|
2184
|
+
# `sdkType` of `android`, parameters named `groupId`, `artifactId`,
|
2185
|
+
# `artifactVersion`, and `invokerPackage` are required.
|
2186
|
+
# @return [Types::SdkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2187
|
+
#
|
2188
|
+
# * {Types::SdkResponse#content_type #contentType} => String
|
2189
|
+
# * {Types::SdkResponse#content_disposition #contentDisposition} => String
|
2190
|
+
# * {Types::SdkResponse#body #body} => String
|
2191
|
+
#
|
2192
|
+
# @example Request syntax with placeholder values
|
2193
|
+
# resp = client.get_sdk({
|
2194
|
+
# rest_api_id: "String", # required
|
2195
|
+
# stage_name: "String", # required
|
2196
|
+
# sdk_type: "String", # required
|
2197
|
+
# parameters: {
|
2198
|
+
# "String" => "String",
|
2199
|
+
# },
|
2200
|
+
# })
|
2201
|
+
#
|
2202
|
+
# @example Response structure
|
2203
|
+
# resp.content_type #=> String
|
2204
|
+
# resp.content_disposition #=> String
|
2205
|
+
# resp.body #=> String
|
2206
|
+
# @overload get_sdk(params = {})
|
2207
|
+
# @param [Hash] params ({})
|
2208
|
+
def get_sdk(params = {}, options = {})
|
2209
|
+
req = build_request(:get_sdk, params)
|
2210
|
+
req.send_request(options)
|
2211
|
+
end
|
2212
|
+
|
2213
|
+
# Gets information about a Stage resource.
|
2214
|
+
# @option params [required, String] :rest_api_id
|
2215
|
+
# The identifier of the RestApi resource for the Stage resource to get
|
2216
|
+
# information about.
|
2217
|
+
# @option params [required, String] :stage_name
|
2218
|
+
# The name of the Stage resource to get information about.
|
2219
|
+
# @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2220
|
+
#
|
2221
|
+
# * {Types::Stage#deployment_id #deploymentId} => String
|
2222
|
+
# * {Types::Stage#client_certificate_id #clientCertificateId} => String
|
2223
|
+
# * {Types::Stage#stage_name #stageName} => String
|
2224
|
+
# * {Types::Stage#description #description} => String
|
2225
|
+
# * {Types::Stage#cache_cluster_enabled #cacheClusterEnabled} => Boolean
|
2226
|
+
# * {Types::Stage#cache_cluster_size #cacheClusterSize} => String
|
2227
|
+
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
2228
|
+
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
2229
|
+
# * {Types::Stage#variables #variables} => Hash<String,String>
|
2230
|
+
# * {Types::Stage#created_date #createdDate} => Time
|
2231
|
+
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
2232
|
+
#
|
2233
|
+
# @example Request syntax with placeholder values
|
2234
|
+
# resp = client.get_stage({
|
2235
|
+
# rest_api_id: "String", # required
|
2236
|
+
# stage_name: "String", # required
|
2237
|
+
# })
|
2238
|
+
#
|
2239
|
+
# @example Response structure
|
2240
|
+
# resp.deployment_id #=> String
|
2241
|
+
# resp.client_certificate_id #=> String
|
2242
|
+
# resp.stage_name #=> String
|
2243
|
+
# resp.description #=> String
|
2244
|
+
# resp.cache_cluster_enabled #=> Boolean
|
2245
|
+
# resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
|
2246
|
+
# resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
|
2247
|
+
# resp.method_settings #=> Hash
|
2248
|
+
# resp.method_settings["String"].metrics_enabled #=> Boolean
|
2249
|
+
# resp.method_settings["String"].logging_level #=> String
|
2250
|
+
# resp.method_settings["String"].data_trace_enabled #=> Boolean
|
2251
|
+
# resp.method_settings["String"].throttling_burst_limit #=> Integer
|
2252
|
+
# resp.method_settings["String"].throttling_rate_limit #=> Float
|
2253
|
+
# resp.method_settings["String"].caching_enabled #=> Boolean
|
2254
|
+
# resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
|
2255
|
+
# resp.method_settings["String"].cache_data_encrypted #=> Boolean
|
2256
|
+
# resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
|
2257
|
+
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
2258
|
+
# resp.variables #=> Hash
|
2259
|
+
# resp.variables["String"] #=> String
|
2260
|
+
# resp.created_date #=> Time
|
2261
|
+
# resp.last_updated_date #=> Time
|
2262
|
+
# @overload get_stage(params = {})
|
2263
|
+
# @param [Hash] params ({})
|
2264
|
+
def get_stage(params = {}, options = {})
|
2265
|
+
req = build_request(:get_stage, params)
|
2266
|
+
req.send_request(options)
|
2267
|
+
end
|
2268
|
+
|
2269
|
+
# Gets information about one or more Stage resources.
|
2270
|
+
# @option params [required, String] :rest_api_id
|
2271
|
+
# The stages' API identifiers.
|
2272
|
+
# @option params [String] :deployment_id
|
2273
|
+
# The stages' deployment identifiers.
|
2274
|
+
# @return [Types::Stages] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2275
|
+
#
|
2276
|
+
# * {Types::Stages#item #item} => Array<Types::Stage>
|
2277
|
+
#
|
2278
|
+
# @example Request syntax with placeholder values
|
2279
|
+
# resp = client.get_stages({
|
2280
|
+
# rest_api_id: "String", # required
|
2281
|
+
# deployment_id: "String",
|
2282
|
+
# })
|
2283
|
+
#
|
2284
|
+
# @example Response structure
|
2285
|
+
# resp.item #=> Array
|
2286
|
+
# resp.item[0].deployment_id #=> String
|
2287
|
+
# resp.item[0].client_certificate_id #=> String
|
2288
|
+
# resp.item[0].stage_name #=> String
|
2289
|
+
# resp.item[0].description #=> String
|
2290
|
+
# resp.item[0].cache_cluster_enabled #=> Boolean
|
2291
|
+
# resp.item[0].cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
|
2292
|
+
# resp.item[0].cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
|
2293
|
+
# resp.item[0].method_settings #=> Hash
|
2294
|
+
# resp.item[0].method_settings["String"].metrics_enabled #=> Boolean
|
2295
|
+
# resp.item[0].method_settings["String"].logging_level #=> String
|
2296
|
+
# resp.item[0].method_settings["String"].data_trace_enabled #=> Boolean
|
2297
|
+
# resp.item[0].method_settings["String"].throttling_burst_limit #=> Integer
|
2298
|
+
# resp.item[0].method_settings["String"].throttling_rate_limit #=> Float
|
2299
|
+
# resp.item[0].method_settings["String"].caching_enabled #=> Boolean
|
2300
|
+
# resp.item[0].method_settings["String"].cache_ttl_in_seconds #=> Integer
|
2301
|
+
# resp.item[0].method_settings["String"].cache_data_encrypted #=> Boolean
|
2302
|
+
# resp.item[0].method_settings["String"].require_authorization_for_cache_control #=> Boolean
|
2303
|
+
# resp.item[0].method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
2304
|
+
# resp.item[0].variables #=> Hash
|
2305
|
+
# resp.item[0].variables["String"] #=> String
|
2306
|
+
# resp.item[0].created_date #=> Time
|
2307
|
+
# resp.item[0].last_updated_date #=> Time
|
2308
|
+
# @overload get_stages(params = {})
|
2309
|
+
# @param [Hash] params ({})
|
2310
|
+
def get_stages(params = {}, options = {})
|
2311
|
+
req = build_request(:get_stages, params)
|
2312
|
+
req.send_request(options)
|
2313
|
+
end
|
2314
|
+
|
2315
|
+
# Gets the usage data of a usage plan in a specified time interval.
|
2316
|
+
# @option params [required, String] :usage_plan_id
|
2317
|
+
# The Id of the usage plan associated with the usage data.
|
2318
|
+
# @option params [String] :key_id
|
2319
|
+
# The Id of the API key associated with the resultant usage data.
|
2320
|
+
# @option params [required, String] :start_date
|
2321
|
+
# The starting date (e.g., 2016-01-01) of the usage data.
|
2322
|
+
# @option params [required, String] :end_date
|
2323
|
+
# The ending date (e.g., 2016-12-31) of the usage data.
|
2324
|
+
# @option params [String] :position
|
2325
|
+
# Position
|
2326
|
+
# @option params [Integer] :limit
|
2327
|
+
# The maximum number of results to be returned.
|
2328
|
+
# @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2329
|
+
#
|
2330
|
+
# * {Types::Usage#usage_plan_id #usagePlanId} => String
|
2331
|
+
# * {Types::Usage#start_date #startDate} => String
|
2332
|
+
# * {Types::Usage#end_date #endDate} => String
|
2333
|
+
# * {Types::Usage#position #position} => String
|
2334
|
+
# * {Types::Usage#items #items} => Hash<String,Array<Array<Integer>>>
|
2335
|
+
#
|
2336
|
+
# @example Request syntax with placeholder values
|
2337
|
+
# resp = client.get_usage({
|
2338
|
+
# usage_plan_id: "String", # required
|
2339
|
+
# key_id: "String",
|
2340
|
+
# start_date: "String", # required
|
2341
|
+
# end_date: "String", # required
|
2342
|
+
# position: "String",
|
2343
|
+
# limit: 1,
|
2344
|
+
# })
|
2345
|
+
#
|
2346
|
+
# @example Response structure
|
2347
|
+
# resp.usage_plan_id #=> String
|
2348
|
+
# resp.start_date #=> String
|
2349
|
+
# resp.end_date #=> String
|
2350
|
+
# resp.position #=> String
|
2351
|
+
# resp.items #=> Hash
|
2352
|
+
# resp.items["String"] #=> Array
|
2353
|
+
# resp.items["String"][0] #=> Array
|
2354
|
+
# resp.items["String"][0][0] #=> Integer
|
2355
|
+
# @overload get_usage(params = {})
|
2356
|
+
# @param [Hash] params ({})
|
2357
|
+
def get_usage(params = {}, options = {})
|
2358
|
+
req = build_request(:get_usage, params)
|
2359
|
+
req.send_request(options)
|
2360
|
+
end
|
2361
|
+
|
2362
|
+
# Gets a usage plan of a given plan identifier.
|
2363
|
+
# @option params [required, String] :usage_plan_id
|
2364
|
+
# The identifier of the UsagePlan resource to be retrieved.
|
2365
|
+
# @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2366
|
+
#
|
2367
|
+
# * {Types::UsagePlan#id #id} => String
|
2368
|
+
# * {Types::UsagePlan#name #name} => String
|
2369
|
+
# * {Types::UsagePlan#description #description} => String
|
2370
|
+
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
2371
|
+
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
2372
|
+
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
2373
|
+
#
|
2374
|
+
# @example Request syntax with placeholder values
|
2375
|
+
# resp = client.get_usage_plan({
|
2376
|
+
# usage_plan_id: "String", # required
|
2377
|
+
# })
|
2378
|
+
#
|
2379
|
+
# @example Response structure
|
2380
|
+
# resp.id #=> String
|
2381
|
+
# resp.name #=> String
|
2382
|
+
# resp.description #=> String
|
2383
|
+
# resp.api_stages #=> Array
|
2384
|
+
# resp.api_stages[0].api_id #=> String
|
2385
|
+
# resp.api_stages[0].stage #=> String
|
2386
|
+
# resp.throttle.burst_limit #=> Integer
|
2387
|
+
# resp.throttle.rate_limit #=> Float
|
2388
|
+
# resp.quota.limit #=> Integer
|
2389
|
+
# resp.quota.offset #=> Integer
|
2390
|
+
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
2391
|
+
# @overload get_usage_plan(params = {})
|
2392
|
+
# @param [Hash] params ({})
|
2393
|
+
def get_usage_plan(params = {}, options = {})
|
2394
|
+
req = build_request(:get_usage_plan, params)
|
2395
|
+
req.send_request(options)
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# Gets a usage plan key of a given key identifier.
|
2399
|
+
# @option params [required, String] :usage_plan_id
|
2400
|
+
# The Id of the UsagePlan resource representing the usage plan
|
2401
|
+
# containing the to-be-retrieved UsagePlanKey resource representing a
|
2402
|
+
# plan customer.
|
2403
|
+
# @option params [required, String] :key_id
|
2404
|
+
# The key Id of the to-be-retrieved UsagePlanKey resource representing a
|
2405
|
+
# plan customer.
|
2406
|
+
# @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2407
|
+
#
|
2408
|
+
# * {Types::UsagePlanKey#id #id} => String
|
2409
|
+
# * {Types::UsagePlanKey#type #type} => String
|
2410
|
+
# * {Types::UsagePlanKey#value #value} => String
|
2411
|
+
# * {Types::UsagePlanKey#name #name} => String
|
2412
|
+
#
|
2413
|
+
# @example Request syntax with placeholder values
|
2414
|
+
# resp = client.get_usage_plan_key({
|
2415
|
+
# usage_plan_id: "String", # required
|
2416
|
+
# key_id: "String", # required
|
2417
|
+
# })
|
2418
|
+
#
|
2419
|
+
# @example Response structure
|
2420
|
+
# resp.id #=> String
|
2421
|
+
# resp.type #=> String
|
2422
|
+
# resp.value #=> String
|
2423
|
+
# resp.name #=> String
|
2424
|
+
# @overload get_usage_plan_key(params = {})
|
2425
|
+
# @param [Hash] params ({})
|
2426
|
+
def get_usage_plan_key(params = {}, options = {})
|
2427
|
+
req = build_request(:get_usage_plan_key, params)
|
2428
|
+
req.send_request(options)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# Gets all the usage plan keys representing the API keys added to a
|
2432
|
+
# specified usage plan.
|
2433
|
+
# @option params [required, String] :usage_plan_id
|
2434
|
+
# The Id of the UsagePlan resource representing the usage plan
|
2435
|
+
# containing the to-be-retrieved UsagePlanKey resource representing a
|
2436
|
+
# plan customer.
|
2437
|
+
# @option params [String] :position
|
2438
|
+
# A query parameter specifying the zero-based index specifying the
|
2439
|
+
# position of a usage plan key.
|
2440
|
+
# @option params [Integer] :limit
|
2441
|
+
# A query parameter specifying the maximum number usage plan keys
|
2442
|
+
# returned by the GET request.
|
2443
|
+
# @option params [String] :name_query
|
2444
|
+
# A query parameter specifying the name of the to-be-returned usage plan
|
2445
|
+
# keys.
|
2446
|
+
# @return [Types::UsagePlanKeys] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2447
|
+
#
|
2448
|
+
# * {Types::UsagePlanKeys#position #position} => String
|
2449
|
+
# * {Types::UsagePlanKeys#items #items} => Array<Types::UsagePlanKey>
|
2450
|
+
#
|
2451
|
+
# @example Request syntax with placeholder values
|
2452
|
+
# resp = client.get_usage_plan_keys({
|
2453
|
+
# usage_plan_id: "String", # required
|
2454
|
+
# position: "String",
|
2455
|
+
# limit: 1,
|
2456
|
+
# name_query: "String",
|
2457
|
+
# })
|
2458
|
+
#
|
2459
|
+
# @example Response structure
|
2460
|
+
# resp.position #=> String
|
2461
|
+
# resp.items #=> Array
|
2462
|
+
# resp.items[0].id #=> String
|
2463
|
+
# resp.items[0].type #=> String
|
2464
|
+
# resp.items[0].value #=> String
|
2465
|
+
# resp.items[0].name #=> String
|
2466
|
+
# @overload get_usage_plan_keys(params = {})
|
2467
|
+
# @param [Hash] params ({})
|
2468
|
+
def get_usage_plan_keys(params = {}, options = {})
|
2469
|
+
req = build_request(:get_usage_plan_keys, params)
|
2470
|
+
req.send_request(options)
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
# Gets all the usage plans of the caller's account.
|
2474
|
+
# @option params [String] :position
|
2475
|
+
# The zero-based array index specifying the position of the
|
2476
|
+
# to-be-retrieved UsagePlan resource.
|
2477
|
+
# @option params [String] :key_id
|
2478
|
+
# The identifier of the API key associated with the usage plans.
|
2479
|
+
# @option params [Integer] :limit
|
2480
|
+
# The number of UsagePlan resources to be returned as the result.
|
2481
|
+
# @return [Types::UsagePlans] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2482
|
+
#
|
2483
|
+
# * {Types::UsagePlans#position #position} => String
|
2484
|
+
# * {Types::UsagePlans#items #items} => Array<Types::UsagePlan>
|
2485
|
+
#
|
2486
|
+
# @example Request syntax with placeholder values
|
2487
|
+
# resp = client.get_usage_plans({
|
2488
|
+
# position: "String",
|
2489
|
+
# key_id: "String",
|
2490
|
+
# limit: 1,
|
2491
|
+
# })
|
2492
|
+
#
|
2493
|
+
# @example Response structure
|
2494
|
+
# resp.position #=> String
|
2495
|
+
# resp.items #=> Array
|
2496
|
+
# resp.items[0].id #=> String
|
2497
|
+
# resp.items[0].name #=> String
|
2498
|
+
# resp.items[0].description #=> String
|
2499
|
+
# resp.items[0].api_stages #=> Array
|
2500
|
+
# resp.items[0].api_stages[0].api_id #=> String
|
2501
|
+
# resp.items[0].api_stages[0].stage #=> String
|
2502
|
+
# resp.items[0].throttle.burst_limit #=> Integer
|
2503
|
+
# resp.items[0].throttle.rate_limit #=> Float
|
2504
|
+
# resp.items[0].quota.limit #=> Integer
|
2505
|
+
# resp.items[0].quota.offset #=> Integer
|
2506
|
+
# resp.items[0].quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
2507
|
+
# @overload get_usage_plans(params = {})
|
2508
|
+
# @param [Hash] params ({})
|
2509
|
+
def get_usage_plans(params = {}, options = {})
|
2510
|
+
req = build_request(:get_usage_plans, params)
|
2511
|
+
req.send_request(options)
|
2512
|
+
end
|
2513
|
+
|
2514
|
+
# Import API keys from an external source, such as a CSV-formatted file.
|
2515
|
+
# @option params [required, String, IO] :body
|
2516
|
+
# The payload of the POST request to import API keys. For the payload
|
2517
|
+
# format, see [API Key File Format][1].
|
2518
|
+
#
|
2519
|
+
#
|
2520
|
+
#
|
2521
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
2522
|
+
# @option params [required, String] :format
|
2523
|
+
# A query parameter to specify the input format to imported API keys.
|
2524
|
+
# Currently, only the `csv` format is supported.
|
2525
|
+
# @option params [Boolean] :fail_on_warnings
|
2526
|
+
# A query parameter to indicate whether to rollback ApiKey importation
|
2527
|
+
# (`true`) or not (`false`) when error is encountered.
|
2528
|
+
# @return [Types::ApiKeyIds] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2529
|
+
#
|
2530
|
+
# * {Types::ApiKeyIds#ids #ids} => Array<String>
|
2531
|
+
# * {Types::ApiKeyIds#warnings #warnings} => Array<String>
|
2532
|
+
#
|
2533
|
+
# @example Request syntax with placeholder values
|
2534
|
+
# resp = client.import_api_keys({
|
2535
|
+
# body: "data", # required
|
2536
|
+
# format: "csv", # required, accepts csv
|
2537
|
+
# fail_on_warnings: false,
|
2538
|
+
# })
|
2539
|
+
#
|
2540
|
+
# @example Response structure
|
2541
|
+
# resp.ids #=> Array
|
2542
|
+
# resp.ids[0] #=> String
|
2543
|
+
# resp.warnings #=> Array
|
2544
|
+
# resp.warnings[0] #=> String
|
2545
|
+
# @overload import_api_keys(params = {})
|
2546
|
+
# @param [Hash] params ({})
|
2547
|
+
def import_api_keys(params = {}, options = {})
|
2548
|
+
req = build_request(:import_api_keys, params)
|
2549
|
+
req.send_request(options)
|
2550
|
+
end
|
2551
|
+
|
2552
|
+
# A feature of the Amazon API Gateway control service for creating a new
|
2553
|
+
# API from an external API definition file.
|
2554
|
+
# @option params [Boolean] :fail_on_warnings
|
2555
|
+
# A query parameter to indicate whether to rollback the API creation
|
2556
|
+
# (`true`) or not (`false`) when a warning is encountered. The default
|
2557
|
+
# value is `false`.
|
2558
|
+
# @option params [Hash<String,String>] :parameters
|
2559
|
+
# Custom header parameters as part of the request.
|
2560
|
+
# @option params [required, String, IO] :body
|
2561
|
+
# The POST request body containing external API definitions. Currently,
|
2562
|
+
# only Swagger definition JSON files are supported.
|
2563
|
+
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2564
|
+
#
|
2565
|
+
# * {Types::RestApi#id #id} => String
|
2566
|
+
# * {Types::RestApi#name #name} => String
|
2567
|
+
# * {Types::RestApi#description #description} => String
|
2568
|
+
# * {Types::RestApi#created_date #createdDate} => Time
|
2569
|
+
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2570
|
+
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2571
|
+
#
|
2572
|
+
# @example Request syntax with placeholder values
|
2573
|
+
# resp = client.import_rest_api({
|
2574
|
+
# fail_on_warnings: false,
|
2575
|
+
# parameters: {
|
2576
|
+
# "String" => "String",
|
2577
|
+
# },
|
2578
|
+
# body: "data", # required
|
2579
|
+
# })
|
2580
|
+
#
|
2581
|
+
# @example Response structure
|
2582
|
+
# resp.id #=> String
|
2583
|
+
# resp.name #=> String
|
2584
|
+
# resp.description #=> String
|
2585
|
+
# resp.created_date #=> Time
|
2586
|
+
# resp.warnings #=> Array
|
2587
|
+
# resp.warnings[0] #=> String
|
2588
|
+
# resp.binary_media_types #=> Array
|
2589
|
+
# resp.binary_media_types[0] #=> String
|
2590
|
+
# @overload import_rest_api(params = {})
|
2591
|
+
# @param [Hash] params ({})
|
2592
|
+
def import_rest_api(params = {}, options = {})
|
2593
|
+
req = build_request(:import_rest_api, params)
|
2594
|
+
req.send_request(options)
|
2595
|
+
end
|
2596
|
+
|
2597
|
+
# Represents a put integration.
|
2598
|
+
# @option params [required, String] :rest_api_id
|
2599
|
+
# Specifies a put integration request's API identifier.
|
2600
|
+
# @option params [required, String] :resource_id
|
2601
|
+
# Specifies a put integration request's resource ID.
|
2602
|
+
# @option params [required, String] :http_method
|
2603
|
+
# Specifies a put integration request's HTTP method.
|
2604
|
+
# @option params [required, String] :type
|
2605
|
+
# Specifies a put integration input's type.
|
2606
|
+
# @option params [String] :integration_http_method
|
2607
|
+
# Specifies a put integration HTTP method. When the integration type is
|
2608
|
+
# HTTP or AWS, this field is required.
|
2609
|
+
# @option params [String] :uri
|
2610
|
+
# Specifies a put integration input's Uniform Resource Identifier
|
2611
|
+
# (URI). When the integration type is HTTP or AWS, this field is
|
2612
|
+
# required. For integration with Lambda as an AWS service proxy, this
|
2613
|
+
# value is of the
|
2614
|
+
# 'arn:aws:apigateway:<region>\:lambda:path/2015-03-31/functions/<functionArn>/invocations'
|
2615
|
+
# format.
|
2616
|
+
# @option params [String] :credentials
|
2617
|
+
# Specifies whether credentials are required for a put integration.
|
2618
|
+
# @option params [Hash<String,String>] :request_parameters
|
2619
|
+
# A key-value map specifying request parameters that are passed from the
|
2620
|
+
# method request to the back end. The key is an integration request
|
2621
|
+
# parameter name and the associated value is a method request parameter
|
2622
|
+
# value or static value that must be enclosed within single quotes and
|
2623
|
+
# pre-encoded as required by the back end. The method request parameter
|
2624
|
+
# value must match the pattern of
|
2625
|
+
# `method.request.\{location\}.\{name\}`, where `location` is
|
2626
|
+
# `querystring`, `path`, or `header` and `name` must be a valid and
|
2627
|
+
# unique method request parameter name.
|
2628
|
+
# @option params [Hash<String,String>] :request_templates
|
2629
|
+
# Represents a map of Velocity templates that are applied on the request
|
2630
|
+
# payload based on the value of the Content-Type header sent by the
|
2631
|
+
# client. The content type value is the key in this map, and the
|
2632
|
+
# template (as a String) is the value.
|
2633
|
+
# @option params [String] :passthrough_behavior
|
2634
|
+
# Specifies the pass-through behavior for incoming requests based on the
|
2635
|
+
# Content-Type header in the request, and the available mapping
|
2636
|
+
# templates specified as the `requestTemplates` property on the
|
2637
|
+
# Integration resource. There are three valid values: `WHEN_NO_MATCH`,
|
2638
|
+
# `WHEN_NO_TEMPLATES`, and `NEVER`.
|
2639
|
+
#
|
2640
|
+
# * `WHEN_NO_MATCH` passes the request body for unmapped content types
|
2641
|
+
# through to the integration back end without transformation.
|
2642
|
+
#
|
2643
|
+
# * `NEVER` rejects unmapped content types with an HTTP 415
|
2644
|
+
# 'Unsupported Media Type' response.
|
2645
|
+
#
|
2646
|
+
# * `WHEN_NO_TEMPLATES` allows pass-through when the integration has NO
|
2647
|
+
# content types mapped to templates. However if there is at least one
|
2648
|
+
# content type defined, unmapped content types will be rejected with
|
2649
|
+
# the same 415 response.
|
2650
|
+
# @option params [String] :cache_namespace
|
2651
|
+
# Specifies a put integration input's cache namespace.
|
2652
|
+
# @option params [Array<String>] :cache_key_parameters
|
2653
|
+
# Specifies a put integration input's cache key parameters.
|
2654
|
+
# @option params [String] :content_handling
|
2655
|
+
# Specifies how to handle request payload content type conversions.
|
2656
|
+
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
2657
|
+
# the following behaviors:
|
2658
|
+
#
|
2659
|
+
# * `CONVERT_TO_BINARY`\: Converts a request payload from a
|
2660
|
+
# Base64-encoded string to the corresponding binary blob.
|
2661
|
+
#
|
2662
|
+
# * `CONVERT_TO_TEXT`\: Converts a request payload from a binary blob to
|
2663
|
+
# a Base64-encoded string.
|
2664
|
+
#
|
2665
|
+
# If this property is not defined, the request payload will be passed
|
2666
|
+
# through from the method request to integration request without
|
2667
|
+
# modification, provided that the `passthroughBehaviors` is configured
|
2668
|
+
# to support payload pass-through.
|
2669
|
+
# @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2670
|
+
#
|
2671
|
+
# * {Types::Integration#type #type} => String
|
2672
|
+
# * {Types::Integration#http_method #httpMethod} => String
|
2673
|
+
# * {Types::Integration#uri #uri} => String
|
2674
|
+
# * {Types::Integration#credentials #credentials} => String
|
2675
|
+
# * {Types::Integration#request_parameters #requestParameters} => Hash<String,String>
|
2676
|
+
# * {Types::Integration#request_templates #requestTemplates} => Hash<String,String>
|
2677
|
+
# * {Types::Integration#passthrough_behavior #passthroughBehavior} => String
|
2678
|
+
# * {Types::Integration#content_handling #contentHandling} => String
|
2679
|
+
# * {Types::Integration#cache_namespace #cacheNamespace} => String
|
2680
|
+
# * {Types::Integration#cache_key_parameters #cacheKeyParameters} => Array<String>
|
2681
|
+
# * {Types::Integration#integration_responses #integrationResponses} => Hash<String,Types::IntegrationResponse>
|
2682
|
+
#
|
2683
|
+
# @example Request syntax with placeholder values
|
2684
|
+
# resp = client.put_integration({
|
2685
|
+
# rest_api_id: "String", # required
|
2686
|
+
# resource_id: "String", # required
|
2687
|
+
# http_method: "String", # required
|
2688
|
+
# type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
|
2689
|
+
# integration_http_method: "String",
|
2690
|
+
# uri: "String",
|
2691
|
+
# credentials: "String",
|
2692
|
+
# request_parameters: {
|
2693
|
+
# "String" => "String",
|
2694
|
+
# },
|
2695
|
+
# request_templates: {
|
2696
|
+
# "String" => "String",
|
2697
|
+
# },
|
2698
|
+
# passthrough_behavior: "String",
|
2699
|
+
# cache_namespace: "String",
|
2700
|
+
# cache_key_parameters: ["String"],
|
2701
|
+
# content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
|
2702
|
+
# })
|
2703
|
+
#
|
2704
|
+
# @example Response structure
|
2705
|
+
# resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
2706
|
+
# resp.http_method #=> String
|
2707
|
+
# resp.uri #=> String
|
2708
|
+
# resp.credentials #=> String
|
2709
|
+
# resp.request_parameters #=> Hash
|
2710
|
+
# resp.request_parameters["String"] #=> String
|
2711
|
+
# resp.request_templates #=> Hash
|
2712
|
+
# resp.request_templates["String"] #=> String
|
2713
|
+
# resp.passthrough_behavior #=> String
|
2714
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2715
|
+
# resp.cache_namespace #=> String
|
2716
|
+
# resp.cache_key_parameters #=> Array
|
2717
|
+
# resp.cache_key_parameters[0] #=> String
|
2718
|
+
# resp.integration_responses #=> Hash
|
2719
|
+
# resp.integration_responses["String"].status_code #=> String
|
2720
|
+
# resp.integration_responses["String"].selection_pattern #=> String
|
2721
|
+
# resp.integration_responses["String"].response_parameters #=> Hash
|
2722
|
+
# resp.integration_responses["String"].response_parameters["String"] #=> String
|
2723
|
+
# resp.integration_responses["String"].response_templates #=> Hash
|
2724
|
+
# resp.integration_responses["String"].response_templates["String"] #=> String
|
2725
|
+
# resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2726
|
+
# @overload put_integration(params = {})
|
2727
|
+
# @param [Hash] params ({})
|
2728
|
+
def put_integration(params = {}, options = {})
|
2729
|
+
req = build_request(:put_integration, params)
|
2730
|
+
req.send_request(options)
|
2731
|
+
end
|
2732
|
+
|
2733
|
+
# Represents a put integration.
|
2734
|
+
# @option params [required, String] :rest_api_id
|
2735
|
+
# Specifies a put integration response request's API identifier.
|
2736
|
+
# @option params [required, String] :resource_id
|
2737
|
+
# Specifies a put integration response request's resource identifier.
|
2738
|
+
# @option params [required, String] :http_method
|
2739
|
+
# Specifies a put integration response request's HTTP method.
|
2740
|
+
# @option params [required, String] :status_code
|
2741
|
+
# Specifies the status code that is used to map the integration response
|
2742
|
+
# to an existing MethodResponse.
|
2743
|
+
# @option params [String] :selection_pattern
|
2744
|
+
# Specifies the selection pattern of a put integration response.
|
2745
|
+
# @option params [Hash<String,String>] :response_parameters
|
2746
|
+
# A key-value map specifying response parameters that are passed to the
|
2747
|
+
# method response from the back end. The key is a method response header
|
2748
|
+
# parameter name and the mapped value is an integration response header
|
2749
|
+
# value, a static value enclosed within a pair of single quotes, or a
|
2750
|
+
# JSON expression from the integration response body. The mapping key
|
2751
|
+
# must match the pattern of `method.response.header.\{name\}`, where
|
2752
|
+
# `name` is a valid and unique header name. The mapped non-static value
|
2753
|
+
# must match the pattern of `integration.response.header.\{name\}` or
|
2754
|
+
# `integration.response.body.\{JSON-expression\}`, where `name` must be
|
2755
|
+
# a valid and unique response header name and `JSON-expression` a valid
|
2756
|
+
# JSON expression without the `$` prefix.
|
2757
|
+
# @option params [Hash<String,String>] :response_templates
|
2758
|
+
# Specifies a put integration response's templates.
|
2759
|
+
# @option params [String] :content_handling
|
2760
|
+
# Specifies how to handle response payload content type conversions.
|
2761
|
+
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
2762
|
+
# the following behaviors:
|
2763
|
+
#
|
2764
|
+
# * `CONVERT_TO_BINARY`\: Converts a response payload from a
|
2765
|
+
# Base64-encoded string to the corresponding binary blob.
|
2766
|
+
#
|
2767
|
+
# * `CONVERT_TO_TEXT`\: Converts a response payload from a binary blob
|
2768
|
+
# to a Base64-encoded string.
|
2769
|
+
#
|
2770
|
+
# If this property is not defined, the response payload will be passed
|
2771
|
+
# through from the integration response to the method response without
|
2772
|
+
# modification.
|
2773
|
+
# @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2774
|
+
#
|
2775
|
+
# * {Types::IntegrationResponse#status_code #statusCode} => String
|
2776
|
+
# * {Types::IntegrationResponse#selection_pattern #selectionPattern} => String
|
2777
|
+
# * {Types::IntegrationResponse#response_parameters #responseParameters} => Hash<String,String>
|
2778
|
+
# * {Types::IntegrationResponse#response_templates #responseTemplates} => Hash<String,String>
|
2779
|
+
# * {Types::IntegrationResponse#content_handling #contentHandling} => String
|
2780
|
+
#
|
2781
|
+
# @example Request syntax with placeholder values
|
2782
|
+
# resp = client.put_integration_response({
|
2783
|
+
# rest_api_id: "String", # required
|
2784
|
+
# resource_id: "String", # required
|
2785
|
+
# http_method: "String", # required
|
2786
|
+
# status_code: "StatusCode", # required
|
2787
|
+
# selection_pattern: "String",
|
2788
|
+
# response_parameters: {
|
2789
|
+
# "String" => "String",
|
2790
|
+
# },
|
2791
|
+
# response_templates: {
|
2792
|
+
# "String" => "String",
|
2793
|
+
# },
|
2794
|
+
# content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
|
2795
|
+
# })
|
2796
|
+
#
|
2797
|
+
# @example Response structure
|
2798
|
+
# resp.status_code #=> String
|
2799
|
+
# resp.selection_pattern #=> String
|
2800
|
+
# resp.response_parameters #=> Hash
|
2801
|
+
# resp.response_parameters["String"] #=> String
|
2802
|
+
# resp.response_templates #=> Hash
|
2803
|
+
# resp.response_templates["String"] #=> String
|
2804
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2805
|
+
# @overload put_integration_response(params = {})
|
2806
|
+
# @param [Hash] params ({})
|
2807
|
+
def put_integration_response(params = {}, options = {})
|
2808
|
+
req = build_request(:put_integration_response, params)
|
2809
|
+
req.send_request(options)
|
2810
|
+
end
|
2811
|
+
|
2812
|
+
# Add a method to an existing Resource resource.
|
2813
|
+
# @option params [required, String] :rest_api_id
|
2814
|
+
# The RestApi identifier for the new Method resource.
|
2815
|
+
# @option params [required, String] :resource_id
|
2816
|
+
# The Resource identifier for the new Method resource.
|
2817
|
+
# @option params [required, String] :http_method
|
2818
|
+
# Specifies the method request's HTTP method type.
|
2819
|
+
# @option params [required, String] :authorization_type
|
2820
|
+
# Specifies the type of authorization used for the method.
|
2821
|
+
# @option params [String] :authorizer_id
|
2822
|
+
# Specifies the identifier of an Authorizer to use on this Method, if
|
2823
|
+
# the type is CUSTOM.
|
2824
|
+
# @option params [Boolean] :api_key_required
|
2825
|
+
# Specifies whether the method required a valid ApiKey.
|
2826
|
+
# @option params [Hash<String,Boolean>] :request_parameters
|
2827
|
+
# A key-value map defining required or optional method request
|
2828
|
+
# parameters that can be accepted by Amazon API Gateway. A key defines a
|
2829
|
+
# method request parameter name matching the pattern of
|
2830
|
+
# `method.request.\{location\}.\{name\}`, where `location` is
|
2831
|
+
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
2832
|
+
# parameter name. The value associated with the key is a Boolean flag
|
2833
|
+
# indicating whether the parameter is required (`true`) or optional
|
2834
|
+
# (`false`). The method request parameter names defined here are
|
2835
|
+
# available in Integration to be mapped to integration request
|
2836
|
+
# parameters or body-mapping templates.
|
2837
|
+
# @option params [Hash<String,String>] :request_models
|
2838
|
+
# Specifies the Model resources used for the request's content type.
|
2839
|
+
# Request models are represented as a key/value map, with a content type
|
2840
|
+
# as the key and a Model name as the value.
|
2841
|
+
# @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2842
|
+
#
|
2843
|
+
# * {Types::Method#http_method #httpMethod} => String
|
2844
|
+
# * {Types::Method#authorization_type #authorizationType} => String
|
2845
|
+
# * {Types::Method#authorizer_id #authorizerId} => String
|
2846
|
+
# * {Types::Method#api_key_required #apiKeyRequired} => Boolean
|
2847
|
+
# * {Types::Method#request_parameters #requestParameters} => Hash<String,Boolean>
|
2848
|
+
# * {Types::Method#request_models #requestModels} => Hash<String,String>
|
2849
|
+
# * {Types::Method#method_responses #methodResponses} => Hash<String,Types::MethodResponse>
|
2850
|
+
# * {Types::Method#method_integration #methodIntegration} => Types::Integration
|
2851
|
+
#
|
2852
|
+
# @example Request syntax with placeholder values
|
2853
|
+
# resp = client.put_method({
|
2854
|
+
# rest_api_id: "String", # required
|
2855
|
+
# resource_id: "String", # required
|
2856
|
+
# http_method: "String", # required
|
2857
|
+
# authorization_type: "String", # required
|
2858
|
+
# authorizer_id: "String",
|
2859
|
+
# api_key_required: false,
|
2860
|
+
# request_parameters: {
|
2861
|
+
# "String" => false,
|
2862
|
+
# },
|
2863
|
+
# request_models: {
|
2864
|
+
# "String" => "String",
|
2865
|
+
# },
|
2866
|
+
# })
|
2867
|
+
#
|
2868
|
+
# @example Response structure
|
2869
|
+
# resp.http_method #=> String
|
2870
|
+
# resp.authorization_type #=> String
|
2871
|
+
# resp.authorizer_id #=> String
|
2872
|
+
# resp.api_key_required #=> Boolean
|
2873
|
+
# resp.request_parameters #=> Hash
|
2874
|
+
# resp.request_parameters["String"] #=> Boolean
|
2875
|
+
# resp.request_models #=> Hash
|
2876
|
+
# resp.request_models["String"] #=> String
|
2877
|
+
# resp.method_responses #=> Hash
|
2878
|
+
# resp.method_responses["String"].status_code #=> String
|
2879
|
+
# resp.method_responses["String"].response_parameters #=> Hash
|
2880
|
+
# resp.method_responses["String"].response_parameters["String"] #=> Boolean
|
2881
|
+
# resp.method_responses["String"].response_models #=> Hash
|
2882
|
+
# resp.method_responses["String"].response_models["String"] #=> String
|
2883
|
+
# resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
2884
|
+
# resp.method_integration.http_method #=> String
|
2885
|
+
# resp.method_integration.uri #=> String
|
2886
|
+
# resp.method_integration.credentials #=> String
|
2887
|
+
# resp.method_integration.request_parameters #=> Hash
|
2888
|
+
# resp.method_integration.request_parameters["String"] #=> String
|
2889
|
+
# resp.method_integration.request_templates #=> Hash
|
2890
|
+
# resp.method_integration.request_templates["String"] #=> String
|
2891
|
+
# resp.method_integration.passthrough_behavior #=> String
|
2892
|
+
# resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2893
|
+
# resp.method_integration.cache_namespace #=> String
|
2894
|
+
# resp.method_integration.cache_key_parameters #=> Array
|
2895
|
+
# resp.method_integration.cache_key_parameters[0] #=> String
|
2896
|
+
# resp.method_integration.integration_responses #=> Hash
|
2897
|
+
# resp.method_integration.integration_responses["String"].status_code #=> String
|
2898
|
+
# resp.method_integration.integration_responses["String"].selection_pattern #=> String
|
2899
|
+
# resp.method_integration.integration_responses["String"].response_parameters #=> Hash
|
2900
|
+
# resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
2901
|
+
# resp.method_integration.integration_responses["String"].response_templates #=> Hash
|
2902
|
+
# resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
|
2903
|
+
# resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
2904
|
+
# @overload put_method(params = {})
|
2905
|
+
# @param [Hash] params ({})
|
2906
|
+
def put_method(params = {}, options = {})
|
2907
|
+
req = build_request(:put_method, params)
|
2908
|
+
req.send_request(options)
|
2909
|
+
end
|
2910
|
+
|
2911
|
+
# Adds a MethodResponse to an existing Method resource.
|
2912
|
+
# @option params [required, String] :rest_api_id
|
2913
|
+
# The RestApi identifier for the Method resource.
|
2914
|
+
# @option params [required, String] :resource_id
|
2915
|
+
# The Resource identifier for the Method resource.
|
2916
|
+
# @option params [required, String] :http_method
|
2917
|
+
# The HTTP verb of the Method resource.
|
2918
|
+
# @option params [required, String] :status_code
|
2919
|
+
# The method response's status code.
|
2920
|
+
# @option params [Hash<String,Boolean>] :response_parameters
|
2921
|
+
# A key-value map specifying required or optional response parameters
|
2922
|
+
# that Amazon API Gateway can send back to the caller. A key defines a
|
2923
|
+
# method response header name and the associated value is a Boolean flag
|
2924
|
+
# indicating whether the method response parameter is required or not.
|
2925
|
+
# The method response header names must match the pattern of
|
2926
|
+
# `method.response.header.\{name\}`, where `name` is a valid and unique
|
2927
|
+
# header name. The response parameter names defined here are available
|
2928
|
+
# in the integration response to be mapped from an integration response
|
2929
|
+
# header expressed in `integration.response.header.\{name\}`, a static
|
2930
|
+
# value enclosed within a pair of single quotes (e.g.,
|
2931
|
+
# `'application/json'`), or a JSON expression from the back-end response
|
2932
|
+
# payload in the form of
|
2933
|
+
# `integration.response.body.\{JSON-expression\}`, where
|
2934
|
+
# `JSON-expression` is a valid JSON expression without the `$` prefix.)
|
2935
|
+
# @option params [Hash<String,String>] :response_models
|
2936
|
+
# Specifies the Model resources used for the response's content type.
|
2937
|
+
# Response models are represented as a key/value map, with a content
|
2938
|
+
# type as the key and a Model name as the value.
|
2939
|
+
# @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2940
|
+
#
|
2941
|
+
# * {Types::MethodResponse#status_code #statusCode} => String
|
2942
|
+
# * {Types::MethodResponse#response_parameters #responseParameters} => Hash<String,Boolean>
|
2943
|
+
# * {Types::MethodResponse#response_models #responseModels} => Hash<String,String>
|
2944
|
+
#
|
2945
|
+
# @example Request syntax with placeholder values
|
2946
|
+
# resp = client.put_method_response({
|
2947
|
+
# rest_api_id: "String", # required
|
2948
|
+
# resource_id: "String", # required
|
2949
|
+
# http_method: "String", # required
|
2950
|
+
# status_code: "StatusCode", # required
|
2951
|
+
# response_parameters: {
|
2952
|
+
# "String" => false,
|
2953
|
+
# },
|
2954
|
+
# response_models: {
|
2955
|
+
# "String" => "String",
|
2956
|
+
# },
|
2957
|
+
# })
|
2958
|
+
#
|
2959
|
+
# @example Response structure
|
2960
|
+
# resp.status_code #=> String
|
2961
|
+
# resp.response_parameters #=> Hash
|
2962
|
+
# resp.response_parameters["String"] #=> Boolean
|
2963
|
+
# resp.response_models #=> Hash
|
2964
|
+
# resp.response_models["String"] #=> String
|
2965
|
+
# @overload put_method_response(params = {})
|
2966
|
+
# @param [Hash] params ({})
|
2967
|
+
def put_method_response(params = {}, options = {})
|
2968
|
+
req = build_request(:put_method_response, params)
|
2969
|
+
req.send_request(options)
|
2970
|
+
end
|
2971
|
+
|
2972
|
+
# A feature of the Amazon API Gateway control service for updating an
|
2973
|
+
# existing API with an input of external API definitions. The update can
|
2974
|
+
# take the form of merging the supplied definition into the existing API
|
2975
|
+
# or overwriting the existing API.
|
2976
|
+
# @option params [required, String] :rest_api_id
|
2977
|
+
# The identifier of the RestApi to be updated.
|
2978
|
+
# @option params [String] :mode
|
2979
|
+
# The `mode` query parameter to specify the update mode. Valid values
|
2980
|
+
# are "merge" and "overwrite". By default, the update mode is
|
2981
|
+
# "merge".
|
2982
|
+
# @option params [Boolean] :fail_on_warnings
|
2983
|
+
# A query parameter to indicate whether to rollback the API update
|
2984
|
+
# (`true`) or not (`false`) when a warning is encountered. The default
|
2985
|
+
# value is `false`.
|
2986
|
+
# @option params [Hash<String,String>] :parameters
|
2987
|
+
# Custom headers supplied as part of the request.
|
2988
|
+
# @option params [required, String, IO] :body
|
2989
|
+
# The PUT request body containing external API definitions. Currently,
|
2990
|
+
# only Swagger definition JSON files are supported.
|
2991
|
+
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2992
|
+
#
|
2993
|
+
# * {Types::RestApi#id #id} => String
|
2994
|
+
# * {Types::RestApi#name #name} => String
|
2995
|
+
# * {Types::RestApi#description #description} => String
|
2996
|
+
# * {Types::RestApi#created_date #createdDate} => Time
|
2997
|
+
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2998
|
+
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2999
|
+
#
|
3000
|
+
# @example Request syntax with placeholder values
|
3001
|
+
# resp = client.put_rest_api({
|
3002
|
+
# rest_api_id: "String", # required
|
3003
|
+
# mode: "merge", # accepts merge, overwrite
|
3004
|
+
# fail_on_warnings: false,
|
3005
|
+
# parameters: {
|
3006
|
+
# "String" => "String",
|
3007
|
+
# },
|
3008
|
+
# body: "data", # required
|
3009
|
+
# })
|
3010
|
+
#
|
3011
|
+
# @example Response structure
|
3012
|
+
# resp.id #=> String
|
3013
|
+
# resp.name #=> String
|
3014
|
+
# resp.description #=> String
|
3015
|
+
# resp.created_date #=> Time
|
3016
|
+
# resp.warnings #=> Array
|
3017
|
+
# resp.warnings[0] #=> String
|
3018
|
+
# resp.binary_media_types #=> Array
|
3019
|
+
# resp.binary_media_types[0] #=> String
|
3020
|
+
# @overload put_rest_api(params = {})
|
3021
|
+
# @param [Hash] params ({})
|
3022
|
+
def put_rest_api(params = {}, options = {})
|
3023
|
+
req = build_request(:put_rest_api, params)
|
3024
|
+
req.send_request(options)
|
3025
|
+
end
|
3026
|
+
|
3027
|
+
# Simulate the execution of an Authorizer in your RestApi with headers,
|
3028
|
+
# parameters, and an incoming request body.
|
3029
|
+
#
|
3030
|
+
# <div class="seeAlso">
|
3031
|
+
# [Enable custom authorizers][1]
|
3032
|
+
# </div>
|
3033
|
+
#
|
3034
|
+
#
|
3035
|
+
#
|
3036
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
3037
|
+
# @option params [required, String] :rest_api_id
|
3038
|
+
# Specifies a test invoke authorizer request's RestApi identifier.
|
3039
|
+
# @option params [required, String] :authorizer_id
|
3040
|
+
# Specifies a test invoke authorizer request's Authorizer ID.
|
3041
|
+
# @option params [Hash<String,String>] :headers
|
3042
|
+
# \[Required\] A key-value map of headers to simulate an incoming
|
3043
|
+
# invocation request. This is where the incoming authorization token, or
|
3044
|
+
# identity source, should be specified.
|
3045
|
+
# @option params [String] :path_with_query_string
|
3046
|
+
# \[Optional\] The URI path, including query string, of the simulated
|
3047
|
+
# invocation request. Use this to specify path parameters and query
|
3048
|
+
# string parameters.
|
3049
|
+
# @option params [String] :body
|
3050
|
+
# \[Optional\] The simulated request body of an incoming invocation
|
3051
|
+
# request.
|
3052
|
+
# @option params [Hash<String,String>] :stage_variables
|
3053
|
+
# A key-value map of stage variables to simulate an invocation on a
|
3054
|
+
# deployed Stage.
|
3055
|
+
# @option params [Hash<String,String>] :additional_context
|
3056
|
+
# \[Optional\] A key-value map of additional context variables.
|
3057
|
+
# @return [Types::TestInvokeAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3058
|
+
#
|
3059
|
+
# * {Types::TestInvokeAuthorizerResponse#client_status #clientStatus} => Integer
|
3060
|
+
# * {Types::TestInvokeAuthorizerResponse#log #log} => String
|
3061
|
+
# * {Types::TestInvokeAuthorizerResponse#latency #latency} => Integer
|
3062
|
+
# * {Types::TestInvokeAuthorizerResponse#principal_id #principalId} => String
|
3063
|
+
# * {Types::TestInvokeAuthorizerResponse#policy #policy} => String
|
3064
|
+
# * {Types::TestInvokeAuthorizerResponse#authorization #authorization} => Hash<String,Array<String>>
|
3065
|
+
# * {Types::TestInvokeAuthorizerResponse#claims #claims} => Hash<String,String>
|
3066
|
+
#
|
3067
|
+
# @example Request syntax with placeholder values
|
3068
|
+
# resp = client.test_invoke_authorizer({
|
3069
|
+
# rest_api_id: "String", # required
|
3070
|
+
# authorizer_id: "String", # required
|
3071
|
+
# headers: {
|
3072
|
+
# "String" => "String",
|
3073
|
+
# },
|
3074
|
+
# path_with_query_string: "String",
|
3075
|
+
# body: "String",
|
3076
|
+
# stage_variables: {
|
3077
|
+
# "String" => "String",
|
3078
|
+
# },
|
3079
|
+
# additional_context: {
|
3080
|
+
# "String" => "String",
|
3081
|
+
# },
|
3082
|
+
# })
|
3083
|
+
#
|
3084
|
+
# @example Response structure
|
3085
|
+
# resp.client_status #=> Integer
|
3086
|
+
# resp.log #=> String
|
3087
|
+
# resp.latency #=> Integer
|
3088
|
+
# resp.principal_id #=> String
|
3089
|
+
# resp.policy #=> String
|
3090
|
+
# resp.authorization #=> Hash
|
3091
|
+
# resp.authorization["String"] #=> Array
|
3092
|
+
# resp.authorization["String"][0] #=> String
|
3093
|
+
# resp.claims #=> Hash
|
3094
|
+
# resp.claims["String"] #=> String
|
3095
|
+
# @overload test_invoke_authorizer(params = {})
|
3096
|
+
# @param [Hash] params ({})
|
3097
|
+
def test_invoke_authorizer(params = {}, options = {})
|
3098
|
+
req = build_request(:test_invoke_authorizer, params)
|
3099
|
+
req.send_request(options)
|
3100
|
+
end
|
3101
|
+
|
3102
|
+
# Simulate the execution of a Method in your RestApi with headers,
|
3103
|
+
# parameters, and an incoming request body.
|
3104
|
+
# @option params [required, String] :rest_api_id
|
3105
|
+
# Specifies a test invoke method request's API identifier.
|
3106
|
+
# @option params [required, String] :resource_id
|
3107
|
+
# Specifies a test invoke method request's resource ID.
|
3108
|
+
# @option params [required, String] :http_method
|
3109
|
+
# Specifies a test invoke method request's HTTP method.
|
3110
|
+
# @option params [String] :path_with_query_string
|
3111
|
+
# The URI path, including query string, of the simulated invocation
|
3112
|
+
# request. Use this to specify path parameters and query string
|
3113
|
+
# parameters.
|
3114
|
+
# @option params [String] :body
|
3115
|
+
# The simulated request body of an incoming invocation request.
|
3116
|
+
# @option params [Hash<String,String>] :headers
|
3117
|
+
# A key-value map of headers to simulate an incoming invocation request.
|
3118
|
+
# @option params [String] :client_certificate_id
|
3119
|
+
# A ClientCertificate identifier to use in the test invocation. API
|
3120
|
+
# Gateway will use the certificate when making the HTTPS request to the
|
3121
|
+
# defined back-end endpoint.
|
3122
|
+
# @option params [Hash<String,String>] :stage_variables
|
3123
|
+
# A key-value map of stage variables to simulate an invocation on a
|
3124
|
+
# deployed Stage.
|
3125
|
+
# @return [Types::TestInvokeMethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3126
|
+
#
|
3127
|
+
# * {Types::TestInvokeMethodResponse#status #status} => Integer
|
3128
|
+
# * {Types::TestInvokeMethodResponse#body #body} => String
|
3129
|
+
# * {Types::TestInvokeMethodResponse#headers #headers} => Hash<String,String>
|
3130
|
+
# * {Types::TestInvokeMethodResponse#log #log} => String
|
3131
|
+
# * {Types::TestInvokeMethodResponse#latency #latency} => Integer
|
3132
|
+
#
|
3133
|
+
# @example Request syntax with placeholder values
|
3134
|
+
# resp = client.test_invoke_method({
|
3135
|
+
# rest_api_id: "String", # required
|
3136
|
+
# resource_id: "String", # required
|
3137
|
+
# http_method: "String", # required
|
3138
|
+
# path_with_query_string: "String",
|
3139
|
+
# body: "String",
|
3140
|
+
# headers: {
|
3141
|
+
# "String" => "String",
|
3142
|
+
# },
|
3143
|
+
# client_certificate_id: "String",
|
3144
|
+
# stage_variables: {
|
3145
|
+
# "String" => "String",
|
3146
|
+
# },
|
3147
|
+
# })
|
3148
|
+
#
|
3149
|
+
# @example Response structure
|
3150
|
+
# resp.status #=> Integer
|
3151
|
+
# resp.body #=> String
|
3152
|
+
# resp.headers #=> Hash
|
3153
|
+
# resp.headers["String"] #=> String
|
3154
|
+
# resp.log #=> String
|
3155
|
+
# resp.latency #=> Integer
|
3156
|
+
# @overload test_invoke_method(params = {})
|
3157
|
+
# @param [Hash] params ({})
|
3158
|
+
def test_invoke_method(params = {}, options = {})
|
3159
|
+
req = build_request(:test_invoke_method, params)
|
3160
|
+
req.send_request(options)
|
3161
|
+
end
|
3162
|
+
|
3163
|
+
# Changes information about the current Account resource.
|
3164
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3165
|
+
# A list of update operations to be applied to the specified resource
|
3166
|
+
# and in the order specified in this list.
|
3167
|
+
# @return [Types::Account] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3168
|
+
#
|
3169
|
+
# * {Types::Account#cloudwatch_role_arn #cloudwatchRoleArn} => String
|
3170
|
+
# * {Types::Account#throttle_settings #throttleSettings} => Types::ThrottleSettings
|
3171
|
+
# * {Types::Account#features #features} => Array<String>
|
3172
|
+
# * {Types::Account#api_key_version #apiKeyVersion} => String
|
3173
|
+
#
|
3174
|
+
# @example Request syntax with placeholder values
|
3175
|
+
# resp = client.update_account({
|
3176
|
+
# patch_operations: [
|
3177
|
+
# {
|
3178
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3179
|
+
# path: "String",
|
3180
|
+
# value: "String",
|
3181
|
+
# from: "String",
|
3182
|
+
# },
|
3183
|
+
# ],
|
3184
|
+
# })
|
3185
|
+
#
|
3186
|
+
# @example Response structure
|
3187
|
+
# resp.cloudwatch_role_arn #=> String
|
3188
|
+
# resp.throttle_settings.burst_limit #=> Integer
|
3189
|
+
# resp.throttle_settings.rate_limit #=> Float
|
3190
|
+
# resp.features #=> Array
|
3191
|
+
# resp.features[0] #=> String
|
3192
|
+
# resp.api_key_version #=> String
|
3193
|
+
# @overload update_account(params = {})
|
3194
|
+
# @param [Hash] params ({})
|
3195
|
+
def update_account(params = {}, options = {})
|
3196
|
+
req = build_request(:update_account, params)
|
3197
|
+
req.send_request(options)
|
3198
|
+
end
|
3199
|
+
|
3200
|
+
# Changes information about an ApiKey resource.
|
3201
|
+
# @option params [required, String] :api_key
|
3202
|
+
# The identifier of the ApiKey resource to be updated.
|
3203
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3204
|
+
# A list of update operations to be applied to the specified resource
|
3205
|
+
# and in the order specified in this list.
|
3206
|
+
# @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3207
|
+
#
|
3208
|
+
# * {Types::ApiKey#id #id} => String
|
3209
|
+
# * {Types::ApiKey#value #value} => String
|
3210
|
+
# * {Types::ApiKey#name #name} => String
|
3211
|
+
# * {Types::ApiKey#description #description} => String
|
3212
|
+
# * {Types::ApiKey#enabled #enabled} => Boolean
|
3213
|
+
# * {Types::ApiKey#created_date #createdDate} => Time
|
3214
|
+
# * {Types::ApiKey#last_updated_date #lastUpdatedDate} => Time
|
3215
|
+
# * {Types::ApiKey#stage_keys #stageKeys} => Array<String>
|
3216
|
+
#
|
3217
|
+
# @example Request syntax with placeholder values
|
3218
|
+
# resp = client.update_api_key({
|
3219
|
+
# api_key: "String", # required
|
3220
|
+
# patch_operations: [
|
3221
|
+
# {
|
3222
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3223
|
+
# path: "String",
|
3224
|
+
# value: "String",
|
3225
|
+
# from: "String",
|
3226
|
+
# },
|
3227
|
+
# ],
|
3228
|
+
# })
|
3229
|
+
#
|
3230
|
+
# @example Response structure
|
3231
|
+
# resp.id #=> String
|
3232
|
+
# resp.value #=> String
|
3233
|
+
# resp.name #=> String
|
3234
|
+
# resp.description #=> String
|
3235
|
+
# resp.enabled #=> Boolean
|
3236
|
+
# resp.created_date #=> Time
|
3237
|
+
# resp.last_updated_date #=> Time
|
3238
|
+
# resp.stage_keys #=> Array
|
3239
|
+
# resp.stage_keys[0] #=> String
|
3240
|
+
# @overload update_api_key(params = {})
|
3241
|
+
# @param [Hash] params ({})
|
3242
|
+
def update_api_key(params = {}, options = {})
|
3243
|
+
req = build_request(:update_api_key, params)
|
3244
|
+
req.send_request(options)
|
3245
|
+
end
|
3246
|
+
|
3247
|
+
# Updates an existing Authorizer resource.
|
3248
|
+
#
|
3249
|
+
# <div class="seeAlso">
|
3250
|
+
# [AWS CLI][1]
|
3251
|
+
# </div>
|
3252
|
+
#
|
3253
|
+
#
|
3254
|
+
#
|
3255
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
|
3256
|
+
# @option params [required, String] :rest_api_id
|
3257
|
+
# The RestApi identifier for the Authorizer resource.
|
3258
|
+
# @option params [required, String] :authorizer_id
|
3259
|
+
# The identifier of the Authorizer resource.
|
3260
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3261
|
+
# A list of update operations to be applied to the specified resource
|
3262
|
+
# and in the order specified in this list.
|
3263
|
+
# @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3264
|
+
#
|
3265
|
+
# * {Types::Authorizer#id #id} => String
|
3266
|
+
# * {Types::Authorizer#name #name} => String
|
3267
|
+
# * {Types::Authorizer#type #type} => String
|
3268
|
+
# * {Types::Authorizer#provider_arns #providerARNs} => Array<String>
|
3269
|
+
# * {Types::Authorizer#auth_type #authType} => String
|
3270
|
+
# * {Types::Authorizer#authorizer_uri #authorizerUri} => String
|
3271
|
+
# * {Types::Authorizer#authorizer_credentials #authorizerCredentials} => String
|
3272
|
+
# * {Types::Authorizer#identity_source #identitySource} => String
|
3273
|
+
# * {Types::Authorizer#identity_validation_expression #identityValidationExpression} => String
|
3274
|
+
# * {Types::Authorizer#authorizer_result_ttl_in_seconds #authorizerResultTtlInSeconds} => Integer
|
3275
|
+
#
|
3276
|
+
# @example Request syntax with placeholder values
|
3277
|
+
# resp = client.update_authorizer({
|
3278
|
+
# rest_api_id: "String", # required
|
3279
|
+
# authorizer_id: "String", # required
|
3280
|
+
# patch_operations: [
|
3281
|
+
# {
|
3282
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3283
|
+
# path: "String",
|
3284
|
+
# value: "String",
|
3285
|
+
# from: "String",
|
3286
|
+
# },
|
3287
|
+
# ],
|
3288
|
+
# })
|
3289
|
+
#
|
3290
|
+
# @example Response structure
|
3291
|
+
# resp.id #=> String
|
3292
|
+
# resp.name #=> String
|
3293
|
+
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
3294
|
+
# resp.provider_arns #=> Array
|
3295
|
+
# resp.provider_arns[0] #=> String
|
3296
|
+
# resp.auth_type #=> String
|
3297
|
+
# resp.authorizer_uri #=> String
|
3298
|
+
# resp.authorizer_credentials #=> String
|
3299
|
+
# resp.identity_source #=> String
|
3300
|
+
# resp.identity_validation_expression #=> String
|
3301
|
+
# resp.authorizer_result_ttl_in_seconds #=> Integer
|
3302
|
+
# @overload update_authorizer(params = {})
|
3303
|
+
# @param [Hash] params ({})
|
3304
|
+
def update_authorizer(params = {}, options = {})
|
3305
|
+
req = build_request(:update_authorizer, params)
|
3306
|
+
req.send_request(options)
|
3307
|
+
end
|
3308
|
+
|
3309
|
+
# Changes information about the BasePathMapping resource.
|
3310
|
+
# @option params [required, String] :domain_name
|
3311
|
+
# The domain name of the BasePathMapping resource to change.
|
3312
|
+
# @option params [required, String] :base_path
|
3313
|
+
# The base path of the BasePathMapping resource to change.
|
3314
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3315
|
+
# A list of update operations to be applied to the specified resource
|
3316
|
+
# and in the order specified in this list.
|
3317
|
+
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3318
|
+
#
|
3319
|
+
# * {Types::BasePathMapping#base_path #basePath} => String
|
3320
|
+
# * {Types::BasePathMapping#rest_api_id #restApiId} => String
|
3321
|
+
# * {Types::BasePathMapping#stage #stage} => String
|
3322
|
+
#
|
3323
|
+
# @example Request syntax with placeholder values
|
3324
|
+
# resp = client.update_base_path_mapping({
|
3325
|
+
# domain_name: "String", # required
|
3326
|
+
# base_path: "String", # required
|
3327
|
+
# patch_operations: [
|
3328
|
+
# {
|
3329
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3330
|
+
# path: "String",
|
3331
|
+
# value: "String",
|
3332
|
+
# from: "String",
|
3333
|
+
# },
|
3334
|
+
# ],
|
3335
|
+
# })
|
3336
|
+
#
|
3337
|
+
# @example Response structure
|
3338
|
+
# resp.base_path #=> String
|
3339
|
+
# resp.rest_api_id #=> String
|
3340
|
+
# resp.stage #=> String
|
3341
|
+
# @overload update_base_path_mapping(params = {})
|
3342
|
+
# @param [Hash] params ({})
|
3343
|
+
def update_base_path_mapping(params = {}, options = {})
|
3344
|
+
req = build_request(:update_base_path_mapping, params)
|
3345
|
+
req.send_request(options)
|
3346
|
+
end
|
3347
|
+
|
3348
|
+
# Changes information about an ClientCertificate resource.
|
3349
|
+
# @option params [required, String] :client_certificate_id
|
3350
|
+
# The identifier of the ClientCertificate resource to be updated.
|
3351
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3352
|
+
# A list of update operations to be applied to the specified resource
|
3353
|
+
# and in the order specified in this list.
|
3354
|
+
# @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3355
|
+
#
|
3356
|
+
# * {Types::ClientCertificate#client_certificate_id #clientCertificateId} => String
|
3357
|
+
# * {Types::ClientCertificate#description #description} => String
|
3358
|
+
# * {Types::ClientCertificate#pem_encoded_certificate #pemEncodedCertificate} => String
|
3359
|
+
# * {Types::ClientCertificate#created_date #createdDate} => Time
|
3360
|
+
# * {Types::ClientCertificate#expiration_date #expirationDate} => Time
|
3361
|
+
#
|
3362
|
+
# @example Request syntax with placeholder values
|
3363
|
+
# resp = client.update_client_certificate({
|
3364
|
+
# client_certificate_id: "String", # required
|
3365
|
+
# patch_operations: [
|
3366
|
+
# {
|
3367
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3368
|
+
# path: "String",
|
3369
|
+
# value: "String",
|
3370
|
+
# from: "String",
|
3371
|
+
# },
|
3372
|
+
# ],
|
3373
|
+
# })
|
3374
|
+
#
|
3375
|
+
# @example Response structure
|
3376
|
+
# resp.client_certificate_id #=> String
|
3377
|
+
# resp.description #=> String
|
3378
|
+
# resp.pem_encoded_certificate #=> String
|
3379
|
+
# resp.created_date #=> Time
|
3380
|
+
# resp.expiration_date #=> Time
|
3381
|
+
# @overload update_client_certificate(params = {})
|
3382
|
+
# @param [Hash] params ({})
|
3383
|
+
def update_client_certificate(params = {}, options = {})
|
3384
|
+
req = build_request(:update_client_certificate, params)
|
3385
|
+
req.send_request(options)
|
3386
|
+
end
|
3387
|
+
|
3388
|
+
# Changes information about a Deployment resource.
|
3389
|
+
# @option params [required, String] :rest_api_id
|
3390
|
+
# The replacement identifier of the RestApi resource for the Deployment
|
3391
|
+
# resource to change information about.
|
3392
|
+
# @option params [required, String] :deployment_id
|
3393
|
+
# The replacement identifier for the Deployment resource to change
|
3394
|
+
# information about.
|
3395
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3396
|
+
# A list of update operations to be applied to the specified resource
|
3397
|
+
# and in the order specified in this list.
|
3398
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3399
|
+
#
|
3400
|
+
# * {Types::Deployment#id #id} => String
|
3401
|
+
# * {Types::Deployment#description #description} => String
|
3402
|
+
# * {Types::Deployment#created_date #createdDate} => Time
|
3403
|
+
# * {Types::Deployment#api_summary #apiSummary} => Hash<String,Hash<String,Types::MethodSnapshot>>
|
3404
|
+
#
|
3405
|
+
# @example Request syntax with placeholder values
|
3406
|
+
# resp = client.update_deployment({
|
3407
|
+
# rest_api_id: "String", # required
|
3408
|
+
# deployment_id: "String", # required
|
3409
|
+
# patch_operations: [
|
3410
|
+
# {
|
3411
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3412
|
+
# path: "String",
|
3413
|
+
# value: "String",
|
3414
|
+
# from: "String",
|
3415
|
+
# },
|
3416
|
+
# ],
|
3417
|
+
# })
|
3418
|
+
#
|
3419
|
+
# @example Response structure
|
3420
|
+
# resp.id #=> String
|
3421
|
+
# resp.description #=> String
|
3422
|
+
# resp.created_date #=> Time
|
3423
|
+
# resp.api_summary #=> Hash
|
3424
|
+
# resp.api_summary["String"] #=> Hash
|
3425
|
+
# resp.api_summary["String"]["String"].authorization_type #=> String
|
3426
|
+
# resp.api_summary["String"]["String"].api_key_required #=> Boolean
|
3427
|
+
# @overload update_deployment(params = {})
|
3428
|
+
# @param [Hash] params ({})
|
3429
|
+
def update_deployment(params = {}, options = {})
|
3430
|
+
req = build_request(:update_deployment, params)
|
3431
|
+
req.send_request(options)
|
3432
|
+
end
|
3433
|
+
|
3434
|
+
# Changes information about the DomainName resource.
|
3435
|
+
# @option params [required, String] :domain_name
|
3436
|
+
# The name of the DomainName resource to be changed.
|
3437
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3438
|
+
# A list of update operations to be applied to the specified resource
|
3439
|
+
# and in the order specified in this list.
|
3440
|
+
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3441
|
+
#
|
3442
|
+
# * {Types::DomainName#domain_name #domainName} => String
|
3443
|
+
# * {Types::DomainName#certificate_name #certificateName} => String
|
3444
|
+
# * {Types::DomainName#certificate_upload_date #certificateUploadDate} => Time
|
3445
|
+
# * {Types::DomainName#distribution_domain_name #distributionDomainName} => String
|
3446
|
+
#
|
3447
|
+
# @example Request syntax with placeholder values
|
3448
|
+
# resp = client.update_domain_name({
|
3449
|
+
# domain_name: "String", # required
|
3450
|
+
# patch_operations: [
|
3451
|
+
# {
|
3452
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3453
|
+
# path: "String",
|
3454
|
+
# value: "String",
|
3455
|
+
# from: "String",
|
3456
|
+
# },
|
3457
|
+
# ],
|
3458
|
+
# })
|
3459
|
+
#
|
3460
|
+
# @example Response structure
|
3461
|
+
# resp.domain_name #=> String
|
3462
|
+
# resp.certificate_name #=> String
|
3463
|
+
# resp.certificate_upload_date #=> Time
|
3464
|
+
# resp.distribution_domain_name #=> String
|
3465
|
+
# @overload update_domain_name(params = {})
|
3466
|
+
# @param [Hash] params ({})
|
3467
|
+
def update_domain_name(params = {}, options = {})
|
3468
|
+
req = build_request(:update_domain_name, params)
|
3469
|
+
req.send_request(options)
|
3470
|
+
end
|
3471
|
+
|
3472
|
+
# Represents an update integration.
|
3473
|
+
# @option params [required, String] :rest_api_id
|
3474
|
+
# Represents an update integration request's API identifier.
|
3475
|
+
# @option params [required, String] :resource_id
|
3476
|
+
# Represents an update integration request's resource identifier.
|
3477
|
+
# @option params [required, String] :http_method
|
3478
|
+
# Represents an update integration request's HTTP method.
|
3479
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3480
|
+
# A list of update operations to be applied to the specified resource
|
3481
|
+
# and in the order specified in this list.
|
3482
|
+
# @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3483
|
+
#
|
3484
|
+
# * {Types::Integration#type #type} => String
|
3485
|
+
# * {Types::Integration#http_method #httpMethod} => String
|
3486
|
+
# * {Types::Integration#uri #uri} => String
|
3487
|
+
# * {Types::Integration#credentials #credentials} => String
|
3488
|
+
# * {Types::Integration#request_parameters #requestParameters} => Hash<String,String>
|
3489
|
+
# * {Types::Integration#request_templates #requestTemplates} => Hash<String,String>
|
3490
|
+
# * {Types::Integration#passthrough_behavior #passthroughBehavior} => String
|
3491
|
+
# * {Types::Integration#content_handling #contentHandling} => String
|
3492
|
+
# * {Types::Integration#cache_namespace #cacheNamespace} => String
|
3493
|
+
# * {Types::Integration#cache_key_parameters #cacheKeyParameters} => Array<String>
|
3494
|
+
# * {Types::Integration#integration_responses #integrationResponses} => Hash<String,Types::IntegrationResponse>
|
3495
|
+
#
|
3496
|
+
# @example Request syntax with placeholder values
|
3497
|
+
# resp = client.update_integration({
|
3498
|
+
# rest_api_id: "String", # required
|
3499
|
+
# resource_id: "String", # required
|
3500
|
+
# http_method: "String", # required
|
3501
|
+
# patch_operations: [
|
3502
|
+
# {
|
3503
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3504
|
+
# path: "String",
|
3505
|
+
# value: "String",
|
3506
|
+
# from: "String",
|
3507
|
+
# },
|
3508
|
+
# ],
|
3509
|
+
# })
|
3510
|
+
#
|
3511
|
+
# @example Response structure
|
3512
|
+
# resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
3513
|
+
# resp.http_method #=> String
|
3514
|
+
# resp.uri #=> String
|
3515
|
+
# resp.credentials #=> String
|
3516
|
+
# resp.request_parameters #=> Hash
|
3517
|
+
# resp.request_parameters["String"] #=> String
|
3518
|
+
# resp.request_templates #=> Hash
|
3519
|
+
# resp.request_templates["String"] #=> String
|
3520
|
+
# resp.passthrough_behavior #=> String
|
3521
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3522
|
+
# resp.cache_namespace #=> String
|
3523
|
+
# resp.cache_key_parameters #=> Array
|
3524
|
+
# resp.cache_key_parameters[0] #=> String
|
3525
|
+
# resp.integration_responses #=> Hash
|
3526
|
+
# resp.integration_responses["String"].status_code #=> String
|
3527
|
+
# resp.integration_responses["String"].selection_pattern #=> String
|
3528
|
+
# resp.integration_responses["String"].response_parameters #=> Hash
|
3529
|
+
# resp.integration_responses["String"].response_parameters["String"] #=> String
|
3530
|
+
# resp.integration_responses["String"].response_templates #=> Hash
|
3531
|
+
# resp.integration_responses["String"].response_templates["String"] #=> String
|
3532
|
+
# resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3533
|
+
# @overload update_integration(params = {})
|
3534
|
+
# @param [Hash] params ({})
|
3535
|
+
def update_integration(params = {}, options = {})
|
3536
|
+
req = build_request(:update_integration, params)
|
3537
|
+
req.send_request(options)
|
3538
|
+
end
|
3539
|
+
|
3540
|
+
# Represents an update integration response.
|
3541
|
+
# @option params [required, String] :rest_api_id
|
3542
|
+
# Specifies an update integration response request's API identifier.
|
3543
|
+
# @option params [required, String] :resource_id
|
3544
|
+
# Specifies an update integration response request's resource
|
3545
|
+
# identifier.
|
3546
|
+
# @option params [required, String] :http_method
|
3547
|
+
# Specifies an update integration response request's HTTP method.
|
3548
|
+
# @option params [required, String] :status_code
|
3549
|
+
# Specifies an update integration response request's status code.
|
3550
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3551
|
+
# A list of update operations to be applied to the specified resource
|
3552
|
+
# and in the order specified in this list.
|
3553
|
+
# @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3554
|
+
#
|
3555
|
+
# * {Types::IntegrationResponse#status_code #statusCode} => String
|
3556
|
+
# * {Types::IntegrationResponse#selection_pattern #selectionPattern} => String
|
3557
|
+
# * {Types::IntegrationResponse#response_parameters #responseParameters} => Hash<String,String>
|
3558
|
+
# * {Types::IntegrationResponse#response_templates #responseTemplates} => Hash<String,String>
|
3559
|
+
# * {Types::IntegrationResponse#content_handling #contentHandling} => String
|
3560
|
+
#
|
3561
|
+
# @example Request syntax with placeholder values
|
3562
|
+
# resp = client.update_integration_response({
|
3563
|
+
# rest_api_id: "String", # required
|
3564
|
+
# resource_id: "String", # required
|
3565
|
+
# http_method: "String", # required
|
3566
|
+
# status_code: "StatusCode", # required
|
3567
|
+
# patch_operations: [
|
3568
|
+
# {
|
3569
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3570
|
+
# path: "String",
|
3571
|
+
# value: "String",
|
3572
|
+
# from: "String",
|
3573
|
+
# },
|
3574
|
+
# ],
|
3575
|
+
# })
|
3576
|
+
#
|
3577
|
+
# @example Response structure
|
3578
|
+
# resp.status_code #=> String
|
3579
|
+
# resp.selection_pattern #=> String
|
3580
|
+
# resp.response_parameters #=> Hash
|
3581
|
+
# resp.response_parameters["String"] #=> String
|
3582
|
+
# resp.response_templates #=> Hash
|
3583
|
+
# resp.response_templates["String"] #=> String
|
3584
|
+
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3585
|
+
# @overload update_integration_response(params = {})
|
3586
|
+
# @param [Hash] params ({})
|
3587
|
+
def update_integration_response(params = {}, options = {})
|
3588
|
+
req = build_request(:update_integration_response, params)
|
3589
|
+
req.send_request(options)
|
3590
|
+
end
|
3591
|
+
|
3592
|
+
# Updates an existing Method resource.
|
3593
|
+
# @option params [required, String] :rest_api_id
|
3594
|
+
# The RestApi identifier for the Method resource.
|
3595
|
+
# @option params [required, String] :resource_id
|
3596
|
+
# The Resource identifier for the Method resource.
|
3597
|
+
# @option params [required, String] :http_method
|
3598
|
+
# The HTTP verb of the Method resource.
|
3599
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3600
|
+
# A list of update operations to be applied to the specified resource
|
3601
|
+
# and in the order specified in this list.
|
3602
|
+
# @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3603
|
+
#
|
3604
|
+
# * {Types::Method#http_method #httpMethod} => String
|
3605
|
+
# * {Types::Method#authorization_type #authorizationType} => String
|
3606
|
+
# * {Types::Method#authorizer_id #authorizerId} => String
|
3607
|
+
# * {Types::Method#api_key_required #apiKeyRequired} => Boolean
|
3608
|
+
# * {Types::Method#request_parameters #requestParameters} => Hash<String,Boolean>
|
3609
|
+
# * {Types::Method#request_models #requestModels} => Hash<String,String>
|
3610
|
+
# * {Types::Method#method_responses #methodResponses} => Hash<String,Types::MethodResponse>
|
3611
|
+
# * {Types::Method#method_integration #methodIntegration} => Types::Integration
|
3612
|
+
#
|
3613
|
+
# @example Request syntax with placeholder values
|
3614
|
+
# resp = client.update_method({
|
3615
|
+
# rest_api_id: "String", # required
|
3616
|
+
# resource_id: "String", # required
|
3617
|
+
# http_method: "String", # required
|
3618
|
+
# patch_operations: [
|
3619
|
+
# {
|
3620
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3621
|
+
# path: "String",
|
3622
|
+
# value: "String",
|
3623
|
+
# from: "String",
|
3624
|
+
# },
|
3625
|
+
# ],
|
3626
|
+
# })
|
3627
|
+
#
|
3628
|
+
# @example Response structure
|
3629
|
+
# resp.http_method #=> String
|
3630
|
+
# resp.authorization_type #=> String
|
3631
|
+
# resp.authorizer_id #=> String
|
3632
|
+
# resp.api_key_required #=> Boolean
|
3633
|
+
# resp.request_parameters #=> Hash
|
3634
|
+
# resp.request_parameters["String"] #=> Boolean
|
3635
|
+
# resp.request_models #=> Hash
|
3636
|
+
# resp.request_models["String"] #=> String
|
3637
|
+
# resp.method_responses #=> Hash
|
3638
|
+
# resp.method_responses["String"].status_code #=> String
|
3639
|
+
# resp.method_responses["String"].response_parameters #=> Hash
|
3640
|
+
# resp.method_responses["String"].response_parameters["String"] #=> Boolean
|
3641
|
+
# resp.method_responses["String"].response_models #=> Hash
|
3642
|
+
# resp.method_responses["String"].response_models["String"] #=> String
|
3643
|
+
# resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
3644
|
+
# resp.method_integration.http_method #=> String
|
3645
|
+
# resp.method_integration.uri #=> String
|
3646
|
+
# resp.method_integration.credentials #=> String
|
3647
|
+
# resp.method_integration.request_parameters #=> Hash
|
3648
|
+
# resp.method_integration.request_parameters["String"] #=> String
|
3649
|
+
# resp.method_integration.request_templates #=> Hash
|
3650
|
+
# resp.method_integration.request_templates["String"] #=> String
|
3651
|
+
# resp.method_integration.passthrough_behavior #=> String
|
3652
|
+
# resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3653
|
+
# resp.method_integration.cache_namespace #=> String
|
3654
|
+
# resp.method_integration.cache_key_parameters #=> Array
|
3655
|
+
# resp.method_integration.cache_key_parameters[0] #=> String
|
3656
|
+
# resp.method_integration.integration_responses #=> Hash
|
3657
|
+
# resp.method_integration.integration_responses["String"].status_code #=> String
|
3658
|
+
# resp.method_integration.integration_responses["String"].selection_pattern #=> String
|
3659
|
+
# resp.method_integration.integration_responses["String"].response_parameters #=> Hash
|
3660
|
+
# resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
3661
|
+
# resp.method_integration.integration_responses["String"].response_templates #=> Hash
|
3662
|
+
# resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
|
3663
|
+
# resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3664
|
+
# @overload update_method(params = {})
|
3665
|
+
# @param [Hash] params ({})
|
3666
|
+
def update_method(params = {}, options = {})
|
3667
|
+
req = build_request(:update_method, params)
|
3668
|
+
req.send_request(options)
|
3669
|
+
end
|
3670
|
+
|
3671
|
+
# Updates an existing MethodResponse resource.
|
3672
|
+
# @option params [required, String] :rest_api_id
|
3673
|
+
# The RestApi identifier for the MethodResponse resource.
|
3674
|
+
# @option params [required, String] :resource_id
|
3675
|
+
# The Resource identifier for the MethodResponse resource.
|
3676
|
+
# @option params [required, String] :http_method
|
3677
|
+
# The HTTP verb of the Method resource.
|
3678
|
+
# @option params [required, String] :status_code
|
3679
|
+
# The status code for the MethodResponse resource.
|
3680
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3681
|
+
# A list of update operations to be applied to the specified resource
|
3682
|
+
# and in the order specified in this list.
|
3683
|
+
# @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3684
|
+
#
|
3685
|
+
# * {Types::MethodResponse#status_code #statusCode} => String
|
3686
|
+
# * {Types::MethodResponse#response_parameters #responseParameters} => Hash<String,Boolean>
|
3687
|
+
# * {Types::MethodResponse#response_models #responseModels} => Hash<String,String>
|
3688
|
+
#
|
3689
|
+
# @example Request syntax with placeholder values
|
3690
|
+
# resp = client.update_method_response({
|
3691
|
+
# rest_api_id: "String", # required
|
3692
|
+
# resource_id: "String", # required
|
3693
|
+
# http_method: "String", # required
|
3694
|
+
# status_code: "StatusCode", # required
|
3695
|
+
# patch_operations: [
|
3696
|
+
# {
|
3697
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3698
|
+
# path: "String",
|
3699
|
+
# value: "String",
|
3700
|
+
# from: "String",
|
3701
|
+
# },
|
3702
|
+
# ],
|
3703
|
+
# })
|
3704
|
+
#
|
3705
|
+
# @example Response structure
|
3706
|
+
# resp.status_code #=> String
|
3707
|
+
# resp.response_parameters #=> Hash
|
3708
|
+
# resp.response_parameters["String"] #=> Boolean
|
3709
|
+
# resp.response_models #=> Hash
|
3710
|
+
# resp.response_models["String"] #=> String
|
3711
|
+
# @overload update_method_response(params = {})
|
3712
|
+
# @param [Hash] params ({})
|
3713
|
+
def update_method_response(params = {}, options = {})
|
3714
|
+
req = build_request(:update_method_response, params)
|
3715
|
+
req.send_request(options)
|
3716
|
+
end
|
3717
|
+
|
3718
|
+
# Changes information about a model.
|
3719
|
+
# @option params [required, String] :rest_api_id
|
3720
|
+
# The RestApi identifier under which the model exists.
|
3721
|
+
# @option params [required, String] :model_name
|
3722
|
+
# The name of the model to update.
|
3723
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3724
|
+
# A list of update operations to be applied to the specified resource
|
3725
|
+
# and in the order specified in this list.
|
3726
|
+
# @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3727
|
+
#
|
3728
|
+
# * {Types::Model#id #id} => String
|
3729
|
+
# * {Types::Model#name #name} => String
|
3730
|
+
# * {Types::Model#description #description} => String
|
3731
|
+
# * {Types::Model#schema #schema} => String
|
3732
|
+
# * {Types::Model#content_type #contentType} => String
|
3733
|
+
#
|
3734
|
+
# @example Request syntax with placeholder values
|
3735
|
+
# resp = client.update_model({
|
3736
|
+
# rest_api_id: "String", # required
|
3737
|
+
# model_name: "String", # required
|
3738
|
+
# patch_operations: [
|
3739
|
+
# {
|
3740
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3741
|
+
# path: "String",
|
3742
|
+
# value: "String",
|
3743
|
+
# from: "String",
|
3744
|
+
# },
|
3745
|
+
# ],
|
3746
|
+
# })
|
3747
|
+
#
|
3748
|
+
# @example Response structure
|
3749
|
+
# resp.id #=> String
|
3750
|
+
# resp.name #=> String
|
3751
|
+
# resp.description #=> String
|
3752
|
+
# resp.schema #=> String
|
3753
|
+
# resp.content_type #=> String
|
3754
|
+
# @overload update_model(params = {})
|
3755
|
+
# @param [Hash] params ({})
|
3756
|
+
def update_model(params = {}, options = {})
|
3757
|
+
req = build_request(:update_model, params)
|
3758
|
+
req.send_request(options)
|
3759
|
+
end
|
3760
|
+
|
3761
|
+
# Changes information about a Resource resource.
|
3762
|
+
# @option params [required, String] :rest_api_id
|
3763
|
+
# The RestApi identifier for the Resource resource.
|
3764
|
+
# @option params [required, String] :resource_id
|
3765
|
+
# The identifier of the Resource resource.
|
3766
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3767
|
+
# A list of update operations to be applied to the specified resource
|
3768
|
+
# and in the order specified in this list.
|
3769
|
+
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3770
|
+
#
|
3771
|
+
# * {Types::Resource#id #id} => String
|
3772
|
+
# * {Types::Resource#parent_id #parentId} => String
|
3773
|
+
# * {Types::Resource#path_part #pathPart} => String
|
3774
|
+
# * {Types::Resource#path #path} => String
|
3775
|
+
# * {Types::Resource#resource_methods #resourceMethods} => Hash<String,Types::Method>
|
3776
|
+
#
|
3777
|
+
# @example Request syntax with placeholder values
|
3778
|
+
# resp = client.update_resource({
|
3779
|
+
# rest_api_id: "String", # required
|
3780
|
+
# resource_id: "String", # required
|
3781
|
+
# patch_operations: [
|
3782
|
+
# {
|
3783
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3784
|
+
# path: "String",
|
3785
|
+
# value: "String",
|
3786
|
+
# from: "String",
|
3787
|
+
# },
|
3788
|
+
# ],
|
3789
|
+
# })
|
3790
|
+
#
|
3791
|
+
# @example Response structure
|
3792
|
+
# resp.id #=> String
|
3793
|
+
# resp.parent_id #=> String
|
3794
|
+
# resp.path_part #=> String
|
3795
|
+
# resp.path #=> String
|
3796
|
+
# resp.resource_methods #=> Hash
|
3797
|
+
# resp.resource_methods["String"].http_method #=> String
|
3798
|
+
# resp.resource_methods["String"].authorization_type #=> String
|
3799
|
+
# resp.resource_methods["String"].authorizer_id #=> String
|
3800
|
+
# resp.resource_methods["String"].api_key_required #=> Boolean
|
3801
|
+
# resp.resource_methods["String"].request_parameters #=> Hash
|
3802
|
+
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
3803
|
+
# resp.resource_methods["String"].request_models #=> Hash
|
3804
|
+
# resp.resource_methods["String"].request_models["String"] #=> String
|
3805
|
+
# resp.resource_methods["String"].method_responses #=> Hash
|
3806
|
+
# resp.resource_methods["String"].method_responses["String"].status_code #=> String
|
3807
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
|
3808
|
+
# resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
|
3809
|
+
# resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
|
3810
|
+
# resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
|
3811
|
+
# resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
|
3812
|
+
# resp.resource_methods["String"].method_integration.http_method #=> String
|
3813
|
+
# resp.resource_methods["String"].method_integration.uri #=> String
|
3814
|
+
# resp.resource_methods["String"].method_integration.credentials #=> String
|
3815
|
+
# resp.resource_methods["String"].method_integration.request_parameters #=> Hash
|
3816
|
+
# resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
|
3817
|
+
# resp.resource_methods["String"].method_integration.request_templates #=> Hash
|
3818
|
+
# resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
|
3819
|
+
# resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
|
3820
|
+
# resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3821
|
+
# resp.resource_methods["String"].method_integration.cache_namespace #=> String
|
3822
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
|
3823
|
+
# resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
|
3824
|
+
# resp.resource_methods["String"].method_integration.integration_responses #=> Hash
|
3825
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
|
3826
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
|
3827
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
|
3828
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
|
3829
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
|
3830
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
|
3831
|
+
# resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
|
3832
|
+
# @overload update_resource(params = {})
|
3833
|
+
# @param [Hash] params ({})
|
3834
|
+
def update_resource(params = {}, options = {})
|
3835
|
+
req = build_request(:update_resource, params)
|
3836
|
+
req.send_request(options)
|
3837
|
+
end
|
3838
|
+
|
3839
|
+
# Changes information about the specified API.
|
3840
|
+
# @option params [required, String] :rest_api_id
|
3841
|
+
# The ID of the RestApi you want to update.
|
3842
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3843
|
+
# A list of update operations to be applied to the specified resource
|
3844
|
+
# and in the order specified in this list.
|
3845
|
+
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3846
|
+
#
|
3847
|
+
# * {Types::RestApi#id #id} => String
|
3848
|
+
# * {Types::RestApi#name #name} => String
|
3849
|
+
# * {Types::RestApi#description #description} => String
|
3850
|
+
# * {Types::RestApi#created_date #createdDate} => Time
|
3851
|
+
# * {Types::RestApi#warnings #warnings} => Array<String>
|
3852
|
+
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
3853
|
+
#
|
3854
|
+
# @example Request syntax with placeholder values
|
3855
|
+
# resp = client.update_rest_api({
|
3856
|
+
# rest_api_id: "String", # required
|
3857
|
+
# patch_operations: [
|
3858
|
+
# {
|
3859
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3860
|
+
# path: "String",
|
3861
|
+
# value: "String",
|
3862
|
+
# from: "String",
|
3863
|
+
# },
|
3864
|
+
# ],
|
3865
|
+
# })
|
3866
|
+
#
|
3867
|
+
# @example Response structure
|
3868
|
+
# resp.id #=> String
|
3869
|
+
# resp.name #=> String
|
3870
|
+
# resp.description #=> String
|
3871
|
+
# resp.created_date #=> Time
|
3872
|
+
# resp.warnings #=> Array
|
3873
|
+
# resp.warnings[0] #=> String
|
3874
|
+
# resp.binary_media_types #=> Array
|
3875
|
+
# resp.binary_media_types[0] #=> String
|
3876
|
+
# @overload update_rest_api(params = {})
|
3877
|
+
# @param [Hash] params ({})
|
3878
|
+
def update_rest_api(params = {}, options = {})
|
3879
|
+
req = build_request(:update_rest_api, params)
|
3880
|
+
req.send_request(options)
|
3881
|
+
end
|
3882
|
+
|
3883
|
+
# Changes information about a Stage resource.
|
3884
|
+
# @option params [required, String] :rest_api_id
|
3885
|
+
# The identifier of the RestApi resource for the Stage resource to
|
3886
|
+
# change information about.
|
3887
|
+
# @option params [required, String] :stage_name
|
3888
|
+
# The name of the Stage resource to change information about.
|
3889
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3890
|
+
# A list of update operations to be applied to the specified resource
|
3891
|
+
# and in the order specified in this list.
|
3892
|
+
# @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3893
|
+
#
|
3894
|
+
# * {Types::Stage#deployment_id #deploymentId} => String
|
3895
|
+
# * {Types::Stage#client_certificate_id #clientCertificateId} => String
|
3896
|
+
# * {Types::Stage#stage_name #stageName} => String
|
3897
|
+
# * {Types::Stage#description #description} => String
|
3898
|
+
# * {Types::Stage#cache_cluster_enabled #cacheClusterEnabled} => Boolean
|
3899
|
+
# * {Types::Stage#cache_cluster_size #cacheClusterSize} => String
|
3900
|
+
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
3901
|
+
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
3902
|
+
# * {Types::Stage#variables #variables} => Hash<String,String>
|
3903
|
+
# * {Types::Stage#created_date #createdDate} => Time
|
3904
|
+
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
3905
|
+
#
|
3906
|
+
# @example Request syntax with placeholder values
|
3907
|
+
# resp = client.update_stage({
|
3908
|
+
# rest_api_id: "String", # required
|
3909
|
+
# stage_name: "String", # required
|
3910
|
+
# patch_operations: [
|
3911
|
+
# {
|
3912
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3913
|
+
# path: "String",
|
3914
|
+
# value: "String",
|
3915
|
+
# from: "String",
|
3916
|
+
# },
|
3917
|
+
# ],
|
3918
|
+
# })
|
3919
|
+
#
|
3920
|
+
# @example Response structure
|
3921
|
+
# resp.deployment_id #=> String
|
3922
|
+
# resp.client_certificate_id #=> String
|
3923
|
+
# resp.stage_name #=> String
|
3924
|
+
# resp.description #=> String
|
3925
|
+
# resp.cache_cluster_enabled #=> Boolean
|
3926
|
+
# resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
|
3927
|
+
# resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
|
3928
|
+
# resp.method_settings #=> Hash
|
3929
|
+
# resp.method_settings["String"].metrics_enabled #=> Boolean
|
3930
|
+
# resp.method_settings["String"].logging_level #=> String
|
3931
|
+
# resp.method_settings["String"].data_trace_enabled #=> Boolean
|
3932
|
+
# resp.method_settings["String"].throttling_burst_limit #=> Integer
|
3933
|
+
# resp.method_settings["String"].throttling_rate_limit #=> Float
|
3934
|
+
# resp.method_settings["String"].caching_enabled #=> Boolean
|
3935
|
+
# resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
|
3936
|
+
# resp.method_settings["String"].cache_data_encrypted #=> Boolean
|
3937
|
+
# resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
|
3938
|
+
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
3939
|
+
# resp.variables #=> Hash
|
3940
|
+
# resp.variables["String"] #=> String
|
3941
|
+
# resp.created_date #=> Time
|
3942
|
+
# resp.last_updated_date #=> Time
|
3943
|
+
# @overload update_stage(params = {})
|
3944
|
+
# @param [Hash] params ({})
|
3945
|
+
def update_stage(params = {}, options = {})
|
3946
|
+
req = build_request(:update_stage, params)
|
3947
|
+
req.send_request(options)
|
3948
|
+
end
|
3949
|
+
|
3950
|
+
# Grants a temporary extension to the reamining quota of a usage plan
|
3951
|
+
# associated with a specified API key.
|
3952
|
+
# @option params [required, String] :usage_plan_id
|
3953
|
+
# The Id of the usage plan associated with the usage data.
|
3954
|
+
# @option params [required, String] :key_id
|
3955
|
+
# The identifier of the API key associated with the usage plan in which
|
3956
|
+
# a temporary extension is granted to the remaining quota.
|
3957
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3958
|
+
# A list of update operations to be applied to the specified resource
|
3959
|
+
# and in the order specified in this list.
|
3960
|
+
# @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3961
|
+
#
|
3962
|
+
# * {Types::Usage#usage_plan_id #usagePlanId} => String
|
3963
|
+
# * {Types::Usage#start_date #startDate} => String
|
3964
|
+
# * {Types::Usage#end_date #endDate} => String
|
3965
|
+
# * {Types::Usage#position #position} => String
|
3966
|
+
# * {Types::Usage#items #items} => Hash<String,Array<Array<Integer>>>
|
3967
|
+
#
|
3968
|
+
# @example Request syntax with placeholder values
|
3969
|
+
# resp = client.update_usage({
|
3970
|
+
# usage_plan_id: "String", # required
|
3971
|
+
# key_id: "String", # required
|
3972
|
+
# patch_operations: [
|
3973
|
+
# {
|
3974
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3975
|
+
# path: "String",
|
3976
|
+
# value: "String",
|
3977
|
+
# from: "String",
|
3978
|
+
# },
|
3979
|
+
# ],
|
3980
|
+
# })
|
3981
|
+
#
|
3982
|
+
# @example Response structure
|
3983
|
+
# resp.usage_plan_id #=> String
|
3984
|
+
# resp.start_date #=> String
|
3985
|
+
# resp.end_date #=> String
|
3986
|
+
# resp.position #=> String
|
3987
|
+
# resp.items #=> Hash
|
3988
|
+
# resp.items["String"] #=> Array
|
3989
|
+
# resp.items["String"][0] #=> Array
|
3990
|
+
# resp.items["String"][0][0] #=> Integer
|
3991
|
+
# @overload update_usage(params = {})
|
3992
|
+
# @param [Hash] params ({})
|
3993
|
+
def update_usage(params = {}, options = {})
|
3994
|
+
req = build_request(:update_usage, params)
|
3995
|
+
req.send_request(options)
|
3996
|
+
end
|
3997
|
+
|
3998
|
+
# Updates a usage plan of a given plan Id.
|
3999
|
+
# @option params [required, String] :usage_plan_id
|
4000
|
+
# The Id of the to-be-updated usage plan.
|
4001
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
4002
|
+
# A list of update operations to be applied to the specified resource
|
4003
|
+
# and in the order specified in this list.
|
4004
|
+
# @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4005
|
+
#
|
4006
|
+
# * {Types::UsagePlan#id #id} => String
|
4007
|
+
# * {Types::UsagePlan#name #name} => String
|
4008
|
+
# * {Types::UsagePlan#description #description} => String
|
4009
|
+
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
4010
|
+
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
4011
|
+
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
4012
|
+
#
|
4013
|
+
# @example Request syntax with placeholder values
|
4014
|
+
# resp = client.update_usage_plan({
|
4015
|
+
# usage_plan_id: "String", # required
|
4016
|
+
# patch_operations: [
|
4017
|
+
# {
|
4018
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
4019
|
+
# path: "String",
|
4020
|
+
# value: "String",
|
4021
|
+
# from: "String",
|
4022
|
+
# },
|
4023
|
+
# ],
|
4024
|
+
# })
|
4025
|
+
#
|
4026
|
+
# @example Response structure
|
4027
|
+
# resp.id #=> String
|
4028
|
+
# resp.name #=> String
|
4029
|
+
# resp.description #=> String
|
4030
|
+
# resp.api_stages #=> Array
|
4031
|
+
# resp.api_stages[0].api_id #=> String
|
4032
|
+
# resp.api_stages[0].stage #=> String
|
4033
|
+
# resp.throttle.burst_limit #=> Integer
|
4034
|
+
# resp.throttle.rate_limit #=> Float
|
4035
|
+
# resp.quota.limit #=> Integer
|
4036
|
+
# resp.quota.offset #=> Integer
|
4037
|
+
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
4038
|
+
# @overload update_usage_plan(params = {})
|
4039
|
+
# @param [Hash] params ({})
|
4040
|
+
def update_usage_plan(params = {}, options = {})
|
4041
|
+
req = build_request(:update_usage_plan, params)
|
4042
|
+
req.send_request(options)
|
4043
|
+
end
|
4044
|
+
|
4045
|
+
# @!endgroup
|
4046
|
+
|
4047
|
+
# @param params ({})
|
4048
|
+
# @api private
|
4049
|
+
def build_request(operation_name, params = {})
|
4050
|
+
handlers = @handlers.for(operation_name)
|
4051
|
+
context = Seahorse::Client::RequestContext.new(
|
4052
|
+
operation_name: operation_name,
|
4053
|
+
operation: config.api.operation(operation_name),
|
4054
|
+
client: self,
|
4055
|
+
params: params,
|
4056
|
+
config: config)
|
4057
|
+
context[:gem_name] = 'aws-sdk-apigateway'
|
4058
|
+
context[:gem_version] = '1.0.0.rc1'
|
4059
|
+
Seahorse::Client::Request.new(handlers, context)
|
4060
|
+
end
|
4061
|
+
|
4062
|
+
# @api private
|
4063
|
+
# @deprecated
|
4064
|
+
def waiter_names
|
4065
|
+
[]
|
4066
|
+
end
|
4067
|
+
|
4068
|
+
class << self
|
4069
|
+
|
4070
|
+
# @api private
|
4071
|
+
attr_reader :identifier
|
4072
|
+
|
4073
|
+
# @api private
|
4074
|
+
def errors_module
|
4075
|
+
Errors
|
4076
|
+
end
|
4077
|
+
|
4078
|
+
end
|
4079
|
+
end
|
4080
|
+
end
|
4081
|
+
end
|