docs(platform): ou scp examples (#93)

Levence · web-flow · commit 3000ba985036 · 2023-08-09T15:53:26.000+10:00
* docs(platform): ou scp examples
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,11 +12,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clone Repository
-        uses: actions/checkout@master
-      - name: Setup Python 3.6
-        uses: actions/setup-python@v1
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+      - name: Setup Python 3.9
+        uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1
         with:
-          python-version: '3.6'
+          python-version: '3.9'
       - name: Install dependencies
         run: make install
       - name: Run tests
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -10,11 +10,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clone Repository
-        uses: actions/checkout@master
-      - name: Setup Python 3.6
-        uses: actions/setup-python@v1
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+      - name: Setup Python 3.9
+        uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1
         with:
-          python-version: '3.6'
+          python-version: '3.9'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -24,12 +24,12 @@ jobs:
           pipenv run python setup.py sdist bdist_wheel
       - name: Publish distribution 📦 to Test PyPI
         if: github.event.release.prerelease == true
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@f8c70e705ffc13c3b4d1221169b84f12a75d6ca8
         with:
           password: ${{ secrets.TEST_PYPI_PASSWORD }}
           repository_url: https://test.pypi.org/legacy/
       - name: Publish distribution 📦 to PyPI
         if: github.event.release.prerelease != true
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@f8c70e705ffc13c3b4d1221169b84f12a75d6ca8
         with:
-          password: ${{ secrets.PYPI_PASSWORD }}
+          password: ${{ secrets.PYPI_PASSWORD }}
diff --git a/examples/account_types/update_policies.py b/examples/account_types/update_policies.py
diff --git a/examples/accounts/read_account_policies.py b/examples/accounts/read_account_policies.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The account to read policies for
+account_id = <Account Id>
+
+# Read the account policies
+accounts = StaxClient("accounts")
+response = accounts.ReadAccountPolicyAttachments(
+    account_id=account_id
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/create_organisational_unit.py b/examples/organisational_units/create_organisational_unit.py
@@ -0,0 +1,23 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+organisational_unit_name = <Organisational Unit Name>
+parent_organisational_unit_id = <Parent Organisational Unit Id>
+tags = {
+    "CostCode": "12345"
+}
+
+# Create the organisational unit
+organisations = StaxClient("organisations")
+response = organisations.CreateOrganisationalUnit(
+    Name=organisational_unit_name,
+    ParentOrganisationalUnitId=parent_organisational_unit_id,
+    Tags=tags,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/delete_organisational_unit.py b/examples/organisational_units/delete_organisational_unit.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The organisational unit to be deleted
+organisational_unit_id = <Organisational Unit Id>
+
+# Delete the organisational unit
+organisations = StaxClient("organisations")
+response = organisations.DeleteOrganisationalUnit(
+    organisational_unit_id=organisational_unit_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/read_organisational_unit.py b/examples/organisational_units/read_organisational_unit.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The organisational unit to be read
+organisational_unit_id = <Organisational Unit Id>
+
+# Read the organisational unit
+organisations = StaxClient("organisations")
+response = organisations.ReadOrganisationalUnit(
+    organisational_unit_id=organisational_unit_id
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/read_organisational_unit_accounts.py b/examples/organisational_units/read_organisational_unit_accounts.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The organisational unit to read accounts for
+organisational_unit_id = <Organisational Unit Id>
+
+# Read the organisational unit accounts
+organisations = StaxClient("organisations")
+response = organisations.ReadOrganisationalUnitAccounts(
+    organisational_unit_id=organisational_unit_id
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/read_organisational_unit_policies.py b/examples/organisational_units/read_organisational_unit_policies.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The organisational unit to read policies for
+organisational_unit_id = <Organisational Unit Id>
+
+# Read the organisational unit policies
+organisations = StaxClient("organisations")
+response = organisations.ReadOrganisationalUnitPolicyAttachments(
+    organisational_unit_id=organisational_unit_id
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/read_organisational_units.py b/examples/organisational_units/read_organisational_units.py
@@ -0,0 +1,13 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# Read all organisational units within your Stax Organisation
+organisations = StaxClient("organisations")
+response = organisations.ReadOrganisationalUnits()
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/organisational_units/update_organisational_unit.py b/examples/organisational_units/update_organisational_unit.py
@@ -0,0 +1,25 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The organisational unit to be updated
+organisational_unit_id = <Organisational Unit Id>
+
+organisational_unit_name = <Organisational Unit Name>
+tags = {
+    "CostCode": "12345"
+}
+
+# Update the organisational unit
+organisations = StaxClient("organisations")
+response = organisations.UpdateOrganisationalUnit(
+    organisational_unit_id=organisational_unit_id,
+    Name=organisational_unit_name,
+    Tags=tags,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/attach_organisation_policy.py b/examples/policy/attach_organisation_policy.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to be attached
+policy_id = <Policy Id>
+
+# Attach a policy to the organisation
+organisations = StaxClient("organisations")
+response = organisations.AttachPolicy(
+    policy_id=policy_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/attach_policy.py b/examples/policy/attach_policy.py
@@ -0,0 +1,31 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to be attached
+policy_id = <Policy Id>
+
+# The target to attach the Policy to
+account_id = <Account Id>
+organisational_unit_id = <Organisational Unit Id>
+
+# Attach a policy to the Account
+policies = StaxClient("policies")
+response = policies.AttachPolicy(
+    policy_id=policy_id,
+    AccountId=account_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
+
+# Attach a policy to the Organisational Unit
+policies = StaxClient("policies")
+response = policies.AttachPolicy(
+    policy_id=policy_id,
+    OrganisationalUnitId=organisational_unit_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/create_policy.py b/examples/policy/create_policy.py
@@ -8,16 +8,18 @@
 Config.secret_key = os.getenv("STAX_SECRET_KEY")
 
 policy_name = <Policy Name>
-
 policy_description = <Policy Description>
-
-policy = <Policy Json>
+policy = <Policy Json String>
+tags = {
+    "CostCode": "12345"
+}
 
 # Create a policy
 organisations = StaxClient("organisations")
 response = organisations.CreatePolicy(
-		Name=policy_name,
-		Description=policy_description,
-		Policy=policy
+    Name=policy_name,
+    Description=policy_description,
+    Policy=policy,
+    Tags=tags,
 )
 print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/delete_policy.py b/examples/policy/delete_policy.py
@@ -12,6 +12,6 @@
 # Delete a policy
 organisations = StaxClient("organisations")
 response = organisations.DeletePolicy(
-	policy_id = policy_id,
+    policy_id = policy_id,
 )
 print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/detach_organisation_policy.py b/examples/policy/detach_organisation_policy.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to be detached
+policy_id = <Policy Id>
+
+# Detach a policy from the organisation
+organisations = StaxClient("organisations")
+response = organisations.DetachPolicy(
+    policy_id=policy_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/detach_policy.py b/examples/policy/detach_policy.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy attachment to be detached
+policy_attachment_id = <Policy Attachment Id>
+
+# Detach a policy attachment
+policies = StaxClient("policies")
+response = policies.DetachPolicy(
+    policy_attachment_id=policy_attachment_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/read_policy.py b/examples/policy/read_policy.py
@@ -0,0 +1,16 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to be read
+policy_id = <Policy Id>
+
+# Read the Policy
+organisations = StaxClient("organisations")
+response = organisations.ReadPolicies(policy_id=policy_id)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/read_policy_attachments.py b/examples/policy/read_policy_attachments.py
@@ -0,0 +1,18 @@
+import json
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to list attachments for
+policy_id = <Policy Id>
+
+# Read the policy attachments for the policy
+policies = StaxClient("policies")
+response = policies.ReadPolicyAttachments(
+    policy_id=policy_id,
+)
+print(json.dumps(response, indent=4, sort_keys=True))
diff --git a/examples/policy/update_policy.py b/examples/policy/update_policy.py
diff --git a/staxapp/aws_srp.py b/staxapp/aws_srp.py
diff --git a/staxapp/openapi.py b/staxapp/openapi.py
