AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Gets a stream for a property graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetPropertygraphStream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions, depending on the query:

Note that you can restrict property-graph queries using the following IAM context keys:

See Condition keys available in Neptune IAM data-access policy statements).

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetPropertygraphStreamAsync.

Namespace: Amazon.Neptunedata
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

C#
public virtual GetPropertygraphStreamResponse GetPropertygraphStream(
         GetPropertygraphStreamRequest request
)

Parameters

request
Type: Amazon.Neptunedata.Model.GetPropertygraphStreamRequest

Container for the necessary parameters to execute the GetPropertygraphStream service method.

Return Value


The response from the GetPropertygraphStream service method, as returned by Neptunedata.

Exceptions

ExceptionCondition
ClientTimeoutException Raised when a request timed out in the client.
ConstraintViolationException Raised when a value in a request field did not satisfy required constraints.
ExpiredStreamException Raised when a request attempts to access an stream that has expired.
IllegalArgumentException Raised when an argument in a request is not supported.
InvalidArgumentException Raised when an argument in a request has an invalid value.
InvalidParameterException Raised when a parameter value is not valid.
MemoryLimitExceededException Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException Raised when a precondition for processing a request is not satisfied.
StreamRecordsNotFoundException Raised when stream records requested by a query cannot be found.
ThrottlingException Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.
TooManyRequestsException Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException Raised when a request attempts to initiate an operation that is not supported.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also