GetSQS

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Queue URLQueue URLThe URL of the queue to act upon
Supports Expression Language: true (will be evaluated using variable registry only)
Auto Delete MessagesAuto Delete Messagestrue
  • true
  • false
Specifies whether the messages should be automatically deleted by the processors once they have been received.
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
Implementations: AWSCredentialsProviderControllerService
AWSIDBrokerCloudCredentialsProviderControllerService		The Controller Service that is used to obtain AWS credentials provider
RegionRegionUS West (Oregon)
  • AWS GovCloud (US-East) AWS Region Code : us-gov-east-1
  • AWS GovCloud (US-West) AWS Region Code : us-gov-west-1
  • Africa (Cape Town) AWS Region Code : af-south-1
  • Asia Pacific (Hong Kong) AWS Region Code : ap-east-1
  • Asia Pacific (Hyderabad) AWS Region Code : ap-south-2
  • Asia Pacific (Jakarta) AWS Region Code : ap-southeast-3
  • Asia Pacific (Melbourne) AWS Region Code : ap-southeast-4
  • Asia Pacific (Mumbai) AWS Region Code : ap-south-1
  • Asia Pacific (Osaka) AWS Region Code : ap-northeast-3
  • Asia Pacific (Seoul) AWS Region Code : ap-northeast-2
  • Asia Pacific (Singapore) AWS Region Code : ap-southeast-1
  • Asia Pacific (Sydney) AWS Region Code : ap-southeast-2
  • Asia Pacific (Tokyo) AWS Region Code : ap-northeast-1
  • Canada (Central) AWS Region Code : ca-central-1
  • China (Beijing) AWS Region Code : cn-north-1
  • China (Ningxia) AWS Region Code : cn-northwest-1
  • Europe (Frankfurt) AWS Region Code : eu-central-1
  • Europe (Ireland) AWS Region Code : eu-west-1
  • Europe (London) AWS Region Code : eu-west-2
  • Europe (Milan) AWS Region Code : eu-south-1
  • Europe (Paris) AWS Region Code : eu-west-3
  • Europe (Spain) AWS Region Code : eu-south-2
  • Europe (Stockholm) AWS Region Code : eu-north-1
  • Europe (Zurich) AWS Region Code : eu-central-2
  • Middle East (Bahrain) AWS Region Code : me-south-1
  • Middle East (UAE) AWS Region Code : me-central-1
  • South America (Sao Paulo) AWS Region Code : sa-east-1
  • US East (N. Virginia) AWS Region Code : us-east-1
  • US East (Ohio) AWS Region Code : us-east-2
  • US ISO East AWS Region Code : us-iso-east-1
  • US ISO WEST AWS Region Code : us-iso-west-1
  • US ISOB East (Ohio) AWS Region Code : us-isob-east-1
  • US West (N. California) AWS Region Code : us-west-1
  • US West (Oregon) AWS Region Code : us-west-2
  • aws-cn-global AWS Region Code : aws-cn-global
  • aws-global AWS Region Code : aws-global
  • aws-iso-b-global AWS Region Code : aws-iso-b-global
  • aws-iso-global AWS Region Code : aws-iso-global
  • aws-us-gov-global AWS Region Code : aws-us-gov-global
No Description Provided.
Batch SizeBatch Size10The maximum number of messages to send in a single network request
Communications TimeoutCommunications Timeout30 secsNo Description Provided.
Endpoint Override URLEndpoint 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Character SetCharacter SetUTF-8
  • Big5
  • Big5-HKSCS
  • CESU-8
  • 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-16
  • 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-IBM1166
  • 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-MacHebrew
  • 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 TimeoutVisibility Timeout15 minsThe amount of time after a message is received but not deleted that the message is hidden from other consumers
Receive Message Wait TimeReceive Message Wait Time0 secThe 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 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 (will be evaluated using variable registry only)
Proxy Passwordproxy-user-passwordProxy password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

NameDescription
successFlowFiles are routed to success relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
hash.valueThe MD5 sum of the message
hash.algorithmMD5
sqs.message.idThe unique identifier of the SQS message
sqs.receipt.handleThe SQS Receipt Handle that is to be used to delete the message from the queue

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PutSQS, DeleteSQS