Amazon SQS - Get queue attributes

Declaration

<AMAWSSQS ACTIVITY="get_queue_attributes" PROVIDER="session_based" SESSION="text" ACCESSKEY="text" SECRETKEY="text (encrypted)" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (encrypted)" SIGNMETHOD="text" SIGNVERSION="number" QUEUEURL="text" ATTR="text (options)" RESULTVARIABLE="text"   />

Related Topics     

Description

Gets one or all attributes of a queue and populates a dataset with the results.

IMPORTANT: Automate Desktop's SQS activities use Amazon's SQS engine to perform their work, therefore, launching and operating Amazon SQS through Automate Desktop requires a valid Access Key ID and Secret Access Key.

Practical usage

Used to get attributes for the specified queue such as the its policy, visibility timeout, approximate number of visible messages in the queue, the default delay on the queue in seconds and more.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where AWS user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:
  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.
  • Session - Specifies that user credentials and/or advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the Amazon SQS - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.
Session Text Yes, if Connection is set to Session SQSSession1 SESSION="SQSession1" The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is 'SQSSession1'.
Access key Text Yes, if Connection is set to Host (Empty) ACCESSKEY="022QF06E7MXBSH9DHM02" A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.
Secret access key Text Yes, if Connection is set to Host (Empty) SECRETKEY="kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct" A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that SQS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.
User agent Text No Automate USERAGENT="Automate" The name of the client or application initiating requests to AWS, which in this case, is Automate Desktop. This parameter's default value is Automate. 
Service URL Text No (Empty) SERVICEURL="https://sqs.eu-west-1.amazonaws.com" The URL that provides the service endpoint. To make the service call to a different region, you can pass the region-specific endpoint URL. For example, entering https://sqs.us-west-1.amazonaws.com points to US West (Northern California) region. A complete list of SQS regions, along with their associated endpoints and valid protocols can be found below under SQS regions and endpoints.
Maximum number of retries on error Number No (Empty) MAXERRORRETRY="4" The total amount of times this activity should retry its request to the server before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability. 
Proxy host Text No (Empty) PROXYHOST="proxy.host.com" The hostname (for example, server.domain.com) or IP address (for example, xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS.  
Proxy port Number No (Empty) PROXYPORT="1028" The port that should be used to connect to the proxy server.
Proxy username Text No (Empty) PROXYUSER="username" The username that should be used to authenticate connection with the proxy server (if required).
Proxy password Text No (Empty) PROXYPWD="encrypted" The password that should be used to authenticate connection with the proxy server (if required).
Signature method Text No (Empty) SIGNMETHOD="HmacSHA256" The signature method to use for signing the request. This provides a valid hashing algorithm for signature calculation. Acceptable AWS signature methods are HmacSHA1 and HmacSHA256.
Signature version Number No (Empty) SIGNVERSION="2" The signature version for signing the request. Valid AWS signature versions are 2 and 4. The difference with version 4 is that it allows you to sign your message using a key that is derived from your secret access key rather than using the secret access key itself.

Queue

Property Type Required Default Markup Description
Queue URL Text Yes (Empty) QUEUEURL="https://queue.amazonaws.com/QueueID" The URL uniquely identifying the queue in which to get a queue attribute from.
Attribute(s) Text (options) Yes (Empty)
  • ATTR="all"
  • ATTR="numberof_messages"
  • ATTR="messages_not_visible"
  • ATTR="visibility_timeout"
  • ATTR="last_modified"
  • ATTR="policy"
 The attribute name to get information about. The available options are:
  • All (default) - Returns all values.
  • Approximate number of messages - Returns the approximate number of visible messages in a queue.
  • Approximate number of messages not visible - Returns the approximate number of messages that are not timed-out and not deleted.
  • Visibility timeout - Returns the visibility timeout for the queue.
  • Last modified timestamp - Returns the time when the queue was last changed (in seconds).
  • Policy - Returns the queue's policy.
Populate variable with attribute Text Yes (Empty) RESULTVAR="myVarName" The name of an existing variable in which to populate with the value of the specified attributes.

Description

Error Causes

On Error

Additional notes

SQS regions and endpoints

This table contains a complete list of Amazon Simple Queue Service endpoints, along with their corresponding regions and supported protocols.

Endpoint Region Protocol
sqs.us-east-1.amazonaws.com US East (Northern Virginia) Region HTTP and HTTPS
sqs.us-west-2.amazonaws.com US West (Oregon) Region HTTP and HTTPS
sqs.us-west-1.amazonaws.com US West (Northern California) Region HTTP and HTTPS
sqs.eu-west-1.amazonaws.com EU (Ireland) Region HTTP and HTTPS
sqs.ap-southeast-1.amazonaws.com Asia Pacific (Singapore) Region HTTP and HTTPS
sqs.ap-southeast-2.amazonaws.com Asia Pacific (Sydney) Region HTTP and HTTPS
sqs.ap-northeast-1.amazonaws.com Asia Pacific (Tokyo) Region HTTP and HTTPS
sqs.sa-east-1.amazonaws.com South America (Sao Paulo) Region HTTP and HTTPS

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task gets a queue's attributes and then stores them into a variable.

Copy 
<AMAWSSQS ACTIVITY="get_queue_attributes" PROVIDER="session_based" SESSION="SQSSession1" QUEUEURL="NetautoURL" RESULTVARIABLE="myVarName" />