Amazon MemoryDB Subnet Groups API

The Subnet Groups API from Amazon MemoryDB — 1 operation(s) for subnet groups.

Operations 4

POST /#CreateSubnetGroup Create Subnet Group #
POST /#DeleteSubnetGroup Delete Subnet Group #
POST /#DescribeSubnetGroups Describe Subnet Groups #
POST /#UpdateSubnetGroup Update Subnet Group #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-memorydb:amazon-memorydb-subnet-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-memorydb-subnet-groups-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon MemoryDB Subnet Groups API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon MemoryDB. 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://memory-db.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateSubnetGroup:
    post:
      operationId: CreateSubnetGroup
      summary: Create Subnet Group
      description: Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate
        for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon
        VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that
        subnet to associate with your nodes. For more information, see Subnets and subnet groups.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateSubnetGroupResponse'
        '400':
          description: InvalidSubnet; ServiceLinkedRoleNotFoundFault; SubnetGroupAlreadyExistsFault; SubnetGroupQuotaExceededFault;
            SubnetNotAllowedFault; SubnetQuotaExceededFault; TagQuotaPerResourceExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidSubnet'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.CreateSubnetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateSubnetGroupRequest'
      tags:
      - Subnet Groups
  /#DeleteSubnetGroup:
    post:
      operationId: DeleteSubnetGroup
      summary: Delete Subnet Group
      description: Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteSubnetGroupResponse'
        '400':
          description: ServiceLinkedRoleNotFoundFault; SubnetGroupInUseFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceLinkedRoleNotFoundFault'
        '404':
          description: SubnetGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SubnetGroupNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DeleteSubnetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSubnetGroupRequest'
      tags:
      - Subnet Groups
  /#DescribeSubnetGroups:
    post:
      operationId: DescribeSubnetGroups
      summary: Describe Subnet Groups
      description: Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only
        the description of that group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeSubnetGroupsResponse'
        '400':
          description: ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceLinkedRoleNotFoundFault'
        '404':
          description: SubnetGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SubnetGroupNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DescribeSubnetGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeSubnetGroupsRequest'
      tags:
      - Subnet Groups
  /#UpdateSubnetGroup:
    post:
      operationId: UpdateSubnetGroup
      summary: Update Subnet Group
      description: Updates a subnet group. For more information, see Updating a subnet group
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateSubnetGroupResponse'
        '400':
          description: InvalidSubnet; ServiceLinkedRoleNotFoundFault; SubnetInUse; SubnetNotAllowedFault; SubnetQuotaExceededFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidSubnet'
        '404':
          description: SubnetGroupNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SubnetGroupNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.UpdateSubnetGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateSubnetGroupRequest'
      tags:
      - Subnet Groups
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:
    AvailabilityZone:
      type: object
      properties:
        Name:
          type: string
          description: The name of the Availability Zone.
    CreateSubnetGroupRequest:
      type: object
      properties:
        SubnetGroupName:
          type: string
          description: The name of the subnet group.
        Description:
          type: string
          description: A description for the subnet group.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of VPC subnet IDs for the subnet group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied
            by a tag value, although null is accepted.
      required:
      - SubnetGroupName
      - SubnetIds
    CreateSubnetGroupResponse:
      type: object
      properties:
        SubnetGroup:
          $ref: '#/components/schemas/SubnetGroup'
    DeleteSubnetGroupRequest:
      type: object
      properties:
        SubnetGroupName:
          type: string
          description: The name of the subnet group to delete.
      required:
      - SubnetGroupName
    DeleteSubnetGroupResponse:
      type: object
      properties:
        SubnetGroup:
          $ref: '#/components/schemas/SubnetGroup'
    DescribeSubnetGroupsRequest:
      type: object
      properties:
        SubnetGroupName:
          type: string
          description: The name of the subnet group 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.
    DescribeSubnetGroupsResponse:
      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.
        SubnetGroups:
          type: array
          items:
            $ref: '#/components/schemas/SubnetGroup'
          description: A list of subnet groups. Each element in the list contains detailed information about one group.
    InvalidSubnet:
      type: object
      properties:
        message:
          type: string
    ServiceLinkedRoleNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Subnet:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier for the subnet.
        AvailabilityZone:
          $ref: '#/components/schemas/AvailabilityZone'
        SupportedNetworkTypes:
          type: array
          items:
            type: string
            enum:
            - ipv4
            - ipv6
            - dual_stack
          description: The network types supported by this subnet. Returns an array of strings that can include 'ipv4', 'ipv6',
            or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.
    SubnetGroup:
      type: object
      properties:
        Name:
          type: string
          description: The name of the subnet group
        Description:
          type: string
          description: A description of the subnet group
        VpcId:
          type: string
          description: The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
        Subnets:
          type: array
          items:
            $ref: '#/components/schemas/Subnet'
          description: A list of subnets associated with the subnet group.
        ARN:
          type: string
          description: The ARN (Amazon Resource Name) of the subnet group.
        SupportedNetworkTypes:
          type: array
          items:
            type: string
            enum:
            - ipv4
            - ipv6
            - dual_stack
          description: The network types supported by this subnet group. Returns an array of strings that can include 'ipv4',
            'ipv6', or both, indicating the IP address types that can be used for clusters deployed in this subnet group.
    SubnetGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. May not be null.
        Value:
          type: string
          description: The tag's value. May be null.
    UpdateSubnetGroupRequest:
      type: object
      properties:
        SubnetGroupName:
          type: string
          description: The name of the subnet group
        Description:
          type: string
          description: A description of the subnet group
        SubnetIds:
          type: array
          items:
            type: string
          description: The EC2 subnet IDs for the subnet group.
      required:
      - SubnetGroupName
    UpdateSubnetGroupResponse:
      type: object
      properties:
        SubnetGroup:
          $ref: '#/components/schemas/SubnetGroup'
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)