Receive
Frends Task for receiving messages from AmazonSQS.
Task version: 1.1.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.AmazonSQS
Task Parameters
Region : Region
Region selection, default EUNorth1. Undefined doesn't select region.
Possible values:
AfSouth1: Region selection, default EUNorth1. Undefined doesn't select region.ApEast1: Region selection, default EUNorth1. Undefined doesn't select region.ApNortheast1: Region selection, default EUNorth1. Undefined doesn't select region.ApNortheast2: Region selection, default EUNorth1. Undefined doesn't select region.ApNortheast3: Region selection, default EUNorth1. Undefined doesn't select region.ApSouth1: Region selection, default EUNorth1. Undefined doesn't select region.ApSoutheast1: Region selection, default EUNorth1. Undefined doesn't select region.ApSoutheast2: Region selection, default EUNorth1. Undefined doesn't select region.CaCentral1: Region selection, default EUNorth1. Undefined doesn't select region.CnNorth1: Region selection, default EUNorth1. Undefined doesn't select region.CnNorthWest1: Region selection, default EUNorth1. Undefined doesn't select region.EuCentral1: Region selection, default EUNorth1. Undefined doesn't select region.EuNorth1: Region selection, default EUNorth1. Undefined doesn't select region.EuSouth1: Region selection, default EUNorth1. Undefined doesn't select region.EuWest1: Region selection, default EUNorth1. Undefined doesn't select region.EuWest2: Region selection, default EUNorth1. Undefined doesn't select region.EuWest3: Region selection, default EUNorth1. Undefined doesn't select region.MeSouth1: Region selection, default EUNorth1. Undefined doesn't select region.SaEast1: Region selection, default EUNorth1. Undefined doesn't select region.UsEast1: Region selection, default EUNorth1. Undefined doesn't select region.UsEast2: Region selection, default EUNorth1. Undefined doesn't select region.UsWest1: Region selection, default EUNorth1. Undefined doesn't select region.UsWest2: Region selection, default EUNorth1. Undefined doesn't select region.Undefined: Region selection, default EUNorth1. Undefined doesn't select region.
Default: -
Example: Region.EuNorth1
UseDefaultCredentials : Boolean
Credentials are loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Default: False
Example: true
CredentialsType : AWSCredentialsType
Type of AWS Credentials. See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm
Possible values:
AnonymousAWSCredentials: Type of AWS Credentials. See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htmBasicAWSCredentials: Type of AWS Credentials. See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htmEnvironmentAWSCredentials: Type of AWS Credentials. See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htmSessionAWSCredentials: Type of AWS Credentials. See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm
Default: -
Example: AWSCredentialsType.BasicAWSCredentials
AccessKey : String
Access key used in AmazonSQS connection
Default: -
Example: -
🗝SecretKey : String
Secret key used in AmazonSQS connection
Default: -
Example: -
🗝SessionToken : String
Session token for SessionAWSCredentials.
Default: -
Example: -
QueueUrl : String
Queue url.
Examples: https://{REGION_ENDPOINT}/queue.
MaxNumberOfMessages : Int32
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10.
Amazon does not provide an option to force an exact number of messages.
Default: 1
Example: 1
DeleteMessageAfterReceiving : Boolean
Delete message(s) from queue after receiving it
Default: True
Example: true
VisibilityTimeout : Int32
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
Default: 30
Example: 30
WaitTimeSeconds : Int32
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
Default: 0
Example: 30
Task Result
ContentLength : Int64
Length of the received content.
StatusCode : HttpStatusCode
Status code of the operation. Possible values: - Continue: Status code of the operation. - SwitchingProtocols: Status code of the operation. - Processing: Status code of the operation. - EarlyHints: Status code of the operation. - OK: Status code of the operation. - Created: Status code of the operation. - Accepted: Status code of the operation. - NonAuthoritativeInformation: Status code of the operation. - NoContent: Status code of the operation. - ResetContent: Status code of the operation. - PartialContent: Status code of the operation. - MultiStatus: Status code of the operation. - AlreadyReported: Status code of the operation. - IMUsed: Status code of the operation. - MultipleChoices: Status code of the operation. - MultipleChoices: Status code of the operation. - MovedPermanently: Status code of the operation. - MovedPermanently: Status code of the operation. - Found: Status code of the operation. - Found: Status code of the operation. - SeeOther: Status code of the operation. - SeeOther: Status code of the operation. - NotModified: Status code of the operation. - UseProxy: Status code of the operation. - Unused: Status code of the operation. - RedirectKeepVerb: Status code of the operation. - RedirectKeepVerb: Status code of the operation. - PermanentRedirect: Status code of the operation. - BadRequest: Status code of the operation. - Unauthorized: Status code of the operation. - PaymentRequired: Status code of the operation. - Forbidden: Status code of the operation. - NotFound: Status code of the operation. - MethodNotAllowed: Status code of the operation. - NotAcceptable: Status code of the operation. - ProxyAuthenticationRequired: Status code of the operation. - RequestTimeout: Status code of the operation. - Conflict: Status code of the operation. - Gone: Status code of the operation. - LengthRequired: Status code of the operation. - PreconditionFailed: Status code of the operation. - RequestEntityTooLarge: Status code of the operation. - RequestUriTooLong: Status code of the operation. - UnsupportedMediaType: Status code of the operation. - RequestedRangeNotSatisfiable: Status code of the operation. - ExpectationFailed: Status code of the operation. - MisdirectedRequest: Status code of the operation. - UnprocessableEntity: Status code of the operation. - UnprocessableEntity: Status code of the operation. - Locked: Status code of the operation. - FailedDependency: Status code of the operation. - UpgradeRequired: Status code of the operation. - PreconditionRequired: Status code of the operation. - TooManyRequests: Status code of the operation. - RequestHeaderFieldsTooLarge: Status code of the operation. - UnavailableForLegalReasons: Status code of the operation. - InternalServerError: Status code of the operation. - NotImplemented: Status code of the operation. - BadGateway: Status code of the operation. - ServiceUnavailable: Status code of the operation. - GatewayTimeout: Status code of the operation. - HttpVersionNotSupported: Status code of the operation. - VariantAlsoNegotiates: Status code of the operation. - InsufficientStorage: Status code of the operation. - LoopDetected: Status code of the operation. - NotExtended: Status code of the operation. - NetworkAuthenticationRequired: Status code of the operation.
Messages : System.Collections.Generic.List<Amazon.SQS.Model.Message>
List of received messages.
ResponseMetadata : Amazon.Runtime.ResponseMetadata
Information about the request.
Task Changelog
Changelog for Task Frends.AmazonSQS.Receive.
[1.0.0] - 2026-01-27
Added
Add a more specific description and test multiple messages
[1.0.0] - 2023-08-11
Added
Initial implementation
Last updated
Was this helpful?