tSQSInput Standard properties - 6.4

Amazon SQS

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Amazon services (Integration) > Amazon SQS components
Data Quality and Preparation > Third-party systems > Amazon services (Integration) > Amazon SQS components
Design and Development > Third-party systems > Amazon services (Integration) > Amazon SQS components
EnrichPlatform
Talend Studio

These properties are used to configure tSQSInput running in the Standard Job framework.

The Standard tSQSInput component belongs to the Cloud family.

The component in this framework is available in all Talend products.

Basic settings

Use an existing connection

Select this check box and in the Component List click the relevant connection component to reuse the connection details you already defined.

Access Key and Secret Key

Specify the access keys (the access key ID in the Access Key field and the secret access key in the Secret Key field) required to access the Amazon Web Services. For more information on AWS access keys, see Access keys (access key ID and secret access key).

To enter the secret key, click the [...] button next to the secret key field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

Inherit credentials from AWS role

Select this check box to leverage the instance profile credentials. These credentials can be used on Amazon EC2 instances, and are delivered through the Amazon EC2 metadata service. To use this option, your Job must be running within Amazon EC2 or other services that can leverage IAM Roles for access to resources. For more information, see Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances.

Assume role
Select this check box and specify the values for the following parameters used to create a new assumed role session.
  • Role ARN: the Amazon Resource Name (ARN) of the role to assume.

  • Role session name: an identifier for the assumed role session.

  • Session duration (minutes): the duration (in minutes) for which we want to have the assumed role session to be active.

For more information on assuming roles, see AssumeRole.
Region

Specify the AWS region by selecting a region name from the list or entering a region between double quotation marks (for example "us-east-1") in the list. For more information on AWS Regions, see AWS Regions and Endpoints.

Queue (Name or URL)

Specify the name or URL of the queue from which the messages will be retrieved.

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. The schema is either Built-In or stored remotely in the Repository.

The schema of this component is predefined with the following four String type message attributes:

  • MessageId: the ID of the message.

  • ReceiptHandle: the receipt handle of the message.

  • MD5OfBody: the MD5 digest of the message body.

  • Body: the message body.

You can click the button next to Edit schema to view the schema and edit the schema by removing the existing attributes or adding the standard SQS attributes and the customized user attributes.

Read standard attributes

Select this check box to retrieve the standard Amazon SQS attributes along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Read custom user attributes

Select this check box to retrieve the customized user attributes along with each message.

Custom visibility timeout

Select this check box and in the field displayed specify the visibility timeout (in seconds) for the received messages. If not specified, the overall visibility timeout for the queue will be used for the received messages. For more information, see Visibility Timeout.

Custom wait time

Select this check box and in the field displayed specify the duration (in seconds) for which the call will wait for the message to arrive in the queue before returning.

Delete the messages while streaming

Select this check box to delete the message while retrieving it from the queue.

Read all messages from the queue

Select this check box to retrieve all messages from the queue.

This check box is not available when the Delete the messages while streaming check box is cleared.

Max number of message to return per request

Specify the maximum number of messages to return per each request. Valid values are 1 to 10.

Die on error

Select this check box to stop the execution of the Job when an error occurs.

Advanced settings

Config client
Select this check box and in the table displayed specify the client configuration parameters. Click the [+] button below the table to add as many rows as needed, each row for a client configuration parameter, and set the value of the following attributes for each parameter:
  • Client Parameter: click the cell and select a parameter from the drop-down list.

  • Value: enter the value for the corresponding parameter.

STS Endpoint

Select this check box and in the field displayed, specify the AWS Security Token Service endpoint, for example, sts.amazonaws.com, where session credentials are retrieved from.

This check box is available only when the Assume role check box is selected.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

Global variables

NB_LINE

The number of messages processed. This is an After variable and it returns an integer.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

Usage

Usage Rule

This component is usually used as a start component of a Job or Subjob and it always needs an output link.