Inquire Queues
The InquireQueue activity queries the queue to discover its attributes and message depth.
General
In the General tab, you can select shared resource to establish a connection to the Amazon server. The following table lists the configurations in the General tab of the InquireQueue activity.
Description
In the Description tab, you can provide a short description for the InquireQueue activity.
Input
In the Input tab, you can specify input values for the InquireQueue activity. The following table lists the input element in the Input tab of the InquireQueue activity.
Output
In the Output tab, you can find the output value of the InquireQueue activity. The following table lists the output elements in the Output tab of the InquireQueue activity.
Output Item | Data Type | Description |
---|---|---|
QueueName | String | A copy of the input schema QueueName. |
QueueUrl | String | The URL of the named queue. |
ApproximateNumberOfMessages | Int | The approximate number of messages on the queue. |
ApproximateNumberOfMessagesNotVisible | Int | The approximate number of messages that are currently hidden. This happens when a client receives a message and when deletes it. |
VisibilityTimeout | Int | The number of seconds a message can be hidden before it becomes visible, regardless of the actions of the client that received it. |
CreatedTimeStamp | String | The times tamp of when the queue was created. |
LastModifiedTimeStamp | String | The time stamp of when the queue was most recently modified. |
Policy | String | Any security policies in place for the queue. |
MaximumMessageSize | Int | The maximum message size permitted for the queue. |
MessageRetentionPeriod | Int | The duration (in seconds) for which a message remains on the queue before being deleted. |
QueueArn | String | The Amazon Resource Name for the queue. |
ApproximateNumberOfMessagesDelayed | Int | The approximate number of messages which have been placed on the queue, for which there is a delay in effect, such that they are not yet visible. |
DelaySeconds | Int | The duration (in seconds) for which the delivery of all messages in the queue will be delayed. |
ReceiveMessageWaitTimeSeconds | Int | The duration for which a ReceiveMessage call must wait for a message to arrive. |
RedrivePolicy | String | The parameters for dead letter queue functionality of this queue. |
ContentbasedDeduplication | Boolean | For FIFO queue, it displays whether content-based deduplication is enabled or disabled. |
Fault
The Fault tab lists exceptions that are generated by this activity.
Fault | Data Type | Description |
---|---|---|
SQSException | Any exception generated by the activity after execution. It has the following fields: ErrorCode and ErrorMessage. | |
ErrorCode | String | The plug-in error code for the exception. For more information, refer to Error Codes topic. |
ErrorMessage | String | The plug-in error message for the exception. It contains the error message from the AWS SQS API call that failed. |