openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 386 kB
JSON
{"openapi":"3.0.0","info":{"version":"2018-11-29","x-release":"v4","title":"AmazonApiGatewayV2","description":"Amazon API Gateway V2","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","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":"apigatewayv2","x-aws-signingName":"apigateway","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigatewayv2-2018-11-29.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},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/apigateway/"},"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 AmazonApiGatewayV2 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 AmazonApiGatewayV2 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 AmazonApiGatewayV2 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 AmazonApiGatewayV2 endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v2/apis":{"post":{"operationId":"CreateApi","description":"Creates an Api resource.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","protocolType"],"properties":{"apiKeySelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"corsConfiguration":{"description":"Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.","type":"object","properties":{"AllowCredentials":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"allowCredentials"},"description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."}]},"AllowHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"allowHeaders"},"description":"Represents a collection of allowed headers. Supported only for HTTP APIs."}]},"AllowMethods":{"allOf":[{"$ref":"#/components/schemas/CorsMethodList"},{"xml":{"name":"allowMethods"},"description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."}]},"AllowOrigins":{"allOf":[{"$ref":"#/components/schemas/CorsOriginList"},{"xml":{"name":"allowOrigins"},"description":"Represents a collection of allowed origins. Supported only for HTTP APIs."}]},"ExposeHeaders":{"allOf":[{"$ref":"#/components/schemas/CorsHeaderList"},{"xml":{"name":"exposeHeaders"},"description":"Represents a collection of exposed headers. Supported only for HTTP APIs."}]},"MaxAge":{"allOf":[{"$ref":"#/components/schemas/IntegerWithLengthBetweenMinus1And86400"},{"xml":{"name":"maxAge"},"description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}]}}},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"disableSchemaValidation":{"description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs.","type":"boolean"},"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"},"name":{"description":"A string with a length between [1-128].","type":"string"},"protocolType":{"description":"Represents a protocol type.","type":"string","enum":["WEBSOCKET","HTTP"]},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}},"target":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"version":{"description":"A string with a length between [1-64].","type":"string"}}}}}}},"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":"GetApis","description":"Gets a collection of Api resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApisResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]},"put":{"operationId":"ImportApi","description":"Imports an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportApiResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"basepath","in":"query","required":false,"description":"Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.","schema":{"type":"string"}},{"name":"failOnWarnings","in":"query","required":false,"description":"Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"The OpenAPI definition. Supported only for HTTP APIs.","type":"string"}}}}}}}},"/v2/domainnames/{domainName}/apimappings":{"post":{"operationId":"CreateApiMapping","description":"Creates an API mapping.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiMappingResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiId","stage"],"properties":{"apiId":{"description":"The identifier.","type":"string"},"apiMappingKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"stage":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"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":"GetApiMappings","description":"Gets API mappings.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiMappingsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"domainName","in":"path","required":true,"description":"The domain name.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/authorizers":{"post":{"operationId":"CreateAuthorizer","description":"Creates an Authorizer for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAuthorizerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["authorizerType","identitySource","name"],"properties":{"authorizerCredentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"authorizerPayloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"authorizerResultTtlInSeconds":{"description":"An integer with a value between [0-3600].","type":"integer","minimum":0,"maximum":3600},"authorizerType":{"description":"The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).","type":"string","enum":["REQUEST","JWT"]},"authorizerUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"enableSimpleResponses":{"description":"Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>","type":"boolean"},"identitySource":{"description":"The identity source for which authorization is requested. 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":"array","items":{"$ref":"#/components/schemas/__string"}},"identityValidationExpression":{"description":"A string with a length between [0-1024].","type":"string"},"jwtConfiguration":{"description":"Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.","type":"object","properties":{"Audience":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"audience"},"description":"A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs."}]},"Issuer":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"issuer"},"description":"The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs."}]}}},"name":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"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":"GetAuthorizers","description":"Gets the Authorizers for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuthorizersResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/deployments":{"post":{"operationId":"CreateDeployment","description":"Creates a Deployment for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"A string with a length between [0-1024].","type":"string"},"stageName":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"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":"GetDeployments","description":"Gets the Deployments for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeploymentsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/domainnames":{"post":{"operationId":"CreateDomainName","description":"Creates a domain name.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainNameResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName"],"properties":{"domainName":{"description":"A string with a length between [1-512].","type":"string"},"domainNameConfigurations":{"description":"The domain name configurations.","type":"array","items":{"$ref":"#/components/schemas/DomainNameConfiguration"}},"mutualTlsAuthentication":{"description":"The mutual TLS authentication configuration for a custom domain name.","type":"object","properties":{"TruststoreUri":{"allOf":[{"$ref":"#/components/schemas/UriWithLengthBetween1And2048"},{"xml":{"name":"truststoreUri"},"description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."}]},"TruststoreVersion":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And64"},{"xml":{"name":"truststoreVersion"},"description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}]}}},"tags":{"description":"Represents a collection of tags associated with the resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And1600"}}}}}}}},"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":"GetDomainNames","description":"Gets the domain names for an AWS account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDomainNamesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/integrations":{"post":{"operationId":"CreateIntegration","description":"Creates an Integration.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integrationType"],"properties":{"connectionId":{"description":"A string with a length between [1-1024].","type":"string"},"connectionType":{"description":"Represents a connection type.","type":"string","enum":["INTERNET","VPC_LINK"]},"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"credentialsArn":{"description":"Represents an Amazon Resource Name (ARN).","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"integrationMethod":{"description":"A string with a length between [1-64].","type":"string"},"integrationSubtype":{"description":"A string with a length between [1-128].","type":"string"},"integrationType":{"description":"Represents an API method integration type.","type":"string","enum":["AWS","HTTP","MOCK","HTTP_PROXY","AWS_PROXY"]},"integrationUri":{"description":"A string representation of a URI with a length between [1-2048].","type":"string"},"passthroughBehavior":{"description":"Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.","type":"string","enum":["WHEN_NO_MATCH","NEVER","WHEN_NO_TEMPLATES"]},"payloadFormatVersion":{"description":"A string with a length between [1-64].","type":"string"},"requestParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"requestTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"responseParameters":{"description":"Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.","type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationParameters"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"timeoutInMillis":{"description":"An integer with a value between [50-30000].","type":"integer","minimum":50,"maximum":30000},"tlsConfig":{"description":"The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.","type":"object","properties":{"ServerNameToVerify":{"allOf":[{"$ref":"#/components/schemas/StringWithLengthBetween1And512"},{"xml":{"name":"serverNameToVerify"},"description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}]}}}}}}}}},"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":"GetIntegrations","description":"Gets the Integrations for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses":{"post":{"operationId":"CreateIntegrationResponse","description":"Creates an IntegrationResponses.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integrationResponseKey"],"properties":{"contentHandlingStrategy":{"description":"Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.","type":"string","enum":["CONVERT_TO_BINARY","CONVERT_TO_TEXT"]},"integrationResponseKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"responseParameters":{"description":"<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And512"}},"responseTemplates":{"description":"A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween0And32K"}},"templateSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"}}}}}}},"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":"GetIntegrationResponses","description":"Gets the IntegrationResponses for an Integration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationResponsesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/models":{"post":{"operationId":"CreateModel","description":"Creates a Model for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","schema"],"properties":{"contentType":{"description":"A string with a length between [1-256].","type":"string"},"description":{"description":"A string with a length between [0-1024].","type":"string"},"name":{"description":"A string with a length between [1-128].","type":"string"},"schema":{"description":"A string with a length between [0-32768].","type":"string"}}}}}}},"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":"GetModels","description":"Gets the Models for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/routes":{"post":{"operationId":"CreateRoute","description":"Creates a Route for an API.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRouteResult"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["routeKey"],"properties":{"apiKeyRequired":{"description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs.","type":"boolean"},"authorizationScopes":{"description":"A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.","type":"array","items":{"$ref":"#/components/schemas/StringWithLengthBetween1And64"}},"authorizationType":{"description":"The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.","type":"string","enum":["NONE","AWS_IAM","CUSTOM","JWT"]},"authorizerId":{"description":"The identifier.","type":"string"},"modelSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"operationName":{"description":"A string with a length between [1-64].","type":"string"},"requestModels":{"description":"The route models.","type":"object","additionalProperties":{"$ref":"#/components/schemas/StringWithLengthBetween1And128"}},"requestParameters":{"description":"The route parameters.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterConstraints"}},"routeKey":{"description":"After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.","type":"string"},"routeResponseSelectionExpression":{"description":"An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.","type":"string"},"target":{"description":"A string with a length between [1-128].","type":"string"}}}}}}},"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":"GetRoutes","description":"Gets the Routes for an API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRoutesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of elements to be returned for this resource.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next page of elements from this collection. Not valid for the last element of the collection.","schema":{"type":"string"}}]}},"/v2/apis/{apiId}/routes/{routeId}/routeresponses":{"post":{"operationId":"CreateRouteResponse","description":"Creates a RouteResponse for a Route.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRouteResponseResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"apiId","in":"path","required":true,"description":"The API identifier.","schema":{"type":"string"}},{"name":"routeId","in":"path","required":true,"description":"The route ID.","schema":{"type":"string"}}],"requ