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-aurora-dsql:amazon-aurora-dsql-policy-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 Aurora DSQL Policy API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon Aurora DSQL. 3 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://dsql.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Policy
paths:
  /cluster/{identifier}/policy:
    delete:
      operationId: DeleteClusterPolicy
      summary: Delete Cluster Policy
      description: Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClusterPolicyOutput'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteClusterPolicyInput'
      tags:
      - Policy
    get:
      operationId: GetClusterPolicy
      summary: Get Cluster Policy
      description: Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClusterPolicyOutput'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetClusterPolicyInput'
      tags:
      - Policy
    post:
      operationId: PutClusterPolicy
      summary: Put Cluster Policy
      description: Attaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutClusterPolicyOutput'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutClusterPolicyInput'
      tags:
      - Policy
components:
  schemas:
    DeleteClusterPolicyInput:
      type: object
      properties:
        identifier:
          type: string
        expectedPolicyVersion:
          type: string
          description: The expected version of the policy to delete. This parameter ensures that you're deleting the correct version of the policy and helps prevent accidental deletions.
        clientToken:
          type: string
      required:
      - identifier
    PutClusterPolicyInput:
      type: object
      properties:
        identifier:
          type: string
        policy:
          type: string
          description: The resource-based policy document to attach to the cluster. This should be a valid JSON policy document that defines permissions and conditions.
        bypassPolicyLockoutSafetyCheck:
          type: boolean
          description: A flag that allows you to bypass the policy lockout safety check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.
        expectedPolicyVersion:
          type: string
          description: The expected version of the current policy. This parameter ensures that you're updating the correct version of the policy and helps prevent concurrent modification conflicts.
        clientToken:
          type: string
      required:
      - identifier
      - policy
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field.
        message:
          type: string
          description: A message describing why this field failed validation.
      required:
      - name
      - message
    DeleteClusterPolicyOutput:
      type: object
      properties:
        policyVersion:
          type: string
          description: The version of the policy that was deleted.
      required:
      - policyVersion
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The resource ID could not be found.
        resourceType:
          type: string
          description: The resource type could not be found.
      required:
      - message
      - resourceId
      - resourceType
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: Retry after seconds.
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: The message that the request was denied due to request throttling.
        serviceCode:
          type: string
          description: The request exceeds a service quota.
        quotaCode:
          type: string
          description: The request exceeds a request rate quota.
        retryAfterSeconds:
          type: integer
          description: The request exceeds a request rate quota. Retry after seconds.
      required:
      - message
    GetClusterPolicyOutput:
      type: object
      properties:
        policy:
          type: string
          description: The resource-based policy document attached to the cluster, returned as a JSON string.
        policyVersion:
          type: string
          description: The version of the policy document. This version number is incremented each time the policy is updated.
      required:
      - policy
      - policyVersion
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: Resource Id
        resourceType:
          type: string
          description: Resource Type
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - deletionProtectionEnabled
          - other
          description: The reason for the validation exception.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of fields that didn't validate.
      required:
      - message
      - reason
    GetClusterPolicyInput:
      type: object
      properties:
        identifier:
          type: string
          description: The ID of the cluster to retrieve the policy from.
      required:
      - identifier
    PutClusterPolicyOutput:
      type: object
      properties:
        policyVersion:
          type: string
          description: The version of the policy after it has been updated or created.
      required:
      - policyVersion
  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: dsql
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/dsql/service/2018-05-10/dsql-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)