Amazon Neptune Management API
Amazon Neptune Management API for creating, managing, and deleting Neptune DB clusters, instances, parameter groups, snapshots, and related infrastructure resources.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon Neptune Management API
description: >-
Amazon Neptune Management API for creating, managing, and deleting Neptune
DB clusters, instances, parameter groups, snapshots, and related
infrastructure resources. This is an AWS Query API that uses HTTPS requests
with Action and parameter query strings.
version: '2014-10-31'
contact:
name: Amazon Web Services
url: https://aws.amazon.com/neptune/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://rds.{region}.amazonaws.com
description: Amazon Neptune Management API regional endpoint
variables:
region:
default: us-east-1
description: AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-north-1
- ap-southeast-1
- ap-southeast-2
- ap-northeast-1
- ap-northeast-2
- ap-south-1
- ca-central-1
- me-south-1
- sa-east-1
security:
- aws_sigv4: []
tags:
- name: DB Clusters
description: Operations for managing Neptune DB clusters
- name: DB Instances
description: Operations for managing Neptune DB instances
- name: Engine
description: Operations for querying engine version information
- name: Events
description: Operations for managing event subscriptions and viewing events
- name: Global Clusters
description: Operations for managing Neptune global database clusters
- name: Maintenance
description: Operations for managing pending maintenance actions
- name: Parameter Groups
description: Operations for managing DB and cluster parameter groups
- name: Snapshots
description: Operations for managing cluster snapshots
- name: Subnet Groups
description: Operations for managing DB subnet groups
paths:
/:
get:
operationId: describeDBClusters
summary: Amazon Neptune Describe Neptune DB Clusters
description: >-
Returns information about provisioned Neptune DB clusters. If a cluster
identifier is supplied, details for that specific cluster are returned.
Otherwise, details for up to 100 clusters are returned.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusters
- name: DBClusterIdentifier
in: query
description: The identifier of the DB cluster to describe.
schema:
type: string
- name: MaxRecords
in: query
description: Maximum number of records to include in the response (20-100).
schema:
type: integer
minimum: 20
maximum: 100
- name: Marker
in: query
description: Pagination token from a previous request.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: Successful response with DB cluster details.
content:
application/xml:
schema:
$ref: '#/components/schemas/DescribeDBClustersResponse'
examples:
describeDBClusters200Example:
summary: Default describeDBClusters 200 response
x-microcks-default: true
value:
DBClusters:
- {}
Marker: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createDBCluster
summary: Amazon Neptune Create a New Neptune DB Cluster
description: >-
Creates a new Amazon Neptune DB cluster. You can use the
ReplicationSourceIdentifier parameter to create the DB cluster as a
read replica of another DB cluster.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBCluster
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateDBClusterRequest'
responses:
'200':
description: DB cluster created successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
createDBCluster200Example:
summary: Default createDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'400':
description: Invalid request parameters.
'409':
description: A DB cluster with the specified identifier already exists.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=DeleteDBCluster:
post:
operationId: deleteDBCluster
summary: Amazon Neptune Delete a Neptune DB Cluster
description: >-
Deletes a previously provisioned DB cluster. When you delete a DB
cluster, all automated backups are deleted and cannot be recovered.
Manual snapshots are not deleted.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The DB cluster identifier for the cluster to be deleted.
schema:
type: string
- name: SkipFinalSnapshot
in: query
description: Whether to skip creation of a final snapshot before deletion.
schema:
type: boolean
- name: FinalDBSnapshotIdentifier
in: query
description: The identifier of the final snapshot to create before deletion.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB cluster deleted successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
deleteDBCluster200Example:
summary: Default deleteDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=ModifyDBCluster:
post:
operationId: modifyDBCluster
summary: Amazon Neptune Modify a Neptune DB Cluster
description: >-
Modifies settings for a DB cluster. You can change one or more database
configuration parameters by specifying them and their new values.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBCluster
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ModifyDBClusterRequest'
responses:
'200':
description: DB cluster modified successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
modifyDBCluster200Example:
summary: Default modifyDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=StartDBCluster:
post:
operationId: startDBCluster
summary: Amazon Neptune Start a Stopped Neptune DB Cluster
description: >-
Starts a stopped Neptune DB cluster. When you start a cluster, Neptune
restores the cluster to the state it was in when it was stopped.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The identifier of the DB cluster to start.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB cluster start initiated successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
startDBCluster200Example:
summary: Default startDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=StopDBCluster:
post:
operationId: stopDBCluster
summary: Amazon Neptune Stop a Running Neptune DB Cluster
description: >-
Stops a running Neptune DB cluster. While the cluster is stopped, you
are charged only for storage. A stopped cluster automatically restarts
after 7 days.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- StopDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The identifier of the DB cluster to stop.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB cluster stop initiated successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
stopDBCluster200Example:
summary: Default stopDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=FailoverDBCluster:
post:
operationId: failoverDBCluster
summary: Amazon Neptune Force a Failover for a Neptune DB Cluster
description: >-
Forces a failover for a DB cluster. A failover for a DB cluster promotes
one of the read replicas in the cluster to be the new primary instance.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- FailoverDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The identifier of the cluster to force a failover for.
schema:
type: string
- name: TargetDBInstanceIdentifier
in: query
description: The name of the instance to promote to the primary instance.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: Failover initiated successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBCluster'
examples:
failoverDBCluster200Example:
summary: Default failoverDBCluster 200 response
x-microcks-default: true
value:
DBClusterIdentifier: neptune-cluster-abc123
DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
Status: available
Engine: example-value
EngineVersion: 1.3.2.0
Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
Port: 1
MasterUsername: my-neptune-cluster
DBClusterParameterGroup: example-value
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=AddRoleToDBCluster:
post:
operationId: addRoleToDBCluster
summary: Amazon Neptune Associate an IAM Role with a Neptune DB Cluster
description: >-
Associates an Identity and Access Management (IAM) role with a Neptune
DB cluster so that the cluster can access other AWS services on your
behalf.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AddRoleToDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The name of the DB cluster to associate the IAM role with.
schema:
type: string
- name: RoleArn
in: query
required: true
description: The ARN of the IAM role to associate with the cluster.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: IAM role associated successfully.
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=RemoveRoleFromDBCluster:
post:
operationId: removeRoleFromDBCluster
summary: Amazon Neptune Disassociate an IAM Role from a Neptune DB Cluster
description: >-
Disassociates an Identity and Access Management (IAM) role from a
Neptune DB cluster.
tags:
- DB Clusters
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RemoveRoleFromDBCluster
- name: DBClusterIdentifier
in: query
required: true
description: The name of the DB cluster to disassociate the role from.
schema:
type: string
- name: RoleArn
in: query
required: true
description: The ARN of the IAM role to disassociate.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: IAM role disassociated successfully.
'404':
description: The specified DB cluster or role was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=CreateDBInstance:
post:
operationId: createDBInstance
summary: Amazon Neptune Create a New Neptune DB Instance
description: >-
Creates a new DB instance in a Neptune DB cluster. The DB instance
inherits the cluster's storage and high availability configuration.
tags:
- DB Instances
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBInstance
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateDBInstanceRequest'
responses:
'200':
description: DB instance created successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBInstance'
examples:
createDBInstance200Example:
summary: Default createDBInstance 200 response
x-microcks-default: true
value:
DBInstanceIdentifier: neptune-cluster-abc123
DBInstanceClass: example-value
Engine: example-value
DBInstanceStatus: available
Endpoint:
Address: example-value
Port: 1
DBClusterIdentifier: neptune-cluster-abc123
AvailabilityZone: example-value
PreferredMaintenanceWindow: example-value
EngineVersion: 1.3.2.0
AutoMinorVersionUpgrade: true
'400':
description: Invalid request parameters.
'409':
description: A DB instance with the specified identifier already exists.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=DeleteDBInstance:
post:
operationId: deleteDBInstance
summary: Amazon Neptune Delete a Neptune DB Instance
description: >-
Deletes a previously provisioned DB instance. When you delete an
instance, all automated backups for that instance are deleted and
cannot be recovered.
tags:
- DB Instances
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDBInstance
- name: DBInstanceIdentifier
in: query
required: true
description: The DB instance identifier for the instance to be deleted.
schema:
type: string
- name: SkipFinalSnapshot
in: query
description: Whether to skip creation of a final snapshot.
schema:
type: boolean
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB instance deleted successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBInstance'
examples:
deleteDBInstance200Example:
summary: Default deleteDBInstance 200 response
x-microcks-default: true
value:
DBInstanceIdentifier: neptune-cluster-abc123
DBInstanceClass: example-value
Engine: example-value
DBInstanceStatus: available
Endpoint:
Address: example-value
Port: 1
DBClusterIdentifier: neptune-cluster-abc123
AvailabilityZone: example-value
PreferredMaintenanceWindow: example-value
EngineVersion: 1.3.2.0
AutoMinorVersionUpgrade: true
'404':
description: The specified DB instance was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=DescribeDBInstances:
get:
operationId: describeDBInstances
summary: Amazon Neptune Describe Neptune DB Instances
description: >-
Returns information about provisioned Neptune DB instances. If a
specific instance identifier is supplied, details for that instance
are returned.
tags:
- DB Instances
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBInstances
- name: DBInstanceIdentifier
in: query
description: The identifier of the DB instance to describe.
schema:
type: string
- name: MaxRecords
in: query
description: Maximum number of records to include in the response.
schema:
type: integer
minimum: 20
maximum: 100
- name: Marker
in: query
description: Pagination token from a previous request.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: Successful response with DB instance details.
content:
application/xml:
schema:
$ref: '#/components/schemas/DescribeDBInstancesResponse'
examples:
describeDBInstances200Example:
summary: Default describeDBInstances 200 response
x-microcks-default: true
value:
DBInstances:
- {}
Marker: example-value
'404':
description: The specified DB instance was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=ModifyDBInstance:
post:
operationId: modifyDBInstance
summary: Amazon Neptune Modify a Neptune DB Instance
description: >-
Modifies settings for a DB instance. You can change one or more database
configuration parameters by specifying them and their new values.
tags:
- DB Instances
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyDBInstance
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ModifyDBInstanceRequest'
responses:
'200':
description: DB instance modified successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBInstance'
examples:
modifyDBInstance200Example:
summary: Default modifyDBInstance 200 response
x-microcks-default: true
value:
DBInstanceIdentifier: neptune-cluster-abc123
DBInstanceClass: example-value
Engine: example-value
DBInstanceStatus: available
Endpoint:
Address: example-value
Port: 1
DBClusterIdentifier: neptune-cluster-abc123
AvailabilityZone: example-value
PreferredMaintenanceWindow: example-value
EngineVersion: 1.3.2.0
AutoMinorVersionUpgrade: true
'404':
description: The specified DB instance was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=RebootDBInstance:
post:
operationId: rebootDBInstance
summary: Amazon Neptune Reboot a Neptune DB Instance
description: >-
Reboots a DB instance. When you reboot an instance, the instance is
restarted. Rebooting results in a momentary outage.
tags:
- DB Instances
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RebootDBInstance
- name: DBInstanceIdentifier
in: query
required: true
description: The identifier of the DB instance to reboot.
schema:
type: string
- name: ForceFailover
in: query
description: Whether to force a failover during the reboot.
schema:
type: boolean
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB instance reboot initiated successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBInstance'
examples:
rebootDBInstance200Example:
summary: Default rebootDBInstance 200 response
x-microcks-default: true
value:
DBInstanceIdentifier: neptune-cluster-abc123
DBInstanceClass: example-value
Engine: example-value
DBInstanceStatus: available
Endpoint:
Address: example-value
Port: 1
DBClusterIdentifier: neptune-cluster-abc123
AvailabilityZone: example-value
PreferredMaintenanceWindow: example-value
EngineVersion: 1.3.2.0
AutoMinorVersionUpgrade: true
'404':
description: The specified DB instance was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=CreateDBClusterSnapshot:
post:
operationId: createDBClusterSnapshot
summary: Amazon Neptune Create a Snapshot of a Neptune DB Cluster
description: >-
Creates a snapshot of a DB cluster. Manual snapshots can be used to
restore a DB cluster to a specific state.
tags:
- Snapshots
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDBClusterSnapshot
- name: DBClusterIdentifier
in: query
required: true
description: The identifier of the DB cluster to create a snapshot for.
schema:
type: string
- name: DBClusterSnapshotIdentifier
in: query
required: true
description: The identifier for the DB cluster snapshot.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: DB cluster snapshot created successfully.
content:
application/xml:
schema:
$ref: '#/components/schemas/DBClusterSnapshot'
examples:
createDBClusterSnapshot200Example:
summary: Default createDBClusterSnapshot 200 response
x-microcks-default: true
value:
DBClusterSnapshotIdentifier: neptune-cluster-abc123
DBClusterIdentifier: neptune-cluster-abc123
SnapshotCreateTime: '2025-03-15T14:30:00Z'
Engine: example-value
EngineVersion: 1.3.2.0
Status: available
AllocatedStorage: 1
VpcId: neptune-cluster-abc123
Port: 1
StorageEncrypted: true
'404':
description: The specified DB cluster was not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/?Action=DescribeDBClusterSnapshots:
get:
operationId: describeDBClusterSnapshots
summary: Amazon Neptune Describe Neptune DB Cluster Snapshots
description: >-
Returns information about DB cluster snapshots. If a specific snapshot
identifier is supplied, details for that snapshot are returned.
tags:
- Snapshots
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDBClusterSnapshots
- name: DBClusterSnapshotIdentifier
in: query
description: The identifier of a specific snapshot to describe.
schema:
type: string
- name: DBClusterIdentifier
in: query
description: The identifier of the cluster to filter snapshots by.
schema:
type: string
- name: MaxRecords
in: query
description: Maximum number of records to include in the response.
schema:
type: integer
- name: Marker
in: query
description: Pagination token from a previous request.
schema:
type: string
- name: Version
in: query
required: true
schema:
type: string
default: '2014-10-31'
responses:
'200':
description: Successful response with snapshot de
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/openapi/amazon-neptune-management-openapi.yml