IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    A SigV4-compatible signer for S3 service. In order to support SigV4a algorithm according to the operation input dynamically, the signer wraps native module SigV4a signer and JS SigV4 signer. It signs the request with SigV4a algorithm if the request needs to be signed with * region. Otherwise, it signs the request with normal SigV4 signer.

    Implements

    • RequestPresigner
    • RequestSigner
    Index

    Constructors

    Methods

    • Returns "none" | "js" | "crt"

    • Sign the provided request for immediate dispatch.

      Parameters

      • requestToSign: HttpRequest
      • options: RequestSigningArguments = {}

      Returns Promise<HttpRequest>

    • Sign with alternate credentials to the ones provided in the constructor. Note: This is only supported for SigV4a when using the CRT implementation.

      Parameters

      • requestToSign: HttpRequest
      • credentials: AwsCredentialIdentity
      • options: RequestSigningArguments = {}

      Returns Promise<HttpRequest>

    • Presign a request. Note: This is only supported for SigV4a when using the CRT implementation.

      Parameters

      • originalRequest: HttpRequest
      • options: RequestPresigningArguments = {}

      Returns Promise<HttpRequest>

    • Parameters

      • originalRequest: HttpRequest
      • credentials: AwsCredentialIdentity
      • options: RequestPresigningArguments = {}

      Returns Promise<HttpRequest>