/
REST AWS SigV4 Account

REST AWS SigV4 Account

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

 

Parameter

Data Type

Description

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.

  • 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:

  1. Create File 

  2. Upload File

  3. Complete File

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:

Next, we configure the Mapper Snap to map the response.entity to the XMLOutput column.


Then, we configure another Mapper Snap to extract the uploadId of the entity.



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

Upload File operation