Amazon SQS List Queues Activity¶

Introduction¶

An Amazon SQS List Queues activity, using its Amazon SQS connection, lists Amazon SQS queues and is intended to be used as a target in an operation.

This activity uses the ListQueues action from the Amazon SQS API.

Prerequisites¶

To successfully use this activity, you must have the following AWS IAM account permissions:

• sqs:GetQueueUrl
• sqs:ListQueues

Cross-account permissions don't apply to this action. For more information, see Basic Examples of Amazon SQS Policies in the Amazon SQS Developer Guide.

Create an Amazon SQS List Queues Activity¶

An instance of an Amazon SQS List Queues activity is created from an Amazon SQS connection using its List Queues activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Amazon SQS List Queues activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure an Amazon SQS List Queues Activity¶

Follow these steps to configure an Amazon SQS List Queues activity:

• Step 1: Enter a Name and Specify Settings
  Provide a name for the activity and specify the settings for listing queues.

• Step 2: Review the Data Schemas
  Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a Name and Specify Settings¶

In this step, provide a name for the activity and specify the settings for listing queues.

• Name: Enter a name to identify the activity. The name must be unique for each Amazon SQS List Queues activity and must not contain forward slashes (/) or colons (:).

• Max Results: Enter the maximum number of queues to list. This can range from 1 to 1000 queues.

• Queue Name Prefix: Enter a queue prefix to filter the list by. Only queues with names that start with the specified value are returned. This value is case-sensitive.

• Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log. It is selected by default.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas¶

Any request or response schemas generated from the endpoint are displayed.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The Amazon SQS connector uses the AWS SDK for Java version 1.12.522. Refer to the API documentation for information on the schema nodes and fields.

  The request and response data schemas consist of these nodes and fields:

  • Request:

    Request Schema Node/Field	Amazon SQS API Field/Method	Description
    ListQueueRequest	ListQueuesRequest	Request to list queues
    request	N/A (Request Node)	Node representing the request
    queueNamePrefix	QueueNamePrefix	String with the prefix of the queues to list
    maxResults	MaxResults	Integer with the maximum number of queues to list

  • Response:

    Response Schema Node/Field	Amazon SQS API Field/Method	Description
    ListQueueResponse	ListQueuesResponse	Response from listing queues
    response	N/A (Response Node)	Node representing the response
    errorMessage	N/A (Response Message)	String set to the response's error message
    status	N/A (Response Status Code)	String set to the response's status
    queueUrls	QueueUrl (List)	List of found queues
    url		Object containing URL string of queue
    #text		String set to the URL of the queue

  Note

  Refer to the ListQueues action for detailed information on the schema nodes and fields.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Amazon SQS endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring an Amazon SQS List Queues activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Amazon SQS List Queues activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.