openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Restapis API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Restapis paths: /restapis/{restapi_id}/authorizers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateAuthorizer description: Adds a new Authorizer resource to an existing RestApi resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Authorizer' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - name - type properties: name: description: The name of the authorizer. type: string type: description: The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. type: string enum: - TOKEN - REQUEST - COGNITO_USER_POOLS providerARNs: description: 'A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined. ' type: array items: $ref: '#/components/schemas/ProviderARN' authType: description: Optional customer-defined field, used in OpenAPI imports and exports without functional impact. type: string authorizerUri: description: Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. type: string authorizerCredentials: description: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. type: string identitySource: description: The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. type: string identityValidationExpression: description: A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer. type: string authorizerResultTtlInSeconds: description: The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. type: integer tags: - Restapis get: operationId: GetAuthorizers description: Describe an existing Authorizers resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Authorizers' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/deployments: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDeployment description: Creates a Deployment resource, which makes a specified RestApi callable over the internet. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Deployment' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: stageName: description: The name of the Stage resource for the Deployment resource to create. type: string stageDescription: description: The description of the Stage resource for the Deployment resource to create. type: string description: description: The description for the Deployment resource to create. type: string cacheClusterEnabled: description: Enables a cache cluster for the Stage resource specified in the input. type: boolean cacheClusterSize: description: Returns the size of the CacheCluster. type: string enum: - '0.5' - '1.6' - '6.1' - '13.5' - '28.4' - '58.2' - '118' - '237' variables: description: A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. type: object additionalProperties: $ref: '#/components/schemas/String' canarySettings: description: The input configuration for a canary deployment. type: object properties: percentTraffic: allOf: - $ref: '#/components/schemas/Double' - description: The percentage (0.0-100.0) of traffic routed to the canary deployment. stageVariableOverrides: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. useStageCache: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. tracingEnabled: description: Specifies whether active tracing with X-ray is enabled for the Stage. type: boolean tags: - Restapis get: operationId: GetDeployments description: Gets information about a Deployments collection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Deployments' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/documentation/parts: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDocumentationPart description: Creates a documentation part. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationPart' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - location - properties properties: location: description: Specifies the target API entity to which the documentation applies. type: object properties: type: allOf: - $ref: '#/components/schemas/DocumentationPartType' - description: The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type. path: allOf: - $ref: '#/components/schemas/String' - description: The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix. method: allOf: - $ref: '#/components/schemas/String' - description: The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly. statusCode: allOf: - $ref: '#/components/schemas/DocumentationPartLocationStatusCode' - description: The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly. name: allOf: - $ref: '#/components/schemas/String' - description: The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type. properties: description: The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published. type: string tags: - Restapis get: operationId: GetDocumentationParts description: Gets documentation parts. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationParts' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: type in: query required: false description: 'The type of API entities of the to-be-retrieved documentation parts. ' schema: type: string enum: - API - AUTHORIZER - MODEL - RESOURCE - METHOD - PATH_PARAMETER - QUERY_PARAMETER - REQUEST_HEADER - REQUEST_BODY - RESPONSE - RESPONSE_HEADER - RESPONSE_BODY - name: name in: query required: false description: The name of API entities of the to-be-retrieved documentation parts. schema: type: string - name: path in: query required: false description: The path of API entities of the to-be-retrieved documentation parts. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer - name: locationStatus in: query required: false description: The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content. schema: type: string enum: - DOCUMENTED - UNDOCUMENTED tags: - Restapis put: operationId: ImportDocumentationParts description: Imports documentation parts responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationPartIds' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: mode in: query required: false description: A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE. schema: type: string enum: - merge - overwrite - name: failonwarnings in: query required: false description: A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false. schema: type: boolean requestBody: required: true content: application/json: schema: type: object required: - body properties: body: description: Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object. type: string tags: - Restapis /restapis/{restapi_id}/documentation/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDocumentationVersion description: Creates a documentation version responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationVersion' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - documentationVersion properties: documentationVersion: description: The version identifier of the new snapshot. type: string stageName: description: The stage name to be associated with the new documentation snapshot. type: string description: description: A description about the new documentation snapshot. type: string tags: - Restapis get: operationId: GetDocumentationVersions description: Gets documentation versions. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationVersions' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/models: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateModel description: Adds a new Model resource to an existing RestApi resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Model' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The RestApi identifier under which the Model will be created. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - name - contentType properties: name: description: The name of the model. Must be alphanumeric. type: string description: description: The description of the model. type: string schema: description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. type: string contentType: description: The content-type for the model. type: string tags: - Restapis get: operationId: GetModels description: Describes existing Models defined for a RestApi resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Models' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/requestvalidators: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateRequestValidator description: Creates a RequestValidator of a given RestApi. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/RequestValidator' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: name: description: The name of the to-be-created RequestValidator. type: string validateRequestBody: description: A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false). type: boolean validateRequestParameters: description: A Boolean flag to indicate whether to validate request parameters, true, or not false. type: boolean tags: - Restapis get: operationId: GetRequestValidators description: Gets the RequestValidators collection of a given RestApi. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RequestValidators' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/resources/{parent_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateResource description: Creates a Resource resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Resource' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: parent_id in: path required: true description: The parent resource's identifier. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - pathPart properties: pathPart: description: The last path segment for this resource. type: string tags: - Restapis /restapis: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateRestApi description: Creates a new RestApi resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/RestApi' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name properties: name: description: The name of the RestApi. type: string description: description: The description of the RestApi. type: string version: description: A version identifier for the API. type: string cloneFrom: description: The ID of the RestApi that you want to clone from. type: string binaryMediaTypes: description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. type: array items: $ref: '#/components/schemas/String' minimumCompressionSize: description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. type: integer apiKeySource: description: 'The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.' type: string enum: - HEADER - AUTHORIZER endpointConfiguration: description: 'The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. ' type: object properties: types: allOf: - $ref: '#/components/schemas/ListOfEndpointType' - description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. vpcEndpointIds: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type. policy: description: A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. type: string tags: description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. type: object additionalProperties: $ref: '#/components/schemas/String' disableExecuteApiEndpoint: description: Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint type: boolean tags: - Restapis get: operationId: GetRestApis description: Lists the RestApis resources for your collection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestApis' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer tags: - Restapis /restapis/{restapi_id}/stages: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateStage description: 'Creates a new Stage resource that references a pre-existing Deployment for the API. ' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Stage' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - stageName - deploymentId properties: stageName: description: The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. type: string deploymentId: description: The identifier of the Deployment resource for the Stage resource. type: string description: description: The description of the Stage resource. type: string cacheClusterEnabled: description: Whether cache clustering is enabled for the stage. type: boolean cacheClusterSize: description: Returns the size of the CacheCluster. type: string enum: - '0.5' - '1.6' - '6.1' - '13.5' - '28.4' - '58.2' - '118' - '237' variables: description: A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. type: object additionalProperties: $ref: '#/components/schemas/String' documentationVersion: description: The version of the associated API documentation. type: string canarySettings: description: Configuration settings of a canary deployment. type: object properties: percentTraffic: allOf: - $ref: '#/components/schemas/Double' - description: The percent (0-100) of traffic diverted to a canary deployment. deploymentId: allOf: - $ref: '#/components/schemas/String' - description: The ID of the canary deployment. stageVariableOverrides: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. useStageCache: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. tracingEnabled: description: Specifies whether active tracing with X-ray is enabled for the Stage. type: boolean tags: description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis get: operationId: GetStages description: Gets information about one or more Stage resources. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Stages' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: deploymentId in: query required: false description: The stages' deployment identifiers. schema: type: string tags: - Restapis /restapis/{restapi_id}/authorizers/{authorizer_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteAuthorizer description: Deletes an existing Authorizer resource. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: authorizer_id in: path required: true description: The identifier of the Authorizer resource. schema: type: string tags: - Restapis get: operationId: GetAuthorizer description: Describe an existing Authorizer resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Authorizer' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: authorizer_id in: path required: true description: The identifier of the Authorizer resource. schema: type: string tags: - Restapis post: operationId: TestInvokeAuthorizer description: Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TestInvokeAuthorizerResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: authorizer_id in: path required: true description: Specifies a test invoke authorizer request's Authorizer ID. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: headers: description: A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified. type: object additionalProperties: $ref: '#/components/schemas/String' multiValueHeaders: description: The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified. type: object additionalProperties: $ref: '#/components/schemas/ListOfString' pathWithQueryString: description: The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. type: string body: description: The simulated request body of an incoming invocation request. type: string stageVariables: description: A key-value map of stage variables to simulate an invocation on a deployed Stage. type: object additionalProperties: $ref: '#/components/schemas/String' additionalContext: description: A key-value map of additional context variables. type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateAuthorizer description: Updates an existing Authorizer resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Authorizer' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: authorizer_id in: path required: true description: The identifier of the Authorizer resource. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/deployments/{deployment_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteDeployment description: Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: deployment_id in: path required: true description: The identifier of the Deployment resource to delete. schema: type: string tags: - Restapis get: operationId: GetDeployment description: Gets information about a Deployment resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Deployment' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: deployment_id in: path required: true description: The identifier of the Deployment resource to get information about. schema: type: string - name: embed in: query required: false description: A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. schema: type: array items: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateDeployment description: Changes information about a Deployment resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Deployment' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: deployment_id in: path required: true description: The replacement identifier for the Deployment resource to change information about. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/documentation/parts/{part_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteDocumentationPart description: Deletes a documentation part responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: part_id in: path required: true description: The identifier of the to-be-deleted documentation part. schema: type: string tags: - Restapis get: operationId: GetDocumentationPart description: Gets a documentation part. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationPart' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: part_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string tags: - Restapis patch: operationId: UpdateDocumentationPart description: Updates a documentation part. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationPart' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: part_id in: path required: true description: The identifier of the to-be-updated documentation part. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/documentation/versions/{doc_version}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteDocumentationVersion description: Deletes a documentation version. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: doc_version in: path required: true description: The version identifier of a to-be-deleted documentation snapshot. schema: type: string tags: - Restapis get: operationId: GetDocumentationVersion description: Gets a documentation version. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationVersion' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: doc_version in: path required: true description: The version identifier of the to-be-retrieved documentation snapshot. schema: type: string tags: - Restapis patch: operationId: UpdateDocumentationVersion description: Updates a documentation version. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentationVersion' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi.. schema: type: string - name: doc_version in: path required: true description: The version identifier of the to-be-updated documentation version. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/gatewayresponses/{response_type}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteGatewayResponse description: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: response_type in: path required: true description: The response type of the associated GatewayResponse. schema: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED tags: - Restapis get: operationId: GetGatewayResponse description: Gets a GatewayResponse of a specified response type on the given RestApi. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: response_type in: path required: true description: The response type of the associated GatewayResponse. schema: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED tags: - Restapis put: operationId: PutGatewayResponse description: Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: response_type in: path required: true description: The response type of the associated GatewayResponse schema: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED requestBody: required: true content: application/json: schema: type: object properties: statusCode: description: The status code. type: string pattern: '[1-5]\d\d' responseParameters: description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. type: object additionalProperties: $ref: '#/components/schemas/String' responseTemplates: description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateGatewayResponse description: Updates a GatewayResponse of a specified response type on the given RestApi. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: response_type in: path required: true description: The response type of the associated GatewayResponse. schema: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteIntegration description: Represents a delete integration. responses: '204': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a delete integration request's resource identifier. schema: type: string - name: http_method in: path required: true description: Specifies a delete integration request's HTTP method. schema: type: string tags: - Restapis get: operationId: GetIntegration description: Get the integration settings. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Integration' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a get integration request's resource identifier schema: type: string - name: http_method in: path required: true description: Specifies a get integration request's HTTP method. schema: type: string tags: - Restapis put: operationId: PutIntegration description: Sets up a method's integration. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Integration' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a put integration request's resource ID. schema: type: string - name: http_method in: path required: true description: Specifies the HTTP method for the integration. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - type properties: type: description: 'The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration. ' type: string enum: - HTTP - AWS - MOCK - HTTP_PROXY - AWS_PROXY httpMethod: description: The HTTP method for the integration. type: string uri: description: Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}. type: string connectionType: description: The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. type: string enum: - INTERNET - VPC_LINK connectionId: description: The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type. type: string credentials: description: Specifies whether credentials are required for a put integration. type: string requestParameters: description: A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. type: object additionalProperties: $ref: '#/components/schemas/String' requestTemplates: description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. type: object additionalProperties: $ref: '#/components/schemas/String' passthroughBehavior: description: 'Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. ' type: string cacheNamespace: description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources. type: string cacheKeyParameters: description: A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters. type: array items: $ref: '#/components/schemas/String' contentHandling: description:

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT timeoutInMillis: description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. type: integer tlsConfig: description: Specifies the TLS configuration for an integration. type: object properties: insecureSkipVerification: allOf: - $ref: '#/components/schemas/Boolean' - description:

Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn't recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.

