AuthAws Rust 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

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::AuthAws;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let auth_aws = AuthAws::new();
// ... the native object is freed when `auth_aws` goes out of scope.

pub fn new() -> AuthAws

Creates the underlying native Chilkat object (AuthAws also implements Default). Every method takes &self, so the object never needs to be declared mut. A AuthAws is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for AuthAws

The native object is freed when the AuthAws is dropped — when it goes out of scope, or explicitly with drop(auth_aws). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<AuthAws>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match auth_aws.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

AccessKey

// read/write
pub fn access_key(&self) -> String
pub fn set_access_key(&self, value: &str)

Introduced in version 9.5.0.58

The AWS access key.

AuthAws Rust 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