Amazon MemoryDB Engine Versions API

openapi: 3.1.0
info:
  title: Amazon MemoryDB Engine Versions API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon MemoryDB. 1 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://memory-db.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DescribeEngineVersions:
    post:
      operationId: DescribeEngineVersions
      summary: Describe Engine Versions
      description: Returns a list of the available Redis OSS engine versions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEngineVersionsResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DescribeEngineVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEngineVersionsRequest'
      tags:
      - Engine Versions
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: memorydb
  schemas:
    DescribeEngineVersionsRequest:
      type: object
      properties:
        Engine:
          type: string
          description: The name of the engine for which to list available versions.
        EngineVersion:
          type: string
          description: The Redis OSS engine version
        ParameterGroupFamily:
          type: string
          description: The name of a specific parameter group family to return details for.
        MaxResults:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified
            MaxResults value, a token is included in the response so that the remaining results can be retrieved.
        NextToken:
          type: string
          description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
            nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
            each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
        DefaultOnly:
          type: boolean
          description: If true, specifies that only the default version of the specified engine or engine and major version
            combination is to be returned.
    DescribeEngineVersionsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
            nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
            each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
        EngineVersions:
          type: array
          items:
            $ref: '#/components/schemas/EngineVersionInfo'
          description: A list of engine version details. Each element in the list contains detailed information about one
            engine version.
    EngineVersionInfo:
      type: object
      properties:
        Engine:
          type: string
          description: The name of the engine for which version information is provided.
        EngineVersion:
          type: string
          description: The engine version
        EnginePatchVersion:
          type: string
          description: The patched engine version
        ParameterGroupFamily:
          type: string
          description: Specifies the name of the parameter group family to which the engine default parameters apply.
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/memorydb/service/2021-01-01/memorydb-2021-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)