Enabling insecureSkipVerification isn't recommended, especially for integrations with public HTTPS endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle attacks.

 tags: - Restapis patch: operationId: UpdateIntegration description: Represents an update integration. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Integration' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Represents an update integration request's resource identifier. schema: type: string - name: http_method in: path required: true description: Represents an update integration request's HTTP method. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteIntegrationResponse description: Represents a delete integration response. responses: '204': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a delete integration response request's resource identifier. schema: type: string - name: http_method in: path required: true description: Specifies a delete integration response request's HTTP method. schema: type: string - name: status_code in: path required: true description: Specifies a delete integration response request's status code. schema: type: string pattern: '[1-5]\d\d' description: The status code. tags: - Restapis get: operationId: GetIntegrationResponse description: Represents a get integration response. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IntegrationResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a get integration response request's resource identifier. schema: type: string - name: http_method in: path required: true description: Specifies a get integration response request's HTTP method. schema: type: string - name: status_code in: path required: true description: Specifies a get integration response request's status code. schema: type: string pattern: '[1-5]\d\d' description: The status code. tags: - Restapis put: operationId: PutIntegrationResponse description: Represents a put integration. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/IntegrationResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a put integration response request's resource identifier. schema: type: string - name: http_method in: path required: true description: Specifies a put integration response request's HTTP method. schema: type: string - name: status_code in: path required: true description: Specifies the status code that is used to map the integration response to an existing MethodResponse. schema: type: string pattern: '[1-5]\d\d' description: The status code. requestBody: required: true content: application/json: schema: type: object properties: selectionPattern: description: Specifies the selection pattern of a put integration response. type: string responseParameters: description: A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix. type: object additionalProperties: $ref: '#/components/schemas/String' responseTemplates: description: Specifies a put integration response's templates. type: object additionalProperties: $ref: '#/components/schemas/String' contentHandling: description:

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT tags: - Restapis patch: operationId: UpdateIntegrationResponse description: Represents an update integration response. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IntegrationResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies an update integration response request's resource identifier. schema: type: string - name: http_method in: path required: true description: Specifies an update integration response request's HTTP method. schema: type: string - name: status_code in: path required: true description: Specifies an update integration response request's status code. schema: type: string pattern: '[1-5]\d\d' description: The status code. requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteMethod description: Deletes an existing Method resource. responses: '204': description: Success '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the Method resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string tags: - Restapis get: operationId: GetMethod description: Describe an existing Method resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Method' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the Method resource. schema: type: string - name: http_method in: path required: true description: Specifies the method request's HTTP method type. schema: type: string tags: - Restapis put: operationId: PutMethod description: Add a method to an existing Resource resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/Method' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the new Method resource. schema: type: string - name: http_method in: path required: true description: Specifies the method request's HTTP method type. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - authorizationType properties: authorizationType: description: The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. type: string authorizerId: description: Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer. type: string apiKeyRequired: description: Specifies whether the method required a valid ApiKey. type: boolean operationName: description: A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example. type: string requestParameters: description: A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates. type: object additionalProperties: $ref: '#/components/schemas/NullableBoolean' requestModels: description: Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. type: object additionalProperties: $ref: '#/components/schemas/String' requestValidatorId: description: The identifier of a RequestValidator for validating the method request. type: string authorizationScopes: description: A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. type: array items: $ref: '#/components/schemas/String' tags: - Restapis post: operationId: TestInvokeMethod description: Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TestInvokeMethodResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: Specifies a test invoke method request's resource ID. schema: type: string - name: http_method in: path required: true description: Specifies a test invoke method request's HTTP method. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: pathWithQueryString: description: The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. type: string body: description: The simulated request body of an incoming invocation request. type: string headers: description: A key-value map of headers to simulate an incoming invocation request. type: object additionalProperties: $ref: '#/components/schemas/String' multiValueHeaders: description: The headers as a map from string to list of values to simulate an incoming invocation request. type: object additionalProperties: $ref: '#/components/schemas/ListOfString' clientCertificateId: description: A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint. type: string stageVariables: description: A key-value map of stage variables to simulate an invocation on a deployed Stage. type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateMethod description: Updates an existing Method resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Method' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the Method resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteMethodResponse description: Deletes an existing MethodResponse resource. responses: '204': description: Success '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the MethodResponse resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string - name: status_code in: path required: true description: The status code identifier for the MethodResponse resource. schema: type: string pattern: '[1-5]\d\d' description: The status code. tags: - Restapis get: operationId: GetMethodResponse description: Describes a MethodResponse resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MethodResponse' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the MethodResponse resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string - name: status_code in: path required: true description: The status code for the MethodResponse resource. schema: type: string pattern: '[1-5]\d\d' description: The status code. tags: - Restapis put: operationId: PutMethodResponse description: Adds a MethodResponse to an existing Method resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/MethodResponse' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the Method resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string - name: status_code in: path required: true description: The method response's status code. schema: type: string pattern: '[1-5]\d\d' description: The status code. requestBody: required: true content: application/json: schema: type: object properties: responseParameters: description: A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) type: object additionalProperties: $ref: '#/components/schemas/NullableBoolean' responseModels: description: Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateMethodResponse description: Updates an existing MethodResponse resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/MethodResponse' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The Resource identifier for the MethodResponse resource. schema: type: string - name: http_method in: path required: true description: The HTTP verb of the Method resource. schema: type: string - name: status_code in: path required: true description: The status code for the MethodResponse resource. schema: type: string pattern: '[1-5]\d\d' description: The status code. requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/models/{model_name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteModel description: Deletes a model. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: model_name in: path required: true description: The name of the model to delete. schema: type: string tags: - Restapis get: operationId: GetModel description: Describes an existing model defined for a RestApi resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Model' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The RestApi identifier under which the Model exists. schema: type: string - name: model_name in: path required: true description: The name of the model as an identifier. schema: type: string - name: flatten in: query required: false description: A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false. schema: type: boolean tags: - Restapis patch: operationId: UpdateModel description: Changes information about a model. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Model' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: model_name in: path required: true description: The name of the model to update. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteRequestValidator description: Deletes a RequestValidator of a given RestApi. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: requestvalidator_id in: path required: true description: The identifier of the RequestValidator to be deleted. schema: type: string tags: - Restapis get: operationId: GetRequestValidator description: Gets a RequestValidator of a given RestApi. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RequestValidator' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: requestvalidator_id in: path required: true description: The identifier of the RequestValidator to be retrieved. schema: type: string tags: - Restapis patch: operationId: UpdateRequestValidator description: Updates a RequestValidator of a given RestApi. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RequestValidator' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: requestvalidator_id in: path required: true description: The identifier of RequestValidator to be updated. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/resources/{resource_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteResource description: Deletes a Resource resource. responses: '202': description: Success '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The identifier of the Resource resource. schema: type: string tags: - Restapis get: operationId: GetResource description: Lists information about a resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Resource' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The identifier for the Resource resource. schema: type: string - name: embed in: query required: false description: A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods. schema: type: array items: $ref: '#/components/schemas/String' tags: - Restapis patch: operationId: UpdateResource description: Changes information about a Resource resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Resource' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: resource_id in: path required: true description: The identifier of the Resource resource. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteRestApi description: Deletes the specified API. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string tags: - Restapis get: operationId: GetRestApi description: Lists the RestApi resource in the collection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestApi' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string tags: - Restapis put: operationId: PutRestApi description: A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestApi' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: mode in: query required: false description: The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge". schema: type: string enum: - merge - overwrite - name: failonwarnings in: query required: false description: A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false. schema: type: boolean - name: parameters in: query required: false description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'. schema: type: object additionalProperties: $ref: '#/components/schemas/String' requestBody: required: true content: application/json: schema: type: object required: - body properties: body: description: The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB. type: string tags: - Restapis patch: operationId: UpdateRestApi description: Changes information about the specified API. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestApi' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/stages/{stage_name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteStage description: Deletes a Stage resource. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the Stage resource to delete. schema: type: string tags: - Restapis get: operationId: GetStage description: Gets information about a Stage resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Stage' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the Stage resource to get information about. schema: type: string tags: - Restapis patch: operationId: UpdateStage description: Changes information about a Stage resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Stage' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the Stage resource to change information about. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: patchOperations: description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. type: array items: $ref: '#/components/schemas/PatchOperation' tags: - Restapis /restapis/{restapi_id}/stages/{stage_name}/cache/authorizers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: FlushStageAuthorizersCache description: Flushes all authorizer cache entries on a stage. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the stage to flush. schema: type: string tags: - Restapis /restapis/{restapi_id}/stages/{stage_name}/cache/data: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: FlushStageCache description: Flushes a stage's cache. responses: '202': description: Success '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the stage to flush its cache. schema: type: string tags: - Restapis /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetExport description: Exports a deployed version of a RestApi in a specified format. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the Stage that will be exported. schema: type: string - name: export_type in: path required: true description: The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. schema: type: string - name: parameters in: query required: false description: 'A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions=''integrations'' or extensions=''apigateway'' will export the API with x-amazon-apigateway-integration extensions. extensions=''authorizers'' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool' schema: type: object additionalProperties: $ref: '#/components/schemas/String' - name: Accept in: header required: false description: The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests. schema: type: string tags: - Restapis /restapis/{restapi_id}/gatewayresponses: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetGatewayResponses description: Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GatewayResponses' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here. schema: type: integer tags: - Restapis /restapis/{restapi_id}/models/{model_name}/default_template: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetModelTemplate description: Generates a sample mapping template that can be used to transform a payload into the structure of a model. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Template' '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: model_name in: path required: true description: The name of the model for which to generate a template. schema: type: string tags: - Restapis /restapis/{restapi_id}/resources: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetResources description: Lists information about a collection of Resource resources. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Resources' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: position in: query required: false description: The current pagination position in the paged result set. schema: type: string - name: limit in: query required: false description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500. schema: type: integer - name: embed in: query required: false description: A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods. schema: type: array items: $ref: '#/components/schemas/String' tags: - Restapis /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSdk description: Generates a client SDK for a RestApi and Stage. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SdkResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: restapi_id in: path required: true description: The string identifier of the associated RestApi. schema: type: string - name: stage_name in: path required: true description: The name of the Stage that the SDK will use. schema: type: string - name: sdk_type in: path required: true description: The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported. schema: type: string - name: parameters in: query required: false description: 'A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required. ' schema: type: object additionalProperties: $ref: '#/components/schemas/String' tags: - Restapis components: schemas: ListOfAuthorizer: type: array items: $ref: '#/components/schemas/Authorizer' TooManyRequestsException: {} NotFoundException: {} Integration: type: object properties: type: allOf: - $ref: '#/components/schemas/IntegrationType' - description:

