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:

Amazon, DynamoDB, AWS, Delete, Remove

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 NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Table NameTable NameThe DynamoDB table name
Supports Expression Language: true (will be evaluated using variable registry only)
Hash Key NameHash Key NameThe hash key name of the item
Supports Expression Language: true (will be evaluated using variable registry only)
Range Key NameRange Key NameThe range key name of the item
Supports Expression Language: true (will be evaluated using variable registry only)
Hash Key ValueHash Key Value${dynamodb.item.hash.key.value}The hash key value of the item
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Range Key ValueRange Key Value${dynamodb.item.range.key.value}No Description Provided.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Hash Key Value TypeHash Key Value Typestring
  • string
  • number
The hash key value type of the item
Range Key Value TypeRange Key Value Typestring
  • string
  • number
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)1The items to be retrieved in one batch
Supports Expression Language: true (will be evaluated using variable registry only)
RegionRegionUS West (Oregon)
  • AWS GovCloud (US) AWS Region Code : us-gov-west-1
  • AWS GovCloud (US-East) AWS Region Code : us-gov-east-1
  • US East (N. Virginia) AWS Region Code : us-east-1
  • US East (Ohio) AWS Region Code : us-east-2
  • US West (N. California) AWS Region Code : us-west-1
  • US West (Oregon) AWS Region Code : us-west-2
  • EU (Ireland) AWS Region Code : eu-west-1
  • EU (London) AWS Region Code : eu-west-2
  • EU (Paris) AWS Region Code : eu-west-3
  • EU (Frankfurt) AWS Region Code : eu-central-1
  • EU (Zurich) AWS Region Code : eu-central-2
  • EU (Stockholm) AWS Region Code : eu-north-1
  • EU (Milan) AWS Region Code : eu-south-1
  • EU (Spain) AWS Region Code : eu-south-2
  • Asia Pacific (Hong Kong) AWS Region Code : ap-east-1
  • Asia Pacific (Mumbai) AWS Region Code : ap-south-1
  • Asia Pacific (Hyderabad) AWS Region Code : ap-south-2
  • Asia Pacific (Singapore) AWS Region Code : ap-southeast-1
  • Asia Pacific (Sydney) AWS Region Code : ap-southeast-2
  • Asia Pacific (Jakarta) AWS Region Code : ap-southeast-3
  • Asia Pacific (Melbourne) AWS Region Code : ap-southeast-4
  • Asia Pacific (Tokyo) AWS Region Code : ap-northeast-1
  • Asia Pacific (Seoul) AWS Region Code : ap-northeast-2
  • Asia Pacific (Osaka) AWS Region Code : ap-northeast-3
  • South America (Sao Paulo) AWS Region Code : sa-east-1
  • China (Beijing) AWS Region Code : cn-north-1
  • China (Ningxia) AWS Region Code : cn-northwest-1
  • Canada (Central) AWS Region Code : ca-central-1
  • Canada West (Calgary) AWS Region Code : ca-west-1
  • Middle East (UAE) AWS Region Code : me-central-1
  • Middle East (Bahrain) AWS Region Code : me-south-1
  • Africa (Cape Town) AWS Region Code : af-south-1
  • US ISO East AWS Region Code : us-iso-east-1
  • US ISOB East (Ohio) AWS Region Code : us-isob-east-1
  • US ISO West AWS Region Code : us-iso-west-1
  • Israel (Tel Aviv) AWS Region Code : il-central-1
The AWS Region to connect to.
Access Key IDAccess KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Secret Access KeySecret KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Credentials FileCredentials FilePath to a file containing AWS access key and secret key in properties file format.

This property requires exactly one file to be provided..
AWS Credentials Provider ServiceAWS Credentials Provider serviceController Service API:
AWSCredentialsProviderService
Implementation: AWSCredentialsProviderControllerService		The Controller Service that is used to obtain AWS credentials provider
Communications TimeoutCommunications Timeout30 secsThe amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.
SSL Context ServiceSSL Context ServiceController Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService		Specifies an optional SSL Context Service that, if provided, will be used to create connections
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService		Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN
Proxy HostProxy HostProxy host name or IP
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Host PortProxy Host PortProxy host port
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Usernameproxy-user-nameProxy username
Supports Expression Language: true (undefined scope)
Proxy Passwordproxy-user-passwordProxy password
Sensitive Property: true
Supports Expression Language: true (undefined scope)

Relationships:

NameDescription
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

Reads Attributes:

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

Writes Attributes:

NameDescription
dynamodb.key.error.unprocessedDynamoDB unprocessed keys
dynmodb.range.key.value.errorDynamoDB range key error
dynamodb.key.error.not.foundDynamoDB key not found
dynamodb.error.exception.messageDynamoDB exception message
dynamodb.error.codeDynamoDB error code
dynamodb.error.messageDynamoDB error message
dynamodb.error.typeDynamoDB error type
dynamodb.error.serviceDynamoDB error service
dynamodb.error.retryableDynamoDB error is retryable
dynamodb.error.request.idDynamoDB error request id
dynamodb.error.status.codeDynamoDB status code

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:

None specified.

See Also:

GetDynamoDB, PutDynamoDB, PutDynamoDBRecord