AuthAws React Native Reference Documentation

AuthAws

Current Version: 11.6.1

Chilkat.AuthAws

Configure AWS request signing for REST calls and temporary pre-signed URLs.

Chilkat.AuthAws holds the AWS authentication settings used by Chilkat.Rest when sending signed AWS requests. It supports AWS Signature Version 4 by default, can optionally use the older Signature Version 2 where applicable, accepts direct credential values or secure secret specifiers, and can generate temporary Signature V4 pre-signed URLs for AWS services.

REST authentication object

Provide AWS signing settings to Chilkat.Rest so outgoing requests are authenticated according to AWS requirements.

Signature Version 4

Sign requests using AWS Signature Version 4, including service, region, credentials, headers, and request payload details.

Credentials and secrets

Use access keys and secret keys directly, or use secret specifiers when credentials should be resolved from a secure credential source.

Region and service targeting

Configure the AWS region and service name so signatures are generated for the correct AWS endpoint.

Temporary credentials

Include session tokens when signing requests with temporary AWS credentials from STS, IAM roles, or similar credential flows.

Pre-signed URLs

Generate temporary Signature V4 pre-signed URLs when a client needs limited-time access without sending AWS credentials.

Common pattern: Create and configure an AuthAws object with the AWS access key, secret key or secret specifier, region, service name, and optional session token, then pass it to Chilkat.Rest before sending the request. Use AuthAws for AWS request signing; use service-specific Chilkat classes or Chilkat.Http/Chilkat.Rest for constructing and sending the actual API request.

For an extended overview, see AuthAws Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, AuthAws } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const authAws = new AuthAws()
// ... the native object is released when `authAws` is garbage collected, or now with authAws.dispose()

new AuthAws()

Creates the underlying native Chilkat object. AuthAws is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  authAws.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // AuthAws.someMethod(...): <reason>
  console.log(authAws.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await authAws.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // AuthAws.someMethodAsync: <reason>
}

Properties

AccessKey

// read/write
accessKey: string

Introduced in version 9.5.0.58

The AWS access key.

AuthAws React Native Reference Documentation

AuthAws

Current Version: 11.6.1

Configure AWS request signing for REST calls and temporary pre-signed URLs.

REST authentication object

Signature Version 4

Credentials and secrets

Region and service targeting

Temporary credentials

Pre-signed URLs

Object Creation

Errors

Properties

AccessKey

CanonicalizedResourceV2

DebugLogFilePath

EnableSecrets

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

PrecomputedMd5

PrecomputedSha256

Region

SecretKey

ServiceName

SignatureVersion

VerboseLogging

Version

Methods

GenPresignedUrl