Specifies an API method integration type. The valid value is one of the following:

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

httpMethod: allOf: - $ref: '#/components/schemas/String' - description: Specifies the integration's HTTP method type. uri: allOf: - $ref: '#/components/schemas/String' - description:

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

connectionType: allOf: - $ref: '#/components/schemas/ConnectionType' - description: The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. connectionId: allOf: - $ref: '#/components/schemas/String' - description: The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise. credentials: allOf: - $ref: '#/components/schemas/String' - description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null. requestParameters: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. requestTemplates: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. passthroughBehavior: allOf: - $ref: '#/components/schemas/String' - description: 'Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.' contentHandling: allOf: - $ref: '#/components/schemas/ContentHandlingStrategy' - description:

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

timeoutInMillis: allOf: - $ref: '#/components/schemas/Integer' - description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. cacheNamespace: allOf: - $ref: '#/components/schemas/String' - description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources. cacheKeyParameters: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters. integrationResponses: allOf: - $ref: '#/components/schemas/MapOfIntegrationResponse' - description: Specifies the integration's responses. tlsConfig: allOf: - $ref: '#/components/schemas/TlsConfig' - description: Specifies the TLS configuration for an integration. description: Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. ServiceUnavailableException: {} MapOfIntegrationResponse: type: object additionalProperties: $ref: '#/components/schemas/IntegrationResponse' IntegrationType: type: string enum: - HTTP - AWS - MOCK - HTTP_PROXY - AWS_PROXY description: 'The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration. ' Deployment: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The identifier for the deployment resource. description: allOf: - $ref: '#/components/schemas/String' - description: The description for the deployment resource. createdDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the deployment resource was created. apiSummary: allOf: - $ref: '#/components/schemas/PathToMapOfMethodSnapshot' - description: A summary of the RestApi at the date and time that the deployment resource was created. description: An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. Stage: type: object properties: deploymentId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the Deployment that the stage points to. clientCertificateId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of a client certificate for an API stage. stageName: allOf: - $ref: '#/components/schemas/String' - description: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. description: allOf: - $ref: '#/components/schemas/String' - description: The stage's description. cacheClusterEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether a cache cluster is enabled for the stage. cacheClusterSize: allOf: - $ref: '#/components/schemas/CacheClusterSize' - description: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness. cacheClusterStatus: allOf: - $ref: '#/components/schemas/CacheClusterStatus' - description: The status of the cache cluster for the stage, if enabled. methodSettings: allOf: - $ref: '#/components/schemas/MapOfMethodSettings' - description: 'A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage. ' variables: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. documentationVersion: allOf: - $ref: '#/components/schemas/String' - description: The version of the associated API documentation. accessLogSettings: allOf: - $ref: '#/components/schemas/AccessLogSettings' - description: Settings for logging access in this stage. canarySettings: allOf: - $ref: '#/components/schemas/CanarySettings' - description: Settings for the canary deployment in this stage. tracingEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether active tracing with X-ray is enabled for the Stage. webAclArn: allOf: - $ref: '#/components/schemas/String' - description: The ARN of the WebAcl associated with the Stage. tags: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: The collection of tags. Each tag element is associated with a given resource. createdDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp when the stage was created. lastUpdatedDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp when the stage last updated. description: Represents a unique identifier for a version of a deployed RestApi that is callable by users. RequestValidator: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The identifier of this RequestValidator. name: allOf: - $ref: '#/components/schemas/String' - description: The name of this RequestValidator validateRequestBody: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean flag to indicate whether to validate a request body according to the configured Model schema. validateRequestParameters: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean flag to indicate whether to validate request parameters (true) or not (false). description: A set of validation rules for incoming Method requests. Timestamp: type: string format: date-time MapOfMethodResponse: type: object additionalProperties: $ref: '#/components/schemas/MethodResponse' ListOfModel: type: array items: $ref: '#/components/schemas/Model' CanarySettings: type: object properties: percentTraffic: allOf: - $ref: '#/components/schemas/Double' - description: The percent (0-100) of traffic diverted to a canary deployment. deploymentId: allOf: - $ref: '#/components/schemas/String' - description: The ID of the canary deployment. stageVariableOverrides: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. useStageCache: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. description: Configuration settings of a canary deployment. RequestValidators: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfRequestValidator' - xml: name: item description: The current page of elements from this collection. description: A collection of RequestValidator resources of a given RestApi. Deployments: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfDeployment' - xml: name: item description: The current page of elements from this collection. description: Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments. IntegrationResponse: type: object properties: statusCode: allOf: - $ref: '#/components/schemas/StatusCode' - description: Specifies the status code that is used to map the integration response to an existing MethodResponse. selectionPattern: allOf: - $ref: '#/components/schemas/String' - description: Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. responseParameters: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix. responseTemplates: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. contentHandling: allOf: - $ref: '#/components/schemas/ContentHandlingStrategy' - description:

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

