Skip to content

Commit 232de20

Browse files
authored
add api coverage section for aws service docs (#12)
* convert all remaining files to mdx * fix the build * patch transfer * rename to api coverage section * add feature coverage imports * add api coverage sections * fix regressions * more fixes * add ses as well
1 parent b92d9cd commit 232de20

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+705
-115
lines changed
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ description: Get started with AWS Account Management on LocalStack
44
tags: ["Ultimate"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
## Introduction
810

911
Account service provides APIs to manage your AWS account.
1012
You can use the Account APIs to retrieve information about your account, manage your contact information and alternate contacts.
1113
Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account.
1214

1315
LocalStack allows you to use the Account API to retrieve information about your account.
14-
The supported APIs are available on our [API coverage page](), which provides information on the extent of Account's integration with LocalStack.
16+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Account's integration with LocalStack.
1517

1618
:::note
1719
LocalStack's Account provider is mock-only and does not support connecting to any real AWS account.
@@ -97,3 +99,7 @@ The Resource Browser allows you to perform the following actions:
9799
* **View Contact Information**: View the contact information for your mocked AWS account by clicking on the contact information.
98100
* **Update Contact Information**: Update the contact information for your mocked AWS account by clicking on the contact information.
99101
* **Filter**: Filter the contact information and alternate contacts by types, such as `BILLING`, `OPERATIONS`, and `SECURITY`.
102+
103+
## API Coverage
104+
105+
<FeatureCoverage service="account" client:load />
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: Get started with AWS Certificate Manager (ACM) on LocalStack
44
tags: ["Free"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
## Introduction
810

911
[AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/) is a service that enables you to create and manage SSL/TLS certificates that can be used to secure your applications and resources in AWS.
@@ -13,7 +15,7 @@ ACM supports securing multiple domain names and subdomains and can create wildca
1315
You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
1416

1517
LocalStack allows you to use the ACM APIs to create, list, and delete certificates.
16-
The supported APIs are available on our [API coverage page](), which provides information on the extent of ACM's integration with LocalStack.
18+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of ACM's integration with LocalStack.
1719

1820
## Getting started
1921

@@ -89,3 +91,7 @@ The following code snippets and sample applications provide practical examples o
8991

9092
- [API Gateway with Custom Domains](https://github.com/localstack/localstack-pro-samples/tree/master/apigw-custom-domain)
9193
- [Generating an ACM certificate via Terraform](https://github.com/localstack/localstack-terraform-samples/tree/master/acm-route53)
94+
95+
## API Coverage
96+
97+
<FeatureCoverage service="acm" client:load />
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ tags: ["Ultimate"]
55
persistence: supported
66
---
77

8+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
9+
810
## Introduction
911

1012
Amplify is a JavaScript-based development framework with libraries, UI components, and a standard CLI interface for building and deploying web and mobile applications.
1113
With Amplify, developers can build and host static websites, single-page applications, and full-stack serverless web applications using an abstraction layer over popular AWS services like DynamoDB, Cognito, AppSync, Lambda, S3, and more.
1214

1315
LocalStack allows you to use the Amplify APIs to build and test their Amplify applications locally.
14-
The supported APIs are available on our [API coverage page](), which provides information on the extent of Amplify's integration with LocalStack.
16+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Amplify's integration with LocalStack.
1517

1618
:::note
1719
The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported.
@@ -71,3 +73,7 @@ The Resource Browser allows you to perform the following actions:
7173
- **View Amplify applications**: View the list of Amplify applications created in LocalStack by clicking on the application ID.
7274
- **Edit Amplify applications**: Edit the configuration of an existing Amplify application by clicking on the application ID and then clicking **Edit App**.
7375
- **Delete Amplify applications**: Delete an existing Amplify application by selecting the application, followed by clicking **Actions** and then **Remove Selected**.
76+
77+
## API Coverage
78+
79+
<FeatureCoverage service="amplify" client:load />

src/content/docs/aws/services/apacheflink.md renamed to src/content/docs/aws/services/apacheflink.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: >
55
tags: ["Ultimate"]
66
---
77

8+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
9+
810
:::note
911
This service was formerly known as 'Kinesis Data Analytics for Apache Flink'.
1012
:::
@@ -283,3 +285,7 @@ $ awslocal kinesisanalyticsv2 untag-resource \
283285
The application logging level defaults to `INFO` and can not be overridden.
284286
- Parallelism is limited to the default value of 1, with one TaskManager that has one [Task Slot](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/concepts/flink-architecture/#task-slots-and-resources) allocated.
285287
[Parallelism configuration](https://docs.aws.amazon.com/managed-flink/latest/apiv2/API_FlinkApplicationConfiguration.html#APIReference-Type-FlinkApplicationConfiguration-ParallelismConfiguration) provided on Flink application creation or update is ignored.
288+
289+
## API Coverage
290+
291+
<FeatureCoverage service="kinesisanalyticsv2" client:load />

src/content/docs/aws/services/apigateway.md renamed to src/content/docs/aws/services/apigateway.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags: ["Free", "Base"]
55
persistence: supported
66
---
77

8+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
9+
810
## Introduction
911

1012
API Gateway is a managed service that enables developers to create, deploy, and manage APIs (Application Programming Interfaces).
@@ -14,7 +16,7 @@ API Gateway supports standard HTTP methods such as `GET`, `POST`, `PUT`, `PATCH`
1416
LocalStack supports API Gateway V1 (REST API) in the Free plan, and API Gateway V2 (HTTP, Management and WebSocket API) in the Base plan.
1517
LocalStack allows you to use the API Gateway APIs to create, deploy, and manage APIs on your local machine to invoke those exposed API endpoints.
1618

17-
The supported APIs are available on the API coverage page for [API Gateway V1]() & [API Gateway V2](), which provides information on the extent of API Gateway's integration with LocalStack.
19+
The supported APIs are available on the API coverage page for [API Gateway V1](#api-coverage-v1) & [API Gateway V2](#api-coverage-v2), which provides information on the extent of API Gateway's integration with LocalStack.
1820

1921
## Getting started
2022

@@ -487,3 +489,11 @@ The following code snippets and sample applications provide practical examples o
487489
- [Serverless Microservices with Amazon API Gateway, DynamoDB, SQS, and Lambda](https://github.com/localstack/microservices-apigateway-lambda-dynamodb-sqs-sample)
488490
- [Note-Taking application using AWS SDK for JavaScript, Amazon DynamoDB, Lambda, Cognito, API Gateway, and S3](https://github.com/localstack/aws-sdk-js-notes-app)
489491
- For Terraform samples, check out the [LocalStack Terraform examples](https://github.com/localstack/localstack-terraform-samples) repository
492+
493+
## API Coverage (V1)
494+
495+
<FeatureCoverage service="apigateway" client:load />
496+
497+
## API Coverage (V2)
498+
499+
<FeatureCoverage service="apigatewayv2" client:load />

src/content/docs/aws/services/appautoscaling.md renamed to src/content/docs/aws/services/appautoscaling.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags: ["Base"]
55
persistence: supported
66
---
77

8+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
9+
810
## Introduction
911

1012
Application Auto Scaling is a centralized solution for managing automatic scaling by defining scaling policies based on specific metrics.
@@ -13,7 +15,7 @@ With Application Auto Scaling, you can configure automatic scaling for services
1315
Auto scaling uses CloudWatch under the hood to configure scalable targets which a service namespace, resource ID, and scalable dimension can uniquely identify.
1416

1517
LocalStack allows you to use the Application Auto Scaling APIs in your local environment to scale different resources based on scaling policies and scheduled scaling.
16-
The supported APIs are available on our [API coverage page](), which provides information on the extent of Application Auto Scaling's integration with LocalStack.
18+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Application Auto Scaling's integration with LocalStack.
1719

1820
## Getting Started
1921

@@ -144,3 +146,7 @@ The following service namespaces are currently supported:
144146
* Cassandra
145147
* Comprenhend
146148
* Custom Resource
149+
150+
## API Coverage
151+
152+
<FeatureCoverage service="application-autoscaling" client:load />

src/content/docs/aws/services/appconfig.md renamed to src/content/docs/aws/services/appconfig.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ description: Get started with AppConfig on LocalStack
44
tags: ["Base"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
AppConfig is a service provided by Amazon Web Services (AWS) that simplifies the process of managing and deploying application configurations.
810
AppConfig offers centralized management of configuration data and the ability to create, manage, and deploy configuration changes separately.
911
It allows you to avoid deploying the service repeatedly for smaller changes, enables controlled deployments to applications and includes built-in validation checks & monitoring.
1012

1113
LocalStack allows you to use the AppConfig APIs in your local environment to define configurations for different environments and deploy them to your applications as needed.
12-
The supported APIs are available on our [API coverage page](), which provides information on the extent of AppConfig's integration with LocalStack.
14+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of AppConfig's integration with LocalStack.
1315

1416
## Getting started
1517

@@ -209,3 +211,7 @@ The Resource Browser allows you to perform the following actions:
209211
- **View AppConfig applications**: View the list of AppConfig applications created in LocalStack by clicking on the application ID.
210212
- **Edit AppConfig applications**: Edit the configuration of an existing AppConfig application by clicking on the application ID and then clicking **Edit Application**.
211213
- **Delete AppConfig applications**: Delete an existing AppConfig application by selecting the application, followed by clicking **Actions** and then **Remove Selected**.
214+
215+
## API Coverage
216+
217+
<FeatureCoverage service="appconfig" client:load />
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ description: Get started with AppSync on LocalStack
44
tags: ["Ultimate"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
## Introduction
810

911
AppSync is a managed service provided by Amazon Web Services (AWS) that enables you to create serverless GraphQL APIs to query databases, microservices, and other APIs.
1012
AppSync allows you to define your data models and business logic using a declarative approach, and connect to various data sources, including other AWS services, relational databases, and custom data sources.
1113

1214
LocalStack allows you to use the AppSync APIs in your local environment to connect your applications and services to data and events.
13-
The supported APIs are available on our [API coverage page](), which provides information on the extent of AppSync's integration with LocalStack.
15+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of AppSync's integration with LocalStack.
1416

1517
## Getting started
1618

@@ -324,3 +326,7 @@ The Resource Browser allows you to perform the following actions:
324326
The following code snippets and sample applications provide practical examples of how to use AppSync in LocalStack for various use cases:
325327

326328
- [AppSync GraphQL APIs for DynamoDB and RDS Aurora PostgreSQL](https://github.com/localstack/appsync-graphql-api-sample)
329+
330+
## API Coverage
331+
332+
<FeatureCoverage service="appsync" client:load />

src/content/docs/aws/services/athena.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: Get started with Athena on LocalStack
44
tags: ["Ultimate"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
import { Tabs, TabItem } from '@astrojs/starlight/components';
810

911
## Introduction
@@ -13,7 +15,7 @@ Athena allows users to create ad-hoc queries to perform data analysis, filter, a
1315
It supports various file formats, such as JSON, Parquet, and CSV, making it compatible with a wide range of data sources.
1416

1517
LocalStack allows you to configure the Athena APIs with a Hive metastore that can connect to the S3 API and query your data directly in your local environment.
16-
The supported APIs are available on our [API coverage page](), which provides information on the extent of Athena's integration with LocalStack.
18+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Athena's integration with LocalStack.
1719

1820
## Getting started
1921

@@ -273,3 +275,7 @@ The Resource Browser allows you to perform the following actions:
273275
The following code snippets and sample applications provide practical examples of how to use Athena in LocalStack for various use cases:
274276
275277
- [Query data in S3 Bucket with Amazon Athena, Glue Catalog & CloudFormation](https://github.com/localstack/query-data-s3-athena-glue-sample)
278+
279+
## API Coverage
280+
281+
<FeatureCoverage service="athena" client:load />

src/content/docs/aws/services/autoscaling.md renamed to src/content/docs/aws/services/autoscaling.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ description: Get started with Auto Scaling on LocalStack
44
tags: ["Base"]
55
---
66

7+
import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage";
8+
79
## Introduction
810

911
Auto Scaling helps you maintain application availability and allows you to automatically add or remove EC2 instances according to the demand.
1012
You can use Auto Scaling to ensure that you are running your desired number of instances.
1113

1214
LocalStack allows you to use the Auto Scaling APIs locally to create and manage Auto Scaling groups locally.
13-
The supported APIs are available on our [API coverage page](), which provides information on the extent of Auto Scaling's integration with LocalStack.
15+
The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Auto Scaling's integration with LocalStack.
1416

1517
## Getting started
1618

@@ -138,3 +140,7 @@ Replace `i-0d678c4ecf6018dde` with the instance ID that you fetched from the out
138140

139141
LocalStack does not support the `docker`/`libvirt` [VM manager for EC2](/aws/services/ec2/#vm-managers).
140142
It only works with the `mock` VM manager.
143+
144+
## API Coverage
145+
146+
<FeatureCoverage service="autoscaling" client:load />

0 commit comments

Comments
 (0)