Overview
Configuration is provided for establishing connections with the Amazon Simple Queue Service service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Amazon Simple Queue Service REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Amazon Simple Queue Service.
Step 3. Set [Region] to the desired Region in the Server host parameter. Then provide Access Key and Secret Key in the grid below for the Access Key and Secret Key parameters
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Amazon Simple Queue Service instance.
In this guide, we will show how to read data from the Amazon Simple Queue Service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Amazon Simple Queue Service connection from the combo. Select from available Amazon Simple Queue Service resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Amazon Simple Queue Servie resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Amazon Simple Queue Service.
In this guide, we will show how to write data to the Amazon Simple Queue Service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Amazon Simple Queue Service connection from the combo. Also, select resource action and Amazon Simple Queue Service resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Amazon Simple Queue Service resource.
Configuration
Base URL address: https://sqs.[region].amazonaws.com/.
- Amazon AWS Signature v4
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Access Key: Required. Specify access key.
- Secret Key: Required. Specify secret key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=aws4s.authorizationHeader (request, connection)}} -
Host:
{{=request.signedRequest.headers['Host']}} -
X-Amz-Content-Sha256:
{{=request.signedRequest.headers['X-Amz-Content-Sha256']}} -
X-Amz-Date:
{{=request.signedRequest.headers['X-Amz-Date']}} -
X-Amz-Security-Token:
{{=request.signedRequest.headers['X-Amz-Security-Token']}}
Documentation: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=_.map(response.ListQueuesResponse.ListQueuesResult.queueUrls, function(item) { return { QueueUrl: item }; })}}.
The result is paginated.The following request parameters will be automatically processed:
-
Action:
ListQueues -
NextToken:
{{=parameters.iterator}} -
MaxResults:
{{=parameters.batchSize}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html.
-
Action:
- [Read single] action
-
Endpoint URL address:
/.
The result is extracted from:{{=[{ QueueUrl: response.GetQueueUrlResponse.GetQueueUrlResult.QueueUrl }]}}.The action has the following user-defined parameters:
- QueueName: Required. The name of the queue whose URL must be fetched. Maximum 80 characters.
The following request parameters will be automatically processed:
-
Action:
GetQueueUrl
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html.
- [Read dead letter] action
-
Endpoint URL address:
/.
The result is extracted from:{{=_.map(response.ListDeadLetterSourceQueuesResponse.ListDeadLetterSourceQueuesResult.queueUrls, function(item) { return { QueueUrl: item }; })}}.
The result is paginated.The action has the following user-defined parameters:
- QueueUrl: Required. Specify the path of the dead-letter queue (e.g /[awsAccountId]/testqueue ).
The following request parameters will be automatically processed:
-
Action:
ListDeadLetterSourceQueues -
NextToken:
{{=parameters.iterator}} -
MaxResults:
{{=parameters.batchSize}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListDeadLetterSourceQueues.html.
- [Create] action
-
Endpoint URL address:
/.The following request parameters will be automatically processed:
-
Action:
CreateQueue -
QueueName:
{{=item.QueueName}} -
_itemTags:
{{=SQS.setPrefixedList('Tag', item.Tags)}} -
_itemAttributes:
{{=item.Attributes}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html.
-
Action:
- [Delete] action
-
Endpoint URL address:
{{=item.QueueUrlPath}}.The following request parameters will be automatically processed:
-
Action:
DeleteQueue
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteQueue.html.
-
Action:
- QueueUrl
Template: ShortText.
- QueueUrlPath
A key field. Template: ShortText. The gathered value is processed with
{{=new Uri(item.QueueUrl).path()}}expression.- QueueName
Template: ShortText. The gathered value is processed with
{{=SQS.getQueueName(item.QueueUrl))}}expression.- Tags
The value is gathered from
/{{=SQS.getQueueName(item.QueueUrl)}}address. The gathered value is processed with{{=response.ListQueueTagsResponse.ListQueueTagsResult.Tags}}expression. Field components:- An array.
- Contains the following components: Key, Value.
- Attributes
The value is gathered from
/{{=SQS.getQueueName(item.QueueUrl)}}address. The gathered value is processed with{{=response.GetQueueAttributesResponse.GetQueueAttributesResult.Attributes}}expression. Before setting, the value is processed with{{=SQS.setPrefixedList('Attribute', value)}}expression. Field components:- An array.
- Contains the following components: Name, Value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.
The result is extracted from:{{=response.ReceiveMessageResponse.ReceiveMessageResult.messages}}.
The result is paginated.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue (e.g /[awsAccountId]/testqueue ).
- MessageAttributeName: Specify attributes that need to be returned along with each message. (e.g. 'All'). Optional.
- AttributeName: Specify message attributes that need to be returned along with each message. (e.g. 'All'). Optional.
The following request parameters will be automatically processed:
-
Action:
ReceiveMessage -
MaxNumberOfMessages:
{{=parameters.batchSize}} -
MsgAttribute:
{{=SQS.setPrefixedList('MessageAttributeName', parameters.get('MessageAttributeName') && parameters.MessageAttributeName.split(','))}} -
Attribute:
{{=SQS.setPrefixedList('AttributeName', parameters.get('AttributeName') && parameters.AttributeName.split(','))}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html.
- [Create] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue (e.g /[awsAccountId]/testqueue).
The following request parameters will be automatically processed:
-
Action:
SendMessage -
MessageBody:
{{=item.MessageBody}} -
_itemAttributes:
{{=item.MessageAttributes}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html.
- [Update] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue (e.g /[awsAccountId]/testqueue ).
- ReceiptHandle: Required. Please specify the handle associated with the message to update.
- VisibilityTimeout: Required. The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
The following request parameters will be automatically processed:
-
Action:
ChangeMessageVisibility -
VisibilityTimeout:
{{=parameters.get('VisibilityTimeout')}} -
ReceiptHandle:
{{=parameters.get('ReceiptHandle')}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibility.html.
- [Delete] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue (e.g /[awsAccountId]/testqueue).
The following request parameters will be automatically processed:
-
Action:
DeleteMessage -
ReceiptHandle:
{{=item.ReceiptHandle}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessage.html.
- MessageId
A key field. Data type: DT_GUID
- ReceiptHandle
Template: ShortText.
- MD5OfBody
Template: ShortText.
- MessageBody
Template: LongText.
- Body
Template: LongText.
- MessageAttributes
Before setting, the value is processed with
{{=SQS.setPrefixedList('MessageAttribute', value)}}expression. Field components:- An array.
- Contains the following components: Name, Value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.
The result is extracted from:{{=response.ListQueueTagsResponse.ListQueueTagsResult.Tags}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue (e.g /[awsAccountId]/testqueue ).
The following request parameters will be automatically processed:
-
Action:
ListQueueTags
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html.
- [Create] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue to tag (e.g /[awsAccountId]/testqueue ).
The following request parameters will be automatically processed:
-
Action:
TagQueue -
_item:
{{=SQS.setPrefixedList('Tag', batch)}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_TagQueue.html.
- [Delete] action
-
Endpoint URL address:
{{=item.QueueUrlPath}}.The following request parameters will be automatically processed:
-
Action:
UntagQueue -
TagKey:
{{=item.TagKey}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_UntagQueue.html.
-
Action:
- QueueUrlPath
A key field. Template: ShortText.
- Key
Template: ShortText.
- Value
Template: ShortText.
- TagKey
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.QueueUrlPath}}.
The result is extracted from:{{=response.GetQueueAttributesResponse.GetQueueAttributesResult.Attributes}}.The action has the following user-defined parameters:
- QueueUrlPath: Required. Specify the path of the queue to untagqueue (e.g /[awsAccountId]/testqueue ).
- AttributeName: Required. Specify the attribute you'd like to retrieve (e.g. 'All').
The following request parameters will be automatically processed:
-
Action:
GetQueueAttributes -
_attributes:
{{=SQS.setPrefixedList('AttributeName', parameters.get('AttributeName') && parameters.AttributeName.split(','))}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html.
- Name
Template: ShortText.
- Value
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
{{=item.QueueUrlPath}}.The action has the following user-defined parameters:
- ActionName: Required. Multiple comma-separated values are accepted.
- AWSAccountId: Required. Multiple comma-separated values are accepted.
The following request parameters will be automatically processed:
-
Action:
AddPermission -
_AWSAccountId:
{{=SQS.setPrefixedList('AWSAccountId', parameters.AWSAccountId.split(','))}} -
_ActionName:
{{=SQS.setPrefixedList('ActionName', parameters.ActionName.split(','))}} -
Label:
{{=item.Label}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_AddPermission.html.
- [Delete] action
-
Endpoint URL address:
{{=item.QueueUrlPath}}.The following request parameters will be automatically processed:
-
Action:
RemovePermission -
Label:
{{=item.Label}}
Documentation: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_RemovePermission.html.
-
Action:
- QueueUrlPath
A key field. Template: ShortText.
- Label
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.