Skip to content

FAQ Update #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2025
+21 −0
Merged

FAQ Update #665

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a79a53
update how to get error message
xiazhvera Oct 10, 2025
449ecc7
update section title
xiazhvera Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions documents/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*__Jump To:__*
* [Where should I start](#where-should-i-start)
* [How do I enable logging](#how-do-i-enable-logging)
* [How do I get more information from an error code](#how-do-i-get-more-information-from-an-error-code)
* [Installation Issues](#installation-issues)
* [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup)
* [I am experiencing deadlocks](#i-am-experiencing-deadlocks)
Expand All @@ -26,6 +27,26 @@ io.init_logging(io.LogLevel.Error, 'stderr')
```
You can also enable [CloudWatch logging](https://docs.aws.amazon.com/iot/latest/developerguide/cloud-watch-logs.html) for IoT which will provide you with additional information that is not available on the client side sdk.

### How do I get more information from an error code?

When you encounter an `AwsCrtError`, you can get error details using `str()` or `repr()`:

```python
try:
# Your AWS IoT code here
pass
except Exception as e:
print(f"Error: {e}") # Using str()
print(f"Error: {repr(e)}") # Using repr() for more details
```

**Example output:**
```
# Assume we got error 1059, AWS_IO_DNS_INVALID_NAME
Error: AWS_IO_DNS_INVALID_NAME: Host name was invalid for dns resolution."
Error: AwsCrtError(name='AWS_IO_DNS_INVALID_NAME', message='Host name was invalid for dns resolution.', code=1059)
```

### Installation Issues

`awsiotsdk` depends on [awscrt](https://github.com/awslabs/aws-crt-python), which makes use of C extensions. Precompiled wheels are downloaded when installing on major platforms (Mac, Windows, Linux, Raspberry Pi OS). If wheels are unavailable for your platform, your machine must compile some C libraries. For example:
Expand Down