Description:
Fetches messages from an Amazon Simple Queuing Service Queue
Tags:
Amazon, AWS, SQS, Queue, Get, Fetch, Poll
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, 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 nifi.properties file has an entry for the property nifi.sensitive.props.key.
Name | Default Value | Allowable Values | Description |
Queue URL | The URL of the queue to act upon | ||
Auto Delete Messages | true |
* true * false |
Specifies whether the messages should be automatically deleted by the processors once they have been received. |
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: AWSCredentialsProviderService Implementation: AWSCredentialsProviderControllerService |
The Controller Service that is used to obtain aws credentials provider | |
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 ![]() * cn-north-1 ![]() |
No Description Provided. |
Batch Size | 10 | The maximum number of messages to send in a single network request | |
Communications Timeout | 30 secs | No Description Provided. | |
Character Set | UTF-8 |
* Big5
* Big5-HKSCS * EUC-JP * EUC-KR * GB18030 * GB2312 * GBK * IBM-Thai * IBM00858 * IBM01140 * IBM01141 * IBM01142 * IBM01143 * IBM01144 * IBM01145 * IBM01146 * IBM01147 * IBM01148 * IBM01149 * IBM037 * IBM1026 * IBM1047 * IBM273 * IBM277 * IBM278 * IBM280 * IBM284 * IBM285 * IBM290 * IBM297 * IBM420 * IBM424 * IBM437 * IBM500 * IBM775 * IBM850 * IBM852 * IBM855 * IBM857 * IBM860 * IBM861 * IBM862 * IBM863 * IBM864 * IBM865 * IBM866 * IBM868 * IBM869 * IBM870 * IBM871 * IBM918 * ISO-2022-CN * ISO-2022-JP * ISO-2022-JP-2 * ISO-2022-KR * ISO-8859-1 * ISO-8859-13 * ISO-8859-15 * ISO-8859-2 * ISO-8859-3 * ISO-8859-4 * ISO-8859-5 * ISO-8859-6 * ISO-8859-7 * ISO-8859-8 * ISO-8859-9 * JIS_X0201 * JIS_X0212-1990 * KOI8-R * KOI8-U * Shift_JIS * TIS-620 * US-ASCII * UTF-16 * UTF-16BE * UTF-16LE * UTF-32 * UTF-32BE * UTF-32LE * UTF-8 * windows-1250 * windows-1251 * windows-1252 * windows-1253 * windows-1254 * windows-1255 * windows-1256 * windows-1257 * windows-1258 * windows-31j * x-Big5-HKSCS-2001 * x-Big5-Solaris * x-euc-jp-linux * x-EUC-TW * x-eucJP-Open * x-IBM1006 * x-IBM1025 * x-IBM1046 * x-IBM1097 * x-IBM1098 * x-IBM1112 * x-IBM1122 * x-IBM1123 * x-IBM1124 * x-IBM1364 * x-IBM1381 * x-IBM1383 * x-IBM300 * x-IBM33722 * x-IBM737 * x-IBM833 * x-IBM834 * x-IBM856 * x-IBM874 * x-IBM875 * x-IBM921 * x-IBM922 * x-IBM930 * x-IBM933 * x-IBM935 * x-IBM937 * x-IBM939 * x-IBM942 * x-IBM942C * x-IBM943 * x-IBM943C * x-IBM948 * x-IBM949 * x-IBM949C * x-IBM950 * x-IBM964 * x-IBM970 * x-ISCII91 * x-ISO-2022-CN-CNS * x-ISO-2022-CN-GB * x-iso-8859-11 * x-JIS0208 * x-JISAutoDetect * x-Johab * x-MacArabic * x-MacCentralEurope * x-MacCroatian * x-MacCyrillic * x-MacDingbat * x-MacGreek * x-MacHe ew * x-MacIceland * x-MacRoman * x-MacRomania * x-MacSymbol * x-MacThai * x-MacTurkish * x-MacUkraine * x-MS932_0213 * x-MS950-HKSCS * x-MS950-HKSCS-XP * x-mswin-936 * x-PCK * x-SJIS_0213 * x-UTF-16LE-BOM * X-UTF-32BE-BOM * X-UTF-32LE-BOM * x-windows-50220 * x-windows-50221 * x-windows-874 * x-windows-949 * x-windows-950 * x-windows-iso2022jp |
The Character Set that should be used to encode the textual content of the SQS message |
Visibility Timeout | 15 mins | The amount of time after a message is received but not deleted that the message is hidden from other consumers | |
Receive Message Wait Time | 0 sec | The maximum amount of time to wait on a long polling receive call. Setting this to a value of 1 second or greater will reduce the number of SQS requests and decrease fetch latency at the cost of a constantly active thread. | |
Proxy Host |
Proxy host name or IP Supports Expression Language: true |
||
Proxy Host Port |
Proxy host port Supports Expression Language: true |
Relationships:
Name | Description |
success | FlowFiles are routed to success relationship |
Reads Attributes:
None specified.
Writes Attributes:
Name | Description |
hash.value | The MD5 sum of the message |
hash.algorithm | MD5 |
sqs.message.id | The unique identifier of the SQS message |
sqs.receipt.handle | The SQS Receipt Handle that is to be used to delete the message from the queue |
See Also:
PutSQS,DeleteSQS
Was this page helpful?
Yes
No
Thank you for your feedback!
Thank you for your feedback and comments. We will rectify this as soon as possible!
An unknown error has occurred. Please try again.
Help us improve this page