CloudFront OriginAccessControl API

The OriginAccessControl API from CloudFront — 2 operation(s) for originaccesscontrol.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /2020-05-31/origin-access-control Create an origin access control · Create Origin Access Control #
Ask an LLM
“How do I lock down my S3 bucket so only CloudFront can read it?”
“Can I create a new origin access control to sign requests to my origin?”
Tell an agent
Create a new origin access control.
Add an OAC so CloudFront signs requests to my private S3 origin.
GET /2020-05-31/origin-access-control List origin access controls · List Origin Access Controls #
Ask an LLM
“Which origin access controls have I set up for my S3 origins?”
“Can I see every OAC in my account?”
Tell an agent
List all of my origin access controls.
Show every OAC configured in my account.
DELETE /2020-05-31/origin-access-control/{Id} Delete an origin access control · Delete Origin Access Control #
Ask an LLM
“How do I remove an origin access control I'm no longer using?”
“Does deleting an OAC require its current ETag?”
Tell an agent destructive · confirm first
Delete origin access control {id}.
Delete OAC {id} using ETag {etag}.
GET /2020-05-31/origin-access-control/{Id} Get an origin access control · Get Origin Access Control #
Ask an LLM
“What signing behavior does a specific origin access control use?”
“Can I look up one OAC by its ID?”
Tell an agent
Get origin access control {id}.
Show the signing settings of OAC {id}.
GET /2020-05-31/origin-access-control/{Id}/config Get Origin Access Control Config #
PUT /2020-05-31/origin-access-control/{Id}/config Update Origin Access Control #

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-originaccesscontrol-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-originaccesscontrol-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon CloudFront Originaccesscontrol API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 6 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.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2020-05-31/origin-access-control:
    post:
      operationId: CreateOriginAccessControl
      summary: Create Origin Access Control
      description: Creates a new origin access control in CloudFront. After you create an origin access control, you can add
        it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
        This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content
        only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access
        to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateOriginAccessControlResult'
        '400':
          description: InvalidArgument; TooManyOriginAccessControls
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '409':
          description: OriginAccessControlAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OriginAccessControlAlreadyExists'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateOriginAccessControlRequest'
      tags:
      - Originaccesscontrol
    get:
      operationId: ListOriginAccessControls
      summary: List Origin Access Controls
      description: Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account. You can
        optionally specify the maximum number of items to receive in the response. If the total number of items in the list
        exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items,
        send another request that specifies the NextMarker value from the current response as the Marker value in the next
        request. If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls
        operation doesn't return the Items element in the response.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListOriginAccessControlsResult'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListOriginAccessControlsRequest'
      tags:
      - Originaccesscontrol
  /2020-05-31/origin-access-control/{Id}:
    delete:
      operationId: DeleteOriginAccessControl
      summary: Delete Origin Access Control
      description: Deletes a CloudFront origin access control. You cannot delete an origin access control if it's in use.
        First, update all distributions to remove the origin access control from all origins, then delete the origin access
        control.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidIfMatchVersion
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidIfMatchVersion'
        '404':
          description: NoSuchOriginAccessControl
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchOriginAccessControl'
        '409':
          description: OriginAccessControlInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OriginAccessControlInUse'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteOriginAccessControlRequest'
      tags:
      - Originaccesscontrol
    get:
      operationId: GetOriginAccessControl
      summary: Get Origin Access Control
      description: Gets a CloudFront origin access control, including its unique identifier.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetOriginAccessControlResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: NoSuchOriginAccessControl
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchOriginAccessControl'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetOriginAccessControlRequest'
      tags:
      - Originaccesscontrol
  /2020-05-31/origin-access-control/{Id}/config:
    get:
      operationId: GetOriginAccessControlConfig
      summary: Get Origin Access Control Config
      description: Gets a CloudFront origin access control configuration.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetOriginAccessControlConfigResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: NoSuchOriginAccessControl
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchOriginAccessControl'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetOriginAccessControlConfigRequest'
      tags:
      - Originaccesscontrol
    put:
      operationId: UpdateOriginAccessControl
      summary: Update Origin Access Control
      description: Updates a CloudFront origin access control.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateOriginAccessControlResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: IllegalUpdate; InvalidArgument; InvalidIfMatchVersion
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/IllegalUpdate'
        '404':
          description: NoSuchOriginAccessControl
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchOriginAccessControl'
        '409':
          description: OriginAccessControlAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OriginAccessControlAlreadyExists'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateOriginAccessControlRequest'
      tags:
      - Originaccesscontrol
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
  schemas:
    AccessDenied:
      type: object
      properties:
        Message:
          type: string
    CreateOriginAccessControlRequest:
      type: object
      properties:
        OriginAccessControlConfig:
          $ref: '#/components/schemas/OriginAccessControlConfig'
      required:
      - OriginAccessControlConfig
    CreateOriginAccessControlResult:
      type: object
      properties:
        OriginAccessControl:
          $ref: '#/components/schemas/OriginAccessControl'
        Location:
          type: string
          description: The URL of the origin access control.
        ETag:
          type: string
          description: The version identifier for the current version of the origin access control.
    DeleteOriginAccessControlRequest:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the origin access control that you are deleting.
        IfMatch:
          type: string
          description: The current version (ETag value) of the origin access control that you are deleting.
      required:
      - Id
    GetOriginAccessControlConfigRequest:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the origin access control.
      required:
      - Id
    GetOriginAccessControlConfigResult:
      type: object
      properties:
        OriginAccessControlConfig:
          $ref: '#/components/schemas/OriginAccessControlConfig'
        ETag:
          type: string
          description: The version identifier for the current version of the origin access control.
    GetOriginAccessControlRequest:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the origin access control.
      required:
      - Id
    GetOriginAccessControlResult:
      type: object
      properties:
        OriginAccessControl:
          $ref: '#/components/schemas/OriginAccessControl'
        ETag:
          type: string
          description: The version identifier for the current version of the origin access control.
    IllegalUpdate:
      type: object
      properties:
        Message:
          type: string
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    InvalidIfMatchVersion:
      type: object
      properties:
        Message:
          type: string
    ListOriginAccessControlsRequest:
      type: object
      properties:
        Marker:
          type: string
          description: Use this field when paginating results to indicate where to begin in your list of origin access controls.
            The response includes the items in the list that occur after the marker. To get the next page of the list, set
            this field's value to the value of NextMarker from the current page's response.
        MaxItems:
          type: integer
          description: The maximum number of origin access controls that you want in the response.
    ListOriginAccessControlsResult:
      type: object
      properties:
        OriginAccessControlList:
          $ref: '#/components/schemas/OriginAccessControlList'
    NoSuchOriginAccessControl:
      type: object
      properties:
        Message:
          type: string
    OriginAccessControl:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the origin access control.
        OriginAccessControlConfig:
          $ref: '#/components/schemas/OriginAccessControlConfig'
      required:
      - Id
    OriginAccessControlAlreadyExists:
      type: object
      properties:
        Message:
          type: string
    OriginAccessControlConfig:
      type: object
      properties:
        Name:
          type: string
          description: A name to identify the origin access control. You can specify up to 64 characters.
        Description:
          type: string
          description: A description of the origin access control.
        SigningProtocol:
          type: string
          enum:
          - sigv4
          - sigv4a
          description: The signing protocol of the origin access control, which determines how CloudFront signs (authenticates)
            requests. The only valid values are sigv4 and sigv4a.
        SigningBehavior:
          type: string
          enum:
          - never
          - always
          - no-override
          - always-amz-auth
          description: 'Specifies which requests CloudFront signs (adds authentication information to). Specify always for
            the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront
            Developer Guide. This field can have one of the following values: always – CloudFront signs all origin requests,
            overwriting the Authorization header from the viewer request if one exists. never – CloudFront doesn''t sign any
            origin requests. This value turns off origin access control for all origins in all distributions that use this
            origin access control. no-override – If the view'
        OriginAccessControlOriginType:
          type: string
          enum:
          - s3
          - mediastore
          - mediapackagev2
          - lambda
          description: The type of origin that this origin access control is for.
      required:
      - Name
      - SigningProtocol
      - SigningBehavior
      - OriginAccessControlOriginType
    OriginAccessControlInUse:
      type: object
      properties:
        Message:
          type: string
    OriginAccessControlList:
      type: object
      properties:
        Marker:
          type: string
          description: The value of the Marker field that was provided in the request.
        NextMarker:
          type: string
          description: If there are more items in the list than are in this response, this element is present. It contains
            the value to use in the Marker field of another request to continue listing origin access controls.
        MaxItems:
          type: integer
          description: The maximum number of origin access controls requested.
        IsTruncated:
          type: boolean
          description: If there are more items in the list than are in this response, this value is true.
        Quantity:
          type: integer
          description: The number of origin access controls returned in the response.
        Items:
          type: array
          items:
            $ref: '#/components/schemas/OriginAccessControlSummary'
          description: Contains the origin access controls in the list.
      required:
      - Marker
      - MaxItems
      - IsTruncated
      - Quantity
    OriginAccessControlSummary:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the origin access control.
        Description:
          type: string
          description: A description of the origin access control.
        Name:
          type: string
          description: A unique name that identifies the origin access control.
        SigningProtocol:
          type: string
          enum:
          - sigv4
          - sigv4a
          description: The signing protocol of the origin access control. The signing protocol determines how CloudFront signs
            (authenticates) requests. The only valid values are sigv4 and sigv4a.
        SigningBehavior:
          type: string
          enum:
          - never
          - always
          - no-override
          - always-amz-auth
          description: 'A value that specifies which requests CloudFront signs (adds authentication information to). This
            field can have one of the following values: never – CloudFront doesn''t sign any origin requests. always – CloudFront
            signs all origin requests, overwriting the Authorization header from the viewer request if necessary. no-override
            – If the viewer request doesn''t contain the Authorization header, CloudFront signs the origin request. If the
            viewer request contains the Authorization header, CloudFront doesn''t sign the origin request, but instead passes
            along the Authorization header that it received '
        OriginAccessControlOriginType:
          type: string
          enum:
          - s3
          - mediastore
          - mediapackagev2
          - lambda
          description: The type of origin that this origin access control is for.
      required:
      - Id
      - Description
      - Name
      - SigningProtocol
      - SigningBehavior
      - OriginAccessControlOriginType
    PreconditionFailed:
      type: object
      properties:
        Message:
          type: string
    UpdateOriginAccessControlRequest:
      type: object
      properties:
        OriginAccessControlConfig:
          $ref: '#/components/schemas/OriginAccessControlConfig'
        Id:
          type: string
          description: The unique identifier of the origin access control that you are updating.
        IfMatch:
          type: string
          description: The current version (ETag value) of the origin access control that you are updating.
      required:
      - OriginAccessControlConfig
      - Id
    UpdateOriginAccessControlResult:
      type: object
      properties:
        OriginAccessControl:
          $ref: '#/components/schemas/OriginAccessControl'
        ETag:
          type: string
          description: The new version of the origin access control after it has been updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)