---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: AuthAws
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_AuthAwsRef.html
---
# Chilkat AuthAws — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=AuthAws
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/AuthAws.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/guide.md`.

## Purpose

**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](https://www.chilkatsoft.com/authaws_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```sql
DECLARE @hr int
DECLARE @authAws int
EXEC @hr = sp_OACreate 'Chilkat.AuthAws', @authAws OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @authAws ...

EXEC @hr = sp_OADestroy @authAws
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.AuthAws.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @authAws, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `EXEC sp_OAGetProperty @authAws, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @authAws, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @authAws, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @authAws, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @authAws, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @authAws, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @authAws, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @authAws, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @authAws, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @authAws, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @authAws, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @authAws, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @authAws, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessKey` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'AccessKey', @sValue OUT EXEC sp_OASetProperty @authAws, 'AccessKey', @sValue` |
| `CanonicalizedResourceV2` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'CanonicalizedResourceV2', @sValue OUT EXEC sp_OASetProperty @authAws, 'CanonicalizedResourceV2', @sValue` |
| `EnableSecrets` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'EnableSecrets', @iValue OUT EXEC sp_OASetProperty @authAws, 'EnableSecrets', @iValue` |
| `PrecomputedMd5` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'PrecomputedMd5', @sValue OUT EXEC sp_OASetProperty @authAws, 'PrecomputedMd5', @sValue` |
| `PrecomputedSha256` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'PrecomputedSha256', @sValue OUT EXEC sp_OASetProperty @authAws, 'PrecomputedSha256', @sValue` |
| `Region` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'Region', @sValue OUT EXEC sp_OASetProperty @authAws, 'Region', @sValue` |
| `SecretKey` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'SecretKey', @sValue OUT EXEC sp_OASetProperty @authAws, 'SecretKey', @sValue` |
| `ServiceName` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'ServiceName', @sValue OUT EXEC sp_OASetProperty @authAws, 'ServiceName', @sValue` |
| `SignatureVersion` | property, read/write | `EXEC sp_OAGetProperty @authAws, 'SignatureVersion', @iValue OUT EXEC sp_OASetProperty @authAws, 'SignatureVersion', @iValue` |
| `GenPresignedUrl` | method | `EXEC sp_OAMethod @authAws, 'GenPresignedUrl', @sResult OUT, @httpVerb, @useHttps, @domain, @path, @numSecondsValid, @awsService` |

## Properties

### AuthAws.AccessKey

`Chilkat 11.7.0 · sqlserver · AuthAws · AccessKey · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'AccessKey', @sValue OUT
EXEC sp_OASetProperty @authAws, 'AccessKey', @sValue
```

The AWS access key.

### AuthAws.CanonicalizedResourceV2

`Chilkat 11.7.0 · sqlserver · AuthAws · CanonicalizedResourceV2 · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'CanonicalizedResourceV2', @sValue OUT
EXEC sp_OASetProperty @authAws, 'CanonicalizedResourceV2', @sValue
```

If AWS Signature Version V2 is used, then this property must be set. The rules for setting the canonicalized resource for the V2 signature method is described here: [Constructing the CanonicalizedResource Element](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html#ConstructingTheCanonicalizedResourceElement).

### AuthAws.EnableSecrets

`Chilkat 11.7.0 · sqlserver · AuthAws · EnableSecrets · property · read/write · since 11.5.0`

```sql
EXEC sp_OAGetProperty @authAws, 'EnableSecrets', @iValue OUT
EXEC sp_OASetProperty @authAws, 'EnableSecrets', @iValue
```

If `1` a secret specifier of the format "!!part1\|part2\|.." can be provided instead of the actual value for the AccessKey and SecretKey properties.

The default value is `0`.

### AuthAws.PrecomputedMd5

`Chilkat 11.7.0 · sqlserver · AuthAws · PrecomputedMd5 · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'PrecomputedMd5', @sValue OUT
EXEC sp_OASetProperty @authAws, 'PrecomputedMd5', @sValue
```

This property can optionally be set for AWS requests that have a non-empty request body. This should be the base64 encoding of the 16 bytes of the MD5 hash. The most common need for this is if doing an S3 upload from a stream. (If the pre-computed MD5 is not provided, then Chilkat is forced to stream the entire file into memory so that it can calculate the MD5 for authentication.)

**Note:** AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses SHA256.

### AuthAws.PrecomputedSha256

`Chilkat 11.7.0 · sqlserver · AuthAws · PrecomputedSha256 · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'PrecomputedSha256', @sValue OUT
EXEC sp_OASetProperty @authAws, 'PrecomputedSha256', @sValue
```

This property can optionally be set for AWS requests that have a non-empty request body. This should be the lowercase hex encoding of the 32-bytes of the SHA256 hash. The most common need for this is if doing an S3 upload from a stream. (If the pre-computed SHA-256 is not provided, then Chilkat is forced to stream the entire file into memory so that it can calculate the SHA-256 for authentication.)

**Note:** AWS Signature Version 4 uses the SHA256 hash. (AWS Signature Version 2 uses MD5)

### AuthAws.Region

`Chilkat 11.7.0 · sqlserver · AuthAws · Region · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'Region', @sValue OUT
EXEC sp_OASetProperty @authAws, 'Region', @sValue
```

The AWS region, such as `us-east-1`, `us-west-2`, `eu-west-1`, `eu-central-1`, etc. The default is `us-east-1`. It is only used when the SignatureVersion property is set to 4. This property is unused when the SignatureVersion property is set to 2.

### AuthAws.SecretKey

`Chilkat 11.7.0 · sqlserver · AuthAws · SecretKey · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'SecretKey', @sValue OUT
EXEC sp_OASetProperty @authAws, 'SecretKey', @sValue
```

The AWS secret key.

### AuthAws.ServiceName

`Chilkat 11.7.0 · sqlserver · AuthAws · ServiceName · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'ServiceName', @sValue OUT
EXEC sp_OASetProperty @authAws, 'ServiceName', @sValue
```

The AWS service namespace, such as `s3`, `ses`, etc. See http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

This property is unused when the SignatureVersion property is set to 2.

### AuthAws.SignatureVersion

`Chilkat 11.7.0 · sqlserver · AuthAws · SignatureVersion · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAws, 'SignatureVersion', @iValue OUT
EXEC sp_OASetProperty @authAws, 'SignatureVersion', @iValue
```

The AWS Signature Version to be used in authentication. The default value is 4. This can optionally be set to the value 2 to use the older V2 signature version.

## Methods

### AuthAws.GenPresignedUrl

`Chilkat 11.7.0 · sqlserver · AuthAws · GenPresignedUrl · method · since 9.5.0.85`

```sql
EXEC sp_OAMethod @authAws, 'GenPresignedUrl', @sResult OUT, @httpVerb, @useHttps, @domain, @path, @numSecondsValid, @awsService
```

Generates a temporary pre-signed URL for an Amazon AWS service using AWS Signature V4. Requires that the SecretKey, AccessKey, and Region properties be set to valid values prior to calling this method.

The URL that is generated has this format:

```
https://<domain>/<path>
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=<AccessKey>/<currentDate>/<Region>/<awsService>/aws4_request
&X-Amz-Date=<currentDateTime>
&X-Amz-Expires=<numSecondsValid>
&X-Amz-SignedHeaders=host
&X-Amz-Signature=<signature-value>
```

The `httpVerb` is the HTTP verb such as `GET`, `PUT`, `POST`, `DELETE`, etc. The `awsService` is a string naming the AWS service, such as `s3`, `execute-api`, etc. If `useHttps` is `1`, then the returned URL begins with `https://`, otherwise it begins with `http://`.

**Note:** It is generally not feasible to use pre-signed URLs for `POST` operations for any AWS service except for `S3`. See [AWS Pre-Signed URLs for POST Operations (non-S3)](https://www.chilkatsoft.com/aws_pre_signed_urls_for_post_operations.asp)

Returns `NULL` on failure