description: Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response. ListOfGatewayResponse: type: array items: $ref: '#/components/schemas/GatewayResponse' PathToMapOfMethodSnapshot: type: object additionalProperties: $ref: '#/components/schemas/MapOfMethodSnapshot' Models: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfModel' - xml: name: item description: The current page of elements from this collection. description: Represents a collection of Model resources. MapOfStringToString: type: object additionalProperties: $ref: '#/components/schemas/String' Resource: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The resource's identifier. parentId: allOf: - $ref: '#/components/schemas/String' - description: The parent resource's identifier. pathPart: allOf: - $ref: '#/components/schemas/String' - description: The last path segment for this resource. path: allOf: - $ref: '#/components/schemas/String' - description: The full path for this resource. resourceMethods: allOf: - $ref: '#/components/schemas/MapOfMethod' - description: Gets an API resource's method of a given HTTP verb. description: Represents an API resource. TestInvokeAuthorizerResponse: type: object properties: clientStatus: allOf: - $ref: '#/components/schemas/Integer' - description: The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded. log: allOf: - $ref: '#/components/schemas/String' - description: The API Gateway execution log for the test authorizer request. latency: allOf: - $ref: '#/components/schemas/Long' - description: The execution latency of the test authorizer request. principalId: allOf: - $ref: '#/components/schemas/String' - description: The principal identity returned by the Authorizer policy: allOf: - $ref: '#/components/schemas/String' - description: The JSON policy document returned by the Authorizer authorization: allOf: - $ref: '#/components/schemas/MapOfStringToList' - description: The authorization response. claims: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API. description: Represents the response of the test invoke request for a custom Authorizer DocumentationPartIds: type: object properties: ids: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of the returned documentation part identifiers. warnings: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of warning messages reported during import of documentation parts. description: A collection of the imported DocumentationPart identifiers. Stages: type: object properties: item: allOf: - $ref: '#/components/schemas/ListOfStage' - description: The current page of elements from this collection. description: A list of Stage resources that are associated with the ApiKey resource. ExportResponse: type: object properties: body: allOf: - $ref: '#/components/schemas/Blob' - description: The binary blob response to GetExport, which contains the export. description: The binary blob response to GetExport, which contains the generated SDK. MapOfMethodSettings: type: object additionalProperties: $ref: '#/components/schemas/MethodSetting' MapOfMethod: type: object additionalProperties: $ref: '#/components/schemas/Method' Double: type: number format: double ConnectionType: type: string enum: - INTERNET - VPC_LINK GatewayResponse: type: object properties: responseType: allOf: - $ref: '#/components/schemas/GatewayResponseType' - description: The response type of the associated GatewayResponse. statusCode: allOf: - $ref: '#/components/schemas/StatusCode' - description: The HTTP status code for this GatewayResponse. responseParameters: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. responseTemplates: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. defaultResponse: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer. ' description: A gateway response of a given response type and status code, with optional response parameters and mapping templates. Boolean: type: boolean ConflictException: {} MethodSnapshot: type: object properties: authorizationType: allOf: - $ref: '#/components/schemas/String' - description: The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. apiKeyRequired: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether the method requires a valid ApiKey. description: Represents a summary of a Method resource, given a particular date and time. CacheClusterStatus: type: string enum: - CREATE_IN_PROGRESS - AVAILABLE - DELETE_IN_PROGRESS - NOT_AVAILABLE - FLUSH_IN_PROGRESS description: Returns the status of the CacheCluster. ListOfEndpointType: type: array items: $ref: '#/components/schemas/EndpointType' NullableBoolean: type: boolean GatewayResponseType: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED MethodResponse: type: object properties: statusCode: allOf: - $ref: '#/components/schemas/StatusCode' - description: The method response's status code. responseParameters: allOf: - $ref: '#/components/schemas/MapOfStringToBoolean' - description: A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) responseModels: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. description: 'Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. ' ApiKeySourceType: type: string enum: - HEADER - AUTHORIZER AccessLogSettings: type: object properties: format: allOf: - $ref: '#/components/schemas/String' - description: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. destinationArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. description: Access log settings, including the access log format and access log destination ARN. DocumentationPartLocationStatusCode: type: string pattern: ^([1-5]\d\d|\*|\s*)$ Model: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The identifier for the model resource. name: allOf: - $ref: '#/components/schemas/String' - description: The name of the model. Must be an alphanumeric string. description: allOf: - $ref: '#/components/schemas/String' - description: The description of the model. schema: allOf: - $ref: '#/components/schemas/String' - description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail. contentType: allOf: - $ref: '#/components/schemas/String' - description: The content-type for the model. description: Represents the data structure of a method's request or response payload. DocumentationPartLocation: type: object required: - type properties: type: allOf: - $ref: '#/components/schemas/DocumentationPartType' - description: The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type. path: allOf: - $ref: '#/components/schemas/String' - description: The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix. method: allOf: - $ref: '#/components/schemas/String' - description: The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly. statusCode: allOf: - $ref: '#/components/schemas/DocumentationPartLocationStatusCode' - description: The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly. name: allOf: - $ref: '#/components/schemas/String' - description: The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type. description: Specifies the target API entity to which the documentation applies. DocumentationParts: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfDocumentationPart' - xml: name: item description: The current page of elements from this collection. description: The collection of documentation parts of an API. AuthorizerType: type: string enum: - TOKEN - REQUEST - COGNITO_USER_POOLS description: The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. DocumentationVersions: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfDocumentationVersion' - xml: name: item description: The current page of elements from this collection. description: 'The collection of documentation snapshots of an API. ' NullableInteger: type: integer Op: type: string enum: - add - remove - replace - move - copy - test UnauthorizedException: {} SdkResponse: type: object properties: body: allOf: - $ref: '#/components/schemas/Blob' - description: The binary blob response to GetSdk, which contains the generated SDK. description: The binary blob response to GetSdk, which contains the generated SDK. Long: type: integer ListOfARNs: type: array items: $ref: '#/components/schemas/ProviderARN' Authorizers: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfAuthorizer' - xml: name: item description: The current page of elements from this collection. description: Represents a collection of Authorizer resources. PatchOperation: type: object properties: op: allOf: - $ref: '#/components/schemas/Op' - description: An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.. path: allOf: - $ref: '#/components/schemas/String' - description: 'The op operation''s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.' value: allOf: - $ref: '#/components/schemas/String' - description: 'The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ''{"a": ...}''.' from: allOf: - $ref: '#/components/schemas/String' - description: The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId". description: For more information about supported patch operations, see Patch Operations. ListOfDocumentationVersion: type: array items: $ref: '#/components/schemas/DocumentationVersion' Resources: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfResource' - xml: name: item description: The current page of elements from this collection. description: Represents a collection of Resource resources. DocumentationPart: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created. location: allOf: - $ref: '#/components/schemas/DocumentationPartLocation' - description: The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden. properties: description: 'A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.' description: A documentation part for a targeted API entity. EndpointType: type: string enum: - REGIONAL - EDGE - PRIVATE description: The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs. String: type: string MapOfMethodSnapshot: type: object additionalProperties: $ref: '#/components/schemas/MethodSnapshot' CacheClusterSize: type: string enum: - '0.5' - '1.6' - '6.1' - '13.5' - '28.4' - '58.2' - '118' - '237' description: Returns the size of the CacheCluster. Authorizer: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The identifier for the authorizer resource. name: allOf: - $ref: '#/components/schemas/String' - description: The name of the authorizer. type: allOf: - $ref: '#/components/schemas/AuthorizerType' - description: The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. providerARNs: allOf: - $ref: '#/components/schemas/ListOfARNs' - description: 'A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined. ' authType: allOf: - $ref: '#/components/schemas/String' - description: Optional customer-defined field, used in OpenAPI imports and exports without functional impact. authorizerUri: allOf: - $ref: '#/components/schemas/String' - description: Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. authorizerCredentials: allOf: - $ref: '#/components/schemas/String' - description: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. identitySource: allOf: - $ref: '#/components/schemas/String' - description: 'The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. ' identityValidationExpression: allOf: - $ref: '#/components/schemas/String' - description: A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer. authorizerResultTtlInSeconds: allOf: - $ref: '#/components/schemas/NullableInteger' - description: The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. description: Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. ContentHandlingStrategy: type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT MapOfStringToBoolean: type: object additionalProperties: $ref: '#/components/schemas/NullableBoolean' ListOfDocumentationPart: type: array items: $ref: '#/components/schemas/DocumentationPart' EndpointConfiguration: type: object properties: types: allOf: - $ref: '#/components/schemas/ListOfEndpointType' - description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. vpcEndpointIds: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type. description: 'The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. ' ProviderARN: type: string StatusCode: type: string pattern: '[1-5]\d\d' description: The status code. DocumentationVersion: type: object properties: version: allOf: - $ref: '#/components/schemas/String' - description: The version identifier of the API documentation snapshot. createdDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when the API documentation snapshot is created. description: allOf: - $ref: '#/components/schemas/String' - description: The description of the API documentation snapshot. description: A snapshot of the documentation of an API. ListOfDeployment: type: array items: $ref: '#/components/schemas/Deployment' ListOfStage: type: array items: $ref: '#/components/schemas/Stage' Integer: type: integer GatewayResponses: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfGatewayResponse' - xml: name: item description: Returns the entire collection, because of no pagination support. description: The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection. RestApi: type: object properties: id: allOf: - $ref: '#/components/schemas/String' - description: The API's identifier. This identifier is unique across all of your APIs in API Gateway. name: allOf: - $ref: '#/components/schemas/String' - description: The API's name. description: allOf: - $ref: '#/components/schemas/String' - description: The API's description. createdDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp when the API was created. version: allOf: - $ref: '#/components/schemas/String' - description: A version identifier for the API. warnings: allOf: - $ref: '#/components/schemas/ListOfString' - description: The warning messages reported when failonwarnings is turned on during API import. binaryMediaTypes: allOf: - $ref: '#/components/schemas/ListOfString' - description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. minimumCompressionSize: allOf: - $ref: '#/components/schemas/NullableInteger' - description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. apiKeySource: allOf: - $ref: '#/components/schemas/ApiKeySourceType' - description: 'The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.' endpointConfiguration: allOf: - $ref: '#/components/schemas/EndpointConfiguration' - description: 'The endpoint configuration of this RestApi showing the endpoint types of the API. ' policy: allOf: - $ref: '#/components/schemas/String' - description: A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. tags: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: The collection of tags. Each tag element is associated with a given resource. disableExecuteApiEndpoint: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. description: Represents a REST API. Template: type: object properties: value: allOf: - $ref: '#/components/schemas/String' - description: The Apache Velocity Template Language (VTL) template content used for the template resource. description: Represents a mapping template used to transform a payload. BadRequestException: {} LimitExceededException: {} DocumentationPartType: type: string enum: - API - AUTHORIZER - MODEL - RESOURCE - METHOD - PATH_PARAMETER - QUERY_PARAMETER - REQUEST_HEADER - REQUEST_BODY - RESPONSE - RESPONSE_HEADER - RESPONSE_BODY ListOfResource: type: array items: $ref: '#/components/schemas/Resource' RestApis: type: object properties: position: $ref: '#/components/schemas/String' items: allOf: - $ref: '#/components/schemas/ListOfRestApi' - xml: name: item description: The current page of elements from this collection. description: Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs. MethodSetting: type: object properties: metricsEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean. loggingLevel: allOf: - $ref: '#/components/schemas/String' - description: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events. dataTraceEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. throttlingBurstLimit: allOf: - $ref: '#/components/schemas/Integer' - description: Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer. throttlingRateLimit: allOf: - $ref: '#/components/schemas/Double' - description: Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double. cachingEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean. cacheTtlInSeconds: allOf: - $ref: '#/components/schemas/Integer' - description: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. cacheDataEncrypted: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean. requireAuthorizationForCacheControl: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean. unauthorizedCacheControlHeaderStrategy: allOf: - $ref: '#/components/schemas/UnauthorizedCacheControlHeaderStrategy' - description: Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER. description: Specifies the method setting properties. ListOfString: type: array items: $ref: '#/components/schemas/String' TestInvokeMethodResponse: type: object properties: status: allOf: - $ref: '#/components/schemas/Integer' - description: The HTTP status code. body: allOf: - $ref: '#/components/schemas/String' - description: The body of the HTTP response. headers: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: The headers of the HTTP response. multiValueHeaders: allOf: - $ref: '#/components/schemas/MapOfStringToList' - description: The headers of the HTTP response as a map from string to list of values. log: allOf: - $ref: '#/components/schemas/String' - description: The API Gateway execution log for the test invoke request. latency: allOf: - $ref: '#/components/schemas/Long' - description: The execution latency of the test invoke request. description: Represents the response of the test invoke request in the HTTP method. TlsConfig: type: object properties: insecureSkipVerification: allOf: - $ref: '#/components/schemas/Boolean' - description:

Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn't recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.

