Retrieves a document from DynamoDB based on hash and range key. The key can be string or number.For any get request all the primary keys are required (hash or hash and range based on the table keys).A Json Document ('Map') attribute of the DynamoDB item is read into the content of the FlowFile.


Amazon, DynamoDB, AWS, Get, Fetch


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Table NameThe DynamoDB table name
Supports Expression Language: true
Hash Key NameThe hash key name of the item
Supports Expression Language: true
Range Key NameThe range key name of the item
Supports Expression Language: true
Hash Key Value${dynamodb.item.hash.key.value}The hash key value of the item
Supports Expression Language: true
Range Key Value${dynamodb.item.range.key.value}No Description Provided.
Supports Expression Language: true
Hash Key Value Typestring
  • string
  • number
The hash key value type of the item
Range Key Value Typestring
  • string
  • number
The range key value type of the item
Json Document attributeThe Json document to be retrieved from the dynamodb item
Supports Expression Language: true
Batch items for each request (between 1 and 50)1The items to be retrieved in one batch
Supports Expression Language: true
  • us-gov-west-1 us-gov-west-1
  • us-east-1 us-east-1
  • us-east-2 us-east-2
  • us-west-1 us-west-1
  • us-west-2 us-west-2
  • eu-west-1 eu-west-1
  • eu-west-2 eu-west-2
  • eu-central-1 eu-central-1
  • ap-south-1 ap-south-1
  • ap-southeast-1 ap-southeast-1
  • ap-southeast-2 ap-southeast-2
  • ap-northeast-1 ap-northeast-1
  • ap-northeast-2 ap-northeast-2
  • sa-east-1 sa-east-1
  • cn-north-1 cn-north-1
  • ca-central-1 ca-central-1
No Description Provided.
Access KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true
Secret KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true
Credentials FilePath to a file containing AWS access key and secret key in properties file format.
AWS Credentials Provider serviceController Service API:
The Controller Service that is used to obtain aws credentials provider
Communications Timeout30 secsNo Description Provided.
SSL Context ServiceController Service API:
Specifies an optional SSL Context Service that, if provided, will be used to create connections


unprocessedFlowFiles are routed to unprocessed relationship when DynamoDB is not able to process all the items in the request. Typical reasons are insufficient table throughput capacity and exceeding the maximum bytes per request. Unprocessed FlowFiles can be retried with a new request.
successFlowFiles are routed to success relationship
failureFlowFiles are routed to failure relationship
not foundFlowFiles are routed to not found relationship if key not found in the table

Reads Attributes:

dynamodb.item.hash.key.valueItems hash key value
dynamodb.item.range.key.valueItems range key value

Writes Attributes:

dynamodb.key.error.unprocessedDynamo db unprocessed keys
dynmodb.range.key.value.errorDynamod db range key error
dynamodb.key.error.not.foundDynamo db key not found
dynamodb.error.exception.messageDynamo db exception message
dynamodb.error.codeDynamo db error code
dynamodb.error.messageDynamo db error message
dynamodb.error.typeDynamo db error type
dynamodb.error.serviceDynamo db error service
dynamodb.error.retryableDynamo db error is retryable
dynamodb.error.request.idDynamo db error request id
dynamodb.error.status.codeDynamo db status code

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

See Also:

DeleteDynamoDB, PutDynamoDB