In this article

Overview

You can use this account type to connect REST Snaps with data sources that use REST AWS SigV4 accounts. Amazon Web Services (AWS) Signature Version 4 is the process of adding authentication information to AWS requests sent by the HTTP client.

Prerequisites

None.

Limitations and Known Issues

None.

Account Settings

SnapLogic Documentation > REST AWS SigV4 Account > REST AWS SigV4 Account_Overview.png

Parameter	Data Type	Description
Label* Default Value: N/A Example: AWS_V4_REST_Account	String	Specify a unique label for the account.
Access-key ID* Default Value: N/A Example:Auikj8647IJKL1MPQ=	String/Expression	Specify the access key ID associated with your AWS authentication.
Secret Key* Default Value: N/A Example: aBcdeFGhiJKLM/N1O	String/Expression	Specify the secret key associated with your AWS authentication.
Security Token Default Value: N/A Example: FwoGYXdzEGUaDFInugbfG X8xlGA4ZwNV3uSQBjIre4G7AXvfuGO2F q41wKGc4TcSknLVYpI2aKf9z21+7oszQ==	String/Expression	Specify the security token to make requests using temporary credentials (for example, AWS STS) for accessing AWS resources. You do not have to specify Security Token if you use permanent credentials. Learn more about adding signature to the HTTP request - AWS General Reference.
AWS Region Default Value: N/A Example: us-west-2	String/Expression	Specify the AWS Region for constructing the authorization header.
Service Name Default Value: N/A Example: S3	String/Expression	Specify the Service Name for constructing the authorization header.

If you configure this account for your REST Snaps, you must include the service and region in the Service URL field of the Snap settings. See the example below for more information.

SnapLogic Documentation > REST AWS SigV4 Account > REST_Snap_service_region.png

If you include query parameters in the Service URL field, ensure that you pass the key-value pairs in the ascending order of the keys. For example, http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/?max-keys=15&prefix=AEP
http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/?prefix=AEP&max-keys=15 — this URL denotes an incorrect order as the keys are not in an ascending order.
Alternatively, you can provide the query parameters in the Query parameters field set of the Snap in any order.

Example

Creating a New File in AWS S3 Using REST AWS SigV4 Account

The following example Pipeline demonstrates how we can create a new file in AWS S3 bucket. Broadly, creating a new file in AWS S3 is a three step process:

Prerequisites:

Configure a valid REST AWS SigV4 Account to authenticate the REST APIs.
Configure Filename as your Pipeline parameter and an S3 account for the bucket.

Create File operation

First, we configure the REST POST Snap to perform the create file operation. To this end, we configure the Snap as follows:
SnapLogic Documentation > REST AWS SigV4 Account > Create_MultiPart_Snap_config.png

Next, we configure the Mapper Snap to map the response.entity to the XMLOutput column.
SnapLogic Documentation > REST AWS SigV4 Account > Get_XML_Output_Snap_Config.png

Then, we configure another Mapper Snap to extract the uploadId of the entity.
SnapLogic Documentation > REST AWS SigV4 Account > Get_Upload_ID_Snap_Config.png

Upon validation, the Snap generates the output with uploadId as follows:
SnapLogic Documentation > REST AWS SigV4 Account > Get_Upload_ID_output.png

Upload File operation

Next, we configure the REST PUT Snap as follows to perform the upload file operation.
SnapLogic Documentation > REST AWS SigV4 Account > Upload_Multipart_Snap_Config.png

Next, we configure the Mapper Snap to extract the etag and uploadId.
SnapLogic Documentation > REST AWS SigV4 Account > Get_Etag_and_UploadID_config.png

Upon validation, the Snap generates the output with etag and uploadId entities as follows:

SnapLogic Documentation > REST AWS SigV4 Account > Get_Etag_and_UploadID_output_preview.png

Complete File operation

We configure the REST HTTP POST Snap to complete the file operation.
SnapLogic Documentation > REST AWS SigV4 Account > Complete_Multipart_Snap_Config.png

Upon validation, the Snap generates the output preview as follows:

SnapLogic Documentation > REST AWS SigV4 Account > Complete_Multipart_Snap_Output.png

Finally, we configure the REST GET Snap to extract the required details from the uploaded file.
SnapLogic Documentation > REST AWS SigV4 Account > REST_GET_Read_File_Snap_Config.png

Upon validation, the Snap gets the entity data in the file as follows:
SnapLogic Documentation > REST AWS SigV4 Account > Read_the_File_Output_Preview.png

Download this Pipeline.

Downloads

Related Links