AWS.Neptune (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.

Adds a source identifier to an existing event notification subscription.

Adds metadata tags to an Amazon Neptune resource.

Applies a pending maintenance action to a resource (for example, to a DB instance).

Copies the specified DB cluster parameter group.

Copies a snapshot of a DB cluster.

Copies the specified DB parameter group.

Creates a new Amazon Neptune DB cluster.

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

Creates a new DB cluster parameter group.

Creates a snapshot of a DB cluster.

Creates an event notification subscription.

The DeleteDBCluster action deletes a previously provisioned DB cluster.

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

Deletes a specified DB cluster parameter group.

The DeleteDBInstance action deletes a previously provisioned DB instance.

Deletes a specified DBParameterGroup.

Deletes an event notification subscription.

Returns information about endpoints for an Amazon Neptune DB cluster.

Returns a list of DBClusterParameterGroup descriptions.

Returns the detailed parameter list for a particular DB cluster parameter group.

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

Returns information about DB cluster snapshots.

Returns information about provisioned DB clusters, and supports pagination.

Returns a list of the available DB engines.

Returns information about provisioned instances, and supports pagination.

Returns a list of DBParameterGroup descriptions.

Returns the detailed parameter list for a particular DB parameter group.

Returns a list of DBSubnetGroup descriptions.

Returns the default engine and system parameter information for the cluster database engine.

Returns the default engine and system parameter information for the specified database engine.

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Lists all the subscription descriptions for a customer account.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.

Returns a list of orderable DB instance options for the specified engine.

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

Forces a failover for a DB cluster.

Lists all tags on an Amazon Neptune resource.

Modify a setting for a DB cluster.

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

Modifies the parameters of a DB cluster parameter group.

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

Modifies settings for a DB instance.

Modifies the parameters of a DB parameter group.

Modifies an existing DB subnet group.

Modifies an existing event notification subscription.

You might need to reboot your DB instance, usually for maintenance reasons.

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

Removes a source identifier from an existing event notification subscription.

Removes metadata tags from an Amazon Neptune resource.

Modifies the parameters of a DB cluster parameter group to the default value.

Modifies the parameters of a DB parameter group to the engine/system default value.

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Restores a DB cluster to an arbitrary point in time.

Starts an Amazon Neptune DB cluster that was stopped using the AWS console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

Stops an Amazon Neptune DB cluster.

Link to this section Functions

Link to this function

add_role_to_db_cluster(client, input, options \\ [])

View Source

Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.

Link to this function

add_source_identifier_to_subscription(client, input, options \\ [])

View Source

Adds a source identifier to an existing event notification subscription.

Link to this function

add_tags_to_resource(client, input, options \\ [])

View Source

Adds metadata tags to an Amazon Neptune resource.

These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

Link to this function

apply_pending_maintenance_action(client, input, options \\ [])

View Source

Applies a pending maintenance action to a resource (for example, to a DB instance).

Link to this function

copy_db_cluster_parameter_group(client, input, options \\ [])

View Source

Copies the specified DB cluster parameter group.

Link to this function

copy_db_cluster_snapshot(client, input, options \\ [])

View Source

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

Link to this function

copy_db_parameter_group(client, input, options \\ [])

View Source

Copies the specified DB parameter group.

Link to this function

create_db_cluster(client, input, options \\ [])

View Source

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 or Amazon Neptune DB instance.

Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

Link to this function

create_db_cluster_endpoint(client, input, options \\ [])

View Source

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

Link to this function

create_db_cluster_parameter_group(client, input, options \\ [])

View Source

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Link to this function

create_db_cluster_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of a DB cluster.

Link to this function

create_db_instance(client, input, options \\ [])

View Source

Creates a new DB instance.

Link to this function

create_db_parameter_group(client, input, options \\ [])

View Source

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Link to this function

create_db_subnet_group(client, input, options \\ [])

View Source

Creates a new DB subnet group.

DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

Link to this function

create_event_subscription(client, input, options \\ [])

View Source

Creates an event notification subscription.

This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

Link to this function

delete_db_cluster(client, input, options \\ [])

View Source

The DeleteDBCluster action deletes a previously provisioned DB cluster.

When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

Link to this function

delete_db_cluster_endpoint(client, input, options \\ [])

View Source

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

Link to this function

delete_db_cluster_parameter_group(client, input, options \\ [])

View Source

Deletes a specified DB cluster parameter group.

The DB cluster parameter group to be deleted can't be associated with any DB clusters.

Link to this function

delete_db_cluster_snapshot(client, input, options \\ [])

View Source

Deletes a DB cluster snapshot.

If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

Link to this function

delete_db_instance(client, input, options \\ [])

View Source

The DeleteDBInstance action deletes a previously provisioned DB instance.

When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

Link to this function

delete_db_parameter_group(client, input, options \\ [])

View Source

Deletes a specified DBParameterGroup.

The DBParameterGroup to be deleted can't be associated with any DB instances.

Link to this function

delete_db_subnet_group(client, input, options \\ [])

View Source

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

Link to this function

delete_event_subscription(client, input, options \\ [])

View Source

Deletes an event notification subscription.

Link to this function

describe_db_cluster_endpoints(client, input, options \\ [])

View Source

Returns information about endpoints for an Amazon Neptune DB cluster.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

Link to this function

describe_db_cluster_parameter_groups(client, input, options \\ [])

View Source

Returns a list of DBClusterParameterGroup descriptions.

If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

Link to this function

describe_db_cluster_parameters(client, input, options \\ [])

View Source

Returns the detailed parameter list for a particular DB cluster parameter group.

Link to this function

describe_db_cluster_snapshot_attributes(client, input, options \\ [])

View Source

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.

To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Link to this function

describe_db_cluster_snapshots(client, input, options \\ [])

View Source

Returns information about DB cluster snapshots.

This API action supports pagination.

Link to this function

describe_db_clusters(client, input, options \\ [])

View Source

Returns information about provisioned DB clusters, and supports pagination.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

Link to this function

describe_db_engine_versions(client, input, options \\ [])

View Source

Returns a list of the available DB engines.

Link to this function

describe_db_instances(client, input, options \\ [])

View Source

Returns information about provisioned instances, and supports pagination.

This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

Link to this function

describe_db_parameter_groups(client, input, options \\ [])

View Source

Returns a list of DBParameterGroup descriptions.

If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

Link to this function

describe_db_parameters(client, input, options \\ [])

View Source

Returns the detailed parameter list for a particular DB parameter group.

Link to this function

describe_db_subnet_groups(client, input, options \\ [])

View Source

Returns a list of DBSubnetGroup descriptions.

If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Link to this function

describe_engine_default_cluster_parameters(client, input, options \\ [])

View Source

Returns the default engine and system parameter information for the cluster database engine.

Link to this function

describe_engine_default_parameters(client, input, options \\ [])

View Source

Returns the default engine and system parameter information for the specified database engine.

Link to this function

describe_event_categories(client, input, options \\ [])

View Source

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Link to this function

describe_event_subscriptions(client, input, options \\ [])

View Source

Lists all the subscription descriptions for a customer account.

The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Link to this function

describe_events(client, input, options \\ [])

View Source

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.

Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Link to this function

describe_orderable_db_instance_options(client, input, options \\ [])

View Source

Returns a list of orderable DB instance options for the specified engine.

Link to this function

describe_pending_maintenance_actions(client, input, options \\ [])

View Source

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Link to this function

describe_valid_db_instance_modifications(client, input, options \\ [])

View Source

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

You can use this information when you call ModifyDBInstance.

Link to this function

failover_db_cluster(client, input, options \\ [])

View Source

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags on an Amazon Neptune resource.

Link to this function

modify_db_cluster(client, input, options \\ [])

View Source

Modify a setting for a DB cluster.

You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Link to this function

modify_db_cluster_endpoint(client, input, options \\ [])

View Source

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

Link to this function

modify_db_cluster_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB cluster parameter group.

To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Link to this function

modify_db_cluster_snapshot_attribute(client, input, options \\ [])

View Source

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

Link to this function

modify_db_instance(client, input, options \\ [])

View Source

Modifies settings for a DB instance.

You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Link to this function

modify_db_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB parameter group.

To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Link to this function

modify_db_subnet_group(client, input, options \\ [])

View Source

Modifies an existing DB subnet group.

DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

Link to this function

modify_event_subscription(client, input, options \\ [])

View Source

Modifies an existing event notification subscription.

Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

Link to this function

promote_read_replica_db_cluster(client, input, options \\ [])

View Source

Not supported.

Link to this function

reboot_db_instance(client, input, options \\ [])

View Source

You might need to reboot your DB instance, usually for maintenance reasons.

For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

Link to this function

remove_role_from_db_cluster(client, input, options \\ [])

View Source

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

Link to this function

remove_source_identifier_from_subscription(client, input, options \\ [])

View Source

Removes a source identifier from an existing event notification subscription.

Link to this function

remove_tags_from_resource(client, input, options \\ [])

View Source

Removes metadata tags from an Amazon Neptune resource.

Link to this function

reset_db_cluster_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB cluster parameter group to the default value.

To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

Link to this function

reset_db_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB parameter group to the engine/system default value.

To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

Link to this function

restore_db_cluster_from_snapshot(client, input, options \\ [])

View Source

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Link to this function

restore_db_cluster_to_point_in_time(client, input, options \\ [])

View Source

Restores a DB cluster to an arbitrary point in time.

Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

Link to this function

start_db_cluster(client, input, options \\ [])

View Source

Starts an Amazon Neptune DB cluster that was stopped using the AWS console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

Link to this function

stop_db_cluster(client, input, options \\ [])

View Source

Stops an Amazon Neptune DB cluster.

When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.