GetDynamoDB

GetDynamoDB 2.0.0

Bundle: org.apache.nifi | nifi-aws-nar
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: AWS, Amazon, DynamoDB, Fetch, Get
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

AWS Credentials Provider Service
The Controller Service that is used to obtain AWS credentials provider

Display Name

AWS Credentials Provider Service

Description

The Controller Service that is used to obtain AWS credentials provider

API Name

AWS Credentials Provider service

Service Interface

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderService

Service Implementations

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Batch items for each request (between 1 and 50)
The items to be retrieved in one batch

Display Name

Batch items for each request (between 1 and 50)

Description

The items to be retrieved in one batch

API Name

Batch items for each request (between 1 and 50)

Default Value

1

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Communications Timeout

Display Name

Communications Timeout

Description

API Name

Communications Timeout

Default Value

30 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Endpoint Override URL
Endpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.

Display Name

Endpoint Override URL

Description

Endpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.

API Name

Endpoint Override URL

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Hash Key Name
The hash key name of the item

Display Name

Hash Key Name

Description

The hash key name of the item

API Name

Hash Key Name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Hash Key Value
The hash key value of the item

Display Name

Hash Key Value

Description

The hash key value of the item

API Name

Hash Key Value

Default Value

${dynamodb.item.hash.key.value}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Hash Key Value Type
The hash key value type of the item
Display Name

Hash Key Value Type

Description

The hash key value type of the item

API Name

Hash Key Value Type

Default Value

string

Allowable Values
- string
- number
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Json Document attribute
The Json document to be retrieved from the dynamodb item ('s' type in the schema)

Display Name

Json Document attribute

Description

The Json document to be retrieved from the dynamodb item ('s' type in the schema)

API Name

Json Document attribute

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Range Key Name
The range key name of the item

Display Name

Range Key Name

Description

The range key name of the item

API Name

Range Key Name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Range Key Value

Display Name

Range Key Value

Description

API Name

Range Key Value

Default Value

${dynamodb.item.range.key.value}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Range Key Value Type
The range key value type of the item
Display Name

Range Key Value Type

Description

The range key value type of the item

API Name

Range Key Value Type

Default Value

string

Allowable Values
- string
- number
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Region
Display Name

Region

Description

API Name

Region

Default Value

us-west-2

Allowable Values
- AWS GovCloud (US-East)
- AWS GovCloud (US-West)
- Africa (Cape Town)
- Asia Pacific (Hong Kong)
- Asia Pacific (Hyderabad)
- Asia Pacific (Jakarta)
- Asia Pacific (Malaysia)
- Asia Pacific (Melbourne)
- Asia Pacific (Mumbai)
- Asia Pacific (Osaka)
- Asia Pacific (Seoul)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- Canada (Central)
- Canada West (Calgary)
- China (Beijing)
- China (Ningxia)
- EU ISOE West
- Europe (Frankfurt)
- Europe (Ireland)
- Europe (London)
- Europe (Milan)
- Europe (Paris)
- Europe (Spain)
- Europe (Stockholm)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (Bahrain)
- Middle East (UAE)
- South America (Sao Paulo)
- US East (N. Virginia)
- US East (Ohio)
- US ISO East
- US ISO WEST
- US ISOB East (Ohio)
- US West (N. California)
- US West (Oregon)
- aws-cn-global
- aws-global
- aws-iso-b-global
- aws-iso-global
- aws-us-gov-global
Expression Language Scope

Not Supported

Sensitive

false

Required

true
SSL Context Service
Specifies an optional SSL Context Service that, if provided, will be used to create connections

Display Name

SSL Context Service

Description

Specifies an optional SSL Context Service that, if provided, will be used to create connections

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Table Name
The DynamoDB table name

Display Name

Table Name

Description

The DynamoDB table name

API Name

Table Name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

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	DynamoDB unprocessed keys
dynmodb.range.key.value.error	DynamoDB range key error
dynamodb.key.error.not.found	DynamoDB key not found
dynamodb.error.exception.message	DynamoDB exception message
dynamodb.error.code	DynamoDB error code
dynamodb.error.message	DynamoDB error message
dynamodb.error.service	DynamoDB error service
dynamodb.error.retryable	DynamoDB error is retryable
dynamodb.error.request.id	DynamoDB error request id
dynamodb.error.status.code	DynamoDB status code