Package software.amazon.awssdk.services.dynamodb.streams

Interface DynamoDbStreamsClient

    • Method Detail

      • describeStream

        default DescribeStreamResponse describeStream​(DescribeStreamRequest describeStreamRequest)
                                       throws ResourceNotFoundException,
                                              InternalServerErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              DynamoDbException

        Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

        You can call DescribeStream at a maximum rate of 10 times per second.

        Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

        Parameters:
        describeStreamRequest - Represents the input of a DescribeStream operation.
        Returns:
        Result of the DescribeStream operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        InternalServerErrorException - An error occurred on the server side.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation

      • describeStream

        default DescribeStreamResponse describeStream​(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
                                       throws ResourceNotFoundException,
                                              InternalServerErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              DynamoDbException

        Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

        You can call DescribeStream at a maximum rate of 10 times per second.

        Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.


        This is a convenience which creates an instance of the DescribeStreamRequest.Builder avoiding the need to create one manually via DescribeStreamRequest.builder()

        Parameters:
        describeStreamRequest - A Consumer that will call methods on DescribeStreamRequest.Builder to create a request. Represents the input of a DescribeStream operation.
        Returns:
        Result of the DescribeStream operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        InternalServerErrorException - An error occurred on the server side.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation

      • getRecords

        default GetRecordsResponse getRecords​(GetRecordsRequest getRecordsRequest)
                               throws ResourceNotFoundException,
                                      LimitExceededException,
                                      InternalServerErrorException,
                                      ExpiredIteratorException,
                                      TrimmedDataAccessException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DynamoDbException

        Retrieves the stream records from a given shard.

        Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

        GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.

        Parameters:
        getRecordsRequest - Represents the input of a GetRecords operation.
        Returns:
        Result of the GetRecords operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        LimitExceededException - There is no limit to the number of daily on-demand backups that can be taken.

        For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable, UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

        When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

        When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

        There is a soft account quota of 2,500 tables.

        GetRecords was called with a value of more than 1000 for the limit request parameter.

        More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

        InternalServerErrorException - An error occurred on the server side.
        ExpiredIteratorException - The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.
        TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.

        In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

        • You request a shard iterator with a sequence number older than the trim point (24 hours).

        • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation

      • getRecords

        default GetRecordsResponse getRecords​(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
                               throws ResourceNotFoundException,
                                      LimitExceededException,
                                      InternalServerErrorException,
                                      ExpiredIteratorException,
                                      TrimmedDataAccessException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DynamoDbException

        Retrieves the stream records from a given shard.

        Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

        GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.


        This is a convenience which creates an instance of the GetRecordsRequest.Builder avoiding the need to create one manually via GetRecordsRequest.builder()

        Parameters:
        getRecordsRequest - A Consumer that will call methods on GetRecordsRequest.Builder to create a request. Represents the input of a GetRecords operation.
        Returns:
        Result of the GetRecords operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        LimitExceededException - There is no limit to the number of daily on-demand backups that can be taken.

        For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable, UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

        When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

        When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

        There is a soft account quota of 2,500 tables.

        GetRecords was called with a value of more than 1000 for the limit request parameter.

        More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

        InternalServerErrorException - An error occurred on the server side.
        ExpiredIteratorException - The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.
        TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.

        In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

        • You request a shard iterator with a sequence number older than the trim point (24 hours).

        • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation

      • getShardIterator

        default GetShardIteratorResponse getShardIterator​(GetShardIteratorRequest getShardIteratorRequest)
                                           throws ResourceNotFoundException,
                                                  InternalServerErrorException,
                                                  TrimmedDataAccessException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  DynamoDbException

        Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

        A shard iterator expires 15 minutes after it is returned to the requester.

        Parameters:
        getShardIteratorRequest - Represents the input of a GetShardIterator operation.
        Returns:
        Result of the GetShardIterator operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        InternalServerErrorException - An error occurred on the server side.
        TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.

        In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

        • You request a shard iterator with a sequence number older than the trim point (24 hours).

        • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation

      • getShardIterator

        default GetShardIteratorResponse getShardIterator​(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
                                           throws ResourceNotFoundException,
                                                  InternalServerErrorException,
                                                  TrimmedDataAccessException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  DynamoDbException

        Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

        A shard iterator expires 15 minutes after it is returned to the requester.


        This is a convenience which creates an instance of the GetShardIteratorRequest.Builder avoiding the need to create one manually via GetShardIteratorRequest.builder()

        Parameters:
        getShardIteratorRequest - A Consumer that will call methods on GetShardIteratorRequest.Builder to create a request. Represents the input of a GetShardIterator operation.
        Returns:
        Result of the GetShardIterator operation returned by the service.
        Throws:
        ResourceNotFoundException - The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
        InternalServerErrorException - An error occurred on the server side.
        TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.

        In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

        • You request a shard iterator with a sequence number older than the trim point (24 hours).

        • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        DynamoDbStreamsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        DynamoDbException
        See Also:
        AWS API Documentation