diff docs/introduction.rst @ 282:da1596034954

Implemented an "AWS" namespace to retrieve some AWS-specific metadata
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 07 Dec 2020 01:06:33 +0100
parents af371f9c016d
children 28aa21095a68
line wrap: on
line diff
--- a/docs/introduction.rst	Mon Oct 05 09:25:11 2020 +0200
+++ b/docs/introduction.rst	Mon Dec 07 01:06:33 2020 +0100
@@ -293,6 +293,23 @@
      ``implementation``
          The return value of :py:func:`platform.python_implementation`
 
+5. The namespace ``AWS``
+
+   Contains some metadata for AWS instances when running from within
+   AWS:
+
+     ``metadata.instance-id``
+
+     ``metadata.placement.region``
+
+     ``metadata.placement.availability-zone``
+
+     ``dynamic.instance-identity.region``
+       and all other properties of the instance-identity document
+       (e.g. ``instanceId``, ``instanceType``, ``imageId``, ``pendingTime``,
+       ``architecture``, ``availabilityZone``, ``privateIp``, ``version``
+       et al.).
+
 
 Examples
 ~~~~~~~~