Enabling insecureSkipVerification isn't recommended, especially for integrations with public HTTPS endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle attacks.

 description: Specifies the TLS configuration for an integration. Method: type: object properties: httpMethod: allOf: - $ref: '#/components/schemas/String' - description: The method's HTTP verb. authorizationType: allOf: - $ref: '#/components/schemas/String' - description: The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. authorizerId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM. apiKeyRequired: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. requestValidatorId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of a RequestValidator for request validation. operationName: allOf: - $ref: '#/components/schemas/String' - description: A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example. requestParameters: allOf: - $ref: '#/components/schemas/MapOfStringToBoolean' - description: A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates. requestModels: allOf: - $ref: '#/components/schemas/MapOfStringToString' - description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). methodResponses: allOf: - $ref: '#/components/schemas/MapOfMethodResponse' - description: 'Gets a method response associated with a given HTTP status code. ' methodIntegration: allOf: - $ref: '#/components/schemas/Integration' - description: Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. authorizationScopes: allOf: - $ref: '#/components/schemas/ListOfString' - description: A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. description: ' Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. ' ListOfRestApi: type: array items: $ref: '#/components/schemas/RestApi' MapOfStringToList: type: object additionalProperties: $ref: '#/components/schemas/ListOfString' ListOfRequestValidator: type: array items: $ref: '#/components/schemas/RequestValidator' Blob: type: string UnauthorizedCacheControlHeaderStrategy: type: string enum: - FAIL_WITH_403 - SUCCEED_WITH_RESPONSE_HEADER - SUCCEED_WITHOUT_RESPONSE_HEADER parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true