Amazon Bedrock Bedrock Datasets API

The Bedrock Datasets API from Amazon Bedrock — 2 operation(s) for bedrock datasets.

GitHub OpenAPI

Operations 5

POST /datasets Create Dataset #
GET /datasets List Datasets #
GET /datasets/{datasetId} Get Dataset #
PUT /datasets/{datasetId} Update Dataset #
DELETE /datasets/{datasetId} Delete Dataset #

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/amazon-bedrock:amazon-bedrock-datasets-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

amazon-bedrock-datasets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Bedrock Datasets API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 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://bedrock-agentcore-control.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /datasets:
    post:
      operationId: CreateDataset
      summary: Create Dataset
      description: Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset
        until status transitions to ACTIVE or CREATE_FAILED.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
        '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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
      tags:
      - Datasets
    get:
      operationId: ListDatasets
      summary: List Datasets
      description: Lists all datasets in the caller's account, paginated.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDatasetsRequest'
      tags:
      - Datasets
  /datasets/{datasetId}:
    get:
      operationId: GetDataset
      summary: Get Dataset
      description: Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata.
        If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDatasetResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDatasetRequest'
      tags:
      - Datasets
    put:
      operationId: UpdateDataset
      summary: Update Dataset
      description: Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain
        unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDatasetResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetRequest'
      tags:
      - Datasets
    delete:
      operationId: DeleteDataset
      summary: Delete Dataset
      description: Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all
        versions and the dataset record itself. If provided, deletes only that specific version.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDatasetResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentcoreControlValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDatasetRequest'
      tags:
      - Datasets
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: bedrock-agentcore
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    BedrockAgentcoreControlValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CannotParse
          - FieldValidationFailed
          - IdempotentParameterMismatchException
          - EventInOtherSession
          - ResourceConflict
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - message
      - reason
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateDatasetRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If you don't specify this field, a value is randomly generated for you. If this token matches a previous request,
            the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
        datasetName:
          type: string
          description: Human-readable name for the dataset. Must be unique within the account. Immutable after creation.
        description:
          type: string
          description: A description of the dataset.
        source:
          $ref: '#/components/schemas/DataSourceType'
        schemaType:
          type: string
          enum:
          - AGENTCORE_EVALUATION_PREDEFINED_V1
          - AGENTCORE_EVALUATION_SIMULATED_V1
          - THIRD_PARTY_EVALUATION_V1
          description: Versioned schema type governing the structure of examples. Immutable after creation.
        kmsKeyArn:
          type: string
          description: Optional KMS key ARN for server-side encryption on service Amazon S3 writes.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of tag keys and values to assign to the dataset.
      required:
      - datasetName
      - source
      - schemaType
    CreateDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created dataset.
        datasetId:
          type: string
          description: The unique identifier of the created dataset.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - ACTIVE
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or
            CREATE_FAILED.
        createdAt:
          type: string
          description: The timestamp when the dataset was created.
      required:
      - datasetArn
      - datasetId
      - status
      - createdAt
    DataSourceType:
      type: object
      properties:
        inlineExamples:
          $ref: '#/components/schemas/InlineExamplesSource'
        s3Source:
          $ref: '#/components/schemas/S3Source'
      description: Exactly one member is set.
    DatasetSummary:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset.
        datasetId:
          type: string
          description: The unique identifier of the dataset.
        datasetName:
          type: string
          description: The name of the dataset.
        description:
          type: string
          description: The description of the dataset.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - ACTIVE
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The current status of the dataset.
        draftStatus:
          type: string
          enum:
          - MODIFIED
          - UNMODIFIED
          description: Publish synchronization state. Only authoritative when status is ACTIVE.
        schemaType:
          type: string
          enum:
          - AGENTCORE_EVALUATION_PREDEFINED_V1
          - AGENTCORE_EVALUATION_SIMULATED_V1
          - THIRD_PARTY_EVALUATION_V1
          description: The schema type of the dataset.
        exampleCount:
          type: integer
          description: The number of examples in the dataset.
        createdAt:
          type: string
          description: The timestamp when the dataset was created.
        updatedAt:
          type: string
          description: The timestamp when the dataset was last updated.
      required:
      - datasetArn
      - datasetId
      - datasetName
      - status
      - schemaType
      - exampleCount
      - createdAt
      - updatedAt
    DeleteDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The unique identifier of the dataset to delete.
        datasetVersion:
          type: string
          description: Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific
            version.
      required:
      - datasetId
    DeleteDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset.
        datasetId:
          type: string
          description: The unique identifier of the dataset.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - ACTIVE
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The current status of the dataset after the delete request.
        datasetVersion:
          type: string
          description: The version that was deleted.
        updatedAt:
          type: string
          description: The timestamp when the delete was initiated.
      required:
      - datasetArn
      - datasetId
      - status
      - datasetVersion
      - updatedAt
    GetDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The unique identifier of the dataset to retrieve.
        datasetVersion:
          type: string
          description: 'Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.'
      required:
      - datasetId
    GetDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset.
        datasetId:
          type: string
          description: The unique identifier of the dataset.
        datasetVersion:
          type: string
          description: 'The resolved version: "DRAFT" (default) or the requested version number.'
        datasetName:
          type: string
          description: The name of the dataset.
        description:
          type: string
          description: The description of the dataset.
        status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - DELETING
          - ACTIVE
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The current status of the dataset.
        draftStatus:
          type: string
          enum:
          - MODIFIED
          - UNMODIFIED
          description: Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has
            unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
        failureReason:
          type: string
          description: Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the
            failure.
        schemaType:
          type: string
          enum:
          - AGENTCORE_EVALUATION_PREDEFINED_V1
          - AGENTCORE_EVALUATION_SIMULATED_V1
          - THIRD_PARTY_EVALUATION_V1
          description: The schema type declared at create time. Immutable after creation.
        kmsKeyArn:
          type: string
          description: KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.
        exampleCount:
          type: integer
          description: The number of examples in the DRAFT.
        downloadUrl:
          type: string
          description: Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires
            after 5 minutes. Omitted if the file does not yet exist.
        downloadUrlExpiresAt:
          type: string
          description: Expiry timestamp for the download URL.
        createdAt:
          type: string
          description: The timestamp when the dataset was created.
        updatedAt:
          type: string
          description: The timestamp when the dataset was last updated.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with the dataset.
      required:
      - datasetArn
      - datasetId
      - datasetVersion
      - datasetName
      - status
      - schemaType
      - exampleCount
      - createdAt
      - updatedAt
    InlineExamplesSource:
      type: object
      properties:
        examples:
          type: array
          items:
            type: object
          description: Examples to add. Each example is assigned an auto-generated UUID.
      required:
      - examples
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListDatasetsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The token for the next page of results.
        maxResults:
          type: integer
          description: The maximum number of datasets to return per page.
    ListDatasetsResponse:
      type: object
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSummary'
          description: The list of datasets.
        nextToken:
          type: string
          description: The token for the next page of results, or null if there are no more results.
      required:
      - datasets
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    S3Source:
      type: object
      properties:
        s3Uri:
          type: string
          description: Amazon S3 URI of the JSONL file (for example, s3://my-bucket/path/to/examples.jsonl).
      required:
      - s3Uri
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The unique identifier of the dataset to update.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If you don't specify this field, a value is randomly generated for you. If this token matches a previous request,
            the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
        description:
          type: string
          description: The updated description for the dataset.
      required:
      - datasetId
    UpdateDatasetResponse:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated dataset.
        datasetId:
          type: string
          description: The unique identifier of the updated dataset.
        updatedAt:
          type: string
          description: The timestamp when the dataset was updated.
      required:
      - datasetArn
      - datasetId
      - updatedAt
    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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bedrock-agentcore-control/service/2023-06-05/bedrock-agentcore-control-2023-06-05.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)