Logo for jsDocs.io

@aws-sdk/middleware-signing

  • Version 3.296.0
  • Published
  • 37.4 kB
  • 6 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;

    Functions

    function awsAuthMiddleware

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

      function getAwsAuthPlugin

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

        function getSigV4AuthPlugin

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

          function resolveAwsAuthConfig

          resolveAwsAuthConfig: <T>(
              input: T & AwsAuthInputConfig & PreviouslyResolved
          ) => T & AwsAuthResolvedConfig;

            function resolveSigV4AuthConfig

            resolveSigV4AuthConfig: <T>(
                input: T & SigV4AuthInputConfig & SigV4PreviouslyResolved
            ) => T & SigV4AuthResolvedConfig;

              Interfaces

              interface AwsAuthInputConfig

              interface AwsAuthInputConfig {}

                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 signerConstructor

                signerConstructor?: new (
                    options: SignatureV4Init & SignatureV4CryptoInit
                ) => RequestSigner;

                • The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

                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 AwsAuthResolvedConfig

                interface AwsAuthResolvedConfig {}

                  property credentials

                  credentials: MemoizedProvider<AwsCredentialIdentity>;

                  property signer

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

                  property signingEscapePath

                  signingEscapePath: boolean;

                  property systemClockOffset

                  systemClockOffset: number;

                  interface SigV4AuthInputConfig

                  interface SigV4AuthInputConfig {}

                    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.

                    interface SigV4AuthResolvedConfig

                    interface SigV4AuthResolvedConfig extends AwsAuthResolvedConfig {}

                      Package Files (3)

                      Dependencies (6)

                      Dev Dependencies (6)

                      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>