SignatureV4 | ApiGatewayManagementApi Client

Hierarchy

SignatureV4

Implements

Index

Constructors

constructor

Methods

presign
sign

Constructors

constructor

new SignatureV4(__namedParameters: { applyChecksum: undefined | false | true; credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>; region: string | Provider<string>; service: string; sha256: HashConstructor | ChecksumConstructor | (HashConstructor & ChecksumConstructor) | (ChecksumConstructor & HashConstructor); uriEscapePath: undefined | false | true }): SignatureV4

- Defined in packages/signature-v4/dist-types/SignatureV4.d.ts:49
Parameters
- __namedParameters: { applyChecksum: undefined | false | true; credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>; region: string | Provider<string>; service: string; sha256: HashConstructor | ChecksumConstructor | (HashConstructor & ChecksumConstructor) | (ChecksumConstructor & HashConstructor); uriEscapePath: undefined | false | true }
  - applyChecksum: undefined | false | true
  - credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>
  - region: string | Provider<string>
  - service: string
  - sha256: HashConstructor | ChecksumConstructor | (HashConstructor & ChecksumConstructor) | (ChecksumConstructor & HashConstructor)
  - uriEscapePath: undefined | false | true
Returns SignatureV4

Methods

presign

presign(originalRequest: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>

Implementation of RequestPresigner.presign
- Defined in packages/signature-v4/dist-types/SignatureV4.d.ts:51
Parameters
- originalRequest: HttpRequest
- Optional options: RequestPresigningArguments
Returns Promise<HttpRequest>

sign

sign(stringToSign: string, options?: SigningArguments): Promise<string>
sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>
sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>

Implementation of StringSigner.sign
- Defined in packages/signature-v4/dist-types/SignatureV4.d.ts:52
Parameters
- stringToSign: string
- Optional options: SigningArguments
Returns Promise<string>
Implementation of EventSigner.sign
- Defined in packages/signature-v4/dist-types/SignatureV4.d.ts:53
Parameters
- event: FormattedEvent
- options: EventSigningArguments
Returns Promise<string>
Implementation of RequestSigner.sign
- Defined in packages/signature-v4/dist-types/SignatureV4.d.ts:54
Parameters
- requestToSign: HttpRequest
- Optional options: RequestSigningArguments
Returns Promise<HttpRequest>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

applyChecksum: undefined | false | true

credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

region: string | Provider<string>

service: string

sha256: HashConstructor | ChecksumConstructor | (HashConstructor & ChecksumConstructor) | (ChecksumConstructor & HashConstructor)

uriEscapePath: undefined | false | true

Returns SignatureV4

Methods

presign

Parameters

originalRequest: HttpRequest

Optional options: RequestPresigningArguments

Returns Promise<HttpRequest>

sign

Parameters

stringToSign: string

Optional options: SigningArguments

Returns Promise<string>

Parameters

event: FormattedEvent

options: EventSigningArguments

Returns Promise<string>

Parameters

requestToSign: HttpRequest

Optional options: RequestSigningArguments

Returns Promise<HttpRequest>