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-elasticache:amazon-elasticache-cache-subnet-group-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon ElastiCache Cache Subnet Group API
  version: '2015-02-02'
  description: Generated from AWS's published Smithy model for Amazon ElastiCache. 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://elasticache.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Cache Subnet Group
paths:
  /?Action=CreateCacheSubnetGroup:
    post:
      operationId: CreateCacheSubnetGroup
      summary: Create Cache Subnet Group
      description: Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateCacheSubnetGroupResult'
              example:
                CacheSubnetGroup:
                  VpcId: vpc-91280df6
                  CacheSubnetGroupDescription: My subnet group.
                  Subnets:
                  - SubnetIdentifier: subnet-6f28c982
                    SubnetAvailabilityZone:
                      Name: us-east-1a
                  - SubnetIdentifier: subnet-bcd382f3
                    SubnetAvailabilityZone:
                      Name: us-east-1c
                  - SubnetIdentifier: subnet-845b3e7c0
                    SubnetAvailabilityZone:
                      Name: us-east-1b
                  CacheSubnetGroupName: my-sn-grp
        '400':
          description: CacheSubnetGroupAlreadyExistsFault; CacheSubnetGroupQuotaExceededFault; CacheSubnetQuotaExceededFault; InvalidSubnet; SubnetNotAllowedFault; TagQuotaPerResourceExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheSubnetGroupAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateCacheSubnetGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateCacheSubnetGroupMessage'
            example:
              CacheSubnetGroupName: my-sn-grp2
              CacheSubnetGroupDescription: Sample subnet group
              SubnetIds:
              - subnet-6f28c982
              - subnet-bcd382f3
              - subnet-845b3e7c0
      tags:
      - Cache Subnet Group
  /?Action=DeleteCacheSubnetGroup:
    post:
      operationId: DeleteCacheSubnetGroup
      summary: Delete Cache Subnet Group
      description: Deletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: CacheSubnetGroupInUse; CacheSubnetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheSubnetGroupInUse'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteCacheSubnetGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteCacheSubnetGroupMessage'
            example:
              CacheSubnetGroupName: my-subnet-group
      tags:
      - Cache Subnet Group
  /?Action=DescribeCacheSubnetGroups:
    post:
      operationId: DescribeCacheSubnetGroups
      summary: Describe Cache Subnet Groups
      description: Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheSubnetGroupMessage'
              example:
                Marker: ''
                CacheSubnetGroups:
                - VpcId: vpc-91280df6
                  CacheSubnetGroupDescription: Default CacheSubnetGroup
                  Subnets:
                  - SubnetIdentifier: subnet-1a2b3c4d
                    SubnetAvailabilityZone:
                      Name: us-east-1a
                  - SubnetIdentifier: subnet-a1b2c3d4
                    SubnetAvailabilityZone:
                      Name: us-east-1c
                  - SubnetIdentifier: subnet-abcd1234
                    SubnetAvailabilityZone:
                      Name: us-east-1e
                  - SubnetIdentifier: subnet-1234abcd
                    SubnetAvailabilityZone:
                      Name: us-east-1b
                  CacheSubnetGroupName: default
        '400':
          description: CacheSubnetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheSubnetGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeCacheSubnetGroups
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeCacheSubnetGroupsMessage'
            example:
              MaxRecords: 25
      tags:
      - Cache Subnet Group
  /?Action=ModifyCacheSubnetGroup:
    post:
      operationId: ModifyCacheSubnetGroup
      summary: Modify Cache Subnet Group
      description: Modifies an existing cache subnet group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyCacheSubnetGroupResult'
              example:
                CacheSubnetGroup:
                  VpcId: vpc-91280df6
                  CacheSubnetGroupDescription: My subnet group.
                  Subnets:
                  - SubnetIdentifier: subnet-a1b2c3d4
                    SubnetAvailabilityZone:
                      Name: us-east-1c
                  - SubnetIdentifier: subnet-1a2b3c4d
                    SubnetAvailabilityZone:
                      Name: us-east-1e
                  - SubnetIdentifier: subnet-bcde2345
                    SubnetAvailabilityZone:
                      Name: us-east-1e
                  - SubnetIdentifier: subnet-1234abcd
                    SubnetAvailabilityZone:
                      Name: us-east-1c
                  - SubnetIdentifier: subnet-abcd1234
                    SubnetAvailabilityZone:
                      Name: us-east-1b
                  CacheSubnetGroupName: my-sn-grp
        '400':
          description: CacheSubnetGroupNotFoundFault; CacheSubnetQuotaExceededFault; InvalidSubnet; SubnetInUse; SubnetNotAllowedFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CacheSubnetGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyCacheSubnetGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/ModifyCacheSubnetGroupMessage'
            example:
              CacheSubnetGroupName: my-sn-grp
              SubnetIds:
              - subnet-bcde2345
      tags:
      - Cache Subnet Group
