aws-sdk-apigateway 1.76.0 → 1.77.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigateway/client.rb +481 -507
- data/lib/aws-sdk-apigateway/types.rb +609 -1445
- data/lib/aws-sdk-apigateway.rb +1 -1
- metadata +2 -2
@@ -15,12 +15,8 @@ module Aws::APIGateway
|
|
15
15
|
#
|
16
16
|
# @!attribute [rw] format
|
17
17
|
# A single line format of the access logs of data, as specified by
|
18
|
-
# selected
|
18
|
+
# selected $context variables. The format must include at least
|
19
19
|
# `$context.requestId`.
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
|
24
20
|
# @return [String]
|
25
21
|
#
|
26
22
|
# @!attribute [rw] destination_arn
|
@@ -39,49 +35,6 @@ module Aws::APIGateway
|
|
39
35
|
|
40
36
|
# Represents an AWS account that is associated with API Gateway.
|
41
37
|
#
|
42
|
-
# <div class="remarks" markdown="1">
|
43
|
-
# To view the account info, call `GET` on this resource.
|
44
|
-
#
|
45
|
-
# #### Error Codes
|
46
|
-
#
|
47
|
-
# The following exception may be thrown when the request fails.
|
48
|
-
#
|
49
|
-
# * UnauthorizedException
|
50
|
-
# * NotFoundException
|
51
|
-
# * TooManyRequestsException
|
52
|
-
#
|
53
|
-
# For detailed error code information, including the corresponding HTTP
|
54
|
-
# Status Codes, see [API Gateway Error Codes][1]
|
55
|
-
#
|
56
|
-
# #### Example: Get the information about an account.
|
57
|
-
#
|
58
|
-
# ##### Request
|
59
|
-
#
|
60
|
-
# GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
61
|
-
#
|
62
|
-
# ##### Response
|
63
|
-
#
|
64
|
-
# The successful response returns a `200 OK` status code and a payload
|
65
|
-
# similar to the following:
|
66
|
-
#
|
67
|
-
# \{ "_links": \{ "curies": \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-\{rel\}.html", "name": "account", "templated": true \}, "self": \{ "href": "/account" \}, "account:update": \{ "href": "/account" \} \}, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": \{ "rateLimit": 500, "burstLimit": 1000 \} \}
|
68
|
-
#
|
69
|
-
# In addition to making the REST API call directly, you can use the AWS
|
70
|
-
# CLI and an AWS SDK to access this resource.
|
71
|
-
#
|
72
|
-
# </div>
|
73
|
-
#
|
74
|
-
# <div class="seeAlso" markdown="1">
|
75
|
-
# [API Gateway Limits][2] [Developer Guide][3], [AWS CLI][4]
|
76
|
-
# </div>
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes
|
81
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html
|
82
|
-
# [3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html
|
83
|
-
# [4]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html
|
84
|
-
#
|
85
38
|
# @!attribute [rw] cloudwatch_role_arn
|
86
39
|
# The ARN of an Amazon CloudWatch role for the current Account.
|
87
40
|
# @return [String]
|
@@ -113,14 +66,6 @@ module Aws::APIGateway
|
|
113
66
|
# on any RestApi, which indicates that the callers with the API key can
|
114
67
|
# make requests to that stage.
|
115
68
|
#
|
116
|
-
# <div class="seeAlso" markdown="1">
|
117
|
-
# [Use API Keys][1]
|
118
|
-
# </div>
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
123
|
-
#
|
124
69
|
# @!attribute [rw] id
|
125
70
|
# The identifier of the API Key.
|
126
71
|
# @return [String]
|
@@ -199,14 +144,6 @@ module Aws::APIGateway
|
|
199
144
|
# Represents a collection of API keys as represented by an ApiKeys
|
200
145
|
# resource.
|
201
146
|
#
|
202
|
-
# <div class="seeAlso" markdown="1">
|
203
|
-
# [Use API Keys][1]
|
204
|
-
# </div>
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
209
|
-
#
|
210
147
|
# @!attribute [rw] warnings
|
211
148
|
# A list of warning messages logged during the import of API keys when
|
212
149
|
# the `failOnWarnings` option is set to true.
|
@@ -268,22 +205,12 @@ module Aws::APIGateway
|
|
268
205
|
# API Gateway will activate the authorizer when a client calls the
|
269
206
|
# method.
|
270
207
|
#
|
271
|
-
# <div class="seeAlso" markdown="1">
|
272
|
-
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
|
273
|
-
# Authorizer][2]
|
274
|
-
# </div>
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
|
279
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
|
280
|
-
#
|
281
208
|
# @!attribute [rw] id
|
282
209
|
# The identifier for the authorizer resource.
|
283
210
|
# @return [String]
|
284
211
|
#
|
285
212
|
# @!attribute [rw] name
|
286
|
-
#
|
213
|
+
# The name of the authorizer.
|
287
214
|
# @return [String]
|
288
215
|
#
|
289
216
|
# @!attribute [rw] type
|
@@ -327,27 +254,27 @@ module Aws::APIGateway
|
|
327
254
|
# @return [String]
|
328
255
|
#
|
329
256
|
# @!attribute [rw] identity_source
|
330
|
-
# The identity source for which authorization is requested.
|
331
|
-
# `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
257
|
+
# The identity source for which authorization is requested. For a
|
258
|
+
# `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and
|
259
|
+
# specifies the request header mapping expression for the custom
|
260
|
+
# header holding the authorization token submitted by the client. For
|
261
|
+
# example, if the token header name is `Auth`, the header mapping
|
262
|
+
# expression is `method.request.header.Auth`. For the `REQUEST`
|
263
|
+
# authorizer, this is required when authorization caching is enabled.
|
264
|
+
# The value is a comma-separated string of one or more mapping
|
265
|
+
# expressions of the specified request parameters. For example, if an
|
266
|
+
# `Auth` header, a `Name` query string parameter are defined as
|
267
|
+
# identity sources, this value is `method.request.header.Auth`,
|
268
|
+
# `method.request.querystring.Name`. These parameters will be used to
|
269
|
+
# derive the authorization caching key and to perform runtime
|
270
|
+
# validation of the `REQUEST` authorizer by verifying all of the
|
271
|
+
# identity-related request parameters are present, not null and
|
272
|
+
# non-empty. Only when this is true does the authorizer invoke the
|
273
|
+
# authorizer Lambda function, otherwise, it returns a 401 Unauthorized
|
274
|
+
# response without calling the Lambda function. The valid value is a
|
275
|
+
# string of comma-separated mapping expressions of the specified
|
276
|
+
# request parameters. When the authorization caching is not enabled,
|
277
|
+
# this property is optional.
|
351
278
|
# @return [String]
|
352
279
|
#
|
353
280
|
# @!attribute [rw] identity_validation_expression
|
@@ -385,16 +312,6 @@ module Aws::APIGateway
|
|
385
312
|
|
386
313
|
# Represents a collection of Authorizer resources.
|
387
314
|
#
|
388
|
-
# <div class="seeAlso" markdown="1">
|
389
|
-
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
|
390
|
-
# Authorizer][2]
|
391
|
-
# </div>
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
|
396
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
|
397
|
-
#
|
398
315
|
# @!attribute [rw] position
|
399
316
|
# @return [String]
|
400
317
|
#
|
@@ -425,19 +342,6 @@ module Aws::APIGateway
|
|
425
342
|
# Represents the base path that callers of the API must provide as part
|
426
343
|
# of the URL after the domain name.
|
427
344
|
#
|
428
|
-
# <div class="remarks" markdown="1">
|
429
|
-
# A custom domain name plus a `BasePathMapping` specification identifies
|
430
|
-
# a deployed RestApi in a given stage of the owner Account.
|
431
|
-
# </div>
|
432
|
-
#
|
433
|
-
# <div class="seeAlso" markdown="1">
|
434
|
-
# [Use Custom Domain Names][1]
|
435
|
-
# </div>
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
440
|
-
#
|
441
345
|
# @!attribute [rw] base_path
|
442
346
|
# The base path name that callers of the API must provide as part of
|
443
347
|
# the URL after the domain name.
|
@@ -461,14 +365,6 @@ module Aws::APIGateway
|
|
461
365
|
|
462
366
|
# Represents a collection of BasePathMapping resources.
|
463
367
|
#
|
464
|
-
# <div class="seeAlso" markdown="1">
|
465
|
-
# [Use Custom Domain Names][1]
|
466
|
-
# </div>
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
471
|
-
#
|
472
368
|
# @!attribute [rw] position
|
473
369
|
# @return [String]
|
474
370
|
#
|
@@ -529,20 +425,6 @@ module Aws::APIGateway
|
|
529
425
|
# Represents a client certificate used to configure client-side SSL
|
530
426
|
# authentication while sending requests to the integration endpoint.
|
531
427
|
#
|
532
|
-
# <div class="remarks">
|
533
|
-
# Client certificates are used to authenticate an API by the backend
|
534
|
-
# server. To authenticate an API client (or user), use IAM roles and
|
535
|
-
# policies, a custom Authorizer or an Amazon Cognito user pool.
|
536
|
-
# </div>
|
537
|
-
#
|
538
|
-
# <div class="seeAlso" markdown="1">
|
539
|
-
# [Use Client-Side Certificate][1]
|
540
|
-
# </div>
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
545
|
-
#
|
546
428
|
# @!attribute [rw] client_certificate_id
|
547
429
|
# The identifier of the client certificate.
|
548
430
|
# @return [String]
|
@@ -583,14 +465,6 @@ module Aws::APIGateway
|
|
583
465
|
|
584
466
|
# Represents a collection of ClientCertificate resources.
|
585
467
|
#
|
586
|
-
# <div class="seeAlso" markdown="1">
|
587
|
-
# [Use Client-Side Certificate][1]
|
588
|
-
# </div>
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
593
|
-
#
|
594
468
|
# @!attribute [rw] position
|
595
469
|
# @return [String]
|
596
470
|
#
|
@@ -710,19 +584,18 @@ module Aws::APIGateway
|
|
710
584
|
# }
|
711
585
|
#
|
712
586
|
# @!attribute [rw] rest_api_id
|
713
|
-
#
|
587
|
+
# The string identifier of the associated RestApi.
|
714
588
|
# @return [String]
|
715
589
|
#
|
716
590
|
# @!attribute [rw] name
|
717
|
-
#
|
591
|
+
# The name of the authorizer.
|
718
592
|
# @return [String]
|
719
593
|
#
|
720
594
|
# @!attribute [rw] type
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
# Cognito user pool.
|
595
|
+
# The authorizer type. Valid values are `TOKEN` for a Lambda function
|
596
|
+
# using a single authorization token submitted in a custom header,
|
597
|
+
# `REQUEST` for a Lambda function using incoming request parameters,
|
598
|
+
# and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
|
726
599
|
# @return [String]
|
727
600
|
#
|
728
601
|
# @!attribute [rw] provider_arns
|
@@ -759,27 +632,27 @@ module Aws::APIGateway
|
|
759
632
|
# @return [String]
|
760
633
|
#
|
761
634
|
# @!attribute [rw] identity_source
|
762
|
-
# The identity source for which authorization is requested.
|
763
|
-
# `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
635
|
+
# The identity source for which authorization is requested. For a
|
636
|
+
# `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and
|
637
|
+
# specifies the request header mapping expression for the custom
|
638
|
+
# header holding the authorization token submitted by the client. For
|
639
|
+
# example, if the token header name is `Auth`, the header mapping
|
640
|
+
# expression is `method.request.header.Auth`. For the `REQUEST`
|
641
|
+
# authorizer, this is required when authorization caching is enabled.
|
642
|
+
# The value is a comma-separated string of one or more mapping
|
643
|
+
# expressions of the specified request parameters. For example, if an
|
644
|
+
# `Auth` header, a `Name` query string parameter are defined as
|
645
|
+
# identity sources, this value is `method.request.header.Auth,
|
646
|
+
# method.request.querystring.Name`. These parameters will be used to
|
647
|
+
# derive the authorization caching key and to perform runtime
|
648
|
+
# validation of the `REQUEST` authorizer by verifying all of the
|
649
|
+
# identity-related request parameters are present, not null and
|
650
|
+
# non-empty. Only when this is true does the authorizer invoke the
|
651
|
+
# authorizer Lambda function, otherwise, it returns a 401 Unauthorized
|
652
|
+
# response without calling the Lambda function. The valid value is a
|
653
|
+
# string of comma-separated mapping expressions of the specified
|
654
|
+
# request parameters. When the authorization caching is not enabled,
|
655
|
+
# this property is optional.
|
783
656
|
# @return [String]
|
784
657
|
#
|
785
658
|
# @!attribute [rw] identity_validation_expression
|
@@ -828,8 +701,7 @@ module Aws::APIGateway
|
|
828
701
|
# }
|
829
702
|
#
|
830
703
|
# @!attribute [rw] domain_name
|
831
|
-
#
|
832
|
-
# create.
|
704
|
+
# The domain name of the BasePathMapping resource to create.
|
833
705
|
# @return [String]
|
834
706
|
#
|
835
707
|
# @!attribute [rw] base_path
|
@@ -840,7 +712,7 @@ module Aws::APIGateway
|
|
840
712
|
# @return [String]
|
841
713
|
#
|
842
714
|
# @!attribute [rw] rest_api_id
|
843
|
-
#
|
715
|
+
# The string identifier of the associated RestApi.
|
844
716
|
# @return [String]
|
845
717
|
#
|
846
718
|
# @!attribute [rw] stage
|
@@ -884,7 +756,7 @@ module Aws::APIGateway
|
|
884
756
|
# }
|
885
757
|
#
|
886
758
|
# @!attribute [rw] rest_api_id
|
887
|
-
#
|
759
|
+
# The string identifier of the associated RestApi.
|
888
760
|
# @return [String]
|
889
761
|
#
|
890
762
|
# @!attribute [rw] stage_name
|
@@ -960,17 +832,17 @@ module Aws::APIGateway
|
|
960
832
|
# }
|
961
833
|
#
|
962
834
|
# @!attribute [rw] rest_api_id
|
963
|
-
#
|
835
|
+
# The string identifier of the associated RestApi.
|
964
836
|
# @return [String]
|
965
837
|
#
|
966
838
|
# @!attribute [rw] location
|
967
|
-
#
|
968
|
-
#
|
839
|
+
# The location of the targeted API entity of the to-be-created
|
840
|
+
# documentation part.
|
969
841
|
# @return [Types::DocumentationPartLocation]
|
970
842
|
#
|
971
843
|
# @!attribute [rw] properties
|
972
|
-
#
|
973
|
-
#
|
844
|
+
# The new documentation content map of the targeted API entity.
|
845
|
+
# Enclosed key-value pairs are API-specific, but only
|
974
846
|
# OpenAPI-compliant key-value pairs can be exported and, hence,
|
975
847
|
# published.
|
976
848
|
# @return [String]
|
@@ -996,11 +868,11 @@ module Aws::APIGateway
|
|
996
868
|
# }
|
997
869
|
#
|
998
870
|
# @!attribute [rw] rest_api_id
|
999
|
-
#
|
871
|
+
# The string identifier of the associated RestApi.
|
1000
872
|
# @return [String]
|
1001
873
|
#
|
1002
874
|
# @!attribute [rw] documentation_version
|
1003
|
-
#
|
875
|
+
# The version identifier of the new snapshot.
|
1004
876
|
# @return [String]
|
1005
877
|
#
|
1006
878
|
# @!attribute [rw] stage_name
|
@@ -1050,7 +922,7 @@ module Aws::APIGateway
|
|
1050
922
|
# }
|
1051
923
|
#
|
1052
924
|
# @!attribute [rw] domain_name
|
1053
|
-
#
|
925
|
+
# The name of the DomainName resource.
|
1054
926
|
# @return [String]
|
1055
927
|
#
|
1056
928
|
# @!attribute [rw] certificate_name
|
@@ -1114,9 +986,10 @@ module Aws::APIGateway
|
|
1114
986
|
# @return [String]
|
1115
987
|
#
|
1116
988
|
# @!attribute [rw] mutual_tls_authentication
|
1117
|
-
#
|
1118
|
-
#
|
1119
|
-
#
|
989
|
+
# The mutual TLS authentication configuration for a custom domain
|
990
|
+
# name. If specified, API Gateway performs two-way authentication
|
991
|
+
# between the client and the server. Clients must present a trusted
|
992
|
+
# certificate to access your API.
|
1120
993
|
# @return [Types::MutualTlsAuthenticationInput]
|
1121
994
|
#
|
1122
995
|
# @!attribute [rw] ownership_verification_certificate_arn
|
@@ -1158,12 +1031,11 @@ module Aws::APIGateway
|
|
1158
1031
|
# }
|
1159
1032
|
#
|
1160
1033
|
# @!attribute [rw] rest_api_id
|
1161
|
-
#
|
1162
|
-
# created.
|
1034
|
+
# The RestApi identifier under which the Model will be created.
|
1163
1035
|
# @return [String]
|
1164
1036
|
#
|
1165
1037
|
# @!attribute [rw] name
|
1166
|
-
#
|
1038
|
+
# The name of the model. Must be alphanumeric.
|
1167
1039
|
# @return [String]
|
1168
1040
|
#
|
1169
1041
|
# @!attribute [rw] description
|
@@ -1172,15 +1044,11 @@ module Aws::APIGateway
|
|
1172
1044
|
#
|
1173
1045
|
# @!attribute [rw] schema
|
1174
1046
|
# The schema for the model. For `application/json` models, this should
|
1175
|
-
# be
|
1176
|
-
#
|
1177
|
-
#
|
1178
|
-
#
|
1179
|
-
# [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
1047
|
+
# be JSON schema draft 4 model.
|
1180
1048
|
# @return [String]
|
1181
1049
|
#
|
1182
1050
|
# @!attribute [rw] content_type
|
1183
|
-
#
|
1051
|
+
# The content-type for the model.
|
1184
1052
|
# @return [String]
|
1185
1053
|
#
|
1186
1054
|
class CreateModelRequest < Struct.new(
|
@@ -1206,7 +1074,7 @@ module Aws::APIGateway
|
|
1206
1074
|
# }
|
1207
1075
|
#
|
1208
1076
|
# @!attribute [rw] rest_api_id
|
1209
|
-
#
|
1077
|
+
# The string identifier of the associated RestApi.
|
1210
1078
|
# @return [String]
|
1211
1079
|
#
|
1212
1080
|
# @!attribute [rw] name
|
@@ -1245,11 +1113,11 @@ module Aws::APIGateway
|
|
1245
1113
|
# }
|
1246
1114
|
#
|
1247
1115
|
# @!attribute [rw] rest_api_id
|
1248
|
-
#
|
1116
|
+
# The string identifier of the associated RestApi.
|
1249
1117
|
# @return [String]
|
1250
1118
|
#
|
1251
1119
|
# @!attribute [rw] parent_id
|
1252
|
-
#
|
1120
|
+
# The parent resource's identifier.
|
1253
1121
|
# @return [String]
|
1254
1122
|
#
|
1255
1123
|
# @!attribute [rw] path_part
|
@@ -1289,7 +1157,7 @@ module Aws::APIGateway
|
|
1289
1157
|
# }
|
1290
1158
|
#
|
1291
1159
|
# @!attribute [rw] name
|
1292
|
-
#
|
1160
|
+
# The name of the RestApi.
|
1293
1161
|
# @return [String]
|
1294
1162
|
#
|
1295
1163
|
# @!attribute [rw] description
|
@@ -1320,11 +1188,9 @@ module Aws::APIGateway
|
|
1320
1188
|
#
|
1321
1189
|
# @!attribute [rw] api_key_source
|
1322
1190
|
# The source of the API key for metering requests according to a usage
|
1323
|
-
# plan. Valid values are:
|
1324
|
-
# `X-API-Key` header of a
|
1325
|
-
#
|
1326
|
-
# * `AUTHORIZER` to read the API key from the `UsageIdentifierKey`
|
1327
|
-
# from a custom authorizer.
|
1191
|
+
# plan. Valid values are: >`HEADER` to read the API key from the
|
1192
|
+
# `X-API-Key` header of a request. `AUTHORIZER` to read the API key
|
1193
|
+
# from the `UsageIdentifierKey` from a custom authorizer.
|
1328
1194
|
# @return [String]
|
1329
1195
|
#
|
1330
1196
|
# @!attribute [rw] endpoint_configuration
|
@@ -1333,7 +1199,8 @@ module Aws::APIGateway
|
|
1333
1199
|
# @return [Types::EndpointConfiguration]
|
1334
1200
|
#
|
1335
1201
|
# @!attribute [rw] policy
|
1336
|
-
# A stringified JSON policy document that applies to this RestApi
|
1202
|
+
# A stringified JSON policy document that applies to this RestApi
|
1203
|
+
# regardless of the caller and Method configuration.
|
1337
1204
|
# @return [String]
|
1338
1205
|
#
|
1339
1206
|
# @!attribute [rw] tags
|
@@ -1346,9 +1213,9 @@ module Aws::APIGateway
|
|
1346
1213
|
# Specifies whether clients can invoke your API by using the default
|
1347
1214
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1348
1215
|
# the default
|
1349
|
-
# https
|
1350
|
-
#
|
1351
|
-
#
|
1216
|
+
# `https://\{api_id\}.execute-api.\{region\}.amazonaws.com` endpoint.
|
1217
|
+
# To require that clients use a custom domain name to invoke your API,
|
1218
|
+
# disable the default endpoint
|
1352
1219
|
# @return [Boolean]
|
1353
1220
|
#
|
1354
1221
|
class CreateRestApiRequest < Struct.new(
|
@@ -1398,18 +1265,17 @@ module Aws::APIGateway
|
|
1398
1265
|
# }
|
1399
1266
|
#
|
1400
1267
|
# @!attribute [rw] rest_api_id
|
1401
|
-
#
|
1268
|
+
# The string identifier of the associated RestApi.
|
1402
1269
|
# @return [String]
|
1403
1270
|
#
|
1404
1271
|
# @!attribute [rw] stage_name
|
1405
|
-
#
|
1406
|
-
#
|
1407
|
-
#
|
1272
|
+
# The name for the Stage resource. Stage names can only contain
|
1273
|
+
# alphanumeric characters, hyphens, and underscores. Maximum length is
|
1274
|
+
# 128 characters.
|
1408
1275
|
# @return [String]
|
1409
1276
|
#
|
1410
1277
|
# @!attribute [rw] deployment_id
|
1411
|
-
#
|
1412
|
-
# resource.
|
1278
|
+
# The identifier of the Deployment resource for the Stage resource.
|
1413
1279
|
# @return [String]
|
1414
1280
|
#
|
1415
1281
|
# @!attribute [rw] description
|
@@ -1478,19 +1344,17 @@ module Aws::APIGateway
|
|
1478
1344
|
# }
|
1479
1345
|
#
|
1480
1346
|
# @!attribute [rw] usage_plan_id
|
1481
|
-
#
|
1482
|
-
#
|
1483
|
-
#
|
1347
|
+
# The Id of the UsagePlan resource representing the usage plan
|
1348
|
+
# containing the to-be-created UsagePlanKey resource representing a
|
1349
|
+
# plan customer.
|
1484
1350
|
# @return [String]
|
1485
1351
|
#
|
1486
1352
|
# @!attribute [rw] key_id
|
1487
|
-
#
|
1488
|
-
# customer.
|
1353
|
+
# The identifier of a UsagePlanKey resource for a plan customer.
|
1489
1354
|
# @return [String]
|
1490
1355
|
#
|
1491
1356
|
# @!attribute [rw] key_type
|
1492
|
-
#
|
1493
|
-
# customer.
|
1357
|
+
# The type of a UsagePlanKey resource for a plan customer.
|
1494
1358
|
# @return [String]
|
1495
1359
|
#
|
1496
1360
|
class CreateUsagePlanKeyRequest < Struct.new(
|
@@ -1538,7 +1402,7 @@ module Aws::APIGateway
|
|
1538
1402
|
# }
|
1539
1403
|
#
|
1540
1404
|
# @!attribute [rw] name
|
1541
|
-
#
|
1405
|
+
# The name of the usage plan.
|
1542
1406
|
# @return [String]
|
1543
1407
|
#
|
1544
1408
|
# @!attribute [rw] description
|
@@ -1592,7 +1456,7 @@ module Aws::APIGateway
|
|
1592
1456
|
# }
|
1593
1457
|
#
|
1594
1458
|
# @!attribute [rw] name
|
1595
|
-
#
|
1459
|
+
# The name used to label and identify the VPC link.
|
1596
1460
|
# @return [String]
|
1597
1461
|
#
|
1598
1462
|
# @!attribute [rw] description
|
@@ -1600,9 +1464,9 @@ module Aws::APIGateway
|
|
1600
1464
|
# @return [String]
|
1601
1465
|
#
|
1602
1466
|
# @!attribute [rw] target_arns
|
1603
|
-
#
|
1604
|
-
#
|
1605
|
-
#
|
1467
|
+
# The ARN of the network load balancer of the VPC targeted by the VPC
|
1468
|
+
# link. The network load balancer must be owned by the same AWS
|
1469
|
+
# account of the API owner.
|
1606
1470
|
# @return [Array<String>]
|
1607
1471
|
#
|
1608
1472
|
# @!attribute [rw] tags
|
@@ -1630,7 +1494,7 @@ module Aws::APIGateway
|
|
1630
1494
|
# }
|
1631
1495
|
#
|
1632
1496
|
# @!attribute [rw] api_key
|
1633
|
-
#
|
1497
|
+
# The identifier of the ApiKey resource to be deleted.
|
1634
1498
|
# @return [String]
|
1635
1499
|
#
|
1636
1500
|
class DeleteApiKeyRequest < Struct.new(
|
@@ -1650,11 +1514,11 @@ module Aws::APIGateway
|
|
1650
1514
|
# }
|
1651
1515
|
#
|
1652
1516
|
# @!attribute [rw] rest_api_id
|
1653
|
-
#
|
1517
|
+
# The string identifier of the associated RestApi.
|
1654
1518
|
# @return [String]
|
1655
1519
|
#
|
1656
1520
|
# @!attribute [rw] authorizer_id
|
1657
|
-
#
|
1521
|
+
# The identifier of the Authorizer resource.
|
1658
1522
|
# @return [String]
|
1659
1523
|
#
|
1660
1524
|
class DeleteAuthorizerRequest < Struct.new(
|
@@ -1675,13 +1539,11 @@ module Aws::APIGateway
|
|
1675
1539
|
# }
|
1676
1540
|
#
|
1677
1541
|
# @!attribute [rw] domain_name
|
1678
|
-
#
|
1679
|
-
# delete.
|
1542
|
+
# The domain name of the BasePathMapping resource to delete.
|
1680
1543
|
# @return [String]
|
1681
1544
|
#
|
1682
1545
|
# @!attribute [rw] base_path
|
1683
|
-
#
|
1684
|
-
# delete.
|
1546
|
+
# The base path name of the BasePathMapping resource to delete.
|
1685
1547
|
#
|
1686
1548
|
# To specify an empty base path, set this parameter to `'(none)'`.
|
1687
1549
|
# @return [String]
|
@@ -1703,8 +1565,7 @@ module Aws::APIGateway
|
|
1703
1565
|
# }
|
1704
1566
|
#
|
1705
1567
|
# @!attribute [rw] client_certificate_id
|
1706
|
-
#
|
1707
|
-
# deleted.
|
1568
|
+
# The identifier of the ClientCertificate resource to be deleted.
|
1708
1569
|
# @return [String]
|
1709
1570
|
#
|
1710
1571
|
class DeleteClientCertificateRequest < Struct.new(
|
@@ -1724,11 +1585,11 @@ module Aws::APIGateway
|
|
1724
1585
|
# }
|
1725
1586
|
#
|
1726
1587
|
# @!attribute [rw] rest_api_id
|
1727
|
-
#
|
1588
|
+
# The string identifier of the associated RestApi.
|
1728
1589
|
# @return [String]
|
1729
1590
|
#
|
1730
1591
|
# @!attribute [rw] deployment_id
|
1731
|
-
#
|
1592
|
+
# The identifier of the Deployment resource to delete.
|
1732
1593
|
# @return [String]
|
1733
1594
|
#
|
1734
1595
|
class DeleteDeploymentRequest < Struct.new(
|
@@ -1749,11 +1610,11 @@ module Aws::APIGateway
|
|
1749
1610
|
# }
|
1750
1611
|
#
|
1751
1612
|
# @!attribute [rw] rest_api_id
|
1752
|
-
#
|
1613
|
+
# The string identifier of the associated RestApi.
|
1753
1614
|
# @return [String]
|
1754
1615
|
#
|
1755
1616
|
# @!attribute [rw] documentation_part_id
|
1756
|
-
#
|
1617
|
+
# The identifier of the to-be-deleted documentation part.
|
1757
1618
|
# @return [String]
|
1758
1619
|
#
|
1759
1620
|
class DeleteDocumentationPartRequest < Struct.new(
|
@@ -1774,12 +1635,11 @@ module Aws::APIGateway
|
|
1774
1635
|
# }
|
1775
1636
|
#
|
1776
1637
|
# @!attribute [rw] rest_api_id
|
1777
|
-
#
|
1638
|
+
# The string identifier of the associated RestApi.
|
1778
1639
|
# @return [String]
|
1779
1640
|
#
|
1780
1641
|
# @!attribute [rw] documentation_version
|
1781
|
-
#
|
1782
|
-
# snapshot.
|
1642
|
+
# The version identifier of a to-be-deleted documentation snapshot.
|
1783
1643
|
# @return [String]
|
1784
1644
|
#
|
1785
1645
|
class DeleteDocumentationVersionRequest < Struct.new(
|
@@ -1799,7 +1659,7 @@ module Aws::APIGateway
|
|
1799
1659
|
# }
|
1800
1660
|
#
|
1801
1661
|
# @!attribute [rw] domain_name
|
1802
|
-
#
|
1662
|
+
# The name of the DomainName resource to be deleted.
|
1803
1663
|
# @return [String]
|
1804
1664
|
#
|
1805
1665
|
class DeleteDomainNameRequest < Struct.new(
|
@@ -1820,11 +1680,11 @@ module Aws::APIGateway
|
|
1820
1680
|
# }
|
1821
1681
|
#
|
1822
1682
|
# @!attribute [rw] rest_api_id
|
1823
|
-
#
|
1683
|
+
# The string identifier of the associated RestApi.
|
1824
1684
|
# @return [String]
|
1825
1685
|
#
|
1826
1686
|
# @!attribute [rw] response_type
|
1827
|
-
#
|
1687
|
+
# The response type of the associated GatewayResponse.
|
1828
1688
|
# @return [String]
|
1829
1689
|
#
|
1830
1690
|
class DeleteGatewayResponseRequest < Struct.new(
|
@@ -1846,16 +1706,15 @@ module Aws::APIGateway
|
|
1846
1706
|
# }
|
1847
1707
|
#
|
1848
1708
|
# @!attribute [rw] rest_api_id
|
1849
|
-
#
|
1709
|
+
# The string identifier of the associated RestApi.
|
1850
1710
|
# @return [String]
|
1851
1711
|
#
|
1852
1712
|
# @!attribute [rw] resource_id
|
1853
|
-
#
|
1854
|
-
# identifier.
|
1713
|
+
# Specifies a delete integration request's resource identifier.
|
1855
1714
|
# @return [String]
|
1856
1715
|
#
|
1857
1716
|
# @!attribute [rw] http_method
|
1858
|
-
#
|
1717
|
+
# Specifies a delete integration request's HTTP method.
|
1859
1718
|
# @return [String]
|
1860
1719
|
#
|
1861
1720
|
class DeleteIntegrationRequest < Struct.new(
|
@@ -1879,22 +1738,20 @@ module Aws::APIGateway
|
|
1879
1738
|
# }
|
1880
1739
|
#
|
1881
1740
|
# @!attribute [rw] rest_api_id
|
1882
|
-
#
|
1741
|
+
# The string identifier of the associated RestApi.
|
1883
1742
|
# @return [String]
|
1884
1743
|
#
|
1885
1744
|
# @!attribute [rw] resource_id
|
1886
|
-
#
|
1887
|
-
#
|
1745
|
+
# Specifies a delete integration response request's resource
|
1746
|
+
# identifier.
|
1888
1747
|
# @return [String]
|
1889
1748
|
#
|
1890
1749
|
# @!attribute [rw] http_method
|
1891
|
-
#
|
1892
|
-
# method.
|
1750
|
+
# Specifies a delete integration response request's HTTP method.
|
1893
1751
|
# @return [String]
|
1894
1752
|
#
|
1895
1753
|
# @!attribute [rw] status_code
|
1896
|
-
#
|
1897
|
-
# status code.
|
1754
|
+
# Specifies a delete integration response request's status code.
|
1898
1755
|
# @return [String]
|
1899
1756
|
#
|
1900
1757
|
class DeleteIntegrationResponseRequest < Struct.new(
|
@@ -1918,15 +1775,15 @@ module Aws::APIGateway
|
|
1918
1775
|
# }
|
1919
1776
|
#
|
1920
1777
|
# @!attribute [rw] rest_api_id
|
1921
|
-
#
|
1778
|
+
# The string identifier of the associated RestApi.
|
1922
1779
|
# @return [String]
|
1923
1780
|
#
|
1924
1781
|
# @!attribute [rw] resource_id
|
1925
|
-
#
|
1782
|
+
# The Resource identifier for the Method resource.
|
1926
1783
|
# @return [String]
|
1927
1784
|
#
|
1928
1785
|
# @!attribute [rw] http_method
|
1929
|
-
#
|
1786
|
+
# The HTTP verb of the Method resource.
|
1930
1787
|
# @return [String]
|
1931
1788
|
#
|
1932
1789
|
class DeleteMethodRequest < Struct.new(
|
@@ -1950,21 +1807,19 @@ module Aws::APIGateway
|
|
1950
1807
|
# }
|
1951
1808
|
#
|
1952
1809
|
# @!attribute [rw] rest_api_id
|
1953
|
-
#
|
1810
|
+
# The string identifier of the associated RestApi.
|
1954
1811
|
# @return [String]
|
1955
1812
|
#
|
1956
1813
|
# @!attribute [rw] resource_id
|
1957
|
-
#
|
1958
|
-
# resource.
|
1814
|
+
# The Resource identifier for the MethodResponse resource.
|
1959
1815
|
# @return [String]
|
1960
1816
|
#
|
1961
1817
|
# @!attribute [rw] http_method
|
1962
|
-
#
|
1818
|
+
# The HTTP verb of the Method resource.
|
1963
1819
|
# @return [String]
|
1964
1820
|
#
|
1965
1821
|
# @!attribute [rw] status_code
|
1966
|
-
#
|
1967
|
-
# resource.
|
1822
|
+
# The status code identifier for the MethodResponse resource.
|
1968
1823
|
# @return [String]
|
1969
1824
|
#
|
1970
1825
|
class DeleteMethodResponseRequest < Struct.new(
|
@@ -1987,11 +1842,11 @@ module Aws::APIGateway
|
|
1987
1842
|
# }
|
1988
1843
|
#
|
1989
1844
|
# @!attribute [rw] rest_api_id
|
1990
|
-
#
|
1845
|
+
# The string identifier of the associated RestApi.
|
1991
1846
|
# @return [String]
|
1992
1847
|
#
|
1993
1848
|
# @!attribute [rw] model_name
|
1994
|
-
#
|
1849
|
+
# The name of the model to delete.
|
1995
1850
|
# @return [String]
|
1996
1851
|
#
|
1997
1852
|
class DeleteModelRequest < Struct.new(
|
@@ -2012,11 +1867,11 @@ module Aws::APIGateway
|
|
2012
1867
|
# }
|
2013
1868
|
#
|
2014
1869
|
# @!attribute [rw] rest_api_id
|
2015
|
-
#
|
1870
|
+
# The string identifier of the associated RestApi.
|
2016
1871
|
# @return [String]
|
2017
1872
|
#
|
2018
1873
|
# @!attribute [rw] request_validator_id
|
2019
|
-
#
|
1874
|
+
# The identifier of the RequestValidator to be deleted.
|
2020
1875
|
# @return [String]
|
2021
1876
|
#
|
2022
1877
|
class DeleteRequestValidatorRequest < Struct.new(
|
@@ -2037,11 +1892,11 @@ module Aws::APIGateway
|
|
2037
1892
|
# }
|
2038
1893
|
#
|
2039
1894
|
# @!attribute [rw] rest_api_id
|
2040
|
-
#
|
1895
|
+
# The string identifier of the associated RestApi.
|
2041
1896
|
# @return [String]
|
2042
1897
|
#
|
2043
1898
|
# @!attribute [rw] resource_id
|
2044
|
-
#
|
1899
|
+
# The identifier of the Resource resource.
|
2045
1900
|
# @return [String]
|
2046
1901
|
#
|
2047
1902
|
class DeleteResourceRequest < Struct.new(
|
@@ -2061,7 +1916,7 @@ module Aws::APIGateway
|
|
2061
1916
|
# }
|
2062
1917
|
#
|
2063
1918
|
# @!attribute [rw] rest_api_id
|
2064
|
-
#
|
1919
|
+
# The string identifier of the associated RestApi.
|
2065
1920
|
# @return [String]
|
2066
1921
|
#
|
2067
1922
|
class DeleteRestApiRequest < Struct.new(
|
@@ -2081,11 +1936,11 @@ module Aws::APIGateway
|
|
2081
1936
|
# }
|
2082
1937
|
#
|
2083
1938
|
# @!attribute [rw] rest_api_id
|
2084
|
-
#
|
1939
|
+
# The string identifier of the associated RestApi.
|
2085
1940
|
# @return [String]
|
2086
1941
|
#
|
2087
1942
|
# @!attribute [rw] stage_name
|
2088
|
-
#
|
1943
|
+
# The name of the Stage resource to delete.
|
2089
1944
|
# @return [String]
|
2090
1945
|
#
|
2091
1946
|
class DeleteStageRequest < Struct.new(
|
@@ -2107,13 +1962,13 @@ module Aws::APIGateway
|
|
2107
1962
|
# }
|
2108
1963
|
#
|
2109
1964
|
# @!attribute [rw] usage_plan_id
|
2110
|
-
#
|
2111
|
-
#
|
2112
|
-
#
|
1965
|
+
# The Id of the UsagePlan resource representing the usage plan
|
1966
|
+
# containing the to-be-deleted UsagePlanKey resource representing a
|
1967
|
+
# plan customer.
|
2113
1968
|
# @return [String]
|
2114
1969
|
#
|
2115
1970
|
# @!attribute [rw] key_id
|
2116
|
-
#
|
1971
|
+
# The Id of the UsagePlanKey resource to be deleted.
|
2117
1972
|
# @return [String]
|
2118
1973
|
#
|
2119
1974
|
class DeleteUsagePlanKeyRequest < Struct.new(
|
@@ -2133,7 +1988,7 @@ module Aws::APIGateway
|
|
2133
1988
|
# }
|
2134
1989
|
#
|
2135
1990
|
# @!attribute [rw] usage_plan_id
|
2136
|
-
#
|
1991
|
+
# The Id of the to-be-deleted usage plan.
|
2137
1992
|
# @return [String]
|
2138
1993
|
#
|
2139
1994
|
class DeleteUsagePlanRequest < Struct.new(
|
@@ -2152,8 +2007,8 @@ module Aws::APIGateway
|
|
2152
2007
|
# }
|
2153
2008
|
#
|
2154
2009
|
# @!attribute [rw] vpc_link_id
|
2155
|
-
#
|
2156
|
-
#
|
2010
|
+
# The identifier of the VpcLink. It is used in an Integration to
|
2011
|
+
# reference this VpcLink.
|
2157
2012
|
# @return [String]
|
2158
2013
|
#
|
2159
2014
|
class DeleteVpcLinkRequest < Struct.new(
|
@@ -2166,22 +2021,6 @@ module Aws::APIGateway
|
|
2166
2021
|
# by users using Stages. A deployment must be associated with a Stage
|
2167
2022
|
# for it to be callable over the Internet.
|
2168
2023
|
#
|
2169
|
-
# <div class="remarks" markdown="1">
|
2170
|
-
# To create a deployment, call `POST` on the Deployments resource of a
|
2171
|
-
# RestApi. To view, update, or delete a deployment, call `GET`, `PATCH`,
|
2172
|
-
# or `DELETE` on the specified deployment resource
|
2173
|
-
# (`/restapis/\{restapi_id\}/deployments/\{deployment_id\}`).
|
2174
|
-
# </div>
|
2175
|
-
#
|
2176
|
-
# <div class="seeAlso" markdown="1">
|
2177
|
-
# RestApi, Deployments, Stage, [AWS CLI][1], [AWS SDKs][2]
|
2178
|
-
# </div>
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
#
|
2182
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html
|
2183
|
-
# [2]: https://aws.amazon.com/tools/
|
2184
|
-
#
|
2185
2024
|
# @!attribute [rw] id
|
2186
2025
|
# The identifier for the deployment resource.
|
2187
2026
|
# @return [String]
|
@@ -2252,23 +2091,6 @@ module Aws::APIGateway
|
|
2252
2091
|
# interact with your collection. The collection offers a paginated view
|
2253
2092
|
# of the contained deployments.
|
2254
2093
|
#
|
2255
|
-
# <div class="remarks" markdown="1">
|
2256
|
-
# To create a new deployment of a RestApi, make a `POST` request against
|
2257
|
-
# this resource. To view, update, or delete an existing deployment, make
|
2258
|
-
# a `GET`, `PATCH`, or `DELETE` request, respectively, on a specified
|
2259
|
-
# Deployment resource.
|
2260
|
-
# </div>
|
2261
|
-
#
|
2262
|
-
# <div class="seeAlso" markdown="1">
|
2263
|
-
# [Deploying an API][1], [AWS CLI][2], [AWS SDKs][3]
|
2264
|
-
# </div>
|
2265
|
-
#
|
2266
|
-
#
|
2267
|
-
#
|
2268
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
|
2269
|
-
# [2]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html
|
2270
|
-
# [3]: https://aws.amazon.com/tools/
|
2271
|
-
#
|
2272
2094
|
# @!attribute [rw] position
|
2273
2095
|
# @return [String]
|
2274
2096
|
#
|
@@ -2285,31 +2107,6 @@ module Aws::APIGateway
|
|
2285
2107
|
|
2286
2108
|
# A documentation part for a targeted API entity.
|
2287
2109
|
#
|
2288
|
-
# <div class="remarks" markdown="1">
|
2289
|
-
# A documentation part consists of a content map (`properties`) and a
|
2290
|
-
# target (`location`). The target specifies an API entity to which the
|
2291
|
-
# documentation content applies. The supported API entity types are
|
2292
|
-
# `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
|
2293
|
-
# `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
|
2294
|
-
# `RESPONSE_HEADER`, and `RESPONSE_BODY`. Valid `location` fields depend
|
2295
|
-
# on the API entity type. All valid fields are not required.
|
2296
|
-
#
|
2297
|
-
# The content map is a JSON string of API-specific key-value pairs.
|
2298
|
-
# Although an API can use any shape for the content map, only the
|
2299
|
-
# OpenAPI-compliant documentation fields will be injected into the
|
2300
|
-
# associated API entity definition in the exported OpenAPI definition
|
2301
|
-
# file.
|
2302
|
-
#
|
2303
|
-
# </div>
|
2304
|
-
#
|
2305
|
-
# <div class="seeAlso" markdown="1">
|
2306
|
-
# [Documenting an API][1], DocumentationParts
|
2307
|
-
# </div>
|
2308
|
-
#
|
2309
|
-
#
|
2310
|
-
#
|
2311
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2312
|
-
#
|
2313
2110
|
# @!attribute [rw] id
|
2314
2111
|
# The DocumentationPart identifier, generated by API Gateway when the
|
2315
2112
|
# `DocumentationPart` is created.
|
@@ -2328,10 +2125,8 @@ module Aws::APIGateway
|
|
2328
2125
|
# A content map of API-specific key-value pairs describing the
|
2329
2126
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
2330
2127
|
# `"\{ "description": "The API does ..." \}"`. Only
|
2331
|
-
# OpenAPI-compliant documentation-related fields from the
|
2332
|
-
#
|
2333
|
-
#
|
2334
|
-
# map are exported and, hence, published as part of the API entity
|
2128
|
+
# OpenAPI-compliant documentation-related fields from the properties
|
2129
|
+
# map are exported and, hence, published as part of the API entity
|
2335
2130
|
# definitions, while the original documentation parts are exported in
|
2336
2131
|
# a OpenAPI extension of `x-amazon-apigateway-documentation`.
|
2337
2132
|
# @return [String]
|
@@ -2346,21 +2141,6 @@ module Aws::APIGateway
|
|
2346
2141
|
|
2347
2142
|
# A collection of the imported DocumentationPart identifiers.
|
2348
2143
|
#
|
2349
|
-
# <div class="remarks">
|
2350
|
-
# This is used to return the result when documentation parts in an
|
2351
|
-
# external (e.g., OpenAPI) file are imported into API Gateway
|
2352
|
-
# </div>
|
2353
|
-
#
|
2354
|
-
# <div class="seeAlso" markdown="1">
|
2355
|
-
# [Documenting an API][1], [documentationpart:import][2],
|
2356
|
-
# DocumentationPart
|
2357
|
-
# </div>
|
2358
|
-
#
|
2359
|
-
#
|
2360
|
-
#
|
2361
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2362
|
-
# [2]: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/
|
2363
|
-
#
|
2364
2144
|
# @!attribute [rw] ids
|
2365
2145
|
# A list of the returned documentation part identifiers.
|
2366
2146
|
# @return [Array<String>]
|
@@ -2391,13 +2171,12 @@ module Aws::APIGateway
|
|
2391
2171
|
# }
|
2392
2172
|
#
|
2393
2173
|
# @!attribute [rw] type
|
2394
|
-
#
|
2395
|
-
#
|
2396
|
-
# `
|
2397
|
-
# `
|
2398
|
-
#
|
2399
|
-
#
|
2400
|
-
# `RESOURCE` type.
|
2174
|
+
# The type of API entity to which the documentation content applies.
|
2175
|
+
# Valid values are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`,
|
2176
|
+
# `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`,
|
2177
|
+
# `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`.
|
2178
|
+
# Content inheritance does not apply to any entity of the `API`,
|
2179
|
+
# `AUTHORIZER`, `METHOD`, `MODEL`, `REQUEST_BODY`, or `RESOURCE` type.
|
2401
2180
|
# @return [String]
|
2402
2181
|
#
|
2403
2182
|
# @!attribute [rw] path
|
@@ -2452,16 +2231,6 @@ module Aws::APIGateway
|
|
2452
2231
|
|
2453
2232
|
# The collection of documentation parts of an API.
|
2454
2233
|
#
|
2455
|
-
# <div class="remarks"></div>
|
2456
|
-
#
|
2457
|
-
# <div class="seeAlso" markdown="1">
|
2458
|
-
# [Documenting an API][1], DocumentationPart
|
2459
|
-
# </div>
|
2460
|
-
#
|
2461
|
-
#
|
2462
|
-
#
|
2463
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2464
|
-
#
|
2465
2234
|
# @!attribute [rw] position
|
2466
2235
|
# @return [String]
|
2467
2236
|
#
|
@@ -2478,21 +2247,6 @@ module Aws::APIGateway
|
|
2478
2247
|
|
2479
2248
|
# A snapshot of the documentation of an API.
|
2480
2249
|
#
|
2481
|
-
# <div class="remarks" markdown="1">
|
2482
|
-
# Publishing API documentation involves creating a documentation version
|
2483
|
-
# associated with an API stage and exporting the versioned documentation
|
2484
|
-
# to an external (e.g., OpenAPI) file.
|
2485
|
-
#
|
2486
|
-
# </div>
|
2487
|
-
#
|
2488
|
-
# <div class="seeAlso" markdown="1">
|
2489
|
-
# [Documenting an API][1], DocumentationPart, DocumentationVersions
|
2490
|
-
# </div>
|
2491
|
-
#
|
2492
|
-
#
|
2493
|
-
#
|
2494
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2495
|
-
#
|
2496
2250
|
# @!attribute [rw] version
|
2497
2251
|
# The version identifier of the API documentation snapshot.
|
2498
2252
|
# @return [String]
|
@@ -2515,20 +2269,6 @@ module Aws::APIGateway
|
|
2515
2269
|
|
2516
2270
|
# The collection of documentation snapshots of an API.
|
2517
2271
|
#
|
2518
|
-
# <div class="remarks" markdown="1">
|
2519
|
-
# Use the DocumentationVersions to manage documentation snapshots
|
2520
|
-
# associated with various API stages.
|
2521
|
-
#
|
2522
|
-
# </div>
|
2523
|
-
#
|
2524
|
-
# <div class="seeAlso" markdown="1">
|
2525
|
-
# [Documenting an API][1], DocumentationPart, DocumentationVersion
|
2526
|
-
# </div>
|
2527
|
-
#
|
2528
|
-
#
|
2529
|
-
#
|
2530
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2531
|
-
#
|
2532
2272
|
# @!attribute [rw] position
|
2533
2273
|
# @return [String]
|
2534
2274
|
#
|
@@ -2546,28 +2286,6 @@ module Aws::APIGateway
|
|
2546
2286
|
# Represents a custom domain name as a user-friendly host name of an API
|
2547
2287
|
# (RestApi).
|
2548
2288
|
#
|
2549
|
-
# <div class="Remarks" markdown="1">
|
2550
|
-
# When you deploy an API, API Gateway creates a default host name for
|
2551
|
-
# the API. This default API host name is of the
|
2552
|
-
# `\{restapi-id\}.execute-api.\{region\}.amazonaws.com` format. With the
|
2553
|
-
# default host name, you can access the API's root resource with the
|
2554
|
-
# URL of
|
2555
|
-
# `https://\{restapi-id\}.execute-api.\{region\}.amazonaws.com/\{stage\}/`.
|
2556
|
-
# When you set up a custom domain name of `apis.example.com` for this
|
2557
|
-
# API, you can then access the same resource using the URL of the
|
2558
|
-
# `https://apis.examples.com/myApi`, where `myApi` is the base path
|
2559
|
-
# mapping (BasePathMapping) of your API under the custom domain name.
|
2560
|
-
#
|
2561
|
-
# </div>
|
2562
|
-
#
|
2563
|
-
# <div class="seeAlso" markdown="1">
|
2564
|
-
# [Set a Custom Host Name for an API][1]
|
2565
|
-
# </div>
|
2566
|
-
#
|
2567
|
-
#
|
2568
|
-
#
|
2569
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
2570
|
-
#
|
2571
2289
|
# @!attribute [rw] domain_name
|
2572
2290
|
# The custom domain name as an API host name, for example,
|
2573
2291
|
# `my-api.example.com`.
|
@@ -2599,13 +2317,8 @@ module Aws::APIGateway
|
|
2599
2317
|
#
|
2600
2318
|
# @!attribute [rw] regional_hosted_zone_id
|
2601
2319
|
# The region-specific Amazon Route 53 Hosted Zone ID of the regional
|
2602
|
-
# endpoint. For more information, see
|
2603
|
-
# Name
|
2604
|
-
#
|
2605
|
-
#
|
2606
|
-
#
|
2607
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
2608
|
-
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
2320
|
+
# endpoint. For more information, see Set up a Regional Custom Domain
|
2321
|
+
# Name and AWS Regions and Endpoints for API Gateway.
|
2609
2322
|
# @return [String]
|
2610
2323
|
#
|
2611
2324
|
# @!attribute [rw] regional_certificate_name
|
@@ -2624,24 +2337,14 @@ module Aws::APIGateway
|
|
2624
2337
|
# with this custom domain name for an edge-optimized endpoint. You set
|
2625
2338
|
# up this association when adding a DNS record pointing the custom
|
2626
2339
|
# domain name to this distribution name. For more information about
|
2627
|
-
# CloudFront distributions, see the
|
2628
|
-
# documentation][1].
|
2629
|
-
#
|
2630
|
-
#
|
2631
|
-
#
|
2632
|
-
# [1]: https://aws.amazon.com/documentation/cloudfront/
|
2340
|
+
# CloudFront distributions, see the Amazon CloudFront documentation.
|
2633
2341
|
# @return [String]
|
2634
2342
|
#
|
2635
2343
|
# @!attribute [rw] distribution_hosted_zone_id
|
2636
2344
|
# The region-agnostic Amazon Route 53 Hosted Zone ID of the
|
2637
2345
|
# edge-optimized endpoint. The valid value is `Z2FDTNDATAQYW2` for all
|
2638
|
-
# the regions. For more information, see
|
2639
|
-
# Domain Name
|
2640
|
-
#
|
2641
|
-
#
|
2642
|
-
#
|
2643
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
2644
|
-
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
2346
|
+
# the regions. For more information, see Set up a Regional Custom
|
2347
|
+
# Domain Name and AWS Regions and Endpoints for API Gateway.
|
2645
2348
|
# @return [String]
|
2646
2349
|
#
|
2647
2350
|
# @!attribute [rw] endpoint_configuration
|
@@ -2651,10 +2354,9 @@ module Aws::APIGateway
|
|
2651
2354
|
#
|
2652
2355
|
# @!attribute [rw] domain_name_status
|
2653
2356
|
# The status of the DomainName migration. The valid values are
|
2654
|
-
# `AVAILABLE
|
2655
|
-
#
|
2656
|
-
#
|
2657
|
-
# complete. If it is `AVAILABLE`, the domain can be updated.
|
2357
|
+
# `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain
|
2358
|
+
# cannot be modified further until the existing operation is complete.
|
2359
|
+
# If it is `AVAILABLE`, the domain can be updated.
|
2658
2360
|
# @return [String]
|
2659
2361
|
#
|
2660
2362
|
# @!attribute [rw] domain_name_status_message
|
@@ -2710,14 +2412,6 @@ module Aws::APIGateway
|
|
2710
2412
|
|
2711
2413
|
# Represents a collection of DomainName resources.
|
2712
2414
|
#
|
2713
|
-
# <div class="seeAlso" markdown="1">
|
2714
|
-
# [Use Client-Side Certificate][1]
|
2715
|
-
# </div>
|
2716
|
-
#
|
2717
|
-
#
|
2718
|
-
#
|
2719
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
2720
|
-
#
|
2721
2415
|
# @!attribute [rw] position
|
2722
2416
|
# @return [String]
|
2723
2417
|
#
|
@@ -2823,11 +2517,11 @@ module Aws::APIGateway
|
|
2823
2517
|
# }
|
2824
2518
|
#
|
2825
2519
|
# @!attribute [rw] rest_api_id
|
2826
|
-
#
|
2520
|
+
# The string identifier of the associated RestApi.
|
2827
2521
|
# @return [String]
|
2828
2522
|
#
|
2829
2523
|
# @!attribute [rw] stage_name
|
2830
|
-
#
|
2524
|
+
# The name of the stage to flush its cache.
|
2831
2525
|
# @return [String]
|
2832
2526
|
#
|
2833
2527
|
class FlushStageCacheRequest < Struct.new(
|
@@ -2840,42 +2534,6 @@ module Aws::APIGateway
|
|
2840
2534
|
# A gateway response of a given response type and status code, with
|
2841
2535
|
# optional response parameters and mapping templates.
|
2842
2536
|
#
|
2843
|
-
# <div class="remarks" markdown="1">
|
2844
|
-
# For more information about valid gateway response types, see [Gateway
|
2845
|
-
# Response Types Supported by API Gateway][1]
|
2846
|
-
# <div class="example" markdown="1">
|
2847
|
-
# #### Example: Get a Gateway Response of a given response type
|
2848
|
-
#
|
2849
|
-
# ##### Request
|
2850
|
-
#
|
2851
|
-
# This example shows how to get a gateway response of the
|
2852
|
-
# `MISSING_AUTHENTICATION_TOKEN` type.
|
2853
|
-
#
|
2854
|
-
# GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential=\{access-key-id\}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
|
2855
|
-
#
|
2856
|
-
# The response type is specified as a URL path.
|
2857
|
-
#
|
2858
|
-
# ##### Response
|
2859
|
-
#
|
2860
|
-
# The successful operation returns the `200 OK` status code and a
|
2861
|
-
# payload similar to the following:
|
2862
|
-
#
|
2863
|
-
# \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-\{rel\}.html", "name": "gatewayresponse", "templated": true \}, "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:delete": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \} \}, "defaultResponse": false, "responseParameters": \{ "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" \}, "responseTemplates": \{ "application/json": "\{\n "message": $context.error.messageString,\n "type": "$context.error.responseType",\n "stage": "$context.stage",\n "resourcePath": "$context.resourcePath",\n "stageVariables.a": "$stageVariables.a",\n "statusCode": "'404'"\n\}" \}, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" \}
|
2864
|
-
#
|
2865
|
-
#
|
2866
|
-
#
|
2867
|
-
# </div>
|
2868
|
-
# </div>
|
2869
|
-
#
|
2870
|
-
# <div class="seeAlso" markdown="1">
|
2871
|
-
# [Customize Gateway Responses][2]
|
2872
|
-
# </div>
|
2873
|
-
#
|
2874
|
-
#
|
2875
|
-
#
|
2876
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2877
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2878
|
-
#
|
2879
2537
|
# @!attribute [rw] response_type
|
2880
2538
|
# The response type of the associated GatewayResponse.
|
2881
2539
|
# @return [String]
|
@@ -2915,42 +2573,6 @@ module Aws::APIGateway
|
|
2915
2573
|
# `responseType`-to-GatewayResponse object map of key-value pairs. As
|
2916
2574
|
# such, pagination is not supported for querying this collection.
|
2917
2575
|
#
|
2918
|
-
# <div class="remarks" markdown="1">
|
2919
|
-
# For more information about valid gateway response types, see [Gateway
|
2920
|
-
# Response Types Supported by API Gateway][1]
|
2921
|
-
# <div class="example" markdown="1">
|
2922
|
-
# #### Example: Get the collection of gateway responses of an API
|
2923
|
-
#
|
2924
|
-
# ##### Request
|
2925
|
-
#
|
2926
|
-
# This example request shows how to retrieve the GatewayResponses
|
2927
|
-
# collection from an API.
|
2928
|
-
#
|
2929
|
-
# GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential=\{access-key-id\}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
|
2930
|
-
#
|
2931
|
-
#
|
2932
|
-
#
|
2933
|
-
# ##### Response
|
2934
|
-
#
|
2935
|
-
# The successful operation returns the `200 OK` status code and a
|
2936
|
-
# payload similar to the following:
|
2937
|
-
#
|
2938
|
-
# \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-\{rel\}.html", "name": "gatewayresponse", "templated": true \}, "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses" \}, "first": \{ "href": "/restapis/o81lxisefl/gatewayresponses" \}, "gatewayresponse:by-type": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "item": [ \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \} ] \}, "_embedded": \{ "item": [ \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "THROTTLED", "statusCode": "429" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "DEFAULT_5XX" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "DEFAULT_4XX" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "EXPIRED_TOKEN", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "ACCESS_DENIED", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INVALID_API_KEY", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "UNAUTHORIZED", "statusCode": "401" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INVALID_SIGNATURE", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" \} ] \} \}
|
2939
|
-
#
|
2940
|
-
#
|
2941
|
-
#
|
2942
|
-
# </div>
|
2943
|
-
# </div>
|
2944
|
-
#
|
2945
|
-
# <div class="seeAlso" markdown="1">
|
2946
|
-
# [Customize Gateway Responses][2]
|
2947
|
-
# </div>
|
2948
|
-
#
|
2949
|
-
#
|
2950
|
-
#
|
2951
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2952
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2953
|
-
#
|
2954
2576
|
# @!attribute [rw] position
|
2955
2577
|
# @return [String]
|
2956
2578
|
#
|
@@ -3012,7 +2634,7 @@ module Aws::APIGateway
|
|
3012
2634
|
# }
|
3013
2635
|
#
|
3014
2636
|
# @!attribute [rw] api_key
|
3015
|
-
#
|
2637
|
+
# The identifier of the ApiKey resource.
|
3016
2638
|
# @return [String]
|
3017
2639
|
#
|
3018
2640
|
# @!attribute [rw] include_value
|
@@ -3084,11 +2706,11 @@ module Aws::APIGateway
|
|
3084
2706
|
# }
|
3085
2707
|
#
|
3086
2708
|
# @!attribute [rw] rest_api_id
|
3087
|
-
#
|
2709
|
+
# The string identifier of the associated RestApi.
|
3088
2710
|
# @return [String]
|
3089
2711
|
#
|
3090
2712
|
# @!attribute [rw] authorizer_id
|
3091
|
-
#
|
2713
|
+
# The identifier of the Authorizer resource.
|
3092
2714
|
# @return [String]
|
3093
2715
|
#
|
3094
2716
|
class GetAuthorizerRequest < Struct.new(
|
@@ -3110,7 +2732,7 @@ module Aws::APIGateway
|
|
3110
2732
|
# }
|
3111
2733
|
#
|
3112
2734
|
# @!attribute [rw] rest_api_id
|
3113
|
-
#
|
2735
|
+
# The string identifier of the associated RestApi.
|
3114
2736
|
# @return [String]
|
3115
2737
|
#
|
3116
2738
|
# @!attribute [rw] position
|
@@ -3141,16 +2763,14 @@ module Aws::APIGateway
|
|
3141
2763
|
# }
|
3142
2764
|
#
|
3143
2765
|
# @!attribute [rw] domain_name
|
3144
|
-
#
|
3145
|
-
# described.
|
2766
|
+
# The domain name of the BasePathMapping resource to be described.
|
3146
2767
|
# @return [String]
|
3147
2768
|
#
|
3148
2769
|
# @!attribute [rw] base_path
|
3149
|
-
#
|
3150
|
-
#
|
3151
|
-
#
|
3152
|
-
#
|
3153
|
-
# domain name.
|
2770
|
+
# The base path name that callers of the API must provide as part of
|
2771
|
+
# the URL after the domain name. This value must be unique for all of
|
2772
|
+
# the mappings across a single API. Specify '(none)' if you do not
|
2773
|
+
# want callers to specify any base path name after the domain name.
|
3154
2774
|
# @return [String]
|
3155
2775
|
#
|
3156
2776
|
class GetBasePathMappingRequest < Struct.new(
|
@@ -3173,7 +2793,7 @@ module Aws::APIGateway
|
|
3173
2793
|
# }
|
3174
2794
|
#
|
3175
2795
|
# @!attribute [rw] domain_name
|
3176
|
-
#
|
2796
|
+
# The domain name of a BasePathMapping resource.
|
3177
2797
|
# @return [String]
|
3178
2798
|
#
|
3179
2799
|
# @!attribute [rw] position
|
@@ -3204,8 +2824,7 @@ module Aws::APIGateway
|
|
3204
2824
|
# }
|
3205
2825
|
#
|
3206
2826
|
# @!attribute [rw] client_certificate_id
|
3207
|
-
#
|
3208
|
-
# described.
|
2827
|
+
# The identifier of the ClientCertificate resource to be described.
|
3209
2828
|
# @return [String]
|
3210
2829
|
#
|
3211
2830
|
class GetClientCertificateRequest < Struct.new(
|
@@ -3253,12 +2872,11 @@ module Aws::APIGateway
|
|
3253
2872
|
# }
|
3254
2873
|
#
|
3255
2874
|
# @!attribute [rw] rest_api_id
|
3256
|
-
#
|
2875
|
+
# The string identifier of the associated RestApi.
|
3257
2876
|
# @return [String]
|
3258
2877
|
#
|
3259
2878
|
# @!attribute [rw] deployment_id
|
3260
|
-
#
|
3261
|
-
# information about.
|
2879
|
+
# The identifier of the Deployment resource to get information about.
|
3262
2880
|
# @return [String]
|
3263
2881
|
#
|
3264
2882
|
# @!attribute [rw] embed
|
@@ -3296,7 +2914,7 @@ module Aws::APIGateway
|
|
3296
2914
|
# }
|
3297
2915
|
#
|
3298
2916
|
# @!attribute [rw] rest_api_id
|
3299
|
-
#
|
2917
|
+
# The string identifier of the associated RestApi.
|
3300
2918
|
# @return [String]
|
3301
2919
|
#
|
3302
2920
|
# @!attribute [rw] position
|
@@ -3327,11 +2945,11 @@ module Aws::APIGateway
|
|
3327
2945
|
# }
|
3328
2946
|
#
|
3329
2947
|
# @!attribute [rw] rest_api_id
|
3330
|
-
#
|
2948
|
+
# The string identifier of the associated RestApi.
|
3331
2949
|
# @return [String]
|
3332
2950
|
#
|
3333
2951
|
# @!attribute [rw] documentation_part_id
|
3334
|
-
#
|
2952
|
+
# The string identifier of the associated RestApi.
|
3335
2953
|
# @return [String]
|
3336
2954
|
#
|
3337
2955
|
class GetDocumentationPartRequest < Struct.new(
|
@@ -3358,7 +2976,7 @@ module Aws::APIGateway
|
|
3358
2976
|
# }
|
3359
2977
|
#
|
3360
2978
|
# @!attribute [rw] rest_api_id
|
3361
|
-
#
|
2979
|
+
# The string identifier of the associated RestApi.
|
3362
2980
|
# @return [String]
|
3363
2981
|
#
|
3364
2982
|
# @!attribute [rw] type
|
@@ -3412,12 +3030,12 @@ module Aws::APIGateway
|
|
3412
3030
|
# }
|
3413
3031
|
#
|
3414
3032
|
# @!attribute [rw] rest_api_id
|
3415
|
-
#
|
3033
|
+
# The string identifier of the associated RestApi.
|
3416
3034
|
# @return [String]
|
3417
3035
|
#
|
3418
3036
|
# @!attribute [rw] documentation_version
|
3419
|
-
#
|
3420
|
-
#
|
3037
|
+
# The version identifier of the to-be-retrieved documentation
|
3038
|
+
# snapshot.
|
3421
3039
|
# @return [String]
|
3422
3040
|
#
|
3423
3041
|
class GetDocumentationVersionRequest < Struct.new(
|
@@ -3439,7 +3057,7 @@ module Aws::APIGateway
|
|
3439
3057
|
# }
|
3440
3058
|
#
|
3441
3059
|
# @!attribute [rw] rest_api_id
|
3442
|
-
#
|
3060
|
+
# The string identifier of the associated RestApi.
|
3443
3061
|
# @return [String]
|
3444
3062
|
#
|
3445
3063
|
# @!attribute [rw] position
|
@@ -3469,7 +3087,7 @@ module Aws::APIGateway
|
|
3469
3087
|
# }
|
3470
3088
|
#
|
3471
3089
|
# @!attribute [rw] domain_name
|
3472
|
-
#
|
3090
|
+
# The name of the DomainName resource.
|
3473
3091
|
# @return [String]
|
3474
3092
|
#
|
3475
3093
|
class GetDomainNameRequest < Struct.new(
|
@@ -3520,16 +3138,16 @@ module Aws::APIGateway
|
|
3520
3138
|
# }
|
3521
3139
|
#
|
3522
3140
|
# @!attribute [rw] rest_api_id
|
3523
|
-
#
|
3141
|
+
# The string identifier of the associated RestApi.
|
3524
3142
|
# @return [String]
|
3525
3143
|
#
|
3526
3144
|
# @!attribute [rw] stage_name
|
3527
|
-
#
|
3145
|
+
# The name of the Stage that will be exported.
|
3528
3146
|
# @return [String]
|
3529
3147
|
#
|
3530
3148
|
# @!attribute [rw] export_type
|
3531
|
-
#
|
3532
|
-
#
|
3149
|
+
# The type of export. Acceptable values are 'oas30' for OpenAPI
|
3150
|
+
# 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
|
3533
3151
|
# @return [String]
|
3534
3152
|
#
|
3535
3153
|
# @!attribute [rw] parameters
|
@@ -3573,11 +3191,11 @@ module Aws::APIGateway
|
|
3573
3191
|
# }
|
3574
3192
|
#
|
3575
3193
|
# @!attribute [rw] rest_api_id
|
3576
|
-
#
|
3194
|
+
# The string identifier of the associated RestApi.
|
3577
3195
|
# @return [String]
|
3578
3196
|
#
|
3579
3197
|
# @!attribute [rw] response_type
|
3580
|
-
#
|
3198
|
+
# The response type of the associated GatewayResponse.
|
3581
3199
|
# @return [String]
|
3582
3200
|
#
|
3583
3201
|
class GetGatewayResponseRequest < Struct.new(
|
@@ -3602,7 +3220,7 @@ module Aws::APIGateway
|
|
3602
3220
|
# }
|
3603
3221
|
#
|
3604
3222
|
# @!attribute [rw] rest_api_id
|
3605
|
-
#
|
3223
|
+
# The string identifier of the associated RestApi.
|
3606
3224
|
# @return [String]
|
3607
3225
|
#
|
3608
3226
|
# @!attribute [rw] position
|
@@ -3637,16 +3255,15 @@ module Aws::APIGateway
|
|
3637
3255
|
# }
|
3638
3256
|
#
|
3639
3257
|
# @!attribute [rw] rest_api_id
|
3640
|
-
#
|
3258
|
+
# The string identifier of the associated RestApi.
|
3641
3259
|
# @return [String]
|
3642
3260
|
#
|
3643
3261
|
# @!attribute [rw] resource_id
|
3644
|
-
#
|
3645
|
-
# identifier
|
3262
|
+
# Specifies a get integration request's resource identifier
|
3646
3263
|
# @return [String]
|
3647
3264
|
#
|
3648
3265
|
# @!attribute [rw] http_method
|
3649
|
-
#
|
3266
|
+
# Specifies a get integration request's HTTP method.
|
3650
3267
|
# @return [String]
|
3651
3268
|
#
|
3652
3269
|
class GetIntegrationRequest < Struct.new(
|
@@ -3670,22 +3287,19 @@ module Aws::APIGateway
|
|
3670
3287
|
# }
|
3671
3288
|
#
|
3672
3289
|
# @!attribute [rw] rest_api_id
|
3673
|
-
#
|
3290
|
+
# The string identifier of the associated RestApi.
|
3674
3291
|
# @return [String]
|
3675
3292
|
#
|
3676
3293
|
# @!attribute [rw] resource_id
|
3677
|
-
#
|
3678
|
-
# resource identifier.
|
3294
|
+
# Specifies a get integration response request's resource identifier.
|
3679
3295
|
# @return [String]
|
3680
3296
|
#
|
3681
3297
|
# @!attribute [rw] http_method
|
3682
|
-
#
|
3683
|
-
# method.
|
3298
|
+
# Specifies a get integration response request's HTTP method.
|
3684
3299
|
# @return [String]
|
3685
3300
|
#
|
3686
3301
|
# @!attribute [rw] status_code
|
3687
|
-
#
|
3688
|
-
# code.
|
3302
|
+
# Specifies a get integration response request's status code.
|
3689
3303
|
# @return [String]
|
3690
3304
|
#
|
3691
3305
|
class GetIntegrationResponseRequest < Struct.new(
|
@@ -3709,15 +3323,15 @@ module Aws::APIGateway
|
|
3709
3323
|
# }
|
3710
3324
|
#
|
3711
3325
|
# @!attribute [rw] rest_api_id
|
3712
|
-
#
|
3326
|
+
# The string identifier of the associated RestApi.
|
3713
3327
|
# @return [String]
|
3714
3328
|
#
|
3715
3329
|
# @!attribute [rw] resource_id
|
3716
|
-
#
|
3330
|
+
# The Resource identifier for the Method resource.
|
3717
3331
|
# @return [String]
|
3718
3332
|
#
|
3719
3333
|
# @!attribute [rw] http_method
|
3720
|
-
#
|
3334
|
+
# Specifies the method request's HTTP method type.
|
3721
3335
|
# @return [String]
|
3722
3336
|
#
|
3723
3337
|
class GetMethodRequest < Struct.new(
|
@@ -3741,20 +3355,19 @@ module Aws::APIGateway
|
|
3741
3355
|
# }
|
3742
3356
|
#
|
3743
3357
|
# @!attribute [rw] rest_api_id
|
3744
|
-
#
|
3358
|
+
# The string identifier of the associated RestApi.
|
3745
3359
|
# @return [String]
|
3746
3360
|
#
|
3747
3361
|
# @!attribute [rw] resource_id
|
3748
|
-
#
|
3749
|
-
# resource.
|
3362
|
+
# The Resource identifier for the MethodResponse resource.
|
3750
3363
|
# @return [String]
|
3751
3364
|
#
|
3752
3365
|
# @!attribute [rw] http_method
|
3753
|
-
#
|
3366
|
+
# The HTTP verb of the Method resource.
|
3754
3367
|
# @return [String]
|
3755
3368
|
#
|
3756
3369
|
# @!attribute [rw] status_code
|
3757
|
-
#
|
3370
|
+
# The status code for the MethodResponse resource.
|
3758
3371
|
# @return [String]
|
3759
3372
|
#
|
3760
3373
|
class GetMethodResponseRequest < Struct.new(
|
@@ -3779,11 +3392,11 @@ module Aws::APIGateway
|
|
3779
3392
|
# }
|
3780
3393
|
#
|
3781
3394
|
# @!attribute [rw] rest_api_id
|
3782
|
-
#
|
3395
|
+
# The RestApi identifier under which the Model exists.
|
3783
3396
|
# @return [String]
|
3784
3397
|
#
|
3785
3398
|
# @!attribute [rw] model_name
|
3786
|
-
#
|
3399
|
+
# The name of the model as an identifier.
|
3787
3400
|
# @return [String]
|
3788
3401
|
#
|
3789
3402
|
# @!attribute [rw] flatten
|
@@ -3812,11 +3425,11 @@ module Aws::APIGateway
|
|
3812
3425
|
# }
|
3813
3426
|
#
|
3814
3427
|
# @!attribute [rw] rest_api_id
|
3815
|
-
#
|
3428
|
+
# The string identifier of the associated RestApi.
|
3816
3429
|
# @return [String]
|
3817
3430
|
#
|
3818
3431
|
# @!attribute [rw] model_name
|
3819
|
-
#
|
3432
|
+
# The name of the model for which to generate a template.
|
3820
3433
|
# @return [String]
|
3821
3434
|
#
|
3822
3435
|
class GetModelTemplateRequest < Struct.new(
|
@@ -3838,7 +3451,7 @@ module Aws::APIGateway
|
|
3838
3451
|
# }
|
3839
3452
|
#
|
3840
3453
|
# @!attribute [rw] rest_api_id
|
3841
|
-
#
|
3454
|
+
# The string identifier of the associated RestApi.
|
3842
3455
|
# @return [String]
|
3843
3456
|
#
|
3844
3457
|
# @!attribute [rw] position
|
@@ -3869,11 +3482,11 @@ module Aws::APIGateway
|
|
3869
3482
|
# }
|
3870
3483
|
#
|
3871
3484
|
# @!attribute [rw] rest_api_id
|
3872
|
-
#
|
3485
|
+
# The string identifier of the associated RestApi.
|
3873
3486
|
# @return [String]
|
3874
3487
|
#
|
3875
3488
|
# @!attribute [rw] request_validator_id
|
3876
|
-
#
|
3489
|
+
# The identifier of the RequestValidator to be retrieved.
|
3877
3490
|
# @return [String]
|
3878
3491
|
#
|
3879
3492
|
class GetRequestValidatorRequest < Struct.new(
|
@@ -3895,7 +3508,7 @@ module Aws::APIGateway
|
|
3895
3508
|
# }
|
3896
3509
|
#
|
3897
3510
|
# @!attribute [rw] rest_api_id
|
3898
|
-
#
|
3511
|
+
# The string identifier of the associated RestApi.
|
3899
3512
|
# @return [String]
|
3900
3513
|
#
|
3901
3514
|
# @!attribute [rw] position
|
@@ -3927,11 +3540,11 @@ module Aws::APIGateway
|
|
3927
3540
|
# }
|
3928
3541
|
#
|
3929
3542
|
# @!attribute [rw] rest_api_id
|
3930
|
-
#
|
3543
|
+
# The string identifier of the associated RestApi.
|
3931
3544
|
# @return [String]
|
3932
3545
|
#
|
3933
3546
|
# @!attribute [rw] resource_id
|
3934
|
-
#
|
3547
|
+
# The identifier for the Resource resource.
|
3935
3548
|
# @return [String]
|
3936
3549
|
#
|
3937
3550
|
# @!attribute [rw] embed
|
@@ -3965,7 +3578,7 @@ module Aws::APIGateway
|
|
3965
3578
|
# }
|
3966
3579
|
#
|
3967
3580
|
# @!attribute [rw] rest_api_id
|
3968
|
-
#
|
3581
|
+
# The string identifier of the associated RestApi.
|
3969
3582
|
# @return [String]
|
3970
3583
|
#
|
3971
3584
|
# @!attribute [rw] position
|
@@ -4007,7 +3620,7 @@ module Aws::APIGateway
|
|
4007
3620
|
# }
|
4008
3621
|
#
|
4009
3622
|
# @!attribute [rw] rest_api_id
|
4010
|
-
#
|
3623
|
+
# The string identifier of the associated RestApi.
|
4011
3624
|
# @return [String]
|
4012
3625
|
#
|
4013
3626
|
class GetRestApiRequest < Struct.new(
|
@@ -4057,17 +3670,17 @@ module Aws::APIGateway
|
|
4057
3670
|
# }
|
4058
3671
|
#
|
4059
3672
|
# @!attribute [rw] rest_api_id
|
4060
|
-
#
|
3673
|
+
# The string identifier of the associated RestApi.
|
4061
3674
|
# @return [String]
|
4062
3675
|
#
|
4063
3676
|
# @!attribute [rw] stage_name
|
4064
|
-
#
|
3677
|
+
# The name of the Stage that the SDK will use.
|
4065
3678
|
# @return [String]
|
4066
3679
|
#
|
4067
3680
|
# @!attribute [rw] sdk_type
|
4068
|
-
#
|
4069
|
-
# `
|
4070
|
-
#
|
3681
|
+
# The language for the generated SDK. Currently `java`, `javascript`,
|
3682
|
+
# `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are
|
3683
|
+
# supported.
|
4071
3684
|
# @return [String]
|
4072
3685
|
#
|
4073
3686
|
# @!attribute [rw] parameters
|
@@ -4099,7 +3712,7 @@ module Aws::APIGateway
|
|
4099
3712
|
# }
|
4100
3713
|
#
|
4101
3714
|
# @!attribute [rw] id
|
4102
|
-
#
|
3715
|
+
# The identifier of the queried SdkType instance.
|
4103
3716
|
# @return [String]
|
4104
3717
|
#
|
4105
3718
|
class GetSdkTypeRequest < Struct.new(
|
@@ -4145,12 +3758,11 @@ module Aws::APIGateway
|
|
4145
3758
|
# }
|
4146
3759
|
#
|
4147
3760
|
# @!attribute [rw] rest_api_id
|
4148
|
-
#
|
3761
|
+
# The string identifier of the associated RestApi.
|
4149
3762
|
# @return [String]
|
4150
3763
|
#
|
4151
3764
|
# @!attribute [rw] stage_name
|
4152
|
-
#
|
4153
|
-
# about.
|
3765
|
+
# The name of the Stage resource to get information about.
|
4154
3766
|
# @return [String]
|
4155
3767
|
#
|
4156
3768
|
class GetStageRequest < Struct.new(
|
@@ -4172,7 +3784,7 @@ module Aws::APIGateway
|
|
4172
3784
|
# }
|
4173
3785
|
#
|
4174
3786
|
# @!attribute [rw] rest_api_id
|
4175
|
-
#
|
3787
|
+
# The string identifier of the associated RestApi.
|
4176
3788
|
# @return [String]
|
4177
3789
|
#
|
4178
3790
|
# @!attribute [rw] deployment_id
|
@@ -4198,7 +3810,7 @@ module Aws::APIGateway
|
|
4198
3810
|
# }
|
4199
3811
|
#
|
4200
3812
|
# @!attribute [rw] resource_arn
|
4201
|
-
#
|
3813
|
+
# The ARN of a resource that can be tagged.
|
4202
3814
|
# @return [String]
|
4203
3815
|
#
|
4204
3816
|
# @!attribute [rw] position
|
@@ -4230,14 +3842,14 @@ module Aws::APIGateway
|
|
4230
3842
|
# }
|
4231
3843
|
#
|
4232
3844
|
# @!attribute [rw] usage_plan_id
|
4233
|
-
#
|
4234
|
-
#
|
4235
|
-
#
|
3845
|
+
# The Id of the UsagePlan resource representing the usage plan
|
3846
|
+
# containing the to-be-retrieved UsagePlanKey resource representing a
|
3847
|
+
# plan customer.
|
4236
3848
|
# @return [String]
|
4237
3849
|
#
|
4238
3850
|
# @!attribute [rw] key_id
|
4239
|
-
#
|
4240
|
-
#
|
3851
|
+
# The key Id of the to-be-retrieved UsagePlanKey resource representing
|
3852
|
+
# a plan customer.
|
4241
3853
|
# @return [String]
|
4242
3854
|
#
|
4243
3855
|
class GetUsagePlanKeyRequest < Struct.new(
|
@@ -4261,9 +3873,9 @@ module Aws::APIGateway
|
|
4261
3873
|
# }
|
4262
3874
|
#
|
4263
3875
|
# @!attribute [rw] usage_plan_id
|
4264
|
-
#
|
4265
|
-
#
|
4266
|
-
#
|
3876
|
+
# The Id of the UsagePlan resource representing the usage plan
|
3877
|
+
# containing the to-be-retrieved UsagePlanKey resource representing a
|
3878
|
+
# plan customer.
|
4267
3879
|
# @return [String]
|
4268
3880
|
#
|
4269
3881
|
# @!attribute [rw] position
|
@@ -4299,8 +3911,7 @@ module Aws::APIGateway
|
|
4299
3911
|
# }
|
4300
3912
|
#
|
4301
3913
|
# @!attribute [rw] usage_plan_id
|
4302
|
-
#
|
4303
|
-
# retrieved.
|
3914
|
+
# The identifier of the UsagePlan resource to be retrieved.
|
4304
3915
|
# @return [String]
|
4305
3916
|
#
|
4306
3917
|
class GetUsagePlanRequest < Struct.new(
|
@@ -4357,8 +3968,7 @@ module Aws::APIGateway
|
|
4357
3968
|
# }
|
4358
3969
|
#
|
4359
3970
|
# @!attribute [rw] usage_plan_id
|
4360
|
-
#
|
4361
|
-
# data.
|
3971
|
+
# The Id of the usage plan associated with the usage data.
|
4362
3972
|
# @return [String]
|
4363
3973
|
#
|
4364
3974
|
# @!attribute [rw] key_id
|
@@ -4366,11 +3976,11 @@ module Aws::APIGateway
|
|
4366
3976
|
# @return [String]
|
4367
3977
|
#
|
4368
3978
|
# @!attribute [rw] start_date
|
4369
|
-
#
|
3979
|
+
# The starting date (e.g., 2016-01-01) of the usage data.
|
4370
3980
|
# @return [String]
|
4371
3981
|
#
|
4372
3982
|
# @!attribute [rw] end_date
|
4373
|
-
#
|
3983
|
+
# The ending date (e.g., 2016-12-31) of the usage data.
|
4374
3984
|
# @return [String]
|
4375
3985
|
#
|
4376
3986
|
# @!attribute [rw] position
|
@@ -4403,8 +4013,8 @@ module Aws::APIGateway
|
|
4403
4013
|
# }
|
4404
4014
|
#
|
4405
4015
|
# @!attribute [rw] vpc_link_id
|
4406
|
-
#
|
4407
|
-
#
|
4016
|
+
# The identifier of the VpcLink. It is used in an Integration to
|
4017
|
+
# reference this VpcLink.
|
4408
4018
|
# @return [String]
|
4409
4019
|
#
|
4410
4020
|
class GetVpcLinkRequest < Struct.new(
|
@@ -4454,11 +4064,7 @@ module Aws::APIGateway
|
|
4454
4064
|
#
|
4455
4065
|
# @!attribute [rw] body
|
4456
4066
|
# The payload of the POST request to import API keys. For the payload
|
4457
|
-
# format, see
|
4458
|
-
#
|
4459
|
-
#
|
4460
|
-
#
|
4461
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
4067
|
+
# format, see API Key File Format.
|
4462
4068
|
# @return [String]
|
4463
4069
|
#
|
4464
4070
|
# @!attribute [rw] format
|
@@ -4493,7 +4099,7 @@ module Aws::APIGateway
|
|
4493
4099
|
# }
|
4494
4100
|
#
|
4495
4101
|
# @!attribute [rw] rest_api_id
|
4496
|
-
#
|
4102
|
+
# The string identifier of the associated RestApi.
|
4497
4103
|
# @return [String]
|
4498
4104
|
#
|
4499
4105
|
# @!attribute [rw] mode
|
@@ -4509,9 +4115,8 @@ module Aws::APIGateway
|
|
4509
4115
|
# @return [Boolean]
|
4510
4116
|
#
|
4511
4117
|
# @!attribute [rw] body
|
4512
|
-
#
|
4513
|
-
#
|
4514
|
-
# object.
|
4118
|
+
# Raw byte array representing the to-be-imported documentation parts.
|
4119
|
+
# To import from an OpenAPI file, this is a JSON object.
|
4515
4120
|
# @return [String]
|
4516
4121
|
#
|
4517
4122
|
class ImportDocumentationPartsRequest < Struct.new(
|
@@ -4564,18 +4169,14 @@ module Aws::APIGateway
|
|
4564
4169
|
# For example, the AWS CLI command to exclude documentation from the
|
4565
4170
|
# imported API is:
|
4566
4171
|
#
|
4567
|
-
# aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
|
4568
|
-
#
|
4569
4172
|
# The AWS CLI command to set the regional endpoint on the imported API
|
4570
4173
|
# is:
|
4571
|
-
#
|
4572
|
-
# aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
|
4573
4174
|
# @return [Hash<String,String>]
|
4574
4175
|
#
|
4575
4176
|
# @!attribute [rw] body
|
4576
|
-
#
|
4577
|
-
#
|
4578
|
-
#
|
4177
|
+
# The POST request body containing external API definitions.
|
4178
|
+
# Currently, only OpenAPI definition JSON/YAML files are supported.
|
4179
|
+
# The maximum size of the API definition file is 6MB.
|
4579
4180
|
# @return [String]
|
4580
4181
|
#
|
4581
4182
|
class ImportRestApiRequest < Struct.new(
|
@@ -4588,42 +4189,10 @@ module Aws::APIGateway
|
|
4588
4189
|
|
4589
4190
|
# Represents an HTTP, HTTP\_PROXY, AWS, AWS\_PROXY, or Mock integration.
|
4590
4191
|
#
|
4591
|
-
# <div class="remarks">
|
4592
|
-
# In the API Gateway console, the built-in Lambda integration is an AWS
|
4593
|
-
# integration.
|
4594
|
-
# </div>
|
4595
|
-
#
|
4596
|
-
# <div class="seeAlso" markdown="1">
|
4597
|
-
# [Creating an API][1]
|
4598
|
-
# </div>
|
4599
|
-
#
|
4600
|
-
#
|
4601
|
-
#
|
4602
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4603
|
-
#
|
4604
4192
|
# @!attribute [rw] type
|
4605
4193
|
# Specifies an API method integration type. The valid value is one of
|
4606
4194
|
# the following:
|
4607
4195
|
#
|
4608
|
-
# * `AWS`\: for integrating the API method request with an AWS service
|
4609
|
-
# action, including the Lambda function-invoking action. With the
|
4610
|
-
# Lambda function-invoking action, this is referred to as the Lambda
|
4611
|
-
# custom integration. With any other AWS service action, this is
|
4612
|
-
# known as AWS integration.
|
4613
|
-
# * `AWS_PROXY`\: for integrating the API method request with the
|
4614
|
-
# Lambda function-invoking action with the client request passed
|
4615
|
-
# through as-is. This integration is also referred to as the Lambda
|
4616
|
-
# proxy integration.
|
4617
|
-
# * `HTTP`\: for integrating the API method request with an HTTP
|
4618
|
-
# endpoint, including a private HTTP endpoint within a VPC. This
|
4619
|
-
# integration is also referred to as the HTTP custom integration.
|
4620
|
-
# * `HTTP_PROXY`\: for integrating the API method request with an HTTP
|
4621
|
-
# endpoint, including a private HTTP endpoint within a VPC, with the
|
4622
|
-
# client request passed through as-is. This is also referred to as
|
4623
|
-
# the HTTP proxy integration.
|
4624
|
-
# * `MOCK`\: for integrating the API method request with API Gateway
|
4625
|
-
# as a "loop-back" endpoint without invoking any backend.
|
4626
|
-
#
|
4627
4196
|
# For the HTTP and HTTP proxy integrations, each integration can
|
4628
4197
|
# specify a protocol (`http/https`), port and path. Standard 80 and
|
4629
4198
|
# 443 ports are supported as well as custom ports above 1024. An HTTP
|
@@ -4640,34 +4209,30 @@ module Aws::APIGateway
|
|
4640
4209
|
# Specifies Uniform Resource Identifier (URI) of the integration
|
4641
4210
|
# endpoint.
|
4642
4211
|
#
|
4643
|
-
#
|
4644
|
-
#
|
4645
|
-
#
|
4646
|
-
#
|
4647
|
-
#
|
4648
|
-
#
|
4649
|
-
#
|
4650
|
-
#
|
4651
|
-
#
|
4652
|
-
#
|
4653
|
-
#
|
4654
|
-
#
|
4655
|
-
#
|
4656
|
-
#
|
4657
|
-
#
|
4658
|
-
#
|
4659
|
-
#
|
4660
|
-
#
|
4661
|
-
#
|
4662
|
-
#
|
4663
|
-
#
|
4664
|
-
#
|
4665
|
-
#
|
4666
|
-
#
|
4667
|
-
#
|
4668
|
-
#
|
4669
|
-
#
|
4670
|
-
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
4212
|
+
# For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
|
4213
|
+
# formed, encoded HTTP(S) URL according to the RFC-3986 specification,
|
4214
|
+
# for either standard integration, where `connectionType` is not
|
4215
|
+
# `VPC_LINK`, or private integration, where `connectionType` is
|
4216
|
+
# `VPC_LINK`. For a private HTTP integration, the URI is not used for
|
4217
|
+
# routing. For `AWS` or `AWS_PROXY` integrations, the URI is of the
|
4218
|
+
# form
|
4219
|
+
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
|
4220
|
+
# Here, \\\{Region\\} is the API Gateway region (e.g., us-east-1);
|
4221
|
+
# \\\{service\\} is the name of the integrated Amazon Web Services
|
4222
|
+
# service (e.g., s3); and \\\{subdomain\\} is a designated subdomain
|
4223
|
+
# supported by certain Amazon Web Services service for fast host-name
|
4224
|
+
# lookup. action can be used for an Amazon Web Services service
|
4225
|
+
# action-based API, using an
|
4226
|
+
# Action=\\\{name\\}&\\\{p1\\}=\\\{v1\\}&p2=\\\{v2\\}... query
|
4227
|
+
# string. The ensuing \\\{service\_api\\} refers to a supported action
|
4228
|
+
# \\\{name\\} plus any required input parameters. Alternatively, path
|
4229
|
+
# can be used for an AWS service path-based API. The ensuing
|
4230
|
+
# service\_api refers to the path to an Amazon Web Services service
|
4231
|
+
# resource, including the region of the integrated Amazon Web Services
|
4232
|
+
# service, if applicable. For example, for integration with the S3 API
|
4233
|
+
# of GetObject, the uri can be either
|
4234
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
4235
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
4671
4236
|
# @return [String]
|
4672
4237
|
#
|
4673
4238
|
# @!attribute [rw] connection_type
|
@@ -4679,12 +4244,8 @@ module Aws::APIGateway
|
|
4679
4244
|
# @return [String]
|
4680
4245
|
#
|
4681
4246
|
# @!attribute [rw] connection_id
|
4682
|
-
# The
|
4247
|
+
# The ID of the VpcLink used for the integration when
|
4683
4248
|
# `connectionType=VPC_LINK` and undefined, otherwise.
|
4684
|
-
#
|
4685
|
-
#
|
4686
|
-
#
|
4687
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
4688
4249
|
# @return [String]
|
4689
4250
|
#
|
4690
4251
|
# @!attribute [rw] credentials
|
@@ -4716,32 +4277,27 @@ module Aws::APIGateway
|
|
4716
4277
|
# @return [Hash<String,String>]
|
4717
4278
|
#
|
4718
4279
|
# @!attribute [rw] passthrough_behavior
|
4719
|
-
# <div markdown="1">
|
4720
4280
|
# Specifies how the method request body of an unmapped content type
|
4721
4281
|
# will be passed through the integration request to the back end
|
4722
4282
|
# without transformation. A content type is unmapped if no mapping
|
4723
4283
|
# template is defined in the integration or the content type does not
|
4724
4284
|
# match any of the mapped content types, as specified in
|
4725
4285
|
# `requestTemplates`. The valid value is one of the following:
|
4726
|
-
#
|
4727
|
-
#
|
4728
|
-
#
|
4729
|
-
#
|
4730
|
-
#
|
4731
|
-
#
|
4732
|
-
#
|
4733
|
-
#
|
4734
|
-
#
|
4735
|
-
#
|
4736
|
-
#
|
4737
|
-
#
|
4738
|
-
#
|
4739
|
-
#
|
4740
|
-
#
|
4741
|
-
# templates defined in the integration request or no mapping
|
4742
|
-
# template is defined in the integration request.
|
4743
|
-
#
|
4744
|
-
# </div>
|
4286
|
+
# `WHEN_NO_MATCH`\: passes the method request body through the
|
4287
|
+
# integration request to the back end without transformation when the
|
4288
|
+
# method request content type does not match any content type
|
4289
|
+
# associated with the mapping templates defined in the integration
|
4290
|
+
# request. `WHEN_NO_TEMPLATES`\: passes the method request body
|
4291
|
+
# through the integration request to the back end without
|
4292
|
+
# transformation when no mapping template is defined in the
|
4293
|
+
# integration request. If a template is defined when this option is
|
4294
|
+
# selected, the method request of an unmapped content-type will be
|
4295
|
+
# rejected with an HTTP 415 Unsupported Media Type response. `NEVER`\:
|
4296
|
+
# rejects the method request with an HTTP 415 Unsupported Media Type
|
4297
|
+
# response when either the method request content type does not match
|
4298
|
+
# any content type associated with the mapping templates defined in
|
4299
|
+
# the integration request or no mapping template is defined in the
|
4300
|
+
# integration request.
|
4745
4301
|
# @return [String]
|
4746
4302
|
#
|
4747
4303
|
# @!attribute [rw] content_handling
|
@@ -4749,12 +4305,6 @@ module Aws::APIGateway
|
|
4749
4305
|
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
4750
4306
|
# the following behaviors:
|
4751
4307
|
#
|
4752
|
-
# * `CONVERT_TO_BINARY`\: Converts a request payload from a
|
4753
|
-
# Base64-encoded string to the corresponding binary blob.
|
4754
|
-
#
|
4755
|
-
# * `CONVERT_TO_TEXT`\: Converts a request payload from a binary blob
|
4756
|
-
# to a Base64-encoded string.
|
4757
|
-
#
|
4758
4308
|
# If this property is not defined, the request payload will be passed
|
4759
4309
|
# through from the method request to integration request without
|
4760
4310
|
# modification, provided that the `passthroughBehavior` is configured
|
@@ -4781,36 +4331,6 @@ module Aws::APIGateway
|
|
4781
4331
|
#
|
4782
4332
|
# @!attribute [rw] integration_responses
|
4783
4333
|
# Specifies the integration's responses.
|
4784
|
-
#
|
4785
|
-
# <div class="remarks" markdown="1">
|
4786
|
-
#
|
4787
|
-
#
|
4788
|
-
# #### Example: Get integration responses of a method
|
4789
|
-
#
|
4790
|
-
# ##### Request
|
4791
|
-
#
|
4792
|
-
#
|
4793
|
-
#
|
4794
|
-
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
4795
|
-
#
|
4796
|
-
# ##### Response
|
4797
|
-
#
|
4798
|
-
# The successful response returns `200 OK` status and a payload as
|
4799
|
-
# follows:
|
4800
|
-
#
|
4801
|
-
# \{ "_links": \{ "curies": \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E")\n" \}, "statusCode": "200" \}
|
4802
|
-
#
|
4803
|
-
#
|
4804
|
-
#
|
4805
|
-
# </div>
|
4806
|
-
#
|
4807
|
-
# <div class="seeAlso" markdown="1">
|
4808
|
-
# [Creating an API][1]
|
4809
|
-
# </div>
|
4810
|
-
#
|
4811
|
-
#
|
4812
|
-
#
|
4813
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4814
4334
|
# @return [Hash<String,Types::IntegrationResponse>]
|
4815
4335
|
#
|
4816
4336
|
# @!attribute [rw] tls_config
|
@@ -4841,14 +4361,6 @@ module Aws::APIGateway
|
|
4841
4361
|
# existing MethodResponse, and parameters and templates can be used to
|
4842
4362
|
# transform the back-end response.
|
4843
4363
|
#
|
4844
|
-
# <div class="seeAlso" markdown="1">
|
4845
|
-
# [Creating an API][1]
|
4846
|
-
# </div>
|
4847
|
-
#
|
4848
|
-
#
|
4849
|
-
#
|
4850
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4851
|
-
#
|
4852
4364
|
# @!attribute [rw] status_code
|
4853
4365
|
# Specifies the status code that is used to map the integration
|
4854
4366
|
# response to an existing MethodResponse.
|
@@ -4892,12 +4404,6 @@ module Aws::APIGateway
|
|
4892
4404
|
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
4893
4405
|
# the following behaviors:
|
4894
4406
|
#
|
4895
|
-
# * `CONVERT_TO_BINARY`\: Converts a response payload from a
|
4896
|
-
# Base64-encoded string to the corresponding binary blob.
|
4897
|
-
#
|
4898
|
-
# * `CONVERT_TO_TEXT`\: Converts a response payload from a binary blob
|
4899
|
-
# to a Base64-encoded string.
|
4900
|
-
#
|
4901
4407
|
# If this property is not defined, the response payload will be passed
|
4902
4408
|
# through from the integration response to the method response without
|
4903
4409
|
# modification.
|
@@ -4930,55 +4436,17 @@ module Aws::APIGateway
|
|
4930
4436
|
end
|
4931
4437
|
|
4932
4438
|
# Represents a client-facing interface by which the client calls the API
|
4933
|
-
# to access back-end resources. A
|
4934
|
-
#
|
4439
|
+
# to access back-end resources. A Method resource is integrated with an
|
4440
|
+
# Integration resource. Both consist of a request and one or more
|
4935
4441
|
# responses. The method request takes the client input that is passed to
|
4936
4442
|
# the back end through the integration request. A method response
|
4937
4443
|
# returns the output from the back end to the client through an
|
4938
|
-
# integration response. A method request is embodied in a
|
4444
|
+
# integration response. A method request is embodied in a Method
|
4939
4445
|
# resource, whereas an integration request is embodied in an Integration
|
4940
4446
|
# resource. On the other hand, a method response is represented by a
|
4941
4447
|
# MethodResponse resource, whereas an integration response is
|
4942
4448
|
# represented by an IntegrationResponse resource.
|
4943
4449
|
#
|
4944
|
-
# <div class="remarks" markdown="1">
|
4945
|
-
#
|
4946
|
-
#
|
4947
|
-
# #### Example: Retrive the GET method on a specified resource
|
4948
|
-
#
|
4949
|
-
# ##### Request
|
4950
|
-
#
|
4951
|
-
# The following example request retrieves the information about the GET
|
4952
|
-
# method on an API resource (`3kzxbg5sa2`) of an API (`fugvjdxtri`).
|
4953
|
-
#
|
4954
|
-
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
4955
|
-
#
|
4956
|
-
# ##### Response
|
4957
|
-
#
|
4958
|
-
# The successful response returns a `200 OK` status code and a payload
|
4959
|
-
# similar to the following:
|
4960
|
-
#
|
4961
|
-
# \{ "_links": \{ "curies": [ \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-\{rel\}.html", "name": "method", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \} ], "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" \}, "integration:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "method:integration": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "method:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "methodresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/\{status_code\}", "templated": true \} \}, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": \{ "method:integration": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": \{ "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" \}, "requestTemplates": \{ "application/json": "\{\n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" \}, "statusCode": "200" \} \} \}, "method:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \} \} \}
|
4962
|
-
#
|
4963
|
-
# In the example above, the response template for the `200 OK` response
|
4964
|
-
# maps the JSON output from the `ListStreams` action in the back end to
|
4965
|
-
# an XML output. The mapping template is URL-encoded as
|
4966
|
-
# `%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E`
|
4967
|
-
# and the output is decoded using the [$util.urlDecode()][1] helper
|
4968
|
-
# function.
|
4969
|
-
#
|
4970
|
-
# </div>
|
4971
|
-
#
|
4972
|
-
# <div class="seeAlso" markdown="1">
|
4973
|
-
# MethodResponse, Integration, IntegrationResponse, Resource, [Set up an
|
4974
|
-
# API's method][2]
|
4975
|
-
# </div>
|
4976
|
-
#
|
4977
|
-
#
|
4978
|
-
#
|
4979
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference
|
4980
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html
|
4981
|
-
#
|
4982
4450
|
# @!attribute [rw] http_method
|
4983
4451
|
# The method's HTTP verb.
|
4984
4452
|
# @return [String]
|
@@ -5031,75 +4499,12 @@ module Aws::APIGateway
|
|
5031
4499
|
#
|
5032
4500
|
# @!attribute [rw] method_responses
|
5033
4501
|
# Gets a method response associated with a given HTTP status code.
|
5034
|
-
#
|
5035
|
-
# <div class="remarks" markdown="1">
|
5036
|
-
# The collection of method responses are encapsulated in a key-value
|
5037
|
-
# map, where the key is a response's HTTP status code and the value
|
5038
|
-
# is a MethodResponse resource that specifies the response returned to
|
5039
|
-
# the caller from the back end through the integration response.
|
5040
|
-
#
|
5041
|
-
# #### Example: Get a 200 OK response of a GET method
|
5042
|
-
#
|
5043
|
-
# ##### Request
|
5044
|
-
#
|
5045
|
-
#
|
5046
|
-
#
|
5047
|
-
# GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
5048
|
-
#
|
5049
|
-
# ##### Response
|
5050
|
-
#
|
5051
|
-
# The successful response returns a `200 OK` status code and a payload
|
5052
|
-
# similar to the following:
|
5053
|
-
#
|
5054
|
-
# \{ "_links": \{ "curies": \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false \}, "statusCode": "200" \}
|
5055
|
-
#
|
5056
|
-
#
|
5057
|
-
#
|
5058
|
-
# </div>
|
5059
|
-
#
|
5060
|
-
# <div class="seeAlso" markdown="1">
|
5061
|
-
# [AWS CLI][1]
|
5062
|
-
# </div>
|
5063
|
-
#
|
5064
|
-
#
|
5065
|
-
#
|
5066
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html
|
5067
4502
|
# @return [Hash<String,Types::MethodResponse>]
|
5068
4503
|
#
|
5069
4504
|
# @!attribute [rw] method_integration
|
5070
4505
|
# Gets the method's integration responsible for passing the
|
5071
4506
|
# client-submitted request to the back end and performing necessary
|
5072
4507
|
# transformations to make the request compliant with the back end.
|
5073
|
-
#
|
5074
|
-
# <div class="remarks" markdown="1">
|
5075
|
-
#
|
5076
|
-
#
|
5077
|
-
# #### Example:
|
5078
|
-
#
|
5079
|
-
# ##### Request
|
5080
|
-
#
|
5081
|
-
#
|
5082
|
-
#
|
5083
|
-
# GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
5084
|
-
#
|
5085
|
-
# ##### Response
|
5086
|
-
#
|
5087
|
-
# The successful response returns a `200 OK` status code and a payload
|
5088
|
-
# similar to the following:
|
5089
|
-
#
|
5090
|
-
# \{ "_links": \{ "curies": [ \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \} ], "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": \{ "application/json": "\{\n "a": "$input.params('operand1')",\n "b": "$input.params('operand2')", \n "op": "$input.params('operator')" \n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" \}, "responseTemplates": \{ "application/json": "#set($res = $input.path('$'))\n\{\n "result": "$res.a, $res.b, $res.op => $res.c",\n "a" : "$res.a",\n "b" : "$res.b",\n "op" : "$res.op",\n "c" : "$res.c"\n\}" \}, "selectionPattern": "", "statusCode": "200" \} \} \}
|
5091
|
-
#
|
5092
|
-
#
|
5093
|
-
#
|
5094
|
-
# </div>
|
5095
|
-
#
|
5096
|
-
# <div class="seeAlso" markdown="1">
|
5097
|
-
# [AWS CLI][1]
|
5098
|
-
# </div>
|
5099
|
-
#
|
5100
|
-
#
|
5101
|
-
#
|
5102
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html
|
5103
4508
|
# @return [Types::Integration]
|
5104
4509
|
#
|
5105
4510
|
# @!attribute [rw] authorization_scopes
|
@@ -5135,37 +4540,6 @@ module Aws::APIGateway
|
|
5135
4540
|
# the associated integration response that can be transformed using a
|
5136
4541
|
# mapping template.
|
5137
4542
|
#
|
5138
|
-
# <div class="remarks" markdown="1">
|
5139
|
-
#
|
5140
|
-
#
|
5141
|
-
# #### Example: A **MethodResponse** instance of an API
|
5142
|
-
#
|
5143
|
-
# ##### Request
|
5144
|
-
#
|
5145
|
-
# The example request retrieves a **MethodResponse** of the 200 status
|
5146
|
-
# code.
|
5147
|
-
#
|
5148
|
-
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
5149
|
-
#
|
5150
|
-
# ##### Response
|
5151
|
-
#
|
5152
|
-
# The successful response returns `200 OK` status and a payload as
|
5153
|
-
# follows:
|
5154
|
-
#
|
5155
|
-
# \{ "_links": \{ "curies": \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \}
|
5156
|
-
#
|
5157
|
-
#
|
5158
|
-
#
|
5159
|
-
# </div>
|
5160
|
-
#
|
5161
|
-
# <div class="seeAlso" markdown="1">
|
5162
|
-
# Method, IntegrationResponse, Integration [Creating an API][1]
|
5163
|
-
# </div>
|
5164
|
-
#
|
5165
|
-
#
|
5166
|
-
#
|
5167
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
5168
|
-
#
|
5169
4543
|
# @!attribute [rw] status_code
|
5170
4544
|
# The method response's status code.
|
5171
4545
|
# @return [String]
|
@@ -5222,11 +4596,9 @@ module Aws::APIGateway
|
|
5222
4596
|
# @return [String]
|
5223
4597
|
#
|
5224
4598
|
# @!attribute [rw] data_trace_enabled
|
5225
|
-
# Specifies whether
|
5226
|
-
#
|
5227
|
-
#
|
5228
|
-
# logging sensitive data. We recommend that you don't enable this
|
5229
|
-
# option for production APIs. The PATCH path for this setting is
|
4599
|
+
# Specifies whether data trace logging is enabled for this method,
|
4600
|
+
# which affects the log entries pushed to Amazon CloudWatch Logs. The
|
4601
|
+
# PATCH path for this setting is
|
5230
4602
|
# `/\{method_setting_key\}/logging/dataTrace`, and the value is a
|
5231
4603
|
# Boolean.
|
5232
4604
|
# @return [Boolean]
|
@@ -5319,26 +4691,6 @@ module Aws::APIGateway
|
|
5319
4691
|
# Represents the data structure of a method's request or response
|
5320
4692
|
# payload.
|
5321
4693
|
#
|
5322
|
-
# <div class="remarks" markdown="1">
|
5323
|
-
# A request model defines the data structure of the client-supplied
|
5324
|
-
# request payload. A response model defines the data structure of the
|
5325
|
-
# response payload returned by the back end. Although not required,
|
5326
|
-
# models are useful for mapping payloads between the front end and back
|
5327
|
-
# end.
|
5328
|
-
#
|
5329
|
-
# A model is used for generating an API's SDK, validating the input
|
5330
|
-
# request body, and creating a skeletal mapping template.
|
5331
|
-
#
|
5332
|
-
# </div>
|
5333
|
-
#
|
5334
|
-
# <div class="seeAlso" markdown="1">
|
5335
|
-
# Method, MethodResponse, [Models and Mappings][1]
|
5336
|
-
# </div>
|
5337
|
-
#
|
5338
|
-
#
|
5339
|
-
#
|
5340
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
5341
|
-
#
|
5342
4694
|
# @!attribute [rw] id
|
5343
4695
|
# The identifier for the model resource.
|
5344
4696
|
# @return [String]
|
@@ -5353,15 +4705,11 @@ module Aws::APIGateway
|
|
5353
4705
|
#
|
5354
4706
|
# @!attribute [rw] schema
|
5355
4707
|
# The schema for the model. For `application/json` models, this should
|
5356
|
-
# be
|
5357
|
-
#
|
5358
|
-
#
|
5359
|
-
#
|
5360
|
-
#
|
5361
|
-
#
|
5362
|
-
#
|
5363
|
-
#
|
5364
|
-
# [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
4708
|
+
# be JSON schema draft 4 model. Do not include "\\*/" characters in
|
4709
|
+
# the description of any properties because such "\\*/" characters
|
4710
|
+
# may be interpreted as the closing marker for comments in some
|
4711
|
+
# languages, such as Java or JavaScript, causing the installation of
|
4712
|
+
# your API's SDK generated by API Gateway to fail.
|
5365
4713
|
# @return [String]
|
5366
4714
|
#
|
5367
4715
|
# @!attribute [rw] content_type
|
@@ -5380,14 +4728,6 @@ module Aws::APIGateway
|
|
5380
4728
|
|
5381
4729
|
# Represents a collection of Model resources.
|
5382
4730
|
#
|
5383
|
-
# <div class="seeAlso" markdown="1">
|
5384
|
-
# Method, MethodResponse, [Models and Mappings][1]
|
5385
|
-
# </div>
|
5386
|
-
#
|
5387
|
-
#
|
5388
|
-
#
|
5389
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
5390
|
-
#
|
5391
4731
|
# @!attribute [rw] position
|
5392
4732
|
# @return [String]
|
5393
4733
|
#
|
@@ -5402,9 +4742,10 @@ module Aws::APIGateway
|
|
5402
4742
|
include Aws::Structure
|
5403
4743
|
end
|
5404
4744
|
|
4745
|
+
# The mutual TLS authentication configuration for a custom domain name.
|
5405
4746
|
# If specified, API Gateway performs two-way authentication between the
|
5406
4747
|
# client and the server. Clients must present a trusted certificate to
|
5407
|
-
# access your
|
4748
|
+
# access your API.
|
5408
4749
|
#
|
5409
4750
|
# @!attribute [rw] truststore_uri
|
5410
4751
|
# An Amazon S3 URL that specifies the truststore for mutual TLS
|
@@ -5438,9 +4779,10 @@ module Aws::APIGateway
|
|
5438
4779
|
include Aws::Structure
|
5439
4780
|
end
|
5440
4781
|
|
4782
|
+
# The mutual TLS authentication configuration for a custom domain name.
|
5441
4783
|
# If specified, API Gateway performs two-way authentication between the
|
5442
4784
|
# client and the server. Clients must present a trusted certificate to
|
5443
|
-
# access your
|
4785
|
+
# access your API.
|
5444
4786
|
#
|
5445
4787
|
# @note When making an API call, you may pass MutualTlsAuthenticationInput
|
5446
4788
|
# data as a hash:
|
@@ -5451,8 +4793,8 @@ module Aws::APIGateway
|
|
5451
4793
|
# }
|
5452
4794
|
#
|
5453
4795
|
# @!attribute [rw] truststore_uri
|
5454
|
-
# An Amazon S3
|
5455
|
-
#
|
4796
|
+
# An Amazon S3 URL that specifies the truststore for mutual TLS
|
4797
|
+
# authentication, for example `s3://bucket-name/key-name`. The
|
5456
4798
|
# truststore can contain certificates from public or private
|
5457
4799
|
# certificate authorities. To update the truststore, upload a new
|
5458
4800
|
# version to S3, and then update your custom domain name to use the
|
@@ -5463,7 +4805,7 @@ module Aws::APIGateway
|
|
5463
4805
|
# @!attribute [rw] truststore_version
|
5464
4806
|
# The version of the S3 object that contains your truststore. To
|
5465
4807
|
# specify a version, you must have versioning enabled for the S3
|
5466
|
-
# bucket
|
4808
|
+
# bucket
|
5467
4809
|
# @return [String]
|
5468
4810
|
#
|
5469
4811
|
class MutualTlsAuthenticationInput < Struct.new(
|
@@ -5485,9 +4827,12 @@ module Aws::APIGateway
|
|
5485
4827
|
include Aws::Structure
|
5486
4828
|
end
|
5487
4829
|
|
5488
|
-
#
|
5489
|
-
#
|
5490
|
-
#
|
4830
|
+
# For more information about supported patch operations, see [Patch
|
4831
|
+
# Operations][1].
|
4832
|
+
#
|
4833
|
+
#
|
4834
|
+
#
|
4835
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
5491
4836
|
#
|
5492
4837
|
# @note When making an API call, you may pass PatchOperation
|
5493
4838
|
# data as a hash:
|
@@ -5501,50 +4846,41 @@ module Aws::APIGateway
|
|
5501
4846
|
#
|
5502
4847
|
# @!attribute [rw] op
|
5503
4848
|
# An update operation to be performed with this PATCH request. The
|
5504
|
-
# valid value can be
|
5505
|
-
#
|
4849
|
+
# valid value can be add, remove, replace or copy. Not all valid
|
4850
|
+
# operations are supported for a given resource. Support of the
|
5506
4851
|
# operations depends on specific operational contexts. Attempts to
|
5507
4852
|
# apply an unsupported operation on a resource will return an error
|
5508
|
-
# message
|
4853
|
+
# message..
|
5509
4854
|
# @return [String]
|
5510
4855
|
#
|
5511
4856
|
# @!attribute [rw] path
|
5512
|
-
# The
|
5513
|
-
#
|
4857
|
+
# The op operation's target, as identified by a JSON Pointer value
|
4858
|
+
# that references a location within the targeted resource. For
|
5514
4859
|
# example, if the target resource has an updateable property of
|
5515
|
-
#
|
5516
|
-
#
|
5517
|
-
#
|
5518
|
-
# property will be
|
5519
|
-
# appearing in path names must be escaped with "~1", as
|
5520
|
-
# example above. Each
|
4860
|
+
# \\\{"name":"value"\\}, the path for this property is /name. If
|
4861
|
+
# the name property value is a JSON object (e.g., \\\{"name":
|
4862
|
+
# \\\{"child/name": "child-value"\\}\\}), the path for the
|
4863
|
+
# child/name property will be /name/child~1name. Any slash ("/")
|
4864
|
+
# character appearing in path names must be escaped with "~1", as
|
4865
|
+
# shown in the example above. Each op operation can have only one path
|
5521
4866
|
# associated with it.
|
5522
|
-
#
|
5523
|
-
#
|
5524
|
-
#
|
5525
|
-
# [1]: https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08
|
5526
4867
|
# @return [String]
|
5527
4868
|
#
|
5528
4869
|
# @!attribute [rw] value
|
5529
4870
|
# The new target value of the update operation. It is applicable for
|
5530
|
-
# the
|
4871
|
+
# the add or replace operation. When using AWS CLI to update a
|
5531
4872
|
# property of a JSON value, enclose the JSON object with a pair of
|
5532
|
-
# single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'.
|
5533
|
-
# Windows shell, see [Using JSON for Parameters][1].
|
5534
|
-
#
|
5535
|
-
#
|
5536
|
-
#
|
5537
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
4873
|
+
# single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'.
|
5538
4874
|
# @return [String]
|
5539
4875
|
#
|
5540
4876
|
# @!attribute [rw] from
|
5541
|
-
# The
|
5542
|
-
#
|
5543
|
-
#
|
5544
|
-
#
|
5545
|
-
#
|
5546
|
-
#
|
5547
|
-
#
|
4877
|
+
# The copy update operation's source as identified by a JSON-Pointer
|
4878
|
+
# value referencing the location within the targeted resource to copy
|
4879
|
+
# the value from. For example, to promote a canary deployment, you
|
4880
|
+
# copy the canary deployment ID to the affiliated deployment ID by
|
4881
|
+
# calling a PATCH request on a Stage resource with "op":"copy",
|
4882
|
+
# "from":"/canarySettings/deploymentId" and
|
4883
|
+
# "path":"/deploymentId".
|
5548
4884
|
# @return [String]
|
5549
4885
|
#
|
5550
4886
|
class PatchOperation < Struct.new(
|
@@ -5575,11 +4911,11 @@ module Aws::APIGateway
|
|
5575
4911
|
# }
|
5576
4912
|
#
|
5577
4913
|
# @!attribute [rw] rest_api_id
|
5578
|
-
#
|
4914
|
+
# The string identifier of the associated RestApi.
|
5579
4915
|
# @return [String]
|
5580
4916
|
#
|
5581
4917
|
# @!attribute [rw] response_type
|
5582
|
-
#
|
4918
|
+
# The response type of the associated GatewayResponse
|
5583
4919
|
# @return [String]
|
5584
4920
|
#
|
5585
4921
|
# @!attribute [rw] status_code
|
@@ -5638,58 +4974,51 @@ module Aws::APIGateway
|
|
5638
4974
|
# }
|
5639
4975
|
#
|
5640
4976
|
# @!attribute [rw] rest_api_id
|
5641
|
-
#
|
4977
|
+
# The string identifier of the associated RestApi.
|
5642
4978
|
# @return [String]
|
5643
4979
|
#
|
5644
4980
|
# @!attribute [rw] resource_id
|
5645
|
-
#
|
4981
|
+
# Specifies a put integration request's resource ID.
|
5646
4982
|
# @return [String]
|
5647
4983
|
#
|
5648
4984
|
# @!attribute [rw] http_method
|
5649
|
-
#
|
4985
|
+
# Specifies the HTTP method for the integration.
|
5650
4986
|
# @return [String]
|
5651
4987
|
#
|
5652
4988
|
# @!attribute [rw] type
|
5653
|
-
#
|
4989
|
+
# Specifies a put integration input's type.
|
5654
4990
|
# @return [String]
|
5655
4991
|
#
|
5656
4992
|
# @!attribute [rw] integration_http_method
|
5657
|
-
#
|
5658
|
-
# is HTTP or AWS, this field is required.
|
4993
|
+
# The HTTP method for the integration.
|
5659
4994
|
# @return [String]
|
5660
4995
|
#
|
5661
4996
|
# @!attribute [rw] uri
|
5662
4997
|
# Specifies Uniform Resource Identifier (URI) of the integration
|
5663
|
-
# endpoint.
|
5664
|
-
#
|
5665
|
-
#
|
5666
|
-
#
|
5667
|
-
#
|
5668
|
-
#
|
5669
|
-
#
|
5670
|
-
#
|
5671
|
-
#
|
5672
|
-
#
|
5673
|
-
#
|
5674
|
-
#
|
5675
|
-
#
|
5676
|
-
#
|
5677
|
-
#
|
5678
|
-
#
|
5679
|
-
#
|
5680
|
-
#
|
5681
|
-
#
|
5682
|
-
#
|
5683
|
-
#
|
5684
|
-
#
|
5685
|
-
#
|
5686
|
-
#
|
5687
|
-
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
5688
|
-
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
5689
|
-
#
|
5690
|
-
#
|
5691
|
-
#
|
5692
|
-
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
4998
|
+
# endpoint. For HTTP or `HTTP_PROXY` integrations, the URI must be a
|
4999
|
+
# fully formed, encoded HTTP(S) URL according to the RFC-3986
|
5000
|
+
# specification, for either standard integration, where
|
5001
|
+
# `connectionType` is not `VPC_LINK`, or private integration, where
|
5002
|
+
# `connectionType` is `VPC_LINK`. For a private HTTP integration, the
|
5003
|
+
# URI is not used for routing. For `AWS` or `AWS_PROXY` integrations,
|
5004
|
+
# the URI is of the form
|
5005
|
+
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api`\\}.
|
5006
|
+
# Here, \\\{Region\\} is the API Gateway region (e.g., us-east-1);
|
5007
|
+
# \\\{service\\} is the name of the integrated Amazon Web Services
|
5008
|
+
# service (e.g., s3); and \\\{subdomain\\} is a designated subdomain
|
5009
|
+
# supported by certain Amazon Web Services service for fast host-name
|
5010
|
+
# lookup. action can be used for an Amazon Web Services service
|
5011
|
+
# action-based API, using an
|
5012
|
+
# Action=\\\{name\\}&\\\{p1\\}=\\\{v1\\}&p2=\\\{v2\\}... query
|
5013
|
+
# string. The ensuing \\\{service\_api\\} refers to a supported action
|
5014
|
+
# \\\{name\\} plus any required input parameters. Alternatively, path
|
5015
|
+
# can be used for an Amazon Web Services service path-based API. The
|
5016
|
+
# ensuing service\_api refers to the path to an Amazon Web Services
|
5017
|
+
# service resource, including the region of the integrated Amazon Web
|
5018
|
+
# Services service, if applicable. For example, for integration with
|
5019
|
+
# the S3 API of `GetObject`, the `uri` can be either
|
5020
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
5021
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`.
|
5693
5022
|
# @return [String]
|
5694
5023
|
#
|
5695
5024
|
# @!attribute [rw] connection_type
|
@@ -5701,12 +5030,8 @@ module Aws::APIGateway
|
|
5701
5030
|
# @return [String]
|
5702
5031
|
#
|
5703
5032
|
# @!attribute [rw] connection_id
|
5704
|
-
# The
|
5705
|
-
# `
|
5706
|
-
#
|
5707
|
-
#
|
5708
|
-
#
|
5709
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
5033
|
+
# The ID of the VpcLink used for the integration. Specify this value
|
5034
|
+
# only if you specify `VPC_LINK` as the connection type.
|
5710
5035
|
# @return [String]
|
5711
5036
|
#
|
5712
5037
|
# @!attribute [rw] credentials
|
@@ -5738,17 +5063,6 @@ module Aws::APIGateway
|
|
5738
5063
|
# templates specified as the `requestTemplates` property on the
|
5739
5064
|
# Integration resource. There are three valid values: `WHEN_NO_MATCH`,
|
5740
5065
|
# `WHEN_NO_TEMPLATES`, and `NEVER`.
|
5741
|
-
#
|
5742
|
-
# * `WHEN_NO_MATCH` passes the request body for unmapped content types
|
5743
|
-
# through to the integration back end without transformation.
|
5744
|
-
#
|
5745
|
-
# * `NEVER` rejects unmapped content types with an HTTP 415
|
5746
|
-
# 'Unsupported Media Type' response.
|
5747
|
-
#
|
5748
|
-
# * `WHEN_NO_TEMPLATES` allows pass-through when the integration has
|
5749
|
-
# NO content types mapped to templates. However if there is at least
|
5750
|
-
# one content type defined, unmapped content types will be rejected
|
5751
|
-
# with the same 415 response.
|
5752
5066
|
# @return [String]
|
5753
5067
|
#
|
5754
5068
|
# @!attribute [rw] cache_namespace
|
@@ -5769,12 +5083,6 @@ module Aws::APIGateway
|
|
5769
5083
|
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
5770
5084
|
# the following behaviors:
|
5771
5085
|
#
|
5772
|
-
# * `CONVERT_TO_BINARY`\: Converts a request payload from a
|
5773
|
-
# Base64-encoded string to the corresponding binary blob.
|
5774
|
-
#
|
5775
|
-
# * `CONVERT_TO_TEXT`\: Converts a request payload from a binary blob
|
5776
|
-
# to a Base64-encoded string.
|
5777
|
-
#
|
5778
5086
|
# If this property is not defined, the request payload will be passed
|
5779
5087
|
# through from the method request to integration request without
|
5780
5088
|
# modification, provided that the `passthroughBehavior` is configured
|
@@ -5787,6 +5095,7 @@ module Aws::APIGateway
|
|
5787
5095
|
# @return [Integer]
|
5788
5096
|
#
|
5789
5097
|
# @!attribute [rw] tls_config
|
5098
|
+
# Specifies the TLS configuration for an integration.
|
5790
5099
|
# @return [Types::TlsConfig]
|
5791
5100
|
#
|
5792
5101
|
class PutIntegrationRequest < Struct.new(
|
@@ -5832,22 +5141,20 @@ module Aws::APIGateway
|
|
5832
5141
|
# }
|
5833
5142
|
#
|
5834
5143
|
# @!attribute [rw] rest_api_id
|
5835
|
-
#
|
5144
|
+
# The string identifier of the associated RestApi.
|
5836
5145
|
# @return [String]
|
5837
5146
|
#
|
5838
5147
|
# @!attribute [rw] resource_id
|
5839
|
-
#
|
5840
|
-
# resource identifier.
|
5148
|
+
# Specifies a put integration response request's resource identifier.
|
5841
5149
|
# @return [String]
|
5842
5150
|
#
|
5843
5151
|
# @!attribute [rw] http_method
|
5844
|
-
#
|
5845
|
-
# method.
|
5152
|
+
# Specifies a put integration response request's HTTP method.
|
5846
5153
|
# @return [String]
|
5847
5154
|
#
|
5848
5155
|
# @!attribute [rw] status_code
|
5849
|
-
#
|
5850
|
-
#
|
5156
|
+
# Specifies the status code that is used to map the integration
|
5157
|
+
# response to an existing MethodResponse.
|
5851
5158
|
# @return [String]
|
5852
5159
|
#
|
5853
5160
|
# @!attribute [rw] selection_pattern
|
@@ -5878,12 +5185,6 @@ module Aws::APIGateway
|
|
5878
5185
|
# Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
|
5879
5186
|
# the following behaviors:
|
5880
5187
|
#
|
5881
|
-
# * `CONVERT_TO_BINARY`\: Converts a response payload from a
|
5882
|
-
# Base64-encoded string to the corresponding binary blob.
|
5883
|
-
#
|
5884
|
-
# * `CONVERT_TO_TEXT`\: Converts a response payload from a binary blob
|
5885
|
-
# to a Base64-encoded string.
|
5886
|
-
#
|
5887
5188
|
# If this property is not defined, the response payload will be passed
|
5888
5189
|
# through from the integration response to the method response without
|
5889
5190
|
# modification.
|
@@ -5926,22 +5227,22 @@ module Aws::APIGateway
|
|
5926
5227
|
# }
|
5927
5228
|
#
|
5928
5229
|
# @!attribute [rw] rest_api_id
|
5929
|
-
#
|
5230
|
+
# The string identifier of the associated RestApi.
|
5930
5231
|
# @return [String]
|
5931
5232
|
#
|
5932
5233
|
# @!attribute [rw] resource_id
|
5933
|
-
#
|
5234
|
+
# The Resource identifier for the new Method resource.
|
5934
5235
|
# @return [String]
|
5935
5236
|
#
|
5936
5237
|
# @!attribute [rw] http_method
|
5937
|
-
#
|
5238
|
+
# Specifies the method request's HTTP method type.
|
5938
5239
|
# @return [String]
|
5939
5240
|
#
|
5940
5241
|
# @!attribute [rw] authorization_type
|
5941
|
-
#
|
5942
|
-
#
|
5943
|
-
#
|
5944
|
-
#
|
5242
|
+
# The method's authorization type. Valid values are `NONE` for open
|
5243
|
+
# access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using
|
5244
|
+
# a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
|
5245
|
+
# user pool.
|
5945
5246
|
# @return [String]
|
5946
5247
|
#
|
5947
5248
|
# @!attribute [rw] authorizer_id
|
@@ -6032,19 +5333,19 @@ module Aws::APIGateway
|
|
6032
5333
|
# }
|
6033
5334
|
#
|
6034
5335
|
# @!attribute [rw] rest_api_id
|
6035
|
-
#
|
5336
|
+
# The string identifier of the associated RestApi.
|
6036
5337
|
# @return [String]
|
6037
5338
|
#
|
6038
5339
|
# @!attribute [rw] resource_id
|
6039
|
-
#
|
5340
|
+
# The Resource identifier for the Method resource.
|
6040
5341
|
# @return [String]
|
6041
5342
|
#
|
6042
5343
|
# @!attribute [rw] http_method
|
6043
|
-
#
|
5344
|
+
# The HTTP verb of the Method resource.
|
6044
5345
|
# @return [String]
|
6045
5346
|
#
|
6046
5347
|
# @!attribute [rw] status_code
|
6047
|
-
#
|
5348
|
+
# The method response's status code.
|
6048
5349
|
# @return [String]
|
6049
5350
|
#
|
6050
5351
|
# @!attribute [rw] response_parameters
|
@@ -6099,7 +5400,7 @@ module Aws::APIGateway
|
|
6099
5400
|
# }
|
6100
5401
|
#
|
6101
5402
|
# @!attribute [rw] rest_api_id
|
6102
|
-
#
|
5403
|
+
# The string identifier of the associated RestApi.
|
6103
5404
|
# @return [String]
|
6104
5405
|
#
|
6105
5406
|
# @!attribute [rw] mode
|
@@ -6124,9 +5425,9 @@ module Aws::APIGateway
|
|
6124
5425
|
# @return [Hash<String,String>]
|
6125
5426
|
#
|
6126
5427
|
# @!attribute [rw] body
|
6127
|
-
#
|
6128
|
-
#
|
6129
|
-
#
|
5428
|
+
# The PUT request body containing external API definitions. Currently,
|
5429
|
+
# only OpenAPI definition JSON/YAML files are supported. The maximum
|
5430
|
+
# size of the API definition file is 6MB.
|
6130
5431
|
# @return [String]
|
6131
5432
|
#
|
6132
5433
|
class PutRestApiRequest < Struct.new(
|
@@ -6156,9 +5457,8 @@ module Aws::APIGateway
|
|
6156
5457
|
# @return [Integer]
|
6157
5458
|
#
|
6158
5459
|
# @!attribute [rw] offset
|
6159
|
-
# The
|
6160
|
-
#
|
6161
|
-
# starts on Monday.
|
5460
|
+
# The number of requests subtracted from the given limit in the
|
5461
|
+
# initial time period.
|
6162
5462
|
# @return [Integer]
|
6163
5463
|
#
|
6164
5464
|
# @!attribute [rw] period
|
@@ -6176,24 +5476,6 @@ module Aws::APIGateway
|
|
6176
5476
|
|
6177
5477
|
# A set of validation rules for incoming Method requests.
|
6178
5478
|
#
|
6179
|
-
# <div class="remarks" markdown="1">
|
6180
|
-
# In OpenAPI, a RequestValidator of an API is defined by the
|
6181
|
-
# [x-amazon-apigateway-request-validators.requestValidator][1] object.
|
6182
|
-
# It the referenced using the [x-amazon-apigateway-request-validator][2]
|
6183
|
-
# property.
|
6184
|
-
#
|
6185
|
-
# </div>
|
6186
|
-
#
|
6187
|
-
# <div class="seeAlso" markdown="1">
|
6188
|
-
# [Enable Basic Request Validation in API Gateway][3]
|
6189
|
-
# </div>
|
6190
|
-
#
|
6191
|
-
#
|
6192
|
-
#
|
6193
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html
|
6194
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator
|
6195
|
-
# [3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
6196
|
-
#
|
6197
5479
|
# @!attribute [rw] id
|
6198
5480
|
# The identifier of this RequestValidator.
|
6199
5481
|
# @return [String]
|
@@ -6223,21 +5505,6 @@ module Aws::APIGateway
|
|
6223
5505
|
|
6224
5506
|
# A collection of RequestValidator resources of a given RestApi.
|
6225
5507
|
#
|
6226
|
-
# <div class="remarks" markdown="1">
|
6227
|
-
# In OpenAPI, the RequestValidators of an API is defined by the
|
6228
|
-
# [x-amazon-apigateway-request-validators][1] extension.
|
6229
|
-
#
|
6230
|
-
# </div>
|
6231
|
-
#
|
6232
|
-
# <div class="seeAlso" markdown="1">
|
6233
|
-
# [Enable Basic Request Validation in API Gateway][2]
|
6234
|
-
# </div>
|
6235
|
-
#
|
6236
|
-
#
|
6237
|
-
#
|
6238
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html
|
6239
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
6240
|
-
#
|
6241
5508
|
# @!attribute [rw] position
|
6242
5509
|
# @return [String]
|
6243
5510
|
#
|
@@ -6254,14 +5521,6 @@ module Aws::APIGateway
|
|
6254
5521
|
|
6255
5522
|
# Represents an API resource.
|
6256
5523
|
#
|
6257
|
-
# <div class="seeAlso" markdown="1">
|
6258
|
-
# [Create an API][1]
|
6259
|
-
# </div>
|
6260
|
-
#
|
6261
|
-
#
|
6262
|
-
#
|
6263
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
6264
|
-
#
|
6265
5524
|
# @!attribute [rw] id
|
6266
5525
|
# The resource's identifier.
|
6267
5526
|
# @return [String]
|
@@ -6280,32 +5539,6 @@ module Aws::APIGateway
|
|
6280
5539
|
#
|
6281
5540
|
# @!attribute [rw] resource_methods
|
6282
5541
|
# Gets an API resource's method of a given HTTP verb.
|
6283
|
-
#
|
6284
|
-
# <div class="remarks" markdown="1">
|
6285
|
-
# The resource methods are a map of methods indexed by methods' HTTP
|
6286
|
-
# verbs enabled on the resource. This method map is included in the
|
6287
|
-
# `200 OK` response of the `GET
|
6288
|
-
# /restapis/\{restapi_id\}/resources/\{resource_id\}` or `GET
|
6289
|
-
# /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods`
|
6290
|
-
# request.
|
6291
|
-
#
|
6292
|
-
# #### Example: Get the GET method of an API resource
|
6293
|
-
#
|
6294
|
-
# ##### Request
|
6295
|
-
#
|
6296
|
-
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
6297
|
-
#
|
6298
|
-
# ##### Response
|
6299
|
-
#
|
6300
|
-
# \{ "_links": \{ "curies": [ \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-\{rel\}.html", "name": "method", "templated": true \}, \{ "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \} ], "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" \}, "integration:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "method:integration": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "method:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "methodresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/\{status_code\}", "templated": true \} \}, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": \{ "method:integration": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": \{ "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" \}, "requestTemplates": \{ "application/json": "\{\n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E")\n" \}, "statusCode": "200" \} \} \}, "method:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \} \} \}
|
6301
|
-
#
|
6302
|
-
# If the `OPTIONS` is enabled on the resource, you can follow the
|
6303
|
-
# example here to get that method. Just replace the `GET` of the last
|
6304
|
-
# path segment in the request URL with `OPTIONS`.
|
6305
|
-
#
|
6306
|
-
# </div>
|
6307
|
-
#
|
6308
|
-
# <div class="seeAlso"></div>
|
6309
5542
|
# @return [Hash<String,Types::Method>]
|
6310
5543
|
#
|
6311
5544
|
class Resource < Struct.new(
|
@@ -6320,14 +5553,6 @@ module Aws::APIGateway
|
|
6320
5553
|
|
6321
5554
|
# Represents a collection of Resource resources.
|
6322
5555
|
#
|
6323
|
-
# <div class="seeAlso" markdown="1">
|
6324
|
-
# [Create an API][1]
|
6325
|
-
# </div>
|
6326
|
-
#
|
6327
|
-
#
|
6328
|
-
#
|
6329
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
6330
|
-
#
|
6331
5556
|
# @!attribute [rw] position
|
6332
5557
|
# @return [String]
|
6333
5558
|
#
|
@@ -6344,14 +5569,6 @@ module Aws::APIGateway
|
|
6344
5569
|
|
6345
5570
|
# Represents a REST API.
|
6346
5571
|
#
|
6347
|
-
# <div class="seeAlso" markdown="1">
|
6348
|
-
# [Create an API][1]
|
6349
|
-
# </div>
|
6350
|
-
#
|
6351
|
-
#
|
6352
|
-
#
|
6353
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
6354
|
-
#
|
6355
5572
|
# @!attribute [rw] id
|
6356
5573
|
# The API's identifier. This identifier is unique across all of your
|
6357
5574
|
# APIs in API Gateway.
|
@@ -6394,11 +5611,9 @@ module Aws::APIGateway
|
|
6394
5611
|
#
|
6395
5612
|
# @!attribute [rw] api_key_source
|
6396
5613
|
# The source of the API key for metering requests according to a usage
|
6397
|
-
# plan. Valid values are:
|
6398
|
-
# `X-API-Key` header of a
|
6399
|
-
#
|
6400
|
-
# * `AUTHORIZER` to read the API key from the `UsageIdentifierKey`
|
6401
|
-
# from a custom authorizer.
|
5614
|
+
# plan. Valid values are: >`HEADER` to read the API key from the
|
5615
|
+
# `X-API-Key` header of a request. `AUTHORIZER` to read the API key
|
5616
|
+
# from the `UsageIdentifierKey` from a custom authorizer.
|
6402
5617
|
# @return [String]
|
6403
5618
|
#
|
6404
5619
|
# @!attribute [rw] endpoint_configuration
|
@@ -6420,9 +5635,9 @@ module Aws::APIGateway
|
|
6420
5635
|
# Specifies whether clients can invoke your API by using the default
|
6421
5636
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
6422
5637
|
# the default
|
6423
|
-
# https
|
6424
|
-
#
|
6425
|
-
#
|
5638
|
+
# `https://\{api_id\}.execute-api.\{region\}.amazonaws.com` endpoint.
|
5639
|
+
# To require that clients use a custom domain name to invoke your API,
|
5640
|
+
# disable the default endpoint.
|
6426
5641
|
# @return [Boolean]
|
6427
5642
|
#
|
6428
5643
|
class RestApi < Struct.new(
|
@@ -6447,14 +5662,6 @@ module Aws::APIGateway
|
|
6447
5662
|
# interact with your collection. A collection offers a paginated view of
|
6448
5663
|
# your APIs.
|
6449
5664
|
#
|
6450
|
-
# <div class="seeAlso" markdown="1">
|
6451
|
-
# [Create an API][1]
|
6452
|
-
# </div>
|
6453
|
-
#
|
6454
|
-
#
|
6455
|
-
#
|
6456
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
6457
|
-
#
|
6458
5665
|
# @!attribute [rw] position
|
6459
5666
|
# @return [String]
|
6460
5667
|
#
|
@@ -6588,14 +5795,6 @@ module Aws::APIGateway
|
|
6588
5795
|
# Represents a unique identifier for a version of a deployed RestApi
|
6589
5796
|
# that is callable by users.
|
6590
5797
|
#
|
6591
|
-
# <div class="seeAlso" markdown="1">
|
6592
|
-
# [Deploy an API][1]
|
6593
|
-
# </div>
|
6594
|
-
#
|
6595
|
-
#
|
6596
|
-
#
|
6597
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
|
6598
|
-
#
|
6599
5798
|
# @!attribute [rw] deployment_id
|
6600
5799
|
# The identifier of the Deployment that the stage points to.
|
6601
5800
|
# @return [String]
|
@@ -6726,14 +5925,6 @@ module Aws::APIGateway
|
|
6726
5925
|
# A list of Stage resources that are associated with the ApiKey
|
6727
5926
|
# resource.
|
6728
5927
|
#
|
6729
|
-
# <div class="seeAlso" markdown="1">
|
6730
|
-
# [Deploying API in Stages][1]
|
6731
|
-
# </div>
|
6732
|
-
#
|
6733
|
-
#
|
6734
|
-
#
|
6735
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html
|
6736
|
-
#
|
6737
5928
|
# @!attribute [rw] item
|
6738
5929
|
# The current page of elements from this collection.
|
6739
5930
|
# @return [Array<Types::Stage>]
|
@@ -6757,14 +5948,13 @@ module Aws::APIGateway
|
|
6757
5948
|
# }
|
6758
5949
|
#
|
6759
5950
|
# @!attribute [rw] resource_arn
|
6760
|
-
#
|
5951
|
+
# The ARN of a resource that can be tagged.
|
6761
5952
|
# @return [String]
|
6762
5953
|
#
|
6763
5954
|
# @!attribute [rw] tags
|
6764
|
-
#
|
6765
|
-
#
|
6766
|
-
#
|
6767
|
-
# characters.
|
5955
|
+
# The key-value map of strings. The valid character set is
|
5956
|
+
# \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
|
5957
|
+
# not start with `aws:`. The tag value can be up to 256 characters.
|
6768
5958
|
# @return [Hash<String,String>]
|
6769
5959
|
#
|
6770
5960
|
class TagResourceRequest < Struct.new(
|
@@ -6790,21 +5980,9 @@ module Aws::APIGateway
|
|
6790
5980
|
|
6791
5981
|
# Represents a mapping template used to transform a payload.
|
6792
5982
|
#
|
6793
|
-
# <div class="seeAlso" markdown="1">
|
6794
|
-
# [Mapping Templates][1]
|
6795
|
-
# </div>
|
6796
|
-
#
|
6797
|
-
#
|
6798
|
-
#
|
6799
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings
|
6800
|
-
#
|
6801
5983
|
# @!attribute [rw] value
|
6802
|
-
# The Apache
|
6803
|
-
#
|
6804
|
-
#
|
6805
|
-
#
|
6806
|
-
#
|
6807
|
-
# [1]: https://velocity.apache.org/engine/devel/vtl-reference.html
|
5984
|
+
# The Apache Velocity Template Language (VTL) template content used
|
5985
|
+
# for the template resource.
|
6808
5986
|
# @return [String]
|
6809
5987
|
#
|
6810
5988
|
class Template < Struct.new(
|
@@ -6813,7 +5991,7 @@ module Aws::APIGateway
|
|
6813
5991
|
include Aws::Structure
|
6814
5992
|
end
|
6815
5993
|
|
6816
|
-
# Make a request to simulate the
|
5994
|
+
# Make a request to simulate the invocation of an Authorizer.
|
6817
5995
|
#
|
6818
5996
|
# @note When making an API call, you may pass TestInvokeAuthorizerRequest
|
6819
5997
|
# data as a hash:
|
@@ -6838,35 +6016,33 @@ module Aws::APIGateway
|
|
6838
6016
|
# }
|
6839
6017
|
#
|
6840
6018
|
# @!attribute [rw] rest_api_id
|
6841
|
-
#
|
6019
|
+
# The string identifier of the associated RestApi.
|
6842
6020
|
# @return [String]
|
6843
6021
|
#
|
6844
6022
|
# @!attribute [rw] authorizer_id
|
6845
|
-
#
|
6846
|
-
# Authorizer ID.
|
6023
|
+
# Specifies a test invoke authorizer request's Authorizer ID.
|
6847
6024
|
# @return [String]
|
6848
6025
|
#
|
6849
6026
|
# @!attribute [rw] headers
|
6850
|
-
#
|
6851
|
-
#
|
6852
|
-
#
|
6027
|
+
# A key-value map of headers to simulate an incoming invocation
|
6028
|
+
# request. This is where the incoming authorization token, or identity
|
6029
|
+
# source, should be specified.
|
6853
6030
|
# @return [Hash<String,String>]
|
6854
6031
|
#
|
6855
6032
|
# @!attribute [rw] multi_value_headers
|
6856
|
-
#
|
6857
|
-
#
|
6033
|
+
# The headers as a map from string to list of values to simulate an
|
6034
|
+
# incoming invocation request. This is where the incoming
|
6858
6035
|
# authorization token, or identity source, may be specified.
|
6859
6036
|
# @return [Hash<String,Array<String>>]
|
6860
6037
|
#
|
6861
6038
|
# @!attribute [rw] path_with_query_string
|
6862
|
-
#
|
6863
|
-
#
|
6864
|
-
#
|
6039
|
+
# The URI path, including query string, of the simulated invocation
|
6040
|
+
# request. Use this to specify path parameters and query string
|
6041
|
+
# parameters.
|
6865
6042
|
# @return [String]
|
6866
6043
|
#
|
6867
6044
|
# @!attribute [rw] body
|
6868
|
-
#
|
6869
|
-
# request.
|
6045
|
+
# The simulated request body of an incoming invocation request.
|
6870
6046
|
# @return [String]
|
6871
6047
|
#
|
6872
6048
|
# @!attribute [rw] stage_variables
|
@@ -6875,7 +6051,7 @@ module Aws::APIGateway
|
|
6875
6051
|
# @return [Hash<String,String>]
|
6876
6052
|
#
|
6877
6053
|
# @!attribute [rw] additional_context
|
6878
|
-
#
|
6054
|
+
# A key-value map of additional context variables.
|
6879
6055
|
# @return [Hash<String,String>]
|
6880
6056
|
#
|
6881
6057
|
class TestInvokeAuthorizerRequest < Struct.new(
|
@@ -6916,15 +6092,12 @@ module Aws::APIGateway
|
|
6916
6092
|
# @return [String]
|
6917
6093
|
#
|
6918
6094
|
# @!attribute [rw] authorization
|
6095
|
+
# The authorization response.
|
6919
6096
|
# @return [Hash<String,Array<String>>]
|
6920
6097
|
#
|
6921
6098
|
# @!attribute [rw] claims
|
6922
|
-
# The
|
6099
|
+
# The open identity claims, with any supported custom attributes,
|
6923
6100
|
# returned from the Cognito Your User Pool configured for the API.
|
6924
|
-
#
|
6925
|
-
#
|
6926
|
-
#
|
6927
|
-
# [1]: https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
6928
6101
|
# @return [Hash<String,String>]
|
6929
6102
|
#
|
6930
6103
|
class TestInvokeAuthorizerResponse < Struct.new(
|
@@ -6939,7 +6112,7 @@ module Aws::APIGateway
|
|
6939
6112
|
include Aws::Structure
|
6940
6113
|
end
|
6941
6114
|
|
6942
|
-
# Make a request to simulate the
|
6115
|
+
# Make a request to simulate the invocation of a Method.
|
6943
6116
|
#
|
6944
6117
|
# @note When making an API call, you may pass TestInvokeMethodRequest
|
6945
6118
|
# data as a hash:
|
@@ -6963,15 +6136,15 @@ module Aws::APIGateway
|
|
6963
6136
|
# }
|
6964
6137
|
#
|
6965
6138
|
# @!attribute [rw] rest_api_id
|
6966
|
-
#
|
6139
|
+
# The string identifier of the associated RestApi.
|
6967
6140
|
# @return [String]
|
6968
6141
|
#
|
6969
6142
|
# @!attribute [rw] resource_id
|
6970
|
-
#
|
6143
|
+
# Specifies a test invoke method request's resource ID.
|
6971
6144
|
# @return [String]
|
6972
6145
|
#
|
6973
6146
|
# @!attribute [rw] http_method
|
6974
|
-
#
|
6147
|
+
# Specifies a test invoke method request's HTTP method.
|
6975
6148
|
# @return [String]
|
6976
6149
|
#
|
6977
6150
|
# @!attribute [rw] path_with_query_string
|
@@ -7021,14 +6194,6 @@ module Aws::APIGateway
|
|
7021
6194
|
|
7022
6195
|
# Represents the response of the test invoke request in the HTTP method.
|
7023
6196
|
#
|
7024
|
-
# <div class="seeAlso" markdown="1">
|
7025
|
-
# [Test API using the API Gateway console][1]
|
7026
|
-
# </div>
|
7027
|
-
#
|
7028
|
-
#
|
7029
|
-
#
|
7030
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console
|
7031
|
-
#
|
7032
6197
|
# @!attribute [rw] status
|
7033
6198
|
# The HTTP status code.
|
7034
6199
|
# @return [Integer]
|
@@ -7091,6 +6256,8 @@ module Aws::APIGateway
|
|
7091
6256
|
include Aws::Structure
|
7092
6257
|
end
|
7093
6258
|
|
6259
|
+
# Specifies the TLS configuration for an integration.
|
6260
|
+
#
|
7094
6261
|
# @note When making an API call, you may pass TlsConfig
|
7095
6262
|
# data as a hash:
|
7096
6263
|
#
|
@@ -7100,18 +6267,14 @@ module Aws::APIGateway
|
|
7100
6267
|
#
|
7101
6268
|
# @!attribute [rw] insecure_skip_verification
|
7102
6269
|
# Specifies whether or not API Gateway skips verification that the
|
7103
|
-
# certificate for an integration endpoint is issued by a
|
7104
|
-
# certificate authority
|
7105
|
-
#
|
7106
|
-
#
|
7107
|
-
#
|
7108
|
-
#
|
7109
|
-
#
|
7110
|
-
#
|
7111
|
-
#
|
7112
|
-
#
|
7113
|
-
#
|
7114
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html
|
6270
|
+
# certificate for an integration endpoint is issued by a supported
|
6271
|
+
# certificate authority. This isn’t recommended, but it enables you to
|
6272
|
+
# use certificates that are signed by private certificate authorities,
|
6273
|
+
# or certificates that are self-signed. If enabled, API Gateway still
|
6274
|
+
# performs basic certificate validation, which includes checking the
|
6275
|
+
# certificate's expiration date, hostname, and presence of a root
|
6276
|
+
# certificate authority. Supported only for `HTTP` and `HTTP_PROXY`
|
6277
|
+
# integrations.
|
7115
6278
|
# @return [Boolean]
|
7116
6279
|
#
|
7117
6280
|
class TlsConfig < Struct.new(
|
@@ -7158,11 +6321,11 @@ module Aws::APIGateway
|
|
7158
6321
|
# }
|
7159
6322
|
#
|
7160
6323
|
# @!attribute [rw] resource_arn
|
7161
|
-
#
|
6324
|
+
# The ARN of a resource that can be tagged.
|
7162
6325
|
# @return [String]
|
7163
6326
|
#
|
7164
6327
|
# @!attribute [rw] tag_keys
|
7165
|
-
#
|
6328
|
+
# The Tag keys to delete.
|
7166
6329
|
# @return [Array<String>]
|
7167
6330
|
#
|
7168
6331
|
class UntagResourceRequest < Struct.new(
|
@@ -7190,8 +6353,12 @@ module Aws::APIGateway
|
|
7190
6353
|
# }
|
7191
6354
|
#
|
7192
6355
|
# @!attribute [rw] patch_operations
|
7193
|
-
#
|
7194
|
-
#
|
6356
|
+
# For more information about supported patch operations, see [Patch
|
6357
|
+
# Operations][1].
|
6358
|
+
#
|
6359
|
+
#
|
6360
|
+
#
|
6361
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7195
6362
|
# @return [Array<Types::PatchOperation>]
|
7196
6363
|
#
|
7197
6364
|
class UpdateAccountRequest < Struct.new(
|
@@ -7218,12 +6385,16 @@ module Aws::APIGateway
|
|
7218
6385
|
# }
|
7219
6386
|
#
|
7220
6387
|
# @!attribute [rw] api_key
|
7221
|
-
#
|
6388
|
+
# The identifier of the ApiKey resource to be updated.
|
7222
6389
|
# @return [String]
|
7223
6390
|
#
|
7224
6391
|
# @!attribute [rw] patch_operations
|
7225
|
-
#
|
7226
|
-
#
|
6392
|
+
# For more information about supported patch operations, see [Patch
|
6393
|
+
# Operations][1].
|
6394
|
+
#
|
6395
|
+
#
|
6396
|
+
#
|
6397
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7227
6398
|
# @return [Array<Types::PatchOperation>]
|
7228
6399
|
#
|
7229
6400
|
class UpdateApiKeyRequest < Struct.new(
|
@@ -7252,16 +6423,20 @@ module Aws::APIGateway
|
|
7252
6423
|
# }
|
7253
6424
|
#
|
7254
6425
|
# @!attribute [rw] rest_api_id
|
7255
|
-
#
|
6426
|
+
# The string identifier of the associated RestApi.
|
7256
6427
|
# @return [String]
|
7257
6428
|
#
|
7258
6429
|
# @!attribute [rw] authorizer_id
|
7259
|
-
#
|
6430
|
+
# The identifier of the Authorizer resource.
|
7260
6431
|
# @return [String]
|
7261
6432
|
#
|
7262
6433
|
# @!attribute [rw] patch_operations
|
7263
|
-
#
|
7264
|
-
#
|
6434
|
+
# For more information about supported patch operations, see [Patch
|
6435
|
+
# Operations][1].
|
6436
|
+
#
|
6437
|
+
#
|
6438
|
+
#
|
6439
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7265
6440
|
# @return [Array<Types::PatchOperation>]
|
7266
6441
|
#
|
7267
6442
|
class UpdateAuthorizerRequest < Struct.new(
|
@@ -7291,20 +6466,22 @@ module Aws::APIGateway
|
|
7291
6466
|
# }
|
7292
6467
|
#
|
7293
6468
|
# @!attribute [rw] domain_name
|
7294
|
-
#
|
7295
|
-
# change.
|
6469
|
+
# The domain name of the BasePathMapping resource to change.
|
7296
6470
|
# @return [String]
|
7297
6471
|
#
|
7298
6472
|
# @!attribute [rw] base_path
|
7299
|
-
#
|
7300
|
-
# change.
|
6473
|
+
# The base path of the BasePathMapping resource to change.
|
7301
6474
|
#
|
7302
6475
|
# To specify an empty base path, set this parameter to `'(none)'`.
|
7303
6476
|
# @return [String]
|
7304
6477
|
#
|
7305
6478
|
# @!attribute [rw] patch_operations
|
7306
|
-
#
|
7307
|
-
#
|
6479
|
+
# For more information about supported patch operations, see [Patch
|
6480
|
+
# Operations][1].
|
6481
|
+
#
|
6482
|
+
#
|
6483
|
+
#
|
6484
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7308
6485
|
# @return [Array<Types::PatchOperation>]
|
7309
6486
|
#
|
7310
6487
|
class UpdateBasePathMappingRequest < Struct.new(
|
@@ -7333,13 +6510,16 @@ module Aws::APIGateway
|
|
7333
6510
|
# }
|
7334
6511
|
#
|
7335
6512
|
# @!attribute [rw] client_certificate_id
|
7336
|
-
#
|
7337
|
-
# updated.
|
6513
|
+
# The identifier of the ClientCertificate resource to be updated.
|
7338
6514
|
# @return [String]
|
7339
6515
|
#
|
7340
6516
|
# @!attribute [rw] patch_operations
|
7341
|
-
#
|
7342
|
-
#
|
6517
|
+
# For more information about supported patch operations, see [Patch
|
6518
|
+
# Operations][1].
|
6519
|
+
#
|
6520
|
+
#
|
6521
|
+
#
|
6522
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7343
6523
|
# @return [Array<Types::PatchOperation>]
|
7344
6524
|
#
|
7345
6525
|
class UpdateClientCertificateRequest < Struct.new(
|
@@ -7369,7 +6549,7 @@ module Aws::APIGateway
|
|
7369
6549
|
# }
|
7370
6550
|
#
|
7371
6551
|
# @!attribute [rw] rest_api_id
|
7372
|
-
#
|
6552
|
+
# The string identifier of the associated RestApi.
|
7373
6553
|
# @return [String]
|
7374
6554
|
#
|
7375
6555
|
# @!attribute [rw] deployment_id
|
@@ -7378,8 +6558,12 @@ module Aws::APIGateway
|
|
7378
6558
|
# @return [String]
|
7379
6559
|
#
|
7380
6560
|
# @!attribute [rw] patch_operations
|
7381
|
-
#
|
7382
|
-
#
|
6561
|
+
# For more information about supported patch operations, see [Patch
|
6562
|
+
# Operations][1].
|
6563
|
+
#
|
6564
|
+
#
|
6565
|
+
#
|
6566
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7383
6567
|
# @return [Array<Types::PatchOperation>]
|
7384
6568
|
#
|
7385
6569
|
class UpdateDeploymentRequest < Struct.new(
|
@@ -7409,16 +6593,20 @@ module Aws::APIGateway
|
|
7409
6593
|
# }
|
7410
6594
|
#
|
7411
6595
|
# @!attribute [rw] rest_api_id
|
7412
|
-
#
|
6596
|
+
# The string identifier of the associated RestApi.
|
7413
6597
|
# @return [String]
|
7414
6598
|
#
|
7415
6599
|
# @!attribute [rw] documentation_part_id
|
7416
|
-
#
|
6600
|
+
# The identifier of the to-be-updated documentation part.
|
7417
6601
|
# @return [String]
|
7418
6602
|
#
|
7419
6603
|
# @!attribute [rw] patch_operations
|
7420
|
-
#
|
7421
|
-
#
|
6604
|
+
# For more information about supported patch operations, see [Patch
|
6605
|
+
# Operations][1].
|
6606
|
+
#
|
6607
|
+
#
|
6608
|
+
#
|
6609
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7422
6610
|
# @return [Array<Types::PatchOperation>]
|
7423
6611
|
#
|
7424
6612
|
class UpdateDocumentationPartRequest < Struct.new(
|
@@ -7448,17 +6636,20 @@ module Aws::APIGateway
|
|
7448
6636
|
# }
|
7449
6637
|
#
|
7450
6638
|
# @!attribute [rw] rest_api_id
|
7451
|
-
#
|
6639
|
+
# The string identifier of the associated RestApi..
|
7452
6640
|
# @return [String]
|
7453
6641
|
#
|
7454
6642
|
# @!attribute [rw] documentation_version
|
7455
|
-
#
|
7456
|
-
# documentation version.
|
6643
|
+
# The version identifier of the to-be-updated documentation version.
|
7457
6644
|
# @return [String]
|
7458
6645
|
#
|
7459
6646
|
# @!attribute [rw] patch_operations
|
7460
|
-
#
|
7461
|
-
#
|
6647
|
+
# For more information about supported patch operations, see [Patch
|
6648
|
+
# Operations][1].
|
6649
|
+
#
|
6650
|
+
#
|
6651
|
+
#
|
6652
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7462
6653
|
# @return [Array<Types::PatchOperation>]
|
7463
6654
|
#
|
7464
6655
|
class UpdateDocumentationVersionRequest < Struct.new(
|
@@ -7487,12 +6678,16 @@ module Aws::APIGateway
|
|
7487
6678
|
# }
|
7488
6679
|
#
|
7489
6680
|
# @!attribute [rw] domain_name
|
7490
|
-
#
|
6681
|
+
# The name of the DomainName resource to be changed.
|
7491
6682
|
# @return [String]
|
7492
6683
|
#
|
7493
6684
|
# @!attribute [rw] patch_operations
|
7494
|
-
#
|
7495
|
-
#
|
6685
|
+
# For more information about supported patch operations, see [Patch
|
6686
|
+
# Operations][1].
|
6687
|
+
#
|
6688
|
+
#
|
6689
|
+
#
|
6690
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7496
6691
|
# @return [Array<Types::PatchOperation>]
|
7497
6692
|
#
|
7498
6693
|
class UpdateDomainNameRequest < Struct.new(
|
@@ -7522,16 +6717,20 @@ module Aws::APIGateway
|
|
7522
6717
|
# }
|
7523
6718
|
#
|
7524
6719
|
# @!attribute [rw] rest_api_id
|
7525
|
-
#
|
6720
|
+
# The string identifier of the associated RestApi.
|
7526
6721
|
# @return [String]
|
7527
6722
|
#
|
7528
6723
|
# @!attribute [rw] response_type
|
7529
|
-
#
|
6724
|
+
# The response type of the associated GatewayResponse.
|
7530
6725
|
# @return [String]
|
7531
6726
|
#
|
7532
6727
|
# @!attribute [rw] patch_operations
|
7533
|
-
#
|
7534
|
-
#
|
6728
|
+
# For more information about supported patch operations, see [Patch
|
6729
|
+
# Operations][1].
|
6730
|
+
#
|
6731
|
+
#
|
6732
|
+
#
|
6733
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7535
6734
|
# @return [Array<Types::PatchOperation>]
|
7536
6735
|
#
|
7537
6736
|
class UpdateGatewayResponseRequest < Struct.new(
|
@@ -7562,22 +6761,24 @@ module Aws::APIGateway
|
|
7562
6761
|
# }
|
7563
6762
|
#
|
7564
6763
|
# @!attribute [rw] rest_api_id
|
7565
|
-
#
|
6764
|
+
# The string identifier of the associated RestApi.
|
7566
6765
|
# @return [String]
|
7567
6766
|
#
|
7568
6767
|
# @!attribute [rw] resource_id
|
7569
|
-
#
|
7570
|
-
# identifier.
|
6768
|
+
# Represents an update integration request's resource identifier.
|
7571
6769
|
# @return [String]
|
7572
6770
|
#
|
7573
6771
|
# @!attribute [rw] http_method
|
7574
|
-
#
|
7575
|
-
# method.
|
6772
|
+
# Represents an update integration request's HTTP method.
|
7576
6773
|
# @return [String]
|
7577
6774
|
#
|
7578
6775
|
# @!attribute [rw] patch_operations
|
7579
|
-
#
|
7580
|
-
#
|
6776
|
+
# For more information about supported patch operations, see [Patch
|
6777
|
+
# Operations][1].
|
6778
|
+
#
|
6779
|
+
#
|
6780
|
+
#
|
6781
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7581
6782
|
# @return [Array<Types::PatchOperation>]
|
7582
6783
|
#
|
7583
6784
|
class UpdateIntegrationRequest < Struct.new(
|
@@ -7610,27 +6811,29 @@ module Aws::APIGateway
|
|
7610
6811
|
# }
|
7611
6812
|
#
|
7612
6813
|
# @!attribute [rw] rest_api_id
|
7613
|
-
#
|
6814
|
+
# The string identifier of the associated RestApi.
|
7614
6815
|
# @return [String]
|
7615
6816
|
#
|
7616
6817
|
# @!attribute [rw] resource_id
|
7617
|
-
#
|
7618
|
-
#
|
6818
|
+
# Specifies an update integration response request's resource
|
6819
|
+
# identifier.
|
7619
6820
|
# @return [String]
|
7620
6821
|
#
|
7621
6822
|
# @!attribute [rw] http_method
|
7622
|
-
#
|
7623
|
-
# HTTP method.
|
6823
|
+
# Specifies an update integration response request's HTTP method.
|
7624
6824
|
# @return [String]
|
7625
6825
|
#
|
7626
6826
|
# @!attribute [rw] status_code
|
7627
|
-
#
|
7628
|
-
# status code.
|
6827
|
+
# Specifies an update integration response request's status code.
|
7629
6828
|
# @return [String]
|
7630
6829
|
#
|
7631
6830
|
# @!attribute [rw] patch_operations
|
7632
|
-
#
|
7633
|
-
#
|
6831
|
+
# For more information about supported patch operations, see [Patch
|
6832
|
+
# Operations][1].
|
6833
|
+
#
|
6834
|
+
#
|
6835
|
+
#
|
6836
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7634
6837
|
# @return [Array<Types::PatchOperation>]
|
7635
6838
|
#
|
7636
6839
|
class UpdateIntegrationResponseRequest < Struct.new(
|
@@ -7663,20 +6866,24 @@ module Aws::APIGateway
|
|
7663
6866
|
# }
|
7664
6867
|
#
|
7665
6868
|
# @!attribute [rw] rest_api_id
|
7666
|
-
#
|
6869
|
+
# The string identifier of the associated RestApi.
|
7667
6870
|
# @return [String]
|
7668
6871
|
#
|
7669
6872
|
# @!attribute [rw] resource_id
|
7670
|
-
#
|
6873
|
+
# The Resource identifier for the Method resource.
|
7671
6874
|
# @return [String]
|
7672
6875
|
#
|
7673
6876
|
# @!attribute [rw] http_method
|
7674
|
-
#
|
6877
|
+
# The HTTP verb of the Method resource.
|
7675
6878
|
# @return [String]
|
7676
6879
|
#
|
7677
6880
|
# @!attribute [rw] patch_operations
|
7678
|
-
#
|
7679
|
-
#
|
6881
|
+
# For more information about supported patch operations, see [Patch
|
6882
|
+
# Operations][1].
|
6883
|
+
#
|
6884
|
+
#
|
6885
|
+
#
|
6886
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7680
6887
|
# @return [Array<Types::PatchOperation>]
|
7681
6888
|
#
|
7682
6889
|
class UpdateMethodRequest < Struct.new(
|
@@ -7709,25 +6916,28 @@ module Aws::APIGateway
|
|
7709
6916
|
# }
|
7710
6917
|
#
|
7711
6918
|
# @!attribute [rw] rest_api_id
|
7712
|
-
#
|
6919
|
+
# The string identifier of the associated RestApi.
|
7713
6920
|
# @return [String]
|
7714
6921
|
#
|
7715
6922
|
# @!attribute [rw] resource_id
|
7716
|
-
#
|
7717
|
-
# resource.
|
6923
|
+
# The Resource identifier for the MethodResponse resource.
|
7718
6924
|
# @return [String]
|
7719
6925
|
#
|
7720
6926
|
# @!attribute [rw] http_method
|
7721
|
-
#
|
6927
|
+
# The HTTP verb of the Method resource.
|
7722
6928
|
# @return [String]
|
7723
6929
|
#
|
7724
6930
|
# @!attribute [rw] status_code
|
7725
|
-
#
|
6931
|
+
# The status code for the MethodResponse resource.
|
7726
6932
|
# @return [String]
|
7727
6933
|
#
|
7728
6934
|
# @!attribute [rw] patch_operations
|
7729
|
-
#
|
7730
|
-
#
|
6935
|
+
# For more information about supported patch operations, see [Patch
|
6936
|
+
# Operations][1].
|
6937
|
+
#
|
6938
|
+
#
|
6939
|
+
#
|
6940
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7731
6941
|
# @return [Array<Types::PatchOperation>]
|
7732
6942
|
#
|
7733
6943
|
class UpdateMethodResponseRequest < Struct.new(
|
@@ -7759,16 +6969,20 @@ module Aws::APIGateway
|
|
7759
6969
|
# }
|
7760
6970
|
#
|
7761
6971
|
# @!attribute [rw] rest_api_id
|
7762
|
-
#
|
6972
|
+
# The string identifier of the associated RestApi.
|
7763
6973
|
# @return [String]
|
7764
6974
|
#
|
7765
6975
|
# @!attribute [rw] model_name
|
7766
|
-
#
|
6976
|
+
# The name of the model to update.
|
7767
6977
|
# @return [String]
|
7768
6978
|
#
|
7769
6979
|
# @!attribute [rw] patch_operations
|
7770
|
-
#
|
7771
|
-
#
|
6980
|
+
# For more information about supported patch operations, see [Patch
|
6981
|
+
# Operations][1].
|
6982
|
+
#
|
6983
|
+
#
|
6984
|
+
#
|
6985
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7772
6986
|
# @return [Array<Types::PatchOperation>]
|
7773
6987
|
#
|
7774
6988
|
class UpdateModelRequest < Struct.new(
|
@@ -7798,16 +7012,20 @@ module Aws::APIGateway
|
|
7798
7012
|
# }
|
7799
7013
|
#
|
7800
7014
|
# @!attribute [rw] rest_api_id
|
7801
|
-
#
|
7015
|
+
# The string identifier of the associated RestApi.
|
7802
7016
|
# @return [String]
|
7803
7017
|
#
|
7804
7018
|
# @!attribute [rw] request_validator_id
|
7805
|
-
#
|
7019
|
+
# The identifier of RequestValidator to be updated.
|
7806
7020
|
# @return [String]
|
7807
7021
|
#
|
7808
7022
|
# @!attribute [rw] patch_operations
|
7809
|
-
#
|
7810
|
-
#
|
7023
|
+
# For more information about supported patch operations, see [Patch
|
7024
|
+
# Operations][1].
|
7025
|
+
#
|
7026
|
+
#
|
7027
|
+
#
|
7028
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7811
7029
|
# @return [Array<Types::PatchOperation>]
|
7812
7030
|
#
|
7813
7031
|
class UpdateRequestValidatorRequest < Struct.new(
|
@@ -7837,16 +7055,20 @@ module Aws::APIGateway
|
|
7837
7055
|
# }
|
7838
7056
|
#
|
7839
7057
|
# @!attribute [rw] rest_api_id
|
7840
|
-
#
|
7058
|
+
# The string identifier of the associated RestApi.
|
7841
7059
|
# @return [String]
|
7842
7060
|
#
|
7843
7061
|
# @!attribute [rw] resource_id
|
7844
|
-
#
|
7062
|
+
# The identifier of the Resource resource.
|
7845
7063
|
# @return [String]
|
7846
7064
|
#
|
7847
7065
|
# @!attribute [rw] patch_operations
|
7848
|
-
#
|
7849
|
-
#
|
7066
|
+
# For more information about supported patch operations, see [Patch
|
7067
|
+
# Operations][1].
|
7068
|
+
#
|
7069
|
+
#
|
7070
|
+
#
|
7071
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7850
7072
|
# @return [Array<Types::PatchOperation>]
|
7851
7073
|
#
|
7852
7074
|
class UpdateResourceRequest < Struct.new(
|
@@ -7875,12 +7097,16 @@ module Aws::APIGateway
|
|
7875
7097
|
# }
|
7876
7098
|
#
|
7877
7099
|
# @!attribute [rw] rest_api_id
|
7878
|
-
#
|
7100
|
+
# The string identifier of the associated RestApi.
|
7879
7101
|
# @return [String]
|
7880
7102
|
#
|
7881
7103
|
# @!attribute [rw] patch_operations
|
7882
|
-
#
|
7883
|
-
#
|
7104
|
+
# For more information about supported patch operations, see [Patch
|
7105
|
+
# Operations][1].
|
7106
|
+
#
|
7107
|
+
#
|
7108
|
+
#
|
7109
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7884
7110
|
# @return [Array<Types::PatchOperation>]
|
7885
7111
|
#
|
7886
7112
|
class UpdateRestApiRequest < Struct.new(
|
@@ -7909,17 +7135,20 @@ module Aws::APIGateway
|
|
7909
7135
|
# }
|
7910
7136
|
#
|
7911
7137
|
# @!attribute [rw] rest_api_id
|
7912
|
-
#
|
7138
|
+
# The string identifier of the associated RestApi.
|
7913
7139
|
# @return [String]
|
7914
7140
|
#
|
7915
7141
|
# @!attribute [rw] stage_name
|
7916
|
-
#
|
7917
|
-
# about.
|
7142
|
+
# The name of the Stage resource to change information about.
|
7918
7143
|
# @return [String]
|
7919
7144
|
#
|
7920
7145
|
# @!attribute [rw] patch_operations
|
7921
|
-
#
|
7922
|
-
#
|
7146
|
+
# For more information about supported patch operations, see [Patch
|
7147
|
+
# Operations][1].
|
7148
|
+
#
|
7149
|
+
#
|
7150
|
+
#
|
7151
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7923
7152
|
# @return [Array<Types::PatchOperation>]
|
7924
7153
|
#
|
7925
7154
|
class UpdateStageRequest < Struct.new(
|
@@ -7948,12 +7177,16 @@ module Aws::APIGateway
|
|
7948
7177
|
# }
|
7949
7178
|
#
|
7950
7179
|
# @!attribute [rw] usage_plan_id
|
7951
|
-
#
|
7180
|
+
# The Id of the to-be-updated usage plan.
|
7952
7181
|
# @return [String]
|
7953
7182
|
#
|
7954
7183
|
# @!attribute [rw] patch_operations
|
7955
|
-
#
|
7956
|
-
#
|
7184
|
+
# For more information about supported patch operations, see [Patch
|
7185
|
+
# Operations][1].
|
7186
|
+
#
|
7187
|
+
#
|
7188
|
+
#
|
7189
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7957
7190
|
# @return [Array<Types::PatchOperation>]
|
7958
7191
|
#
|
7959
7192
|
class UpdateUsagePlanRequest < Struct.new(
|
@@ -7983,19 +7216,21 @@ module Aws::APIGateway
|
|
7983
7216
|
# }
|
7984
7217
|
#
|
7985
7218
|
# @!attribute [rw] usage_plan_id
|
7986
|
-
#
|
7987
|
-
# data.
|
7219
|
+
# The Id of the usage plan associated with the usage data.
|
7988
7220
|
# @return [String]
|
7989
7221
|
#
|
7990
7222
|
# @!attribute [rw] key_id
|
7991
|
-
#
|
7992
|
-
#
|
7993
|
-
# quota.
|
7223
|
+
# The identifier of the API key associated with the usage plan in
|
7224
|
+
# which a temporary extension is granted to the remaining quota.
|
7994
7225
|
# @return [String]
|
7995
7226
|
#
|
7996
7227
|
# @!attribute [rw] patch_operations
|
7997
|
-
#
|
7998
|
-
#
|
7228
|
+
# For more information about supported patch operations, see [Patch
|
7229
|
+
# Operations][1].
|
7230
|
+
#
|
7231
|
+
#
|
7232
|
+
#
|
7233
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
7999
7234
|
# @return [Array<Types::PatchOperation>]
|
8000
7235
|
#
|
8001
7236
|
class UpdateUsageRequest < Struct.new(
|
@@ -8024,13 +7259,17 @@ module Aws::APIGateway
|
|
8024
7259
|
# }
|
8025
7260
|
#
|
8026
7261
|
# @!attribute [rw] vpc_link_id
|
8027
|
-
#
|
8028
|
-
#
|
7262
|
+
# The identifier of the VpcLink. It is used in an Integration to
|
7263
|
+
# reference this VpcLink.
|
8029
7264
|
# @return [String]
|
8030
7265
|
#
|
8031
7266
|
# @!attribute [rw] patch_operations
|
8032
|
-
#
|
8033
|
-
#
|
7267
|
+
# For more information about supported patch operations, see [Patch
|
7268
|
+
# Operations][1].
|
7269
|
+
#
|
7270
|
+
#
|
7271
|
+
#
|
7272
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
|
8034
7273
|
# @return [Array<Types::PatchOperation>]
|
8035
7274
|
#
|
8036
7275
|
class UpdateVpcLinkRequest < Struct.new(
|
@@ -8042,17 +7281,6 @@ module Aws::APIGateway
|
|
8042
7281
|
|
8043
7282
|
# Represents the usage data of a usage plan.
|
8044
7283
|
#
|
8045
|
-
# <div class="remarks"></div>
|
8046
|
-
#
|
8047
|
-
# <div class="seeAlso" markdown="1">
|
8048
|
-
# [Create and Use Usage Plans][1], [Manage Usage in a Usage Plan][2]
|
8049
|
-
# </div>
|
8050
|
-
#
|
8051
|
-
#
|
8052
|
-
#
|
8053
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
8054
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage
|
8055
|
-
#
|
8056
7284
|
# @!attribute [rw] usage_plan_id
|
8057
7285
|
# The plan Id associated with this usage data.
|
8058
7286
|
# @return [String]
|
@@ -8090,25 +7318,13 @@ module Aws::APIGateway
|
|
8090
7318
|
# Represents a usage plan used to specify who can assess associated API
|
8091
7319
|
# stages. Optionally, target request rate and quota limits can be set.
|
8092
7320
|
# In some cases clients can exceed the targets that you set. Don’t rely
|
8093
|
-
# on usage plans to control costs. Consider using [
|
8094
|
-
# monitor costs and [
|
8095
|
-
#
|
8096
|
-
# <div class="remarks" markdown="1">
|
8097
|
-
# In a usage plan, you associate an API by specifying the API's Id and
|
8098
|
-
# a stage name of the specified API. You add plan customers by adding
|
8099
|
-
# API keys to the plan.
|
8100
|
-
#
|
8101
|
-
# </div>
|
8102
|
-
#
|
8103
|
-
# <div class="seeAlso" markdown="1">
|
8104
|
-
# [Create and Use Usage Plans][3]
|
8105
|
-
# </div>
|
7321
|
+
# on usage plans to control costs. Consider using [Amazon Web Services
|
7322
|
+
# Budgets][1] to monitor costs and [WAF][2] to manage API requests.
|
8106
7323
|
#
|
8107
7324
|
#
|
8108
7325
|
#
|
8109
7326
|
# [1]: https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html
|
8110
7327
|
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
8111
|
-
# [3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
8112
7328
|
#
|
8113
7329
|
# @!attribute [rw] id
|
8114
7330
|
# The identifier of a UsagePlan resource.
|
@@ -8127,8 +7343,8 @@ module Aws::APIGateway
|
|
8127
7343
|
# @return [Array<Types::ApiStage>]
|
8128
7344
|
#
|
8129
7345
|
# @!attribute [rw] throttle
|
8130
|
-
#
|
8131
|
-
# a usage plan.
|
7346
|
+
# A map containing method level throttling information for API stage
|
7347
|
+
# in a usage plan.
|
8132
7348
|
# @return [Types::ThrottleSettings]
|
8133
7349
|
#
|
8134
7350
|
# @!attribute [rw] quota
|
@@ -8161,20 +7377,6 @@ module Aws::APIGateway
|
|
8161
7377
|
|
8162
7378
|
# Represents a usage plan key to identify a plan customer.
|
8163
7379
|
#
|
8164
|
-
# <div class="remarks" markdown="1">
|
8165
|
-
# To associate an API stage with a selected API key in a usage plan, you
|
8166
|
-
# must create a UsagePlanKey resource to represent the selected ApiKey.
|
8167
|
-
#
|
8168
|
-
# </div>
|
8169
|
-
#
|
8170
|
-
# " <div class="seeAlso" markdown="1">
|
8171
|
-
# [Create and Use Usage Plans][1]
|
8172
|
-
# </div>
|
8173
|
-
#
|
8174
|
-
#
|
8175
|
-
#
|
8176
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
8177
|
-
#
|
8178
7380
|
# @!attribute [rw] id
|
8179
7381
|
# The Id of a usage plan key.
|
8180
7382
|
# @return [String]
|
@@ -8204,14 +7406,6 @@ module Aws::APIGateway
|
|
8204
7406
|
# Represents the collection of usage plan keys added to usage plans for
|
8205
7407
|
# the associated API keys and, possibly, other types of keys.
|
8206
7408
|
#
|
8207
|
-
# <div class="seeAlso" markdown="1">
|
8208
|
-
# [Create and Use Usage Plans][1]
|
8209
|
-
# </div>
|
8210
|
-
#
|
8211
|
-
#
|
8212
|
-
#
|
8213
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
8214
|
-
#
|
8215
7409
|
# @!attribute [rw] position
|
8216
7410
|
# @return [String]
|
8217
7411
|
#
|
@@ -8228,14 +7422,6 @@ module Aws::APIGateway
|
|
8228
7422
|
|
8229
7423
|
# Represents a collection of usage plans for an AWS account.
|
8230
7424
|
#
|
8231
|
-
# <div class="seeAlso" markdown="1">
|
8232
|
-
# [Create and Use Usage Plans][1]
|
8233
|
-
# </div>
|
8234
|
-
#
|
8235
|
-
#
|
8236
|
-
#
|
8237
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
8238
|
-
#
|
8239
7425
|
# @!attribute [rw] position
|
8240
7426
|
# @return [String]
|
8241
7427
|
#
|
@@ -8253,18 +7439,6 @@ module Aws::APIGateway
|
|
8253
7439
|
# An API Gateway VPC link for a RestApi to access resources in an Amazon
|
8254
7440
|
# Virtual Private Cloud (VPC).
|
8255
7441
|
#
|
8256
|
-
# <div class="remarks" markdown="1">
|
8257
|
-
# To enable access to a resource in an Amazon Virtual Private Cloud
|
8258
|
-
# through Amazon API Gateway, you, as an API developer, create a VpcLink
|
8259
|
-
# resource targeted for one or more network load balancers of the VPC
|
8260
|
-
# and then integrate an API method with a private integration that uses
|
8261
|
-
# the VpcLink. The private integration has an integration type of `HTTP`
|
8262
|
-
# or `HTTP_PROXY` and has a connection type of `VPC_LINK`. The
|
8263
|
-
# integration uses the `connectionId` property to identify the VpcLink
|
8264
|
-
# used.
|
8265
|
-
#
|
8266
|
-
# </div>
|
8267
|
-
#
|
8268
7442
|
# @!attribute [rw] id
|
8269
7443
|
# The identifier of the VpcLink. It is used in an Integration to
|
8270
7444
|
# reference this VpcLink.
|
@@ -8313,16 +7487,6 @@ module Aws::APIGateway
|
|
8313
7487
|
|
8314
7488
|
# The collection of VPC links under the caller's account in a region.
|
8315
7489
|
#
|
8316
|
-
# <div class="seeAlso" markdown="1">
|
8317
|
-
# [Getting Started with Private Integrations][1], [Set up Private
|
8318
|
-
# Integrations][2]
|
8319
|
-
# </div>
|
8320
|
-
#
|
8321
|
-
#
|
8322
|
-
#
|
8323
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-private-integration.html
|
8324
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-private-integration.html
|
8325
|
-
#
|
8326
7490
|
# @!attribute [rw] position
|
8327
7491
|
# @return [String]
|
8328
7492
|
#
|