CloudFront Keys API

The Keys API from CloudFront — 2 operation(s) for keys.

GitHub OpenAPI

Operations 5

DELETE /key-value-stores/{KvsARN}/keys/{Key} Delete Key #
GET /key-value-stores/{KvsARN}/keys/{Key} Get Key #
PUT /key-value-stores/{KvsARN}/keys/{Key} Put Key #
GET /key-value-stores/{KvsARN}/keys List Keys #
POST /key-value-stores/{KvsARN}/keys Update Keys #

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/cloudfront:cloudfront-keys-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

cloudfront-keys-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon CloudFront Keys API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 5 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://cloudfront-keyvaluestore.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /key-value-stores/{KvsARN}/keys/{Key}:
    delete:
      operationId: DeleteKey
      summary: Delete Key
      description: Deletes the key value pair specified by the key.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKeyResponse'
              example:
                ETag: KV7XY89Z0ABC012
                ItemCount: 3
                TotalSizeInBytes: 5
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteKeyRequest'
            example:
              Key: key1
              KvsARN: arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58
              IfMatch: KV0AB12C3DEF456
      tags:
      - Keys
    get:
      operationId: GetKey
      summary: Get Key
      description: Returns a key value pair.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeyResponse'
              example:
                Key: key1
                Value: value1
                ItemCount: 4
                TotalSizeInBytes: 15
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetKeyRequest'
            example:
              Key: key1
              KvsARN: arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58
      tags:
      - Keys
    put:
      operationId: PutKey
      summary: Put Key
      description: Creates a new key value pair or replaces the value of an existing key.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutKeyResponse'
              example:
                ETag: KV7XY89Z0ABC012
                ItemCount: 4
                TotalSizeInBytes: 15
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKeyRequest'
            example:
              Key: key1
              Value: value1
              KvsARN: arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58
              IfMatch: KV0AB12C3DEF456
      tags:
      - Keys
  /key-value-stores/{KvsARN}/keys:
    get:
      operationId: ListKeys
      summary: List Keys
      description: Returns a list of key value pairs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListKeysResponse'
              example:
                NextToken: hVTTZndkpBZ0VRZ0R1RF
                Items:
                - Key: key1
                  Value: value1
                - Key: key2
                  Value: value2
                - Key: key3
                  Value: value3
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListKeysRequest'
            example:
              KvsARN: arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58
              MaxResults: 3
      tags:
      - Keys
    post:
      operationId: UpdateKeys
      summary: Update Keys
      description: Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateKeysResponse'
              example:
                ETag: KV7XY89Z0ABC012
                ItemCount: 4
                TotalSizeInBytes: 15
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateKeysRequest'
            example:
              KvsARN: arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58
              IfMatch: KV0AB12C3DEF456
              Puts:
              - Key: key1
                Value: value1
              - Key: key2
                Value: value2
      tags:
      - Keys
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: cloudfront-keyvaluestore
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    DeleteKeyRequest:
      type: object
      properties:
        KvsARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Value Store.
        Key:
          type: string
          description: The key to delete.
        IfMatch:
          type: string
          description: The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get
            using DescribeKeyValueStore.
      required:
      - KvsARN
      - Key
      - IfMatch
    DeleteKeyRequestListItem:
      type: object
      properties:
        Key:
          type: string
          description: The key of the key value pair to be deleted.
      required:
      - Key
    DeleteKeyResponse:
      type: object
      properties:
        ItemCount:
          type: integer
          description: Number of key value pairs in the Key Value Store after the successful delete.
        TotalSizeInBytes:
          type: integer
          description: Total size of the Key Value Store after the successful delete, in bytes.
        ETag:
          type: string
          description: The current version identifier of the Key Value Store after the successful delete.
      required:
      - ItemCount
      - TotalSizeInBytes
      - ETag
    GetKeyRequest:
      type: object
      properties:
        KvsARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Value Store.
        Key:
          type: string
          description: The key to get.
      required:
      - KvsARN
      - Key
    GetKeyResponse:
      type: object
      properties:
        Key:
          type: string
          description: The key of the key value pair.
        Value:
          type: string
          description: The value of the key value pair.
        ItemCount:
          type: integer
          description: Number of key value pairs in the Key Value Store.
        TotalSizeInBytes:
          type: integer
          description: Total size of the Key Value Store in bytes.
      required:
      - Key
      - Value
      - ItemCount
      - TotalSizeInBytes
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListKeysRequest:
      type: object
      properties:
        KvsARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Value Store.
        NextToken:
          type: string
          description: If nextToken is returned in the response, there are more results available. Make the next call using
            the returned token to retrieve the next page.
        MaxResults:
          type: integer
          description: Maximum number of results that are returned per call. The default is 10 and maximum allowed page is
            50.
      required:
      - KvsARN
    ListKeysResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If nextToken is returned in the response, there are more results available. Make the next call using
            the returned token to retrieve the next page.
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ListKeysResponseListItem'
          description: Key value pairs
    ListKeysResponseListItem:
      type: object
      properties:
        Key:
          type: string
          description: The key of the key value pair.
        Value:
          type: string
          description: The value of the key value pair.
      required:
      - Key
      - Value
    PutKeyRequest:
      type: object
      properties:
        Key:
          type: string
          description: The key to put.
        Value:
          type: string
          description: The value to put.
        KvsARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Value Store.
        IfMatch:
          type: string
          description: The current version (ETag) of the Key Value Store that you are putting keys into, which you can get
            using DescribeKeyValueStore.
      required:
      - Key
      - Value
      - KvsARN
      - IfMatch
    PutKeyRequestListItem:
      type: object
      properties:
        Key:
          type: string
          description: The key of the key value pair list item to put.
        Value:
          type: string
          description: The value for the key value pair to put.
      required:
      - Key
      - Value
    PutKeyResponse:
      type: object
      properties:
        ItemCount:
          type: integer
          description: Number of key value pairs in the Key Value Store after the successful put.
        TotalSizeInBytes:
          type: integer
          description: Total size of the Key Value Store after the successful put, in bytes.
        ETag:
          type: string
          description: The current version identifier of the Key Value Store after the successful put.
      required:
      - ItemCount
      - TotalSizeInBytes
      - ETag
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    UpdateKeysRequest:
      type: object
      properties:
        KvsARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Value Store.
        IfMatch:
          type: string
          description: The current version (ETag) of the Key Value Store that you are updating keys of, which you can get
            using DescribeKeyValueStore.
        Puts:
          type: array
          items:
            $ref: '#/components/schemas/PutKeyRequestListItem'
          description: List of key value pairs to put.
        Deletes:
          type: array
          items:
            $ref: '#/components/schemas/DeleteKeyRequestListItem'
          description: List of keys to delete.
      required:
      - KvsARN
      - IfMatch
    UpdateKeysResponse:
      type: object
      properties:
        ItemCount:
          type: integer
          description: Number of key value pairs in the Key Value Store after the successful update.
        TotalSizeInBytes:
          type: integer
          description: Total size of the Key Value Store after the successful update, in bytes.
        ETag:
          type: string
          description: The current version identifier of the Key Value Store after the successful update.
      required:
      - ItemCount
      - TotalSizeInBytes
      - ETag
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudfront-keyvaluestore/service/2022-07-26/cloudfront-keyvaluestore-2022-07-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)