For the complete documentation index, see llms.txt. This page is also available as Markdown.

Send

Frends Task for sending messages to AmazonSQS.

Task version: 2.1.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

QueueUrl : String

Queue url.

Examples: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}

Default: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME} Example: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}

Message : String

The message to send.

The maximum string size is 256 KB.

A message can include only XML, JSON, and unformatted text.

Default: - Example: Hello world

Name
Description

Region : Regions

The region to connect.

Possible values:

  • Undefined: Undefined region - uses default configuration.

  • AfSouth1: Africa (Cape Town) - af-south-1.

  • ApEast1: Asia Pacific (Hong Kong) - ap-east-1.

  • ApNortheast1: Asia Pacific (Tokyo) - ap-northeast-1.

  • ApNortheast2: Asia Pacific (Seoul) - ap-northeast-2.

  • ApNortheast3: Asia Pacific (Osaka) - ap-northeast-3.

  • ApSouth1: Asia Pacific (Mumbai) - ap-south-1.

  • ApSoutheast1: Asia Pacific (Singapore) - ap-southeast-1.

  • ApSoutheast2: Asia Pacific (Sydney) - ap-southeast-2.

  • CaCentral1: Canada (Central) - ca-central-1.

  • CnNorth1: China (Beijing) - cn-north-1.

  • CnNorthWest1: China (Ningxia) - cn-northwest-1.

  • EuCentral1: Europe (Frankfurt) - eu-central-1.

  • EuNorth1: Europe (Stockholm) - eu-north-1.

  • EuSouth1: Europe (Milan) - eu-south-1.

  • EuWest1: Europe (Ireland) - eu-west-1.

  • EuWest2: Europe (London) - eu-west-2.

  • EuWest3: Europe (Paris) - eu-west-3.

  • MeSouth1: Middle East (Bahrain) - me-south-1.

  • SaEast1: South America (São Paulo) - sa-east-1.

  • UsEast1: US East (N. Virginia) - us-east-1.

  • UsEast2: US East (Ohio) - us-east-2.

  • UsWest1: US West (N. California) - us-west-1.

  • UsWest2: US West (Oregon) - us-west-2.

Default: EuNorth1 Example: Regions.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 : AwsCredentialsTypes

Type of Aws Credentials.

See more https://docs.aws.amazon.com/sdkfornet1/latest/apidocs/html/T_Amazon_Runtime_AWSCredentials.htm

Possible values:

  • AnonymousAwsCredentials: Anonymous Aws credentials for accessing public resources without authentication.

Using these credentials, the client does not sign the request.

  • BasicAwsCredentials: Basic Aws credentials using access key and secret key.

Consists of an AccessKey and SecretKey for standard authentication.

  • EnvironmentAwsCredentials: Aws credentials loaded from environment variables or application configuration.

Credentials are retrieved from ConfigurationManager.AppSettings or environment variables.

  • SessionAwsCredentials: Session Aws credentials with temporary access using session token.

Consists of AccessKey, SecretKey, and SessionToken for temporary authentication.

Default: BasicAwsCredentials Example: AwsCredentialsTypes.BasicAwsCredentials

AccessKey : String

Access key used in AmazonSQS connection.

Default: - Example: AccessKey

🗝SecretKey : String

Secret key used in AmazonSQS connection.

Default: - Example: SecretKey

🗝SessionToken : String

Session token for SessionAWSCredentials.

Default: - Example: SessionToken

Name
Description

ThrowErrorOnFailure : Boolean

Gets or sets a value indicating whether an error should stop the Task and throw an exception.

If set to true, an exception will be thrown when an error occurs. If set to false, Task will try to continue and the error message will be added into Result.ErrorMessage and Result.Success will be set to false.

Default: True Example: true

ErrorMessageOnFailure : String

Gets or sets a custom error message to be used when an error occurs and ThrowErrorOnFailure is set to false.

If empty, the original error message will be used.

Default: - Example: Failed to send message to AmazonSQS.

DelaySeconds : Int32

The length of time, in seconds, for which to delay a specific message.

Valid values: -1 to 900. Maximum: 15 minutes.

Messages with a positive value become available for processing after the delay period is finished.

If value is -1, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

Default: -1 Example: -1

Task Result

Name
Description

Success : Boolean

Gets a value indicating whether the Task was executed successfully. Example: true

MessageId : String

MessageId. Example: aae72806-1469-4663-b3d3-5228d163baa6

StatusCode : String

Status code of the operation. Example: OK

ContentLength : Int64

Length of the sent content. Example: 378

Error : Error

Error information. This value is generated when an exception occurs and Options.ThrowErrorOnFailure = false. Example: Error occured...

Error.Message : String

Gets or sets the error message. Example: Error occurred...

Error.AdditionalInfo : Object

Gets or sets additional error information. Example: Additional details about the error

Task Changelog

Changelog for Task Frends.AmazonSQS.Send.

[2.1.0] - 2026-07-17

Changed

  • Made task class static to comply with Frends best practices

[2.0.0] - 2025-07-23

Added

  • ErrorMessageOnFailure property to Options class for custom error messages

  • Error class in Definitions folder with Message and AdditionalInfo properties

  • ErrorHandler class in Helpers folder for centralized error handling

Changed

  • Renamed AnonymousAWSCredentials to AnonymousAwsCredentials

  • Renamed BasicAWSCredentials to BasicAwsCredentials

  • Renamed EnvironmentAWSCredentials to EnvironmentAwsCredentials

  • Renamed SessionAWSCredentials to SessionAwsCredentials

  • Renamed ThrowExceptionOnError to ThrowErrorOnFailure

  • Renamed HttpStatus property to StatusCode in Result class

  • Updated error handling to use centralized ErrorHandler.Handle method

  • ThrowErrorOnFailure now defaults to true for consistent behavior

  • Restructured task parameters into Input, Connection, and Options classes

Removed

  • [Breaking] ErrorMessage property from Result class (replaced with Error object)

[1.0.0] - 2024-01-08

Added

  • Initial implementation

Last updated

Was this helpful?