[][src]Crate rusoto_neptune

Amazon Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

If you're using the service, you're probably looking for NeptuneClient and Neptune.

Structs

AddRoleToDBClusterMessage
AddSourceIdentifierToSubscriptionMessage
AddSourceIdentifierToSubscriptionResult
AddTagsToResourceMessage
ApplyPendingMaintenanceActionMessage
ApplyPendingMaintenanceActionResult
AvailabilityZone

Specifies an Availability Zone.

CharacterSet

Specifies a character set.

CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

CopyDBClusterParameterGroupMessage
CopyDBClusterParameterGroupResult
CopyDBClusterSnapshotMessage
CopyDBClusterSnapshotResult
CopyDBParameterGroupMessage
CopyDBParameterGroupResult
CreateDBClusterMessage
CreateDBClusterParameterGroupMessage
CreateDBClusterParameterGroupResult
CreateDBClusterResult
CreateDBClusterSnapshotMessage
CreateDBClusterSnapshotResult
CreateDBInstanceMessage
CreateDBInstanceResult
CreateDBParameterGroupMessage
CreateDBParameterGroupResult
CreateDBSubnetGroupMessage
CreateDBSubnetGroupResult
CreateEventSubscriptionMessage
CreateEventSubscriptionResult
DBCluster

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters action.

DBClusterMember

Contains information about an instance that is part of a DB cluster.

DBClusterMessage
DBClusterOptionGroupStatus

Contains status information for a DB cluster option group.

DBClusterParameterGroup

Contains the details of an Amazon Neptune DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

DBClusterParameterGroupDetails
DBClusterParameterGroupNameMessage
DBClusterParameterGroupsMessage
DBClusterRole

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

DBClusterSnapshot

Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

DBClusterSnapshotAttribute

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

DBClusterSnapshotAttributesResult

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

DBClusterSnapshotMessage
DBEngineVersion

This data type is used as a response element in the action DescribeDBEngineVersions.

DBEngineVersionMessage
DBInstance

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

DBInstanceMessage
DBInstanceStatusInfo

Provides a list of status information for a DB instance.

DBParameterGroup

Contains the details of an Amazon Neptune DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

DBParameterGroupDetails
DBParameterGroupNameMessage
DBParameterGroupStatus

The status of the DB parameter group.

This data type is used as a response element in the following actions:

DBParameterGroupsMessage
DBSecurityGroupMembership

Specifies membership in a designated DB security group.

DBSubnetGroup

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

DBSubnetGroupMessage
DeleteDBClusterMessage
DeleteDBClusterParameterGroupMessage
DeleteDBClusterResult
DeleteDBClusterSnapshotMessage
DeleteDBClusterSnapshotResult
DeleteDBInstanceMessage
DeleteDBInstanceResult
DeleteDBParameterGroupMessage
DeleteDBSubnetGroupMessage
DeleteEventSubscriptionMessage
DeleteEventSubscriptionResult
DescribeDBClusterParameterGroupsMessage
DescribeDBClusterParametersMessage
DescribeDBClusterSnapshotAttributesMessage
DescribeDBClusterSnapshotAttributesResult
DescribeDBClusterSnapshotsMessage
DescribeDBClustersMessage
DescribeDBEngineVersionsMessage
DescribeDBInstancesMessage
DescribeDBParameterGroupsMessage
DescribeDBParametersMessage
DescribeDBSubnetGroupsMessage
DescribeEngineDefaultClusterParametersMessage
DescribeEngineDefaultClusterParametersResult
DescribeEngineDefaultParametersMessage
DescribeEngineDefaultParametersResult
DescribeEventCategoriesMessage
DescribeEventSubscriptionsMessage
DescribeEventsMessage
DescribeOrderableDBInstanceOptionsMessage
DescribePendingMaintenanceActionsMessage
DescribeValidDBInstanceModificationsMessage
DescribeValidDBInstanceModificationsResult
DomainMembership

An Active Directory Domain membership record associated with a DB instance.

DoubleRange

A range of double values.

Endpoint

Specifies a connection endpoint.

EngineDefaults

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

Event

This data type is used as a response element in the DescribeEvents action.

EventCategoriesMap

Contains the results of a successful invocation of the DescribeEventCategories action.

EventCategoriesMessage
EventSubscription

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

EventSubscriptionsMessage
EventsMessage
FailoverDBClusterMessage
FailoverDBClusterResult
Filter

This type is not currently supported.

ListTagsForResourceMessage
ModifyDBClusterMessage
ModifyDBClusterParameterGroupMessage
ModifyDBClusterResult
ModifyDBClusterSnapshotAttributeMessage
ModifyDBClusterSnapshotAttributeResult
ModifyDBInstanceMessage
ModifyDBInstanceResult
ModifyDBParameterGroupMessage
ModifyDBSubnetGroupMessage
ModifyDBSubnetGroupResult
ModifyEventSubscriptionMessage
ModifyEventSubscriptionResult
NeptuneClient

A client for the Amazon Neptune API.

OptionGroupMembership

Provides information on the option groups the DB instance is a member of.

OrderableDBInstanceOption

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

OrderableDBInstanceOptionsMessage
Parameter

Specifies a parameter.

PendingCloudwatchLogsExports

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

PendingMaintenanceActionsMessage
PendingModifiedValues

This data type is used as a response element in the ModifyDBInstance action.

PromoteReadReplicaDBClusterMessage
PromoteReadReplicaDBClusterResult
Range

A range of integer values.

RebootDBInstanceMessage
RebootDBInstanceResult
RemoveRoleFromDBClusterMessage
RemoveSourceIdentifierFromSubscriptionMessage
RemoveSourceIdentifierFromSubscriptionResult
RemoveTagsFromResourceMessage
ResetDBClusterParameterGroupMessage
ResetDBParameterGroupMessage
ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

