cloudenv / server /providers /aws /API_DOCS.md
Vishvam10
initial space commit
b404de3
|
Raw History Blame Contribute Delete
2.88 kB

AWS provider API docs

POST /step (CloudEnvAction)

The environment step endpoint expects a JSON body matching CloudEnvAction:

Field Description
service AWS service id (boto3 client name, same as IAM prefix)
operation PascalCase operation name
payload Boto3 request parameters for that operation
intent Optional string for higher-level agent hints

Markdown per service

Service (enum / IAM prefix) Documentation file
s3 s3_api.md
sqs sqs_api.md
sns sns_api.md
dynamodb dynamodb_api.md
lambda lambda_api.md
iam iam_api.md
sts sts_api.md
secretsmanager secretsmanager_api.md
logs (CloudWatch Logs) logs_api.md
events (EventBridge) events_api.md
kinesis kinesis_api.md
cloudwatch cloudwatch_api.md
ssm ssm_api.md
stepfunctions stepfunctions_api.md
firehose firehose_api.md
ec2 ec2_api.md
rds rds_api.md
elasticache elasticache_api.md
ecs ecs_api.md
route53 route53_api.md
apigateway apigateway_api.md
apigatewayv2 apigatewayv2_api.md
cognito-idp cognito-idp_api.md
cognito-identity cognito-identity_api.md
ses ses_api.md
sesv2 sesv2_api.md
acm acm_api.md
wafv2 wafv2_api.md
glue glue_api.md
athena athena_api.md

OpenAPI 3.0 (Insomnia / Yaak)

Import openapi.yaml. There is a single path POST /step; operations are grouped by example name {service}__{operation} and summary [service] Operation, with service-level tags (aws.s3, aws.lambda, …) for navigation in tools that support tag metadata.

Regenerate docs

Canonical operation lists and explicit service classes:

python scripts/generate_explicit_aws_services.py

Regenerate Markdown curl examples, server/actions/*, and openapi.yaml from *_service.py + botocore:

pip install boto3 pyyaml
python scripts/generate_aws_api_docs.py

Older script generate_service_api_md.py is superseded by generate_aws_api_docs.py for curl/OpenAPI/action enums.

Operation names also appear in operations_data.py.