Function

Static Public Summary
public	buildAuthorization(accessKeyId: string, credentialScope: string, signedHeaders: string, signature: string): string Creates the authorization string https://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html
public	async buildCanonicalRequest(httpRequestMethod: string, canonicalURI: string, canonicalQueryString: string, canonicalHeaders: string, signedHeaders: string, requestPayload: string): Promise<string> Creates the canonical request https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
public	buildStringToSign(requestDate: string, credentialScope: string, hashedCanonicalRequest: string): string Creates the string to sign https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html
public	formatDateTime(date: Date): string Formats a Date object to an AWS date string
public	async preCalculateSigningKey(secretAccessKey: string, date: string, region: string, service: string): Promise<string> Pre-calculates the signing key https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html
public	preCalculatedSign(signingKey: string, stringToSign: string): Promise<string> Pre-calculates the signature https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html
public	async sign(secretAccessKey: string, date: string, region: string, service: string, stringToSign: string): Promise<string> Calculates the signature https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html

Static Public

public buildAuthorization(accessKeyId: string, credentialScope: string, signedHeaders: string, signature: string): string source

import {buildAuthorization} from 'aws-sigv4/src/index.js'

Creates the authorization string https://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html

Params:

Name	Type	Attribute	Description
accessKeyId	string	nullable: false
credentialScope	string	nullable: false
signedHeaders	string	nullable: false
signature	string	nullable: false

Return:

string

public async buildCanonicalRequest(httpRequestMethod: string, canonicalURI: string, canonicalQueryString: string, canonicalHeaders: string, signedHeaders: string, requestPayload: string): Promise<string> source

import {buildCanonicalRequest} from 'aws-sigv4/src/index.js'

Creates the canonical request https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

Params:

Name	Type	Attribute	Description
httpRequestMethod	string	nullable: false	The HTTP request method (e.g. `GET` or `POST`)
canonicalURI	string	nullable: false	The canonical URI
canonicalQueryString	string	nullable: false	The canonical query string
canonicalHeaders	string	nullable: false	The canonical headers
signedHeaders	string	nullable: false	The signed headers
requestPayload	string	nullable: false	The payload of the request

Return:

Promise<string>

The canonical request

public buildStringToSign(requestDate: string, credentialScope: string, hashedCanonicalRequest: string): string source

import {buildStringToSign} from 'aws-sigv4/src/index.js'

Creates the string to sign https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html

Params:

Name	Type	Attribute	Description
requestDate	string	nullable: false	The request date (`YYYMMDDThhmmssZ`)
credentialScope	string	nullable: false	the credential scope (formatted as `YYYYMMDD/region/service/aws4_request`)
hashedCanonicalRequest	string	nullable: false

Return:

string

The string to sign

public formatDateTime(date: Date): string source

import {formatDateTime} from 'aws-sigv4/src/index.js'

Formats a Date object to an AWS date string

Params:

Name	Type	Attribute	Description
date	Date	nullable: false	The date

Return:

string

The formatted date string

public async preCalculateSigningKey(secretAccessKey: string, date: string, region: string, service: string): Promise<string> source

import {preCalculateSigningKey} from 'aws-sigv4/src/index.js'

Pre-calculates the signing key https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html

Params:

Name	Type	Attribute	Description
secretAccessKey	string	nullable: false	The secret access key for the AWS account
date	string	nullable: false	The date in YYYYMMDD format
region	string	nullable: false	The AWS region (e.g. `us-east-1`)
service	string	nullable: false	The AWS service (e.g. `iam`)

Return:

Promise<string>

The pre-calculated signing key

public preCalculatedSign(signingKey: string, stringToSign: string): Promise<string> source

import {preCalculatedSign} from 'aws-sigv4/src/index.js'

Pre-calculates the signature https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html

Params:

Name	Type	Attribute	Description
signingKey	string	nullable: false	The pre-calculated signing key
stringToSign	string	nullable: false	The string to sign

Return:

Promise<string>

The pre-calculated signature

public async sign(secretAccessKey: string, date: string, region: string, service: string, stringToSign: string): Promise<string> source

import {sign} from 'aws-sigv4/src/index.js'

Calculates the signature https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html

Params:

Name	Type	Attribute	Description
secretAccessKey	string	nullable: false	The secret access key for the AWS account
date	string	nullable: false	The date in YYYYMMDD format
region	string	nullable: false	The AWS region (e.g. `us-east-1`)
service	string	nullable: false	The AWS service (e.g. `iam`)
stringToSign	string	nullable: false	The string to sign

Return:

Promise<string>

The signature