Amazon ElastiCache Elasticache Serverless Cache Snapshot API

openapi: 3.2.0
info:
  title: Amazon ElastiCache Serverless Cache Snapshot 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: Serverless Cache Snapshot
paths:
  /?Action=CreateServerlessCacheSnapshot:
    post:
      operationId: CreateServerlessCacheSnapshot
      summary: Create Serverless Cache Snapshot
      description: This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateServerlessCacheSnapshotResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidServerlessCacheStateFault; ServerlessCacheSnapshotAlreadyExistsFault; ServerlessCacheSnapshotQuotaExceededFault; ServiceLinkedRoleNotFoundFault; TagQuotaPerResourceExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateServerlessCacheSnapshot
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateServerlessCacheSnapshotRequest'
      tags:
      - Serverless Cache Snapshot
  /?Action=DeleteServerlessCacheSnapshot:
    post:
      operationId: DeleteServerlessCacheSnapshot
      summary: Delete Serverless Cache Snapshot
      description: Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteServerlessCacheSnapshotResponse'
        '400':
          description: InvalidParameterValueException; InvalidServerlessCacheSnapshotStateFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ServerlessCacheSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheSnapshotNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteServerlessCacheSnapshot
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteServerlessCacheSnapshotRequest'
      tags:
      - Serverless Cache Snapshot
  /?Action=DescribeServerlessCacheSnapshots:
    post:
      operationId: DescribeServerlessCacheSnapshots
      summary: Describe Serverless Cache Snapshots
      description: Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeServerlessCacheSnapshotsResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: ServerlessCacheNotFoundFault; ServerlessCacheSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeServerlessCacheSnapshots
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeServerlessCacheSnapshotsRequest'
      tags:
      - Serverless Cache Snapshot
  /?Action=ExportServerlessCacheSnapshot:
    post:
      operationId: ExportServerlessCacheSnapshot
      summary: Export Serverless Cache Snapshot
      description: Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExportServerlessCacheSnapshotResponse'
        '400':
          description: InvalidParameterValueException; InvalidServerlessCacheSnapshotStateFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ServerlessCacheSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServerlessCacheSnapshotNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ExportServerlessCacheSnapshot
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/ExportServerlessCacheSnapshotRequest'
      tags:
      - Serverless Cache Snapshot
components:
  schemas:
    CreateServerlessCacheSnapshotResponse:
      type: object
      properties:
        ServerlessCacheSnapshot:
          $ref: '#/components/schemas/ServerlessCacheSnapshot'
    ExportServerlessCacheSnapshotResponse:
      type: object
      properties:
        ServerlessCacheSnapshot:
          $ref: '#/components/schemas/ServerlessCacheSnapshot'
    ServerlessCacheSnapshot:
      type: object
      properties:
        ServerlessCacheSnapshotName:
          type: string
          description: The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
        KmsKeyId:
          type: string
          description: The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
        SnapshotType:
          type: string
          description: The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
        Status:
          type: string
          description: The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
        CreateTime:
          type: string
          format: date-time
          description: The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
        ExpiryTime:
          type: string
          format: date-time
          description: The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.
        BytesUsedForCache:
          type: string
          description: The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.
        ServerlessCacheConfiguration:
          $ref: '#/components/schemas/ServerlessCacheConfiguration'
    ServerlessCacheConfiguration:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: The identifier of a serverless cache.
        Engine:
          type: string
          description: The engine that the serverless cache is configured with.
        MajorEngineVersion:
          type: string
          description: The engine version number that the serverless cache is configured with.
    ExportServerlessCacheSnapshotRequest:
      type: object
      properties:
        ServerlessCacheSnapshotName:
          type: string
          description: The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.
        S3BucketName:
          type: string
          description: Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Valkey and Redis OSS only.
      required:
      - ServerlessCacheSnapshotName
      - S3BucketName
    DescribeServerlessCacheSnapshotsRequest:
      type: object
      properties:
        ServerlessCacheName:
          type: string
          description: The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.
        ServerlessCacheSnapshotName:
          type: string
          description: The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.
        SnapshotType:
          type: string
          description: The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.
        NextToken:
          type: string
          description: An optional marker returned from a prior request to support 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 max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
        MaxResults:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.
    ServerlessCacheNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ServerlessCacheSnapshotNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidParameterValueException:
      type: object
      properties:
        message:
          type: string
          description: A parameter value is invalid.
    DeleteServerlessCacheSnapshotResponse:
      type: object
      properties:
        ServerlessCacheSnapshot:
          $ref: '#/components/schemas/ServerlessCacheSnapshot'
    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.
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
          description: Two or more parameters that must not be used together were used together.
    DeleteServerlessCacheSnapshotRequest:
      type: object
      properties:
        ServerlessCacheSnapshotName:
          type: string
          description: Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.
      required:
      - ServerlessCacheSnapshotName
    CreateServerlessCacheSnapshotRequest:
      type: object
      properties:
        ServerlessCacheSnapshotName:
          type: string
          description: The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters. This value is stored as a lowercase string.
        ServerlessCacheName:
          type: string
          description: The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.
        KmsKeyId:
          type: string
          description: 'The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.
      required:
      - ServerlessCacheSnapshotName
      - ServerlessCacheName
    DescribeServerlessCacheSnapshotsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An optional marker returned from a prior request to support 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 max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
        ServerlessCacheSnapshots:
          type: array
          items:
            $ref: '#/components/schemas/ServerlessCacheSnapshot'
          description: The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.
  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)