summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/cloud/amazon/GUIDELINES.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/cloud/amazon/GUIDELINES.md')
-rw-r--r--lib/ansible/modules/cloud/amazon/GUIDELINES.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/ansible/modules/cloud/amazon/GUIDELINES.md b/lib/ansible/modules/cloud/amazon/GUIDELINES.md
index 3a0cfc4767..36267ba8c0 100644
--- a/lib/ansible/modules/cloud/amazon/GUIDELINES.md
+++ b/lib/ansible/modules/cloud/amazon/GUIDELINES.md
@@ -352,6 +352,21 @@ Ansible format, this function will convert the keys to snake_case.
Converts a an Ansible list of filters to a boto3 friendly list of dicts. This is useful for any
boto3 `_facts` modules.
+### boto_exception
+
+Pass an exception returned from boto or boto3, and this function will consistently get the message from the exception.
+
+```
+import traceback
+from ansible.module_utils.ec2 import boto_exception
+try:
+ ...
+except boto.exception.BotoServerError as err:
+ error_msg = boto_exception(err)
+ module.fail_json(msg=error_msg, exception=traceback.format_exc())
+```
+
+
#### boto3_tag_list_to_ansible_dict
Converts a boto3 tag list to an Ansible dict. Boto3 returns tags as a list of dicts containing keys