Description:

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.

Tags:

Amazon, DynamoDB, AWS, Get, Fetc

Properties:

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, and whether a property supports the Expression Language Guide, 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 nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name Default Value Allowable Values Description
Table Name The DynamoDB table name
Hash Key Name The hash key name of the item
Range Key Name The range key name of the item
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 Type string * string
* number
The hash key value type of the item
Range Key Value Type string * string
* number
The range key value type of the item
Json Document attribute 30 sec The Json document to be retrieved from the dynamodb item
Batch items for each request (between 1 and 50) 1 The items to be retrieved in one batch
Region us-west-2 * us-gov-west-1
* us-east-1
* us-east-2
* us-west-1
* us-west-2
* eu-west-2
* eu-central-1
* ap-south-1
* ap-southeast-1
* ap-southeast-2
* ap-northeast-1
* ap-northeast-2
* sa-east-1
* cn-north-1
* ca-central-1
No Description Provided.
Access Key No Description Provided.
Sensitive Property: true
Supports Expression Language: true
Secret Key No Description Provided.
Sensitive Property: true
Supports Expression Language: true
Credentials File Path to a file containing AWS access key and secret key in properties file format.
AWS Credentials Provider service Controller Service API:
AWSCredentialsProviderService
Implementation:
AWSCredentialsProviderControllerService
The Controller Service that is used to obtain aws credentials provider
Communications Timeout 30 secs No Description Provided.
SSL Context Service Controller Service API:
SSLContextService
Implementation:
StandardSSLContextService

Relationships:

Name Description
unprocessed FlowFiles 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.
success FlowFiles are routed to success relationship
failure FlowFiles are routed to failure relationship
not found FlowFiles are routed to not found relationship if key not found in the table

Reads Attributes:

Name Description
dynamodb.item.hash.key.value Items hash key value
dynamodb.item.range.key.value Items range key value

Writes Attributes:

Name Description
dynamodb.key.error.unprocessed Dynamo db unprocessed keys
dynmodb.range.key.value.error Dynamod db range key error
dynamodb.key.error.not.found Dynamo db key not found
dynamodb.error.exception.message Dynamo db exception message
dynamodb.error.code Dynamo db error code
dynamodb.error.message Dynamo db error message
dynamodb.error.type Dynamo db error type
dynamodb.error.service Dynamo db error service
dynamodb.error.retryable Dynamo db error is retryable
dynamodb.error.request.id Dynamo db error request id
dynamodb.error.status.code Dynamo db status code

State management:

This component does not store state.

Restricted:

This component is not restricted.