GetSQS
Description
Fetches messages from an Amazon Simple Queuing Service Queue
Tags
AWS, Amazon, Fetch, Get, Poll, Queue, SQS
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Queue URL * | Queue URL | The URL of the queue to get messages from Supports Expression Language, using Environment variables. | ||
| Region * | Region | US West (Oregon) |
| |
| AWS Credentials Provider Service * | AWS Credentials Provider service | Controller Service: AWSCredentialsProviderService Implementations: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain AWS credentials provider | |
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Specifies an optional SSL Context Service that, if provided, will be used to create connections | |
| Auto Delete Messages * | Auto Delete Messages | true |
| Specifies whether the messages should be automatically deleted by the processors once they have been received. |
| Batch Size * | Batch Size | 10 | The maximum number of messages to send in a single network request | |
| Communications Timeout * | Communications Timeout | 30 secs | ||
| Endpoint Override URL | 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. Supports Expression Language, using Environment variables. | ||
| Character Set * | Character Set | UTF-8 |
| The Character Set that should be used to encode the textual content of the SQS message |
| Visibility Timeout * | 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 * | 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 Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| success | FlowFiles are routed to success relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| hash.algorithm | MD5 |
| hash.value | The MD5 sum of the message |
| 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 |
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
This component does not specify system resource considerations.