components:
  schemas:
    ModifyCacheSubnetGroupMessage:
      type: object
      properties:
        CacheSubnetGroupName:
          type: string
          description: 'The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup'
        CacheSubnetGroupDescription:
          type: string
          description: A description of the cache subnet group.
        SubnetIds:
          type: array
          items:
            type: string
          description: The EC2 subnet IDs for the cache subnet group.
      required:
      - CacheSubnetGroupName
    DescribeCacheSubnetGroupsMessage:
      type: object
      properties:
        CacheSubnetGroupName:
          type: string
          description: The name of the cache subnet group to return details for.
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.'
        Marker:
          type: string
          description: An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    CacheSubnetGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    CacheSubnetGroup:
      type: object
      properties:
        CacheSubnetGroupName:
          type: string
          description: The name of the cache subnet group.
        CacheSubnetGroupDescription:
          type: string
          description: The description of the cache subnet group.
        VpcId:
          type: string
          description: The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
        Subnets:
          type: array
          items:
            $ref: '#/components/schemas/Subnet'
          description: A list of subnets associated with the cache subnet group.
        ARN:
          type: string
          description: The ARN (Amazon Resource Name) of the cache subnet group.
        SupportedNetworkTypes:
          type: array
          items:
            type: string
            enum:
            - ipv4
            - ipv6
            - dual_stack
          description: Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
    DeleteCacheSubnetGroupMessage:
      type: object
      properties:
        CacheSubnetGroupName:
          type: string
          description: 'The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens.'
      required:
      - CacheSubnetGroupName
    CreateCacheSubnetGroupResult:
      type: object
      properties:
        CacheSubnetGroup:
          $ref: '#/components/schemas/CacheSubnetGroup'
    ModifyCacheSubnetGroupResult:
      type: object
      properties:
        CacheSubnetGroup:
          $ref: '#/components/schemas/CacheSubnetGroup'
    SubnetOutpost:
      type: object
      properties:
        SubnetOutpostArn:
          type: string
          description: The outpost ARN of the subnet.
    CacheSubnetGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CacheSubnetGroupInUse:
      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.
    CacheSubnetGroupMessage:
      type: object
      properties:
        Marker:
          type: string
          description: Provides an identifier to allow retrieval of paginated results.
        CacheSubnetGroups:
          type: array
          items:
            $ref: '#/components/schemas/CacheSubnetGroup'
          description: A list of cache subnet groups. Each element in the list contains detailed information about one group.
    Subnet:
      type: object
      properties:
        SubnetIdentifier:
          type: string
          description: The unique identifier for the subnet.
        SubnetAvailabilityZone:
          $ref: '#/components/schemas/AvailabilityZone'
        SubnetOutpost:
          $ref: '#/components/schemas/SubnetOutpost'
        SupportedNetworkTypes:
          type: array
          items:
            type: string
            enum:
            - ipv4
            - ipv6
            - dual_stack
          description: Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
    AvailabilityZone:
      type: object
      properties:
        Name:
          type: string
          description: The name of the Availability Zone.
    CreateCacheSubnetGroupMessage:
      type: object
      properties:
        CacheSubnetGroupName:
          type: string
          description: 'A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup'
        CacheSubnetGroupDescription:
          type: string
          description: A description for the cache subnet group.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of VPC subnet IDs for the cache 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:
      - CacheSubnetGroupName
      - CacheSubnetGroupDescription
      - SubnetIds
  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: elasticache
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elasticache/service/2015-02-02/elasticache-2015-02-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)