Skip to main content

aws-script-automation nvm version PyPI - Python Version

Scripting for AWS API configurations automation

Instalation

Use pip to make instalation:

pip install --user aws-sa

Loading documentation files to deploy

Just pass the file path in the argument:

aws-sa [filepath .json or .yaml]

Examples:

aws-sa file.yaml

or

aws-sa /home/user/Documents/file.json

Configuration

At the first time you need from AWS API key from IAM User.

Insert de values into the next steps:

AWS Access Key ID:<YOU_AWS_ID>

AWS Secret Access Key:<SECRET_KEY>

Default region name:<YOUR_REGION>

First step: Configure endpoints

  1. Insert the Authorization key and domain from endpoints:

    Insert Authorization key (example: asd09aus81923aas112): <AUTHORIZATION_KEY>

    Insert Domain (example: https://example.com): <DOMAIN_WITH_HTTP(S)>

  2. After insert the name from deploy:

    Insert Deploy Name [prod]: <DEPLOY_NAME>

The values ​​are stored if you want to use them later (bracketed value). If you want to use it, just press enter in the field.

Second step: Configure CloudWatch Group

  1. Insert the name from CloudWatch group:

    Insert CloudWatch Group [example]: <NAME_GROUP>

third step: Configure custom domain

  1. Select a custom domain using arrow keys.

  2. Insert value from Base path:

    Insert Base Path [v1]: <BASE_PATH>

Output

A documentation file with the same name as the imported file will be generated with the ending .prod.yaml.

Set name API

You can use different names from documentation file using:

aws-sa [file] --name [new_name]

Example:

aws-sa file.yaml --name test

Observation: You only can use this command on create, not permitted in merge or overwrite.

Use temporary region

You can use a temporary region into API using:

aws-sa [file] --region [region_name]

Example:

aws-sa file.yaml --region us-east-2

You can find the region values here.

Change Region

You can change the default region using:

aws configure set default.region [region]

Merge or overwrite documentation file

You can merge or overwrite a API with another documentation file using:

aws-sa [file] --id <ID_API> [--overwrite|--merge]

Configure automatically gateway-responses

You can configure automatically gateway-responses using:

aws-sa --id <ID_API> [--gateway-response]

Release files for aws-sa 1.3.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for aws-sa 1.3.9
File Interpreter ABI Platform
aws_sa-1.3.9-py3-none-any.whl Python 3 none any Details

Release files / aws_sa-1.3.9-py3-none-any.whl

Download URL aws_sa-1.3.9-py3-none-any.whl
Size 10.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6601dc937e5b29d771f33e7876a4e1069f75382a07f391d01cdcd5abe43a0abc
BLAKE2b-256 checksum
How to use checksums
6267bc7d18ebdb775e5b9fcfce04f5aece6d440fcf4c0ef1631bfd3c4854a050
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

Release history Release notifications | RSS feed

This release

1.3.9 This release

1 release file

1.3.8

1 release file

1.3.7

1 release file

1.3.6

1 release file

1.3.5

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.9

1 release file

1.2.8

1 release file

1.2.7

1 release file

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.9

1 release file

1.1.8

1 release file

1.1.7

1 release file

1.1.6

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page