DeleteDynamoDB
Description
Deletes a document from DynamoDB based on hash and range key. The key can be string or number. The request requires all the primary keys for the operation (hash or hash and range key)
Tags
AWS, Amazon, Delete, DynamoDB, Remove
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Table Name * | Table Name | The DynamoDB table name Supports Expression Language, using Environment variables. | ||
| Region * | Region | US West (Oregon) |
| |
| AWS Credentials Provider Service * | AWS Credentials Provider service | Controller Service: AWSCredentialsProviderService Implementations: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain AWS credentials provider | |
| Hash Key Name * | Hash Key Name | The hash key name of the item Supports Expression Language, using Environment variables. | ||
| Range Key Name | Range Key Name | The range key name of the item Supports Expression Language, using Environment variables. | ||
| Hash Key Value * | Hash Key Value | ${dynamodb.item.hash.key.value} | The hash key value of the item Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Range Key Value | Range Key Value | ${dynamodb.item.range.key.value} | Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Hash Key Value Type * | Hash Key Value Type | string |
| The hash key value type of the item |
| Range Key Value Type * | Range Key Value Type | string |
| The range key value type of the item |
| Batch items for each request (between 1 and 50) | Batch items for each request (between 1 and 50) | 1 | The items to be retrieved in one batch Supports Expression Language, using Environment variables. | |
| Communications Timeout * | Communications Timeout | 30 secs | ||
| Endpoint Override URL | 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. Supports Expression Language, using Environment variables. | ||
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Specifies an optional SSL Context Service that, if provided, will be used to create connections | |
| Proxy Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles are routed to failure relationship |
| success | FlowFiles are routed to success relationship |
| 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. |
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.error.code | DynamoDB error code |
| dynamodb.error.exception.message | DynamoDB exception message |
| dynamodb.error.message | DynamoDB error message |
| dynamodb.error.request.id | DynamoDB error request id |
| dynamodb.error.retryable | DynamoDB error is retryable |
| dynamodb.error.service | DynamoDB error service |
| dynamodb.error.status.code | DynamoDB status code |
| dynamodb.key.error.not.found | DynamoDB key not found |
| dynamodb.key.error.unprocessed | DynamoDB unprocessed keys |
| dynmodb.range.key.value.error | DynamoDB range key error |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.