# Receive

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.AmazonSQS>

{% tabs %}
{% tab title="Parameter: Connection" %}

| Name                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Region : `Region`                      | <p>Region selection, default EUNorth1. Undefined doesn't select region.</p><p>Possible values:</p><ul><li><code>AfSouth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApEast1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApNortheast1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApNortheast2</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApNortheast3</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApSouth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApSoutheast1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>ApSoutheast2</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>CaCentral1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>CnNorth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>CnNorthWest1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuCentral1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuNorth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuSouth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuWest1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuWest2</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>EuWest3</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>MeSouth1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>SaEast1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>UsEast1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>UsEast2</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>UsWest1</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>UsWest2</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><ul><li><code>Undefined</code>:</li></ul><p>Region selection, default EUNorth1. Undefined doesn't select region.</p><p><br>Default: <code>-</code><br>Example: <code>Region.EuNorth1</code></p> |
| UseDefaultCredentials : `Boolean`      | <p>Credentials are loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.</p><p><br>Default: <code>False</code><br>Example: <code>true</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| CredentialsType : `AWSCredentialsType` | <p>Type of AWS Credentials. See more <https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm></p><p>Possible values:</p><ul><li><code>AnonymousAWSCredentials</code>:</li></ul><p>Type of AWS Credentials. See more <https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm></p><ul><li><code>BasicAWSCredentials</code>:</li></ul><p>Type of AWS Credentials. See more <https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm></p><ul><li><code>EnvironmentAWSCredentials</code>:</li></ul><p>Type of AWS Credentials. See more <https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm></p><ul><li><code>SessionAWSCredentials</code>:</li></ul><p>Type of AWS Credentials. See more <https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm></p><p><br>Default: <code>-</code><br>Example: <code>AWSCredentialsType.BasicAWSCredentials</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| AccessKey : `String`                   | <p>Access key used in AmazonSQS connection</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| 🗝SecretKey : `String`                 | <p>Secret key used in AmazonSQS connection</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| 🗝SessionToken : `String`              | <p>Session token for SessionAWSCredentials.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| {% endtab %}                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

{% tab title="Parameter: Input" %}

| Name                          | Description                                                                                                                                                                                                                                                                                                            |            |                                                                                                          |            |                                                                                                          |            |                                                         |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------- |
| QueueUrl : `String`           | <p>Queue url.</p><p>Examples: https\://{REGION\_ENDPOINT}/queue.                                                                                                                                                                                                                                                       | api-domain | /{YOUR\_ACCOUNT\_NUMBER}/{YOUR\_QUEUE\_NAME}</p><p><br>Default: <code>https\://{REGION\_ENDPOINT}/queue. | api-domain | /{YOUR\_ACCOUNT\_NUMBER}/{YOUR\_QUEUE\_NAME}</code><br>Example: <code>https\://{REGION\_ENDPOINT}/queue. | api-domain | /{YOUR\_ACCOUNT\_NUMBER}/{YOUR\_QUEUE\_NAME}</code></p> |
| MaxNumberOfMessages : `Int32` | <p>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.</p><p>Amazon does not provide an option to force an exact number of messages.</p><p><br>Default: <code>1</code><br>Example: <code>1</code></p> |            |                                                                                                          |            |                                                                                                          |            |                                                         |
| {% endtab %}                  |                                                                                                                                                                                                                                                                                                                        |            |                                                                                                          |            |                                                                                                          |            |                                                         |

{% tab title="Parameter: Options" %}

| Name                                    | Description                                                                                                                                                                                                                                                                                                                                                                   |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DeleteMessageAfterReceiving : `Boolean` | <p>Delete message(s) from queue after receiving it</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                                                                                                                                                                                                                                                     |
| VisibilityTimeout : `Int32`             | <p>The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.</p><p><br>Default: <code>30</code><br>Example: <code>30</code></p>                                                                                                                                                    |
| WaitTimeSeconds : `Int32`               | <p>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.</p><p><br>Default: <code>0</code><br>Example: <code>30</code></p> |
| {% endtab %}                            |                                                                                                                                                                                                                                                                                                                                                                               |

{% tab title="Result: Result" %}

| Name                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| {% endtab %}                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

{% tab title="Changelog" %}

## Changelog

### \[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
  {% endtab %}
  {% endtabs %}