RestoreDBClusterFromSnapshotMessage
RestoreDBClusterFromSnapshotResult
RestoreDBClusterToPointInTimeMessage
RestoreDBClusterToPointInTimeResult
Subnet

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups action.

Tag

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

TagListMessage
Timezone

A time zone associated with a DBInstance.

UpgradeTarget

The version of the database engine that a DB instance can be upgraded to.

ValidDBInstanceModificationsMessage

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

ValidStorageOptions

Information about valid modifications that you can make to your DB instance.

Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

VpcSecurityGroupMembership

This data type is used as a response element for queries on VPC security group membership.

Enums

AddRoleToDBClusterError

Errors returned by AddRoleToDBCluster

AddSourceIdentifierToSubscriptionError

Errors returned by AddSourceIdentifierToSubscription

AddTagsToResourceError

Errors returned by AddTagsToResource

ApplyPendingMaintenanceActionError

Errors returned by ApplyPendingMaintenanceAction

CopyDBClusterParameterGroupError

Errors returned by CopyDBClusterParameterGroup

CopyDBClusterSnapshotError

Errors returned by CopyDBClusterSnapshot

CopyDBParameterGroupError

Errors returned by CopyDBParameterGroup

CreateDBClusterError

Errors returned by CreateDBCluster

CreateDBClusterParameterGroupError

Errors returned by CreateDBClusterParameterGroup

CreateDBClusterSnapshotError

Errors returned by CreateDBClusterSnapshot

CreateDBInstanceError

Errors returned by CreateDBInstance

CreateDBParameterGroupError

Errors returned by CreateDBParameterGroup

CreateDBSubnetGroupError

Errors returned by CreateDBSubnetGroup

CreateEventSubscriptionError

Errors returned by CreateEventSubscription

DeleteDBClusterError

Errors returned by DeleteDBCluster

DeleteDBClusterParameterGroupError

Errors returned by DeleteDBClusterParameterGroup

DeleteDBClusterSnapshotError

Errors returned by DeleteDBClusterSnapshot

DeleteDBInstanceError

Errors returned by DeleteDBInstance

DeleteDBParameterGroupError

Errors returned by DeleteDBParameterGroup

DeleteDBSubnetGroupError

Errors returned by DeleteDBSubnetGroup

DeleteEventSubscriptionError

Errors returned by DeleteEventSubscription

DescribeDBClusterParameterGroupsError

Errors returned by DescribeDBClusterParameterGroups

DescribeDBClusterParametersError

Errors returned by DescribeDBClusterParameters

DescribeDBClusterSnapshotAttributesError

Errors returned by DescribeDBClusterSnapshotAttributes

DescribeDBClusterSnapshotsError

Errors returned by DescribeDBClusterSnapshots

DescribeDBClustersError

Errors returned by DescribeDBClusters

DescribeDBEngineVersionsError

Errors returned by DescribeDBEngineVersions

DescribeDBInstancesError

Errors returned by DescribeDBInstances

DescribeDBParameterGroupsError

Errors returned by DescribeDBParameterGroups

DescribeDBParametersError

Errors returned by DescribeDBParameters

DescribeDBSubnetGroupsError

Errors returned by DescribeDBSubnetGroups

DescribeEngineDefaultClusterParametersError

Errors returned by DescribeEngineDefaultClusterParameters

DescribeEngineDefaultParametersError

Errors returned by DescribeEngineDefaultParameters

DescribeEventCategoriesError

Errors returned by DescribeEventCategories

DescribeEventSubscriptionsError

Errors returned by DescribeEventSubscriptions

DescribeEventsError

Errors returned by DescribeEvents

DescribeOrderableDBInstanceOptionsError

Errors returned by DescribeOrderableDBInstanceOptions

DescribePendingMaintenanceActionsError

Errors returned by DescribePendingMaintenanceActions

DescribeValidDBInstanceModificationsError

Errors returned by DescribeValidDBInstanceModifications

FailoverDBClusterError

Errors returned by FailoverDBCluster

ListTagsForResourceError

Errors returned by ListTagsForResource

ModifyDBClusterError

Errors returned by ModifyDBCluster

ModifyDBClusterParameterGroupError

Errors returned by ModifyDBClusterParameterGroup

ModifyDBClusterSnapshotAttributeError

Errors returned by ModifyDBClusterSnapshotAttribute

ModifyDBInstanceError

Errors returned by ModifyDBInstance

ModifyDBParameterGroupError

Errors returned by ModifyDBParameterGroup

ModifyDBSubnetGroupError

Errors returned by ModifyDBSubnetGroup

ModifyEventSubscriptionError

Errors returned by ModifyEventSubscription

PromoteReadReplicaDBClusterError

Errors returned by PromoteReadReplicaDBCluster

RebootDBInstanceError

Errors returned by RebootDBInstance

RemoveRoleFromDBClusterError

Errors returned by RemoveRoleFromDBCluster

RemoveSourceIdentifierFromSubscriptionError

Errors returned by RemoveSourceIdentifierFromSubscription

RemoveTagsFromResourceError

Errors returned by RemoveTagsFromResource

ResetDBClusterParameterGroupError

Errors returned by ResetDBClusterParameterGroup

ResetDBParameterGroupError

Errors returned by ResetDBParameterGroup

RestoreDBClusterFromSnapshotError

Errors returned by RestoreDBClusterFromSnapshot

RestoreDBClusterToPointInTimeError

Errors returned by RestoreDBClusterToPointInTime

Traits

Neptune

Trait representing the capabilities of the Amazon Neptune API. Amazon Neptune clients implement this trait.