Amazon Neptune

Amazon Neptune Neptune Exporttasks API

The Neptune Exporttasks API from Amazon Neptune — 2 operation(s) for neptune exporttasks.

Documentation GitHub OpenAPI

Operations 4

DELETE /exporttasks/{taskIdentifier} Cancel Export Task #

GET /exporttasks/{taskIdentifier} Get Export Task #

GET /exporttasks List Export Tasks #

POST /exporttasks Start Export Task #

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-neptune:amazon-neptune-exporttasks-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.1.0
info:
  title: Amazon Neptune Exporttasks API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 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://neptune-graph.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /exporttasks/{taskIdentifier}:
    delete:
      operationId: CancelExportTask
      summary: Cancel Export Task
      description: Cancel the specified export task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelExportTaskOutput'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelExportTaskInput'
      tags:
      - Exporttasks
    get:
      operationId: GetExportTask
      summary: Get Export Task
      description: Retrieves a specified export task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExportTaskOutput'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetExportTaskInput'
      tags:
      - Exporttasks
  /exporttasks:
    get:
      operationId: ListExportTasks
      summary: List Export Tasks
      description: Retrieves a list of export tasks.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExportTasksOutput'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListExportTasksInput'
      tags:
      - Exporttasks
    post:
      operationId: StartExportTask
      summary: Start Export Task
      description: Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartExportTaskOutput'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartExportTaskInput'
      tags:
      - Exporttasks
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: neptune-graph
  schemas:
    CancelExportTaskInput:
      type: object
      properties:
        taskIdentifier:
          type: string
          description: The unique identifier of the export task.
      required:
      - taskIdentifier
    CancelExportTaskOutput:
      type: object
      properties:
        graphId:
          type: string
          description: The source graph identifier of the cancelled export task.
        roleArn:
          type: string
          description: The ARN of the IAM role that will allow the exporting of data to the destination.
        taskId:
          type: string
          description: The unique identifier of the export task.
        status:
          type: string
          enum:
          - INITIALIZING
          - EXPORTING
          - SUCCEEDED
          - FAILED
          - CANCELLING
          - CANCELLED
          - DELETED
          description: The current status of the export task. The status is CANCELLING when the export task is cancelled.
        format:
          type: string
          enum:
          - PARQUET
          - CSV
          description: The format of the cancelled export task.
        destination:
          type: string
          description: The Amazon S3 URI of the cancelled export task where data will be exported to.
        kmsKeyIdentifier:
          type: string
          description: The KMS key identifier of the cancelled export task.
        parquetType:
          type: string
          enum:
          - COLUMNAR
          description: The parquet type of the cancelled export task.
        statusReason:
          type: string
          description: The reason that the export task has this status value.
      required:
      - graphId
      - roleArn
      - taskId
      - status
      - format
      - destination
      - kmsKeyIdentifier
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: A message describing the problem.
        reason:
          type: string
          enum:
          - CONCURRENT_MODIFICATION
          description: The reason for the conflict exception.
      required:
      - message
    ExportFilter:
      type: object
      properties:
        vertexFilter:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ExportFilterElement'
          description: Used to specify filters on a per-label basis for vertices. This allows you to control which vertex
            labels and properties are included in the export.
        edgeFilter:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ExportFilterElement'
          description: Used to specify filters on a per-label basis for edges. This allows you to control which edge labels
            and properties are included in the export.
    ExportFilterElement:
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ExportFilterPropertyAttributes'
          description: Each property is defined by a key-value pair, where the key is the desired output property name (e.g.
            "name"), and the value is an object.
    ExportFilterPropertyAttributes:
      type: object
      properties:
        outputType:
          type: string
          description: Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float").
            If a type is not provided, the export process will determine the type. If a given property is present as multiple
            types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type
            will be of Any type, otherwise, it will be the type of the property as present in vertices.
        sourcePropertyName:
          type: string
          description: The name of the property as it exists in the original graph data. If not provided, it is assumed that
            the key matches the desired sourcePropertyName.
        multiValueHandling:
          type: string
          enum:
          - TO_LIST
          - PICK_FIRST
          description: Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values
            as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.
    ExportTaskDetails:
      type: object
      properties:
        startTime:
          type: string
          description: The start time of the export task.
        timeElapsedSeconds:
          type: integer
          description: The time elapsed, in seconds, since the start time of the export task.
        progressPercentage:
          type: integer
          description: The number of progress percentage of the export task.
        numVerticesWritten:
          type: integer
          description: The number of exported vertices.
        numEdgesWritten:
          type: integer
          description: The number of exported edges.
      required:
      - startTime
      - timeElapsedSeconds
      - progressPercentage
    ExportTaskSummary:
      type: object
      properties:
        graphId:
          type: string
          description: The source graph identifier of the export task.
        roleArn:
          type: string
          description: The ARN of the IAM role that will allow the data to be exported to the destination.
        taskId:
          type: string
          description: The unique identifier of the export task.
        status:
          type: string
          enum:
          - INITIALIZING
          - EXPORTING
          - SUCCEEDED
          - FAILED
          - CANCELLING
          - CANCELLED
          - DELETED
          description: The current status of the export task.
        format:
          type: string
          enum:
          - PARQUET
          - CSV
          description: The format of the export task.
        destination:
          type: string
          description: The Amazon S3 URI of the export task where data will be exported to.
        kmsKeyIdentifier:
          type: string
          description: The KMS key identifier of the export task.
        parquetType:
          type: string
          enum:
          - COLUMNAR
          description: The parquet type of the export task.
        statusReason:
          type: string
          description: The reason that the export task has this status value.
      required:
      - graphId
      - roleArn
      - taskId
      - status
      - format
      - destination
      - kmsKeyIdentifier
    GetExportTaskInput:
      type: object
      properties:
        taskIdentifier:
          type: string
          description: The unique identifier of the export task.
      required:
      - taskIdentifier
    GetExportTaskOutput:
      type: object
      properties:
        graphId:
          type: string
          description: The source graph identifier of the export task.
        roleArn:
          type: string
          description: The ARN of the IAM role that will allow data to be exported to the destination.
        taskId:
          type: string
          description: The unique identifier of the export task.
        status:
          type: string
          enum:
          - INITIALIZING
          - EXPORTING
          - SUCCEEDED
          - FAILED
          - CANCELLING
          - CANCELLED
          - DELETED
          description: The current status of the export task.
        format:
          type: string
          enum:
          - PARQUET
          - CSV
          description: The format of the export task.
        destination:
          type: string
          description: The Amazon S3 URI of the export task where data will be exported.
        kmsKeyIdentifier:
          type: string
          description: The KMS key identifier of the export task.
        parquetType:
          type: string
          enum:
          - COLUMNAR
          description: The parquet type of the export task.
        statusReason:
          type: string
          description: The reason that the export task has this status value.
        exportTaskDetails:
          $ref: '#/components/schemas/ExportTaskDetails'
        exportFilter:
          $ref: '#/components/schemas/ExportFilter'
      required:
      - graphId
      - roleArn
      - taskId
      - status
      - format
      - destination
      - kmsKeyIdentifier
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: A message describing the problem.
      required:
      - message
    ListExportTasksInput:
      type: object
      properties:
        graphIdentifier:
          type: string
          description: The unique identifier of the Neptune Analytics graph.
        nextToken:
          type: string
          description: Pagination token used to paginate input.
        maxResults:
          type: integer
          description: The maximum number of export tasks to return.
    ListExportTasksOutput:
      type: object
      properties:
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/ExportTaskSummary'
          description: The requested list of export tasks.
        nextToken:
          type: string
          description: Pagination token used to paginate output.
      required:
      - tasks
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: A message describing the problem.
      required:
      - message
    StartExportTaskInput:
      type: object
      properties:
        graphIdentifier:
          type: string
          description: The source graph identifier of the export task.
        roleArn:
          type: string
          description: The ARN of the IAM role that will allow data to be exported to the destination.
        format:
          type: string
          enum:
          - PARQUET
          - CSV
          description: The format of the export task.
        destination:
          type: string
          description: The Amazon S3 URI where data will be exported to.
        kmsKeyIdentifier:
          type: string
          description: The KMS key identifier of the export task.
        parquetType:
          type: string
          enum:
          - COLUMNAR
          description: The parquet type of the export task.
        exportFilter:
          $ref: '#/components/schemas/ExportFilter'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags to be applied to the export task.
      required:
      - graphIdentifier
      - roleArn
      - format
      - destination
      - kmsKeyIdentifier
    StartExportTaskOutput:
      type: object
      properties:
        graphId:
          type: string
          description: The source graph identifier of the export task.
        roleArn:
          type: string
          description: The ARN of the IAM role that will allow data to be exported to the destination.
        taskId:
          type: string
          description: The unique identifier of the export task.
        status:
          type: string
          enum:
          - INITIALIZING
          - EXPORTING
          - SUCCEEDED
          - FAILED
          - CANCELLING
          - CANCELLED
          - DELETED
          description: The current status of the export task.
        format:
          type: string
          enum:
          - PARQUET
          - CSV
          description: The format of the export task.
        destination:
          type: string
          description: The Amazon S3 URI of the export task where data will be exported to.
        kmsKeyIdentifier:
          type: string
          description: The KMS key identifier of the export task.
        parquetType:
          type: string
          enum:
          - COLUMNAR
          description: The parquet type of the export task.
        statusReason:
          type: string
          description: The reason that the export task has this status value.
        exportFilter:
          $ref: '#/components/schemas/ExportFilter'
      required:
      - graphId
      - roleArn
      - taskId
      - status
      - format
      - destination
      - kmsKeyIdentifier
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: A message describing the problem.
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: A message describing the problem.
        reason:
          type: string
          enum:
          - CONSTRAINT_VIOLATION
          - ILLEGAL_ARGUMENT
          - MALFORMED_QUERY
          - QUERY_CANCELLED
          - QUERY_TOO_LARGE
          - UNSUPPORTED_OPERATION
          - BAD_REQUEST
          description: The reason that the resource could not be validated.
      required:
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/neptune-graph/service/2023-11-29/neptune-graph-2023-11-29.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)

Amazon Neptune Neptune Exporttasks API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources