aws-sdk-js-v3 icon indicating copy to clipboard operation
aws-sdk-js-v3 copied to clipboard

signature-v4 misses README doc

Open AllanZhengYP opened this issue 3 years ago • 2 comments

Describe the issue with documentation

We suggests users to consume standalone package @aws-sdk/signature-v4 for signing any request with Signature v4 algorithm. But it doesn't provide any README doc

Expected behavior

The package should include a doc demonstrating signing a basic request.

AllanZhengYP avatar May 17 '22 20:05 AllanZhengYP

  // Create the HTTP request
var request = new HttpRequest({
    body: JSON.stringify(document),
    headers: {
        'Content-Type': 'application/json',
        'host': domain
    },
    hostname: domain,
    method: 'PUT',
    path: 'path'
});
    
// Sign the request
var signer = new SignatureV4({
    credentials: defaultProvider(),
    region: region,
    service: 'es',
    sha256: Sha256
});

var signedRequest = await signer.sign(request);

ajredniwja avatar May 23 '22 14:05 ajredniwja

@ajredniwja where will we get Sha256 in react native?

ShivamJoker avatar Jan 30 '23 17:01 ShivamJoker

Users can refer to smithy package or API reference guide. Closing issue.

aBurmeseDev avatar Jun 19 '25 00:06 aBurmeseDev

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.

github-actions[bot] avatar Jun 19 '25 00:06 github-actions[bot]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

github-actions[bot] avatar Jul 04 '25 00:07 github-actions[bot]