Skip to content

add output pane to all aws service docs #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/content/docs/aws/services/account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,7 @@ Run the following command to fetch the contact information for your account:
awslocal account get-contact-information
```

The command will return the contact information for your account:

```json
```bash title="Output"
{
"ContactInformation": {
"AddressLine1": "XXXX Main St",
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/aws/services/acm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ awslocal acm request-certificate \

This command will return the Amazon Resource Name (ARN) of the new certificate, which you can use in other ACM commands.

```json
```bash title="Output"
{
"CertificateArn": "arn:aws:acm:<region>:000000000000:certificate/<certificate_ID>"
}
Expand Down
12 changes: 3 additions & 9 deletions src/content/docs/aws/services/apacheflink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,7 @@ awslocal kinesisanalyticsv2 add-application-cloud-watch-logging-option \
--cloud-watch-logging-option '{"LogStreamARN": "arn:aws:logs:us-east-1:000000000000:log-group:msaf-log-group:log-stream:msaf-log-stream"}'
```

The response will be similar to:

```json
```bash title="Output"
{
"ApplicationARN": "arn:aws:kinesisanalytics:us-east-1:000000000000:application/msaf-app",
"ApplicationVersionId": 2,
Expand All @@ -202,9 +200,7 @@ Configured logging options can be retrieved using [DescribeApplication](https://
awslocal kinesisanalyticsv2 describe-application --application-name msaf-app | jq .ApplicationDetail.CloudWatchLoggingOptionDescriptions
```

The response will be similar to:

```json
```bash title="Output"
[
{
"CloudWatchLoggingOptionId": "1.1",
Expand Down Expand Up @@ -242,9 +238,7 @@ awslocal kinesisanalyticsv2 list-tags-for-resource \
--resource-arn arn:aws:kinesisanalytics:us-east-1:000000000000:application/msaf-app
```

The response will be similar to:

```json
```bash title="Output"
{
"Tags": [
{
Expand Down
33 changes: 9 additions & 24 deletions src/content/docs/aws/services/apigateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ awslocal apigateway create-rest-api --name 'API Gateway Lambda integration'
```

This creates a new REST API named `API Gateway Lambda integration`.
The above command returns the following response:

```json
```bash title="Output"
{
"id": "cor3o5oeci",
"name": "API Gateway Lambda integration",
Expand All @@ -102,9 +101,7 @@ Use the REST API ID generated in the previous step to fetch the resources for th
awslocal apigateway get-resources --rest-api-id <REST_API_ID>
```

The above command returns the following response:

```json
```bash title="Output"
{
"items": [
{
Expand All @@ -130,9 +127,7 @@ awslocal apigateway create-resource \
--path-part "{somethingId}"
```

The above command returns the following response:

```json
```bash title="Output"
{
"id": "zzcvcf56ar",
"parentId": "u53af9hm83",
Expand All @@ -158,9 +153,7 @@ awslocal apigateway put-method \
--authorization-type "NONE"
```

The above command returns the following response:

```json
```bash title="Output"
{
"httpMethod": "GET",
"authorizationType": "NONE",
Expand Down Expand Up @@ -204,9 +197,7 @@ You can use [curl](https://curl.se/) or any HTTP REST client to invoke the API e
curl -X GET http://<REST_API_ID>.execute-api.localhost.localstack.cloud:4566/dev/test
```

The response would be:

```json
```bash title="Output"
{"message":"Hello World"}
```

Expand All @@ -216,9 +207,7 @@ You can also use our [alternative URL format](#alternative-url-format) in case o
curl -X GET http://localhost:4566/_aws/execute-api/<REST_API_ID>/dev/test
```

The response would be:

```json
```bash title="Output"
{"message":"Hello World"}
```

Expand Down Expand Up @@ -362,9 +351,7 @@ To retrieve the list of APIs and verify the WebSocket endpoint, you can use the
awslocal apigatewayv2 get-apis
```

The response would be:

```json
```bash title="Output"
{
"Items": [{
"ApiEndpoint": "ws://localhost:4510",
Expand Down Expand Up @@ -407,9 +394,7 @@ The following example assigns the custom ID `"myid123"` to the API:
awslocal apigateway create-rest-api --name my-api --tags '{"_custom_id_":"myid123"}'
```

The response would be:

```json
```bash title="Output"
{
"id": "myid123",
....
Expand Down Expand Up @@ -496,4 +481,4 @@ The following code snippets and sample applications provide practical examples o

## API Coverage (V2)

<FeatureCoverage service="apigatewayv2" client:load />
<FeatureCoverage service="apigatewayv2" client:load />
12 changes: 3 additions & 9 deletions src/content/docs/aws/services/appconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,7 @@ awslocal appconfig create-hosted-configuration-version \
configuration-data.json
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"ApplicationId": "400c285",
"ConfigurationProfileId": "7d748f9",
Expand All @@ -143,9 +141,7 @@ awslocal appconfig create-deployment-strategy \
--growth-factor 1.0
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"Id": "f2f2225",
"Name": "my-app-deployment-strategy",
Expand All @@ -168,9 +164,7 @@ awslocal appconfig start-deployment \
--description "My application deployment"
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"ApplicationId": "400c285",
"EnvironmentId": "3695ea3",
Expand Down
33 changes: 10 additions & 23 deletions src/content/docs/aws/services/appsync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ Run the following command to list all tables in your running LocalStack containe
awslocal dynamodb list-tables
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"TableNames": [
"DynamoDBNotesTable"
Expand All @@ -62,9 +60,7 @@ awslocal appsync create-graphql-api \
--authentication-type API_KEY
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"graphqlApi": {
"name": "NotesApi",
Expand All @@ -89,9 +85,7 @@ awslocal appsync create-api-key \
--api-id 014d18d0c2b149ee8b66f39173
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"apiKey": {
"id": "31d94a05",
Expand Down Expand Up @@ -137,9 +131,7 @@ awslocal appsync start-schema-creation \
--definition file://schema.graphql
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"status": "ACTIVE"
}
Expand All @@ -158,9 +150,7 @@ awslocal appsync create-data-source \
--dynamodb-config tableName=DynamoDBNotesTable,awsRegion=us-east-1
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"dataSource": {
"dataSourceArn": "arn:aws:appsync:us-east-1:000000000000:apis/014d18d0c2b149ee8b66f39173/datasources/AppSyncDB",
Expand Down Expand Up @@ -202,9 +192,7 @@ awslocal appsync create-graphql-api \
--tags _custom_id_=faceb00c
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"graphqlApi": {
"name": "my-api",
Expand Down Expand Up @@ -266,12 +254,13 @@ See the AWS documentation for [`evaluate-mapping-template`](https://awscli.amazo
awslocal appsync evaluate-mapping-template \
--template '$ctx.result' \
--context '{"result":"ok"}'
<disable-copy>
```

```bash title="Output"
{
"evaluationResult": "ok",
"logs": []
}
</disable-copy>
```

### JavaScript resolvers
Expand All @@ -284,9 +273,7 @@ awslocal appsync evaluate-code \
--context '{"result": "ok"}'
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"evaluationResult": "ok",
"logs": []
Expand Down
6 changes: 2 additions & 4 deletions src/content/docs/aws/services/athena.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,7 @@ awslocal athena start-query-execution \
--query-string "create external table tbl01 (name STRING, surname STRING) ROW FORMAT DELIMITED FIELDS TERMINATED BY ',' LOCATION 's3://athena-bucket/data/';" --result-configuration "OutputLocation=s3://athena-bucket/output/"
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"QueryExecutionId": "593acab7"
}
Expand Down Expand Up @@ -154,7 +152,7 @@ awslocal athena get-query-results --query-execution-id $queryId

The query should yield a result similar to the output below:

```bash
```bash title="Output"
...
"Rows": [
{
Expand Down
8 changes: 2 additions & 6 deletions src/content/docs/aws/services/autoscaling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ awslocal ec2 create-launch-template \
--launch-template-data '{"ImageId":"ami-ff0fea8310f3","InstanceType":"t2.micro"}'
```

The following output is displayed:

```json
```bash title="Output"
{
"LaunchTemplate": {
"LaunchTemplateId": "lt-5ccdf1a84f178ba44",
Expand Down Expand Up @@ -79,9 +77,7 @@ Run the following command to describe the Auto Scaling group:
awslocal autoscaling describe-auto-scaling-groups
```

The following output is displayed:

```json
```bash title="Output"
{
"AutoScalingGroups": [
{
Expand Down
11 changes: 3 additions & 8 deletions src/content/docs/aws/services/backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ awslocal backup create-backup-vault \
--backup-vault-name primary
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"BackupVaultName": "primary",
"BackupVaultArn": "arn:aws:backup:us-east-1:000000000000:backup-vault:primary",
Expand Down Expand Up @@ -79,9 +77,7 @@ awslocal backup create-backup-plan \
--backup-plan file://backup-plan.json
```

The following output would be retrieved:

```bash
```bash title="Output"
{
"BackupPlanId": "9337aba3",
"BackupPlanArn": "arn:aws:backup:us-east-1:000000000000:backup-plan:testplan",
Expand Down Expand Up @@ -119,9 +115,8 @@ awslocal backup create-backup-selection \
```

Replace the `--backup-plan-id` value with the `BackupPlanId` value from the output of the previous command.
The following output would be retrieved:

```bash
```bash title="Output"
{
"SelectionId": "91ce25f8",
"BackupPlanId": "9337aba3",
Expand Down
Loading