aws.sqs » purgeQueue(profile,queue,var)
Description
The command instructs Nexial to clear out existing messages in the target SQS queue, and store any system message as
var. Usually SQS does not supply any messages if the purge was successful.
Each SQS message would contain the following properties, which may be retrieved (read-only) during Nexial execution:
.id- the message id..body- this contains the message body (or content). Nexial presents this as plain text. According to AWS documentation, this should not exceed 256 KB..attributes- this contains the message attribute(s) associated to this message. This can be thought of as “structured metadata” that provides more context and definition to the associated message. According to AWS documentation, each message can hold up to 10 attributes. To retrieve a specific attribute in Nexial, use the.[attributes].[name]syntax (example below)..receiptHandle- unique identifier to a message received. This property is required to delete a message from its queue.
Parameters
- profile - the profile added in the data file which contains AWS SES credentials and connectivity.
- queue - the target SQS queue to purge.
- var - the variable to store system message(s) incurred as part of the purge.