SignAwsRequestOptions
Options for signAwsRequestHeaders.
Defined in: src/utils/aws/sigv4.ts:103
Options for signAwsRequestHeaders.
Extends
SigV4BaseOptions
Properties
| Property | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
body? | string | Uint8Array<ArrayBufferLike> | empty body | Request payload. | - | src/utils/aws/sigv4.ts:113 |
credentials | AwsCredentials | undefined | Credentials to sign with. | SigV4BaseOptions.credentials | src/utils/aws/sigv4.ts:93 |
date? | Date | undefined | Signing time. Defaults to new Date(); injectable for deterministic tests. | SigV4BaseOptions.date | src/utils/aws/sigv4.ts:97 |
headers? | Record<string, string> | undefined | Headers to include in the signature, in addition to host and x-amz-date (which are always signed). Values must match the headers actually sent on the request byte-for-byte. | - | src/utils/aws/sigv4.ts:111 |
method? | string | 'POST' | HTTP method (e.g. 'POST'). | - | src/utils/aws/sigv4.ts:105 |
region | string | undefined | AWS region used in the credential scope (e.g. 'us-east-1'). | SigV4BaseOptions.region | src/utils/aws/sigv4.ts:91 |
service | string | undefined | AWS service identifier used in the credential scope (e.g. 'polly', 'transcribe'). | SigV4BaseOptions.service | src/utils/aws/sigv4.ts:89 |
url | string | undefined | Full request URL including any query string. | SigV4BaseOptions.url | src/utils/aws/sigv4.ts:87 |