Logo for jsDocs.io

@aws-sdk/middleware-signing

  • Version 3.734.0
  • Published
  • 42.3 kB
  • 7 dependencies
  • Apache-2.0 license

Install

npm i @aws-sdk/middleware-signing
yarn add @aws-sdk/middleware-signing
pnpm add @aws-sdk/middleware-signing

Overview

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-signing/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-signing) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-signing.svg)](https://www.npmjs.com/packag

Index

Variables

Functions

Interfaces

Variables

variable awsAuthMiddlewareOptions

const awsAuthMiddlewareOptions: RelativeMiddlewareOptions;

  • Deprecated

    only used in legacy auth.

Functions

function awsAuthMiddleware

awsAuthMiddleware: <Input extends object, Output extends object>(
    options: AwsAuthResolvedConfig
) => FinalizeRequestMiddleware<Input, Output>;

  • Deprecated

    only used in legacy auth.

function getAwsAuthPlugin

getAwsAuthPlugin: (options: AwsAuthResolvedConfig) => Pluggable<any, any>;

  • Deprecated

    only used in legacy auth.

function getSigV4AuthPlugin

getSigV4AuthPlugin: (options: AwsAuthResolvedConfig) => Pluggable<any, any>;

  • Deprecated

    only used in legacy auth.

Interfaces

interface AwsAuthInputConfig

interface AwsAuthInputConfig {}

  • Modifiers

    • @public

    Deprecated

    only used in legacy auth.

property credentials

credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>;

  • The credentials used to sign requests.

property signer

signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>);

  • The signer to use when signing requests.

property signingEscapePath

signingEscapePath?: boolean;

  • Whether to escape request path when signing the request.

property signingRegion

signingRegion?: string;

  • The region where you want to sign your request against. This can be different to the region in the endpoint.

property systemClockOffset

systemClockOffset?: number;

  • An offset value in milliseconds to apply to all signing times.

interface SigV4AuthInputConfig

interface SigV4AuthInputConfig {}

  • Modifiers

    • @public

    Deprecated

    only used in legacy auth.

property credentials

credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>;

  • The credentials used to sign requests.

property signer

signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>);

  • The signer to use when signing requests.

property signingEscapePath

signingEscapePath?: boolean;

  • Whether to escape request path when signing the request.

property systemClockOffset

systemClockOffset?: number;

  • An offset value in milliseconds to apply to all signing times.

Package Files (3)

Dependencies (7)

Dev Dependencies (5)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-sdk/middleware-signing.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-sdk/middleware-signing)
  • HTML
    <a href="https://www.jsdocs.io/package/@aws-sdk/middleware-signing"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>