Constructor
new AwsRequestSigner(getCredentials, region)
Instantiates an AWS API request signer used to send authenticated signed requests to AWS APIs based on the AWS Signature Version 4 signing process. This also provides a mechanism to generate the signed request without sending it.
Parameters:
| Name | Type | Description |
|---|---|---|
getCredentials |
A mechanism to retrieve AWS security credentials when needed. |
|
region |
The AWS region to use. |
Methods
(async) getRequestOptions(amzOptions)
Generates the signed request for the provided HTTP request for calling an AWS API. This follows the steps described at: https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html
Parameters:
| Name | Type | Description |
|---|---|---|
amzOptions |
The AWS request options that need to be signed. |
Returns:
| Type | Description |
|---|---|
|
A promise that resolves with the GaxiosOptions containing the signed HTTP request parameters. |