GetS3ObjectTags 2025.10.9.21

Bundle

org.apache.nifi | nifi-aws-nar

Description

Check for the existence of an Object in S3 and fetch its Tags without attempting to download it. This processor can be used as a router for workflows that need to check on an Object in S3 before proceeding with data processing

Tags

AWS, Amazon, Archive, Exists, S3

Input Requirement

REQUIRED

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
AWS Credentials Provider serviceThe Controller Service that is used to obtain AWS credentials provider
BucketThe S3 Bucket to interact with
Communications TimeoutThe amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.
Custom Signer Class NameFully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth. Signer interface.
Custom Signer Module LocationComma-separated list of paths to files and/or directories which contain the custom signer’s JAR file and its dependencies (if any).
Endpoint Override URLEndpoint 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.
FullControl User ListA comma-separated list of Amazon User ID’s or E-mail addresses that specifies who should have Full Control for an object
Object KeyThe S3 Object Key to use. This is analogous to a filename for traditional file systems.
OwnerThe Amazon ID to use for the object’s owner
Read ACL User ListA comma-separated list of Amazon User ID’s or E-mail addresses that specifies who should have permissions to read the Access Control List for an object
Read Permission User ListA comma-separated list of Amazon User ID’s or E-mail addresses that specifies who should have Read Access for an object
RegionThe AWS Region to connect to.
SSL Context ServiceSpecifies an optional SSL Context Service that, if provided, will be used to create connections
Signer OverrideThe AWS S3 library uses Signature Version 4 by default but this property allows you to specify the Version 2 signer to support older S3-compatible services or even to plug in your own custom signer implementation.
Tag Attribute Include PatternA regular expression pattern to use for determining which object tags are included as FlowFile attributes. This pattern is only applied to the ‘found’ relationship and will not be used to filter the error attributes in the ‘failure’ relationship.
Tags TargetThis determines where the tags will be written when found.
VersionThe Version of the Object for which to retrieve Tags
proxy-configuration-serviceSpecifies the Proxy Configuration Controller Service to proxy network requests.

Relationships

NameDescription
failureIf the Processor is unable to process a given FlowFile, it will be routed to this Relationship.
foundAn object was found in the bucket at the supplied key
not foundNo object was found in the bucket the supplied key

See also