Amazon API Gateway Api Gateway Responses API

openapi: 3.1.0
info:
  title: Amazon API Gateway Responses API
  version: '2015-07-09'
  description: Generated from AWS's published Smithy model for Amazon API Gateway. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}:
    delete:
      operationId: DeleteMethodResponse
      summary: Delete Method Response
      description: Deletes an existing MethodResponse resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteMethodResponseRequest'
      tags:
      - Responses
    get:
      operationId: GetMethodResponse
      summary: Get Method Response
      description: Describes a MethodResponse resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodResponse'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMethodResponseRequest'
      tags:
      - Responses
    put:
      operationId: PutMethodResponse
      summary: Put Method Response
      description: Adds a MethodResponse to an existing Method resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '429':
          description: LimitExceededException; TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutMethodResponseRequest'
      tags:
      - Responses
    patch:
      operationId: UpdateMethodResponse
      summary: Update Method Response
      description: Updates an existing MethodResponse resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '429':
          description: LimitExceededException; TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMethodResponseRequest'
      tags:
      - Responses
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: apigateway
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    DeleteMethodResponseRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        resourceId:
          type: string
          description: The Resource identifier for the MethodResponse resource.
        httpMethod:
          type: string
          description: The HTTP verb of the Method resource.
        statusCode:
          type: string
          description: The status code identifier for the MethodResponse resource.
      required:
      - restApiId
      - resourceId
      - httpMethod
      - statusCode
    GetMethodResponseRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        resourceId:
          type: string
          description: The Resource identifier for the MethodResponse resource.
        httpMethod:
          type: string
          description: The HTTP verb of the Method resource.
        statusCode:
          type: string
          description: The status code for the MethodResponse resource.
      required:
      - restApiId
      - resourceId
      - httpMethod
      - statusCode
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    MethodResponse:
      type: object
      properties:
        statusCode:
          type: string
          description: The method response's status code.
        responseParameters:
          type: object
          additionalProperties:
            type: boolean
          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
        responseModels:
          type: object
          additionalProperties:
            type: string
          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.
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    PatchOperation:
      type: object
      properties:
        op:
          type: string
          enum:
          - add
          - remove
          - replace
          - move
          - copy
          - test
          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:
          type: 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:
          type: 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:
          type: 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".
    PutMethodResponseRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        resourceId:
          type: string
          description: The Resource identifier for the Method resource.
        httpMethod:
          type: string
          description: The HTTP verb of the Method resource.
        statusCode:
          type: string
          description: The method response's status code.
        responseParameters:
          type: object
          additionalProperties:
            type: boolean
          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 val
        responseModels:
          type: object
          additionalProperties:
            type: string
          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.
      required:
      - restApiId
      - resourceId
      - httpMethod
      - statusCode
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    UpdateMethodResponseRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        resourceId:
          type: string
          description: The Resource identifier for the MethodResponse resource.
        httpMethod:
          type: string
          description: The HTTP verb of the Method resource.
        statusCode:
          type: string
          description: The status code for the MethodResponse resource.
        patchOperations:
          type: array
          items:
            $ref: '#/components/schemas/PatchOperation'
          description: For more information about supported patch operations, see Patch Operations.
      required:
      - restApiId
      - resourceId
      - httpMethod
      - statusCode
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)