> ## Documentation Index
> Fetch the complete documentation index at: https://docs.haiqu.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Credentials Helpers

### AWS credentials management

#### *static* Haiqu.save\_aws\_credentials(aws\_access\_key\_id, aws\_secret\_access\_key, aws\_default\_region='us-east-1', aws\_session\_token=None)

Save AWS credentials in the environment variables:

* "AWS\_ACCESS\_KEY\_ID"
* "AWS\_SECRET\_ACCESS\_KEY"
* "AWS\_DEFAULT\_REGION"
* "AWS\_SESSION\_TOKEN" (optional; required for temporary/STS credentials)

NOTE: overwrites existing environment variables with the same names.

* **Parameters:**
  * **aws\_access\_key\_id** (*str*) -- AWS access key ID.
  * **aws\_secret\_access\_key** (*str*) -- AWS secret access key.
  * **aws\_default\_region** (*str*) -- AWS default region. Defaults to "us-east-1".
  * **aws\_session\_token** (*Optional* \*\[\**str* *]*) -- AWS session token for temporary/STS credentials. Defaults to None.

#### *static* Haiqu.update\_aws\_credentials(options)

Inline update options dictionary with AWS credentails values:

* "aws\_access\_key\_id"
* "aws\_secret\_access\_key"
* "aws\_default\_region"
* "aws\_session\_token" (optional; required for temporary/STS credentials)

Priorities:

1. Implicit values in "options" dictionary.
2. Environment variables.
3. AWS credentials and config files.

* **Parameters:**
  **options** (*dict*) -- Backend options dictionary.

### IBM Quantum credentials management

#### *static* Haiqu.save\_ibm\_credentials(ibm\_quantum\_token, ibm\_quantum\_instance)

Save IBM Quantum API token and instance
using QiskitRuntimeService with the name "haiqu\_ibm\_account".
NOTE: overwrites existing account with the name "haiqu\_ibm\_account".

* **Parameters:**
  * **ibm\_quantum\_token** (*str*) -- IBM Quantum API token.
  * **ibm\_quantum\_instance** (*str*) -- IBM Quantum instance name.

#### *static* Haiqu.update\_ibm\_credentials(options)

Inline update options dictionary with IBM Quantum API token value "ibm\_quantum\_token".

Priorities:

1. Implicit value in "options" dictionary.
2. IBM Quantum config file.

* **Parameters:**
  **options** (*dict*) -- Options dictionary.