tSQSOutput Standard properties - 7.0

Amazon SQS

author
Talend Documentation Team
EnrichVersion
7.0
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 tSQSOutput running in the Standard Job framework.

The Standard tSQSOutput 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 the URL of the queue to which messages will be delivered.

The name of a FIFO queue must end with the .fifo suffix.

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. When you create a Spark Job, avoid the reserved word line when naming the fields.

The schema of this component is predefined with the following columns. You can click the [...] button next to Edit schema to view its schema and edit the schema by adding some customized attributes for the messages to be delivered.

  • Body: the body of the message to be delivered.

  • MessageGroupId: the specific message group that the message belongs to. Available only when the Use FIFO queues (first-in-first-out) check box is selected.

  • MesssageDeduplicationId: the token used for deduplication of the message. Available only when the Use FIFO queues (first-in-first-out) check box is selected and the Use Content Based Deduplication check box is cleared.

For more information on each predefined column, see SendMessage.

Use batch mode

Select this check box to deliver messages to the queue using batch request. In the Batch size field displayed, enter the number of messages to be delivered in each batch. Note that the maximum number of messages delivered in each batch is 10.

Use FIFO (first-in-first-out) queues

Select this check box to deliver messages to a FIFO queue.

For more information on the FIFO queue, see FIFO (First-In-First-Out) Queues.

Use Content Based Deduplication

Select this check box to enable content-based deduplication. With this check box selected, Amazon SQS will use a SHA-256 hash to generate the message deduplication ID using the body of the message.

This property is available only when the Use FIFO (first-in-first-out) queues check box is selected.

Die on error

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

Clear the check box to skip any error and continue the Job execution process.

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 service allows you to request temporary, limited-privilege credentials for the AWS user you authenticate; therefore, you still need to provide the access key and secret key to authenticate the AWS account to be used.

For a list of the STS endpoints you can use, see AWS Security Token Service. For further information about the STS temporary credentials, see Temporary Security Credentials. Both articles are from the AWS documentation.

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 rows processed. This is an After variable and it returns an integer.

NB_LINE_SUCCESS

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

NB_LINE_REJECTED

The number of rows rejected. 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 selected.

Usage

Usage rule

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