Retrieves the contents of an S3 Object and writes it to the content of a FlowFile


Amazon, S3, AWS, Get, Fetch


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, 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 file has an entry for the property nifi.sensitive.props.key.

Name Default Value Allowable Values Description
Bucket No Description Provided.
Supports Expression Language: true
Object Key ${filename} No Description Provided.
Supports Expression Language: true
Region us-west-2 * us-gov-west-1
* us-east-1
* us-west-1
* us-west-2
* eu-west-1
* eu-central-1
* ap-southeast-1
* ap-southeast-2
* ap-northeast-1
* sa-east-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 No Description Provided.
AWS Credentials Provider service Controller Service API:
The Controller Service that is used to obtain aws credentials provider
Communications Timeout 30 secs No Description Provided.
Version The Version of the Object to download

Supports Expression Language: true

SSL Context Service Controller Service API:
Specifies an optional SSL Context Service that, if provided, will be used to create connections
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.
Proxy Host Proxy host name or IP
Supports Expression Language: true
Proxy Host Port Proxy host port
Supports Expression Language: true


Name Description
failure FlowFiles are routed to failure relationship
success FlowFiles are routed to success relationship

Reads Attributes:

None specified.

Writes Attributes:

Name Description
s3.bucket The name of the S3 bucket
path The path of the file
absolute.path The path of the file
filename The name of the file
hash.value The MD5 sum of the file
hash.algorithm MD5
mime.type If S3 provides the content type/MIME type, this attribute will hold that file
s3.etag The ETag that can be used to see if the file has changed
s3.expirationTime If the file has an expiration date, this attribute will be set, containing the milliseconds since epoch in UTC time
s3.expirationTimeRuleId The ID of the rule that dictates this object's expiration time
s3.version The version of the S3 object

See Also: