DOC: aws module can raise a lot of exceptions

See #36
MartinThoma · Aug 3, 2018 · 2c6c653 · 2c6c653
1 parent 38df72c
commit 2c6c653
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/mpu/aws.py b/mpu/aws.py
@@ -47,6 +47,14 @@ def s3_download(source, destination, profile_name=None):
     destination : str
     profile_name : str, optional
         AWS profile
+
+    Raises
+    ------
+    botocore.exceptions.NoCredentialsError
+        Botocore is not able to find your credentials. Either specify
+        profile_name or add the environment variables AWS_ACCESS_KEY_ID,
+        AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN.
+        See https://boto3.readthedocs.io/en/latest/guide/configuration.html
     """
     session = boto3.Session(profile_name=profile_name)
     s3 = session.resource('s3')