diff --git a/academy/index.html b/academy/index.html index ac04de0d89..4424787e23 100644 --- a/academy/index.html +++ b/academy/index.html @@ -155,10 +155,10 @@
  • +

    • LocalStack Academy

    Welcome to our comprehensive LocalStack e-course! Whether you’re a seasoned developer or just starting your cloud journey, this course is tailored to equip you with the essential knowledge to harness the power of LocalStack. Dive into the world of LocalStack, where you’ll not only expedite your development process but also enhance your efficiency in building and testing cloud applications.

    LocalStack 101

    This LocalStack course will walk you through everything you need to know to get started using LocalStack and on your way to becoming a more efficient and productive Cloud developer. Have fun exploring!

    7 lessons2 more lessons
    Start the Course +
    Categories
    Persistence
    Tags

    LocalStack Academy

    Welcome to our comprehensive LocalStack e-course! Whether you’re a seasoned developer or just starting your cloud journey, this course is tailored to equip you with the essential knowledge to harness the power of LocalStack. Dive into the world of LocalStack, where you’ll not only expedite your development process but also enhance your efficiency in building and testing cloud applications.

    LocalStack 101

    This LocalStack course will walk you through everything you need to know to get started using LocalStack and on your way to becoming a more efficient and productive Cloud developer. Have fun exploring!

    7 lessons2 more lessons
    Start the Course

    Development & Deployment with LocalStack

    This course on LocalStack guides you in creating and deploying applications using LocalStack. We cover scenarios around deploying applications with various integrations, such as Terraform and CloudFormation, and integrating CI workflows for your AWS applications. In addition, you will learn about the IAM Policy Stream for automatically generating required IAM policies and Cloud Pods for team collaboration & debugging. Explore the course to learn more about LocalStack and enjoy the learning experience.

    8 lessons3 more lessons
    Start the Course
    Last modified August 23, 2023: Added LocalStack Academy (#742) (27e1e2139)
    \ No newline at end of file diff --git a/academy/localstack-101/cloud-pods/index.html b/academy/localstack-101/cloud-pods/index.html index 356c07f3eb..4668a3d3bc 100644 --- a/academy/localstack-101/cloud-pods/index.html +++ b/academy/localstack-101/cloud-pods/index.html @@ -155,10 +155,10 @@
  • +

    • Cloud Pods and Collaborative Work

    Discover Cloud Pods: a mechanism offering persistent snapshots of LocalStack’s application state. Uncover their significance in enabling reproducible applications, collaborative sandboxing, and consistent AWS API parity. Engage in a brief and enlightening demo showcasing their practicality.

    This video will cover:

    What are Cloud Pods ?

    • Unveil the concept of Cloud Pods, designed to capture a persistent snapshot of LocalStack’s application state. + Create project issue
    Categories
    Persistence
    Tags

    Cloud Pods and Collaborative Work

    Discover Cloud Pods: a mechanism offering persistent snapshots of LocalStack’s application state. Uncover their significance in enabling reproducible applications, collaborative sandboxing, and consistent AWS API parity. Engage in a brief and enlightening demo showcasing their practicality.

    This video will cover:

    What are Cloud Pods ?

    • Unveil the concept of Cloud Pods, designed to capture a persistent snapshot of LocalStack’s application state. Deviate from the default ephemeral state by leveraging Cloud Pods’ capability to preserve data across restarts.

    How are cloud pods useful ?

    • Gain insight into the advantages they offer, including the creation of shareable local cloud sandboxes. Learn about the collaborative potential of distributing and sharing pods among team members and discover how Cloud Pods contribute to reproducibility in applications and pre-seeding test environments.

    Demo

    • Dive into a concise yet impactful demo that brings Cloud Pods to life. diff --git a/academy/localstack-101/course-overview/index.html b/academy/localstack-101/course-overview/index.html index 84fe8b6b3b..b278a36633 100644 --- a/academy/localstack-101/course-overview/index.html +++ b/academy/localstack-101/course-overview/index.html @@ -155,10 +155,10 @@
  • +

    • Course Overview

    In this first video, we will explore the diverse sections covered in this e-course, providing an overview of the exciting topics to be discussed. Discover the course’s main themes and gain insight into specific sections through a concise overview, allowing you to easily navigate to your preferred content.
    Up Next

    What is LocalStack

    Discover the power of LocalStack, a game-changing platform enabling Cloud Development Teams to test and develop Cloud applications locally. Replacing AWS in most use cases, LocalStack ships as a Docker image, and supports APIs for over 70 AWS services, along with advanced collaboration features and CI integrations.

    Next + Create project issue
    Categories
    Persistence
    Tags

    Course Overview

    In this first video, we will explore the diverse sections covered in this e-course, providing an overview of the exciting topics to be discussed. Discover the course’s main themes and gain insight into specific sections through a concise overview, allowing you to easily navigate to your preferred content.
    Up Next

    What is LocalStack

    Discover the power of LocalStack, a game-changing platform enabling Cloud Development Teams to test and develop Cloud applications locally. Replacing AWS in most use cases, LocalStack ships as a Docker image, and supports APIs for over 70 AWS services, along with advanced collaboration features and CI integrations.

    Next

    Last modified April 10, 2024: Adjust urls for some academy pages - needed for extracting data more smoothly for the awesome-localstack repo (#1172) (bb843189f)
    \ No newline at end of file diff --git a/academy/localstack-101/full-project-demo/index.html b/academy/localstack-101/full-project-demo/index.html index 8a76025bae..11aecb85d5 100644 --- a/academy/localstack-101/full-project-demo/index.html +++ b/academy/localstack-101/full-project-demo/index.html @@ -155,10 +155,10 @@
  • +

    • Full Project Demo

    This video explores one of our many Developer Hub sample applications, a note-taking application. We’ll take you through the full process, from checking out the GitHub project, to running the functioning app on LocalStack.

    Discover the ins and outs of one of our Developer Hub’s practical sample applications—a note-taking platform. + Create project issue

    Categories
    Persistence
    Tags

    Full Project Demo

    This video explores one of our many Developer Hub sample applications, a note-taking application. We’ll take you through the full process, from checking out the GitHub project, to running the functioning app on LocalStack.

    Discover the ins and outs of one of our Developer Hub’s practical sample applications—a note-taking platform. This video tutorial offers a comprehensive walk-through, beginning with the checkout of the GitHub project and culminating in deploying the operational application on LocalStack. Covering the essentials, we’ll guide you diff --git a/academy/localstack-101/getting-started/index.html b/academy/localstack-101/getting-started/index.html index caa684122d..fbee8e4c10 100644 --- a/academy/localstack-101/getting-started/index.html +++ b/academy/localstack-101/getting-started/index.html @@ -155,10 +155,10 @@

  • +

    • Getting started

    Discover multiple ways to dive into LocalStack’s world of cloud development. Learn the easiest method, using the LocalStack CLI, or alternatively, you can pull the Docker image, run it or include it in Docker Compose, and start using AWS services.

    There are several LocalStack installation methods to kickstart your cloud development journey. + Create project issue

    Categories
    Persistence
    Tags

    Getting started

    Discover multiple ways to dive into LocalStack’s world of cloud development. Learn the easiest method, using the LocalStack CLI, or alternatively, you can pull the Docker image, run it or include it in Docker Compose, and start using AWS services.

    There are several LocalStack installation methods to kickstart your cloud development journey. Discover multiple pathways to initiate your LocalStack experience:

    You’ll understand the diverse approaches to LocalStack installation:

    1. Quickstart with LocalStack CLI:
    • Install awscli-local and localstack via pip install. On macOS you can use brew install.
    • Start LocalStack using localstack start.
    • Create a bucket and list buckets using awslocal s3 mb s3://test and awslocal s3 ls.
    1. Alternative - Docker: Dive into an alternate installation method using Docker: pull the image and run it, it’s that easy.
    2. Docker Compose: Explore yet another approach via Docker Compose.

    Further reading:

    Up Next

    Web App and Resource Browser

    LocalStack Web Application lets you view and manage all aspects of the LocalStack platform. In this guide you will learn about Resource Browser, that allows you to view, manage, and deploy AWS resources locally while building & testing cloud applications locally.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-101/index.html b/academy/localstack-101/index.html index 2ba4f5cd2a..519f438abb 100644 --- a/academy/localstack-101/index.html +++ b/academy/localstack-101/index.html @@ -155,10 +155,10 @@
  • +

    • LocalStack 101

    This LocalStack course will walk you through everything you need to know to get started using LocalStack and on your way to becoming a more efficient and productive Cloud developer. Have fun exploring!

    Course Overview

    In this first video, we will explore the diverse sections covered in this e-course, providing an overview of the exciting topics to be discussed. Discover the course's main themes and gain insight into specific sections through a concise overview, allowing you to easily navigate to your preferred content.

    Learn More +
    Categories
    Persistence
    Tags

    LocalStack 101

    This LocalStack course will walk you through everything you need to know to get started using LocalStack and on your way to becoming a more efficient and productive Cloud developer. Have fun exploring!

    Course Overview

    In this first video, we will explore the diverse sections covered in this e-course, providing an overview of the exciting topics to be discussed. Discover the course's main themes and gain insight into specific sections through a concise overview, allowing you to easily navigate to your preferred content.

    Learn More

    What is LocalStack

    Discover the power of LocalStack, a game-changing platform enabling Cloud Development Teams to test and develop Cloud applications locally. Replacing AWS in most use cases, LocalStack ships as a Docker image, and supports APIs for over 70 AWS services, along with advanced collaboration features and CI integrations.

    Learn More

    Why LocalStack

    LocalStack is a game-changing platform for cloud developers, offering enhanced productivity, cost savings, and simplified maintenance. With faster deployment and reduced dependency on infrastructure teams, developers can unleash their full potential and streamline cloud workflows.

    Learn More

    Getting started

    Discover multiple ways to dive into LocalStack's world of cloud development. Learn the easiest method, using the LocalStack CLI, or alternatively, you can pull the Docker image, run it or include it in Docker Compose, and start using AWS services.

    Learn More diff --git a/academy/localstack-101/web-app-resource-browser/index.html b/academy/localstack-101/web-app-resource-browser/index.html index 24f625a39a..c410df5f9f 100644 --- a/academy/localstack-101/web-app-resource-browser/index.html +++ b/academy/localstack-101/web-app-resource-browser/index.html @@ -155,10 +155,10 @@ CLI command reference
  • +

    • Web App and Resource Browser

    LocalStack Web Application lets you view and manage all aspects of the LocalStack platform. In this guide you will learn about Resource Browser, that allows you to view, manage, and deploy AWS resources locally while building & testing cloud applications locally.

    In this informative video we guide you through the essential steps of the LocalStack platform:

    • Witness the seamless login flow and discover how to configure the web app.
    • Learn how to effortlessly connect your LocalStack Account to enable a smooth integration experience.
    • Explore the Resource Browser as we demonstrate how to list and create fundamental resources.
    • To create an account for LocalStack, visit app.localstack.cloud/sign-up. + Create project issue
    Categories
    Persistence
    Tags

    Web App and Resource Browser

    LocalStack Web Application lets you view and manage all aspects of the LocalStack platform. In this guide you will learn about Resource Browser, that allows you to view, manage, and deploy AWS resources locally while building & testing cloud applications locally.

    In this informative video we guide you through the essential steps of the LocalStack platform:

    • Witness the seamless login flow and discover how to configure the web app.
    • Learn how to effortlessly connect your LocalStack Account to enable a smooth integration experience.
    • Explore the Resource Browser as we demonstrate how to list and create fundamental resources.
    • To create an account for LocalStack, visit app.localstack.cloud/sign-up. You can sign up with your email address or one of our supported social identity providers (such as GitHub).

    Further reading:

    Up Next

    Full Project Demo

    This video explores one of our many Developer Hub sample applications, a note-taking application. We'll take you through the full process, from checking out the GitHub project, to running the functioning app on LocalStack.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-101/what-is-localstack/index.html b/academy/localstack-101/what-is-localstack/index.html index 14b8025f13..281019b216 100644 --- a/academy/localstack-101/what-is-localstack/index.html +++ b/academy/localstack-101/what-is-localstack/index.html @@ -155,10 +155,10 @@
  • +

    • What is LocalStack

    Discover the power of LocalStack, a game-changing platform enabling Cloud Development Teams to test and develop Cloud applications locally. Replacing AWS in most use cases, LocalStack ships as a Docker image, and supports APIs for over 70 AWS services, along with advanced collaboration features and CI integrations.

    In this lesson, we’ll talk about LocalStack:

    • The revolutionary platform that brings cloud testing to your local machine, simplifying the development process.
    • A drop-in replacement for AWS, ships as a user-friendly Docker image, ensuring effortless installation and setup.
    • Supports over 70 AWS services and capable of a diverse range of functionalities, including compute (Lambda, ECS, EKS), various database (DynamoDB, RDS, DocumentDB), and messaging services (SQS, Kinesis, MSK).
    • Tackles sophisticated and exotic APIs (QLDB, Athena, Glue) and helps enhance your skill set.
    • Contains advanced collaboration features and seamless CI integrations that foster team productivity.
    • Our mission is to empower developers with control over their environments, eliminating time-consuming cloud dev and test loops.
    • You can focus on developing exceptional products to solve real-world challenges with LocalStack as your game-changing companion.

    Embrace the future of cloud development and have fun exploring!

    Further reading:

    Up Next

    Why LocalStack

    LocalStack is a game-changing platform for cloud developers, offering enhanced productivity, cost savings, and simplified maintenance. With faster deployment and reduced dependency on infrastructure teams, developers can unleash their full potential and streamline cloud workflows.

    Next + Create project issue
    Categories
    Persistence
    Tags

    What is LocalStack

    Discover the power of LocalStack, a game-changing platform enabling Cloud Development Teams to test and develop Cloud applications locally. Replacing AWS in most use cases, LocalStack ships as a Docker image, and supports APIs for over 70 AWS services, along with advanced collaboration features and CI integrations.

    In this lesson, we’ll talk about LocalStack:

    • The revolutionary platform that brings cloud testing to your local machine, simplifying the development process.
    • A drop-in replacement for AWS, ships as a user-friendly Docker image, ensuring effortless installation and setup.
    • Supports over 70 AWS services and capable of a diverse range of functionalities, including compute (Lambda, ECS, EKS), various database (DynamoDB, RDS, DocumentDB), and messaging services (SQS, Kinesis, MSK).
    • Tackles sophisticated and exotic APIs (QLDB, Athena, Glue) and helps enhance your skill set.
    • Contains advanced collaboration features and seamless CI integrations that foster team productivity.
    • Our mission is to empower developers with control over their environments, eliminating time-consuming cloud dev and test loops.
    • You can focus on developing exceptional products to solve real-world challenges with LocalStack as your game-changing companion.

    Embrace the future of cloud development and have fun exploring!

    Further reading:

    Up Next

    Why LocalStack

    LocalStack is a game-changing platform for cloud developers, offering enhanced productivity, cost savings, and simplified maintenance. With faster deployment and reduced dependency on infrastructure teams, developers can unleash their full potential and streamline cloud workflows.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-101/why-localstack/index.html b/academy/localstack-101/why-localstack/index.html index 885624d090..af7881c3df 100644 --- a/academy/localstack-101/why-localstack/index.html +++ b/academy/localstack-101/why-localstack/index.html @@ -155,10 +155,10 @@
  • +

    • Why LocalStack

    LocalStack is a game-changing platform for cloud developers, offering enhanced productivity, cost savings, and simplified maintenance. With faster deployment and reduced dependency on infrastructure teams, developers can unleash their full potential and streamline cloud workflows.

    Let’s imagine this scenario: Alice, a software developer, takes on the task of creating a serverless + Create project issue

    Categories
    Persistence
    Tags

    Why LocalStack

    LocalStack is a game-changing platform for cloud developers, offering enhanced productivity, cost savings, and simplified maintenance. With faster deployment and reduced dependency on infrastructure teams, developers can unleash their full potential and streamline cloud workflows.

    Let’s imagine this scenario: Alice, a software developer, takes on the task of creating a serverless Web application on AWS Cloud. However, she faces slow and tedious development due to cloud dependencies (DBs, VMs, MQs, etc.). Every local change needs to be packaged and uploaded to the cloud for testing. diff --git a/academy/localstack-deployment/cloud-pods/index.html b/academy/localstack-deployment/cloud-pods/index.html index dc1fb2e5ba..d41e89c50a 100644 --- a/academy/localstack-deployment/cloud-pods/index.html +++ b/academy/localstack-deployment/cloud-pods/index.html @@ -155,10 +155,10 @@

  • +

    • Cloud pods - Team Collaboration

    In this video, we’ll delve into Cloud pods, which allow you to snapshot the present state of your LocalStack instance and share it with your team. We’ll load a Cloud Pod in our environment through the Web Application. This Cloud Pod will load the infrastructure and application onto our currently active LocalStack instance without manually deploying any resources.

    LocalStack is an ephemeral environment by nature. + Create project issue

    Categories
    Persistence
    Tags

    Cloud pods - Team Collaboration

    In this video, we’ll delve into Cloud pods, which allow you to snapshot the present state of your LocalStack instance and share it with your team. We’ll load a Cloud Pod in our environment through the Web Application. This Cloud Pod will load the infrastructure and application onto our currently active LocalStack instance without manually deploying any resources.

    LocalStack is an ephemeral environment by nature. It means that when you stop your LocalStack instance, all data is removed. However, by using Cloud Pods, you can preserve the LocalStack state. Cloud Pods are snapshots of your LocalStack instance’s state that can be saved, versioned, shared, and restored.

    In this video, we’ll follow the quickstart to import Cloud Pods shared by our team member into our LocalStack instance and observe how this process supports local development and deployment of cloud applications.

    Further reading:


    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-deployment/course-overview/index.html b/academy/localstack-deployment/course-overview/index.html index 41bbfa58ae..21f25dbb28 100644 --- a/academy/localstack-deployment/course-overview/index.html +++ b/academy/localstack-deployment/course-overview/index.html @@ -155,10 +155,10 @@
  • +

    • Course Overview

    In this video, we’ll delve into topics covered in this module, focusing on developing and deploying with LocalStack. In this module, we’ll deploy a container application that uses various AWS services. You will learn more about LocalStack integrations, IAM Policy Stream, and Cloud Pods that help improve your local cloud development, testing, and collaborative experience.
    Up Next

    Deploy a full fledged containerised application using LocalStack

    In this video, we'll guide you through deploying a real-world application that uses various AWS services, such as DynamoDB, ECS, API Gateway, and more. We'll attempt to input data into DynamoDB using the deployed application and then retrieve the same data using the Localstack's DynamoDB resource browser to demonstrate how Localstack enhances the developer experience for cloud applications.

    Next + Create project issue
    Categories
    Persistence
    Tags

    Course Overview

    In this video, we’ll delve into topics covered in this module, focusing on developing and deploying with LocalStack. In this module, we’ll deploy a container application that uses various AWS services. You will learn more about LocalStack integrations, IAM Policy Stream, and Cloud Pods that help improve your local cloud development, testing, and collaborative experience.
    Up Next

    Deploy a full fledged containerised application using LocalStack

    In this video, we'll guide you through deploying a real-world application that uses various AWS services, such as DynamoDB, ECS, API Gateway, and more. We'll attempt to input data into DynamoDB using the deployed application and then retrieve the same data using the Localstack's DynamoDB resource browser to demonstrate how Localstack enhances the developer experience for cloud applications.

    Next

    Last modified April 10, 2024: Adjust urls for some academy pages - needed for extracting data more smoothly for the awesome-localstack repo (#1172) (bb843189f)
    \ No newline at end of file diff --git a/academy/localstack-deployment/deploy-app-ls/index.html b/academy/localstack-deployment/deploy-app-ls/index.html index b8cb50c995..08cb908147 100644 --- a/academy/localstack-deployment/deploy-app-ls/index.html +++ b/academy/localstack-deployment/deploy-app-ls/index.html @@ -155,10 +155,10 @@
  • +

    • Deploy a full fledged containerised application using LocalStack

    In this video, we’ll guide you through deploying a real-world application that uses various AWS services, such as DynamoDB, ECS, API Gateway, and more. We’ll attempt to input data into DynamoDB using the deployed application and then retrieve the same data using the Localstack’s DynamoDB resource browser to demonstrate how Localstack enhances the developer experience for cloud applications.

    In this lesson, we’ll guide you through deploying a continer-based application, which mimics the complexity of a real-world application. + Create project issue

    Categories
    Persistence
    Tags

    Deploy a full fledged containerised application using LocalStack

    In this video, we’ll guide you through deploying a real-world application that uses various AWS services, such as DynamoDB, ECS, API Gateway, and more. We’ll attempt to input data into DynamoDB using the deployed application and then retrieve the same data using the Localstack’s DynamoDB resource browser to demonstrate how Localstack enhances the developer experience for cloud applications.

    In this lesson, we’ll guide you through deploying a continer-based application, which mimics the complexity of a real-world application. We are using the following AWS services and their features to build our infrastructure:

    • Elastic Container Service to create and deploy our containerized application.
    • DynamoDB as a key-value and document database to persist our data.
    • API Gateway to expose the containerized services to the user through HTTP APIs.
    • Cognito User Pools for user authentication and authorizing requests to container APIs.
    • Amplify to create the user client with ReactJS to send requests to container APIs.
    • S3 to deploy the Amplify application to make the web application available to users.
    • IAM to create policies to specify roles and permissions for various AWS services.

    Additionally, we’ll explore the Resource Browser, that enables you to perform basic management operations for the locally deployed AWS resources during the development and testing process, in a fashion similar to the AWS Management Console.

    Finally, we’ll manually generate certain resources using awslocal, a wrapper over the aws CLI which re-routes requests to LocalStack, to demonstrate how LocalStack can be used to create and manage resources locally.

    Further reading:

    Up Next

    LocalStack Integrations - Infrastructure-as-Code and CI tools

    In this video, we will see how LocalStack can be used with infrastructure-as-code (IaC) and continuous integration (CI) tools to enable local development more efficient, and foster team collaboration. LocalStack integrations allow you to use your favorite tools to create and manage AWS resources locally.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-deployment/github-action-ls/index.html b/academy/localstack-deployment/github-action-ls/index.html index 2aa6ef6e06..65d2f7c04e 100644 --- a/academy/localstack-deployment/github-action-ls/index.html +++ b/academy/localstack-deployment/github-action-ls/index.html @@ -155,10 +155,10 @@
  • +

    • Setup GitHub Action workflow that starts up LocalStack and deploys the infrastructure

    In this video, we will employ LocalStack’s GitHub Actions integration to deploy our application’s infrastructure on LocalStack. Additionally, we will perform a diagnostic test to validate the deployment, ensuring that the infrastructure is set up correctly. This will enable you to conduct cloud integration tests for your application and infrastructure.

    LocalStack allows organizations to automate their application testing and integration process using continuous integration (CI). + Create project issue

    Categories
    Persistence
    Tags

    Setup GitHub Action workflow that starts up LocalStack and deploys the infrastructure

    In this video, we will employ LocalStack’s GitHub Actions integration to deploy our application’s infrastructure on LocalStack. Additionally, we will perform a diagnostic test to validate the deployment, ensuring that the infrastructure is set up correctly. This will enable you to conduct cloud integration tests for your application and infrastructure.

    LocalStack allows organizations to automate their application testing and integration process using continuous integration (CI). You can seamlessly integrate LocalStack with your current CI platform. LocalStack offers native plugin for CircleCI & GitHub Actions, and a universal driver for other CI platforms. This integration enables you to include LocalStack’s local AWS cloud emulation in your CI pipelines, leverage advanced features such as Cloud Pods and CI analytics, and execute your test and integration suite before deploying to production.

    Here’s a breakdown of the steps we’ll take:

    • We’ll look the main.yml file located in the .github directory. diff --git a/academy/localstack-deployment/iam-policy-stream/index.html b/academy/localstack-deployment/iam-policy-stream/index.html index 3e619faea9..9781857e2b 100644 --- a/academy/localstack-deployment/iam-policy-stream/index.html +++ b/academy/localstack-deployment/iam-policy-stream/index.html @@ -155,10 +155,10 @@
  • +

    • Security Testing with IAM Policy Stream

    In this video, we’ll talk about the IAM policy Stream. When developing an application, we often need access to AWS resources like DynamoDB, RDS, etc. To grant this access, we create IAM roles and assign permissions through policies. Determining these policies can be challenging — the IAM policy stream simplifies this task by identifying the necessary permissions for your cloud applications.

    In this video, we’ll explore the IAM Policy Stream that assists in assigning precise IAM permissions to a resource. + Create project issue

    Categories
    Persistence
    Tags

    Security Testing with IAM Policy Stream

    In this video, we’ll talk about the IAM policy Stream. When developing an application, we often need access to AWS resources like DynamoDB, RDS, etc. To grant this access, we create IAM roles and assign permissions through policies. Determining these policies can be challenging — the IAM policy stream simplifies this task by identifying the necessary permissions for your cloud applications.

    In this video, we’ll explore the IAM Policy Stream that assists in assigning precise IAM permissions to a resource. This ensures accurate and secure access to the resource.

    Here’s a breakdown of the steps we’ll take:

    1. Enable IAM Policy Stream on the LocalStack Web Application.
    2. Trigger an AWS API request from the CLI, triggering the generation of the necessary policy for the request.
    3. Submit another request to generate the corresponding policy for the resource.
    4. Explore the Summary Policy section to view the consolidated policy for both requests.

    Further reading:

    Up Next

    Setup GitHub Action workflow that starts up LocalStack and deploys the infrastructure

    In this video, we will employ LocalStack's GitHub Actions integration to deploy our application's infrastructure on LocalStack. Additionally, we will perform a diagnostic test to validate the deployment, ensuring that the infrastructure is set up correctly. This will enable you to conduct cloud integration tests for your application and infrastructure.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-deployment/infra-cloudformation/index.html b/academy/localstack-deployment/infra-cloudformation/index.html index 26ae6ea3b5..5e468441bb 100644 --- a/academy/localstack-deployment/infra-cloudformation/index.html +++ b/academy/localstack-deployment/infra-cloudformation/index.html @@ -155,10 +155,10 @@
  • +

    • Creating infra with CloudFormation locally

    In this video, we’ll explore how you can use AWS CloudFormation with LocalStack. AWS CloudFormation allows you to declaratively define your AWS cloud architecture, specifying resources like S3 Buckets and Lambda Functions. To deploy using AWS CloudFormation, we’ll use awslocal, a wrapper CLI around the AWS command line interface.

    In this video, we’ll utilize AWS CloudFormation to deploy AWS resources locally through LocalStack. + Create project issue

    Categories
    Persistence
    Tags

    Creating infra with CloudFormation locally

    In this video, we’ll explore how you can use AWS CloudFormation with LocalStack. AWS CloudFormation allows you to declaratively define your AWS cloud architecture, specifying resources like S3 Buckets and Lambda Functions. To deploy using AWS CloudFormation, we’ll use awslocal, a wrapper CLI around the AWS command line interface.

    In this video, we’ll utilize AWS CloudFormation to deploy AWS resources locally through LocalStack. These resources include DynamoDB tables, API Gateway, and VPC. We’ll use awslocal, a wrapper CLI that serves as a wrapper on the aws CLI to execute Terraform commands against LocalStack.

    Here’s a breakdown of the steps we’ll take:

    • We’ll guide you through the entire CloudFormation Stack, demonstrating various configuration options for creating the infrastructure for our application.
    • After deploying the CloudFormation Stack, we’ll examine some outputted resources, including API URLs, ECS cluster names, VPC ID, and more.
    • Finally, we’ll verify the deployment and confirm the creation of resources using the Resource Browser.

    Further reading:

    Up Next

    Security Testing with IAM Policy Stream

    In this video, we'll talk about the IAM policy Stream. When developing an application, we often need access to AWS resources like DynamoDB, RDS, etc. To grant this access, we create IAM roles and assign permissions through policies. Determining these policies can be challenging — the IAM policy stream simplifies this task by identifying the necessary permissions for your cloud applications.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-deployment/infra-terraform/index.html b/academy/localstack-deployment/infra-terraform/index.html index 153e834ac9..641086a0fb 100644 --- a/academy/localstack-deployment/infra-terraform/index.html +++ b/academy/localstack-deployment/infra-terraform/index.html @@ -155,10 +155,10 @@
  • +

    • Creating infrastructure with Terraform locally

    In this video, we’ll utilize LocalStack’s Terraform integration to deploy and configure local AWS resources on LocalStack. We’ll use tflocal, a wrapper CLI that enables you to run Terraform commands against LocalStack. Alternatively you can use terraform CLI directly with minor modifications to the Terraform configuration, a topic we’ll cover later in the video.

    In this video, we’ll utilize Terraform to deploy AWS resources locally through LocalStack. + Create project issue

    Categories
    Persistence
    Tags

    Creating infrastructure with Terraform locally

    In this video, we’ll utilize LocalStack’s Terraform integration to deploy and configure local AWS resources on LocalStack. We’ll use tflocal, a wrapper CLI that enables you to run Terraform commands against LocalStack. Alternatively you can use terraform CLI directly with minor modifications to the Terraform configuration, a topic we’ll cover later in the video.

    In this video, we’ll utilize Terraform to deploy AWS resources locally through LocalStack. These resources include DynamoDB tables, API Gateway, and VPC. We’ll use tflocal, a wrapper CLI that serves as a wrapper on the terraform CLI to execute Terraform commands against LocalStack.

    Here’s a breakdown of the steps we’ll take:

    • We’ll create a main.tf file and then apply the Terraform configuration on LocalStack.
    • We’ll demonstrate various configuration options for setting up the infrastructure for our application.
    • After applying Terraform, we’ll inspect the output, showcasing deployed resources such as API URLs, ECS cluster name, and VPC ID.
    • Towards the end, we’ll verify the deployment and resource creation using the Resource Browser.

    Further reading:

    Up Next

    Creating infra with CloudFormation locally

    In this video, we'll explore how you can use AWS CloudFormation with LocalStack. AWS CloudFormation allows you to declaratively define your AWS cloud architecture, specifying resources like S3 Buckets and Lambda Functions. To deploy using AWS CloudFormation, we'll use awslocal, a wrapper CLI around the AWS command line interface.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-deployment/ls-integrations/index.html b/academy/localstack-deployment/ls-integrations/index.html index 1798872bfd..6da7b5fb07 100644 --- a/academy/localstack-deployment/ls-integrations/index.html +++ b/academy/localstack-deployment/ls-integrations/index.html @@ -155,10 +155,10 @@
  • +

    • LocalStack Integrations - Infrastructure-as-Code and CI tools

    In this video, we will see how LocalStack can be used with infrastructure-as-code (IaC) and continuous integration (CI) tools to enable local development more efficient, and foster team collaboration. LocalStack integrations allow you to use your favorite tools to create and manage AWS resources locally.

    LocalStack integrates with various Infrastructure as Code tools like Terraform or Pulumi assist in configuration management with added advantages like version control, ease of editing, and reproducibility. + Create project issue

    Categories
    Persistence
    Tags

    LocalStack Integrations - Infrastructure-as-Code and CI tools

    In this video, we will see how LocalStack can be used with infrastructure-as-code (IaC) and continuous integration (CI) tools to enable local development more efficient, and foster team collaboration. LocalStack integrations allow you to use your favorite tools to create and manage AWS resources locally.

    LocalStack integrates with various Infrastructure as Code tools like Terraform or Pulumi assist in configuration management with added advantages like version control, ease of editing, and reproducibility. Additionally, LocalStack integrates with various CI platforms, such as GitHub Actions or CircleCI, to enable the cloud integrations tests before pushing changes to production.

    We discuss how LocalStack integrates with infrastructure-as-code (IaC) and continuous integration (CI) tools. Towards the end, we’ll demonstrate a Terraform deployment of a PostgreSQL Aurora cluster on LocalStack, highlighting the time and resource savings compared to deploying directly on AWS.

    Additionally, we’ll provide examples of using LocalStack with Terraform and Pulumi for reference.

    Further reading:

    Up Next

    Creating infrastructure with Terraform locally

    In this video, we'll utilize LocalStack's Terraform integration to deploy and configure local AWS resources on LocalStack. We'll use tflocal, a wrapper CLI that enables you to run Terraform commands against LocalStack. Alternatively you can use terraform CLI directly with minor modifications to the Terraform configuration, a topic we'll cover later in the video.

    Next

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/academy/localstack-development/index.html b/academy/localstack-development/index.html index 2bf03f78ae..54a138dbdc 100644 --- a/academy/localstack-development/index.html +++ b/academy/localstack-development/index.html @@ -155,10 +155,10 @@
  • +

    • Development & Deployment with LocalStack

    This course on LocalStack guides you in creating and deploying applications using LocalStack. We cover scenarios around deploying applications with various integrations, such as Terraform and CloudFormation, and integrating CI workflows for your AWS applications. In addition, you will learn about the IAM Policy Stream for automatically generating required IAM policies and Cloud Pods for team collaboration & debugging. Explore the course to learn more about LocalStack and enjoy the learning experience.

    Course Overview

    In this video, we'll delve into topics covered in this module, focusing on developing and deploying with LocalStack. In this module, we'll deploy a container application that uses various AWS services. You will learn more about LocalStack integrations, IAM Policy Stream, and Cloud Pods that help improve your local cloud development, testing, and collaborative experience.

    Learn More +
    Categories
    Persistence
    Tags

    Development & Deployment with LocalStack

    This course on LocalStack guides you in creating and deploying applications using LocalStack. We cover scenarios around deploying applications with various integrations, such as Terraform and CloudFormation, and integrating CI workflows for your AWS applications. In addition, you will learn about the IAM Policy Stream for automatically generating required IAM policies and Cloud Pods for team collaboration & debugging. Explore the course to learn more about LocalStack and enjoy the learning experience.

    Course Overview

    In this video, we'll delve into topics covered in this module, focusing on developing and deploying with LocalStack. In this module, we'll deploy a container application that uses various AWS services. You will learn more about LocalStack integrations, IAM Policy Stream, and Cloud Pods that help improve your local cloud development, testing, and collaborative experience.

    Learn More

    Deploy a full fledged containerised application using LocalStack

    In this video, we'll guide you through deploying a real-world application that uses various AWS services, such as DynamoDB, ECS, API Gateway, and more. We'll attempt to input data into DynamoDB using the deployed application and then retrieve the same data using the Localstack's DynamoDB resource browser to demonstrate how Localstack enhances the developer experience for cloud applications.

    Learn More

    LocalStack Integrations - Infrastructure-as-Code and CI tools

    In this video, we will see how LocalStack can be used with infrastructure-as-code (IaC) and continuous integration (CI) tools to enable local development more efficient, and foster team collaboration. LocalStack integrations allow you to use your favorite tools to create and manage AWS resources locally.

    Learn More

    Creating infrastructure with Terraform locally

    In this video, we'll utilize LocalStack's Terraform integration to deploy and configure local AWS resources on LocalStack. We'll use tflocal, a wrapper CLI that enables you to run Terraform commands against LocalStack. Alternatively you can use terraform CLI directly with minor modifications to the Terraform configuration, a topic we'll cover later in the video.

    Learn More diff --git a/applications/index.html b/applications/index.html index b358783cc8..df682baa7d 100644 --- a/applications/index.html +++ b/applications/index.html @@ -155,10 +155,10 @@ CLI command reference
  • +
  • +

    •   less than a minute  

    Last modified March 30, 2023: Introduce the developer hub (#496) (31cc4832d)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

      less than a minute  

    Last modified March 30, 2023: Introduce the developer hub (#496) (31cc4832d)
    \ No newline at end of file diff --git a/developer-hub/index.html b/developer-hub/index.html index 022608083e..a71cbe5291 100644 --- a/developer-hub/index.html +++ b/developer-hub/index.html @@ -154,10 +154,10 @@
  • +

    • Developer Hub

    LocalStack logo

    LocalStack Developer Hub

    Get started with developing and testing cloud & serverless applications locally with LocalStack. Explore our sample applications and step-by-step tutorials to unlock LocalStack's frictionless, integrated cloud developer experience.

    Tutorials

    Learn LocalStack concepts while building simple projects. Find each tutorial walking you through fundamentals of cloud & serverless development with local AWS services to get you started with LocalStack.

    Applications

    Learn to simplify cloud development while setting up local cloud infrastructure with LocalStack! Find application samples walking you through various services, integrations, and more while achieving real-world use cases!

    Last modified March 30, 2023: Introduce the developer hub (#496) (31cc4832d)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    Developer Hub

    LocalStack logo

    LocalStack Developer Hub

    Get started with developing and testing cloud & serverless applications locally with LocalStack. Explore our sample applications and step-by-step tutorials to unlock LocalStack's frictionless, integrated cloud developer experience.

    Tutorials

    Learn LocalStack concepts while building simple projects. Find each tutorial walking you through fundamentals of cloud & serverless development with local AWS services to get you started with LocalStack.

    Applications

    Learn to simplify cloud development while setting up local cloud infrastructure with LocalStack! Find application samples walking you through various services, integrations, and more while achieving real-world use cases!

    Last modified March 30, 2023: Introduce the developer hub (#496) (31cc4832d)
    \ No newline at end of file diff --git a/getting-started/auth-token/index.html b/getting-started/auth-token/index.html index 6250623a7e..3c44000e2d 100644 --- a/getting-started/auth-token/index.html +++ b/getting-started/auth-token/index.html @@ -155,10 +155,10 @@
  • +

    • Auth Token

    Configure your Auth Token to start LocalStack

      7 minute read  

    Introduction

    The Auth Token is a personal identifier used for user authentication outside the LocalStack Web Application, particularly in conjunction with the LocalStack core cloud emulator. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Auth Token

    Configure your Auth Token to start LocalStack

      7 minute read  

    Introduction

    The Auth Token is a personal identifier used for user authentication outside the LocalStack Web Application, particularly in conjunction with the LocalStack core cloud emulator. Its primary functions are to retrieve the user’s license and enable access to advanced features, effectively replacing the older developer API keys.

    The Auth Token remains unchanged unless manually rotated by the user, regardless of any license assignment changes. You can locate your Auth Token on the Getting Started page or the Auth Token page in the LocalStack Web Application.

    Frequently Asked Questions

    This page answers the frequently asked questions about LocalStack Pro, Enterprise, and Community Editions.

    LocalStack Core FAQs

    How to update my LocalStack CLI?

    If the LocalStack CLI version is heavily outdated, it might lead to issues with container startup and debug commands. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Frequently Asked Questions

    This page answers the frequently asked questions about LocalStack Pro, Enterprise, and Community Editions.

    LocalStack Core FAQs

    How to update my LocalStack CLI?

    If the LocalStack CLI version is heavily outdated, it might lead to issues with container startup and debug commands. If you are using an older version of LocalStack, you can update it by running the following command:

    $ pip install --upgrade localstack localstack-ext

    If you are running a newer version of LocalStack, you can check the version by running the following command:

    $ localstack update localstack-cli

    localhost.localstack.cloud is the recommended endpoint - especially for S3, in order to enable host-based bucket endpoints.

    • When using this domain within LocalStack compute environments like Lambda, ECS or EC2, this domain name resolves to the LocalStack container via our DNS server available in version 2.3.
    • By configuring your environment, your applications can also use localhost.localstack.cloud to resolve to the LocalStack container via our DNS server.
    • In addition, we also publish an SSL certificate that is automatically used inside LocalStack, in order to enable HTTPS endpoints with valid certificates.

    Across our docs, we use localhost:4566 instead of localhost.localstack.cloud, to provide a fallback option to users. The primary reason being that some users are behind a corporate firewall or an internet service provider that does not allow resolving localhost.localstack.cloud properly.

    How should I use the latest LocalStack Docker images?

    To use the latest LocalStack Docker images, you either run docker pull localstack/localstack:latest or use the docker-compose pull if the image is set to localstack/localstack:latest. You can also specify a particular digest to make sure you are using the correct image, like this: localstack/localstack:latest@sha256:f803cc657843c6c7acf2631d15600783c3593e496fba418415afc87680d9d5bc.

    You can also use the our diagnose endpoint (http://localhost:4566/_localstack/diagnose) to get the specific image hashes and compare them with the current (latest) images on Docker Hub. diff --git a/getting-started/help-and-support/index.html b/getting-started/help-and-support/index.html index 1937d2d8e3..b969315168 100644 --- a/getting-started/help-and-support/index.html +++ b/getting-started/help-and-support/index.html @@ -155,10 +155,10 @@

  • +

    • Help & Support

    This page outlines how to get help and support while using LocalStack.

      6 minute read  

    Introduction

    We strive to make it as easy as possible for you to use LocalStack, and we are very grateful for any feedback. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Help & Support

    This page outlines how to get help and support while using LocalStack.

      6 minute read  

    Introduction

    We strive to make it as easy as possible for you to use LocalStack, and we are very grateful for any feedback. We provide different levels of support to help you with your queries and issues. The support you receive depends on the plan you are on.

    PlanSupport Level
    Community EditionCommunity Support
    Hobby PlanCommunity Support
    Starter PlanDedicated Support
    Teams PlanDedicated Support
    Enterprise PlanEnterprise Support

    Community Support

    LocalStack’s Community support is available to all users of the LocalStack Community Edition & Hobby Plan users. You can avail community support through the following channels:

    Community support is provided on a best-effort basis and is not guaranteed. diff --git a/getting-started/index.html b/getting-started/index.html index 03fdc757e8..0d6b8ce4e6 100644 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -155,10 +155,10 @@

  • +

    • Getting Started

    This section describes how to install LocalStack using a variety of options, and provides details on how LocalStack can be configured to fit the needs of a local cloud sandbox for development, testing, and experimentation!
    Tags:

    LocalStack is a cloud service emulator that runs in a single container on your laptop or in your CI environment. + Create project issue

    Categories
    Persistence
    Tags

    Getting Started

    This section describes how to install LocalStack using a variety of options, and provides details on how LocalStack can be configured to fit the needs of a local cloud sandbox for development, testing, and experimentation!
    Tags:

    LocalStack is a cloud service emulator that runs in a single container on your laptop or in your CI environment. With LocalStack, you can run your AWS applications or Lambdas entirely on your local machine without connecting to a remote cloud provider!

    Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.

    LocalStack supports a growing number of AWS services, like AWS Lambda, S3, DynamoDB, Kinesis, SQS, SNS, and more! LocalStack Pro supports additional APIs and advanced features to make your cloud development experience a breeze!

    You can find a comprehensive list of supported APIs on our Feature Coverage page.

    LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack’s Cloud Developer Tools.

    Installation

    Basic installation guide to get started with LocalStack on your local machine.

    Auth Token

    Configure your Auth Token to start LocalStack

    Quickstart

    This quickstart gives an overview of how you can get a simple AWS application up and running on your local machine to understand local cloud development with LocalStack!

    Frequently Asked Questions

    This page answers the frequently asked questions about LocalStack Pro, Enterprise, and Community Editions.

    Help & Support

    This page outlines how to get help and support while using LocalStack.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/getting-started/installation/index.html b/getting-started/installation/index.html index 77e7ba86ac..58c662b2ea 100644 --- a/getting-started/installation/index.html +++ b/getting-started/installation/index.html @@ -155,10 +155,10 @@
  • +

    • Installation

    Basic installation guide to get started with LocalStack on your local machine.

    LocalStack CLI

    The quickest way get started with LocalStack is by using the LocalStack CLI. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Installation

    Basic installation guide to get started with LocalStack on your local machine.

    LocalStack CLI

    The quickest way get started with LocalStack is by using the LocalStack CLI. It allows you to start LocalStack from your command line. Please make sure that you have a working Docker installation on your machine before moving on.

    The CLI starts and manages the LocalStack Docker container. For alternative methods of managing the LocalStack container, see our alternative installation instructions.

  • +

    • Quickstart

    This quickstart gives an overview of how you can get a simple AWS application up and running on your local machine to understand local cloud development with LocalStack!

      8 minute read  

    Introduction

    In this quickstart guide, we’ll walk you through the process of starting LocalStack on your local machine and deploying a serverless image resizer application that utilizes several AWS services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Quickstart

    This quickstart gives an overview of how you can get a simple AWS application up and running on your local machine to understand local cloud development with LocalStack!

      8 minute read  

    Introduction

    In this quickstart guide, we’ll walk you through the process of starting LocalStack on your local machine and deploying a serverless image resizer application that utilizes several AWS services. This guide aims to help you understand how to use LocalStack for the development and testing of your AWS applications locally. It introduces you to the following key concepts:

    • Starting a LocalStack instance on your local machine.
    • Deploying an AWS serverless application infrastructure locally.
    • Running an automated integration test suite against local infrastructure.
    • Exploring the LocalStack Web Application to view deployed resources.
    • Destroying the local infrastructure you have provisioned.

    Architecture

    The following diagram shows the architecture that we will deploy locally using LocalStack:

    An AWS architecture demonstrating a sample serverless image resizer application

    The architecture:

    • Configures S3 bucket notifications to invoke a Lambda function.
    • Provides S3 pre-signed POST URLs for direct uploads to the S3 bucket.
    • Creates S3 website hosting for serving the static application client.
    • Configures direct invocation URLs for Lambda functions accessible to the client.
    • Establishes Lambda SNS to SNS topic notifications for failure handling.
    • Creates SNS to SES subscriptions for email notifications triggered by specific events.

    An internal SES LocalStack testing endpoint (/_localstack/aws/ses) is configured as well, to test email sending functionality while running our local integration test suite.

    Prerequisites

    You can start LocalStack using the localstack CLI. Start the LocalStack Pro container with your LOCALSTACK_AUTH_TOKEN pre-configured:

  • +

    • Legal Docs

    This section contains legal documentation for LocalStack.

    Third Party Software Tools

    This page documents the third-party software tools that we use in our software development.

    Last modified May 16, 2024: add preliminary legal docs (#1265) (bfa5fbddd)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    Legal Docs

    This section contains legal documentation for LocalStack.

    Third Party Software Tools

    This page documents the third-party software tools that we use in our software development.

    Last modified May 16, 2024: add preliminary legal docs (#1265) (bfa5fbddd)
    \ No newline at end of file diff --git a/legal/third-party-software-tools/index.html b/legal/third-party-software-tools/index.html index ad92822364..62648cdc25 100644 --- a/legal/third-party-software-tools/index.html +++ b/legal/third-party-software-tools/index.html @@ -155,10 +155,10 @@
  • +

    • Third Party Software Tools

    This page documents the third-party software tools that we use in our software development.

    We build on a number of third-party software tools, including the following:

    Third-Party softwareLicense
    Python/pip modules:
    airspeedBSD License
    amazon_kclpyAmazon Software License
    boto3Apache License 2.0
    coverageApache License 2.0
    docoptMIT License
    flaskBSD License
    flask_swaggerMIT License
    jsonpath-rwApache License 2.0
    motoApache License 2.0
    requestsApache License 2.0
    subprocess32PSF License
    Other tools:
    ElasticsearchApache License 2.0
    kinesis-mockMIT License
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    Third Party Software Tools

    This page documents the third-party software tools that we use in our software development.

    We build on a number of third-party software tools, including the following:

    Third-Party softwareLicense
    Python/pip modules:
    airspeedBSD License
    amazon_kclpyAmazon Software License
    boto3Apache License 2.0
    coverageApache License 2.0
    docoptMIT License
    flaskBSD License
    flask_swaggerMIT License
    jsonpath-rwApache License 2.0
    motoApache License 2.0
    requestsApache License 2.0
    subprocess32PSF License
    Other tools:
    ElasticsearchApache License 2.0
    kinesis-mockMIT License
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/overview/index.html b/overview/index.html index 364e9474e2..10e30a50ba 100644 --- a/overview/index.html +++ b/overview/index.html @@ -162,10 +162,10 @@
  • +

    • Overview

    LocalStack logo

    Welcome to the LocalStack Documentation!
    Explore and learn about LocalStack.

    Get Started

    Install and run LocalStack on your machine, and discover the benefits of local cloud development.

    Integrations

    Use your favorite cloud development framework with LocalStack: CDK, Terraform, Serverless, and more!

    LocalStack in CI

    Use LocalStack in your Continuous Integration pipelines.

    Local AWS Services

    Browse through the AWS Services that LocalStack emulates.

    LocalStack Tools

    Learn how to use LocalStack Cloud Developer Tools to boost your efficiency.

    Understanding LocalStack

    Learn how LocalStack works and how you can tweak it for your use case.

    Featured guides and articles

    Here are some commonly asked questions and related articles.

    Help

    Where can I get help?

    Last modified January 26, 2024: rework state management docs (#1001) (1ec2b8b4e)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    Overview

    LocalStack logo

    Welcome to the LocalStack Documentation!
    Explore and learn about LocalStack.

    Get Started

    Install and run LocalStack on your machine, and discover the benefits of local cloud development.

    Integrations

    Use your favorite cloud development framework with LocalStack: CDK, Terraform, Serverless, and more!

    LocalStack in CI

    Use LocalStack in your Continuous Integration pipelines.

    Local AWS Services

    Browse through the AWS Services that LocalStack emulates.

    LocalStack Tools

    Learn how to use LocalStack Cloud Developer Tools to boost your efficiency.

    Understanding LocalStack

    Learn how LocalStack works and how you can tweak it for your use case.

    Featured guides and articles

    Here are some commonly asked questions and related articles.

    Help

    Where can I get help?

    Last modified January 26, 2024: rework state management docs (#1001) (1ec2b8b4e)
    \ No newline at end of file diff --git a/references/api-key/index.html b/references/api-key/index.html index 769903b7ae..7674974af7 100644 --- a/references/api-key/index.html +++ b/references/api-key/index.html @@ -155,10 +155,10 @@
  • +

    • API Key (Deprecated)

    Configure your API key to start LocalStack

      4 minute read  

    Table of Contents
    Categories
    Persistence
    Tags

    API Key (Deprecated)

    Configure your API key to start LocalStack

      4 minute read  

    The LocalStack API key is a unique identifier to activate your LocalStack license needed to start LocalStack Pro. You can find your API key in the LocalStack Web app. diff --git a/references/arm64-support/index.html b/references/arm64-support/index.html index 23efa3aa7c..4d852a669a 100644 --- a/references/arm64-support/index.html +++ b/references/arm64-support/index.html @@ -155,10 +155,10 @@

  • +

    • ARM64 Support

    Running LocalStack on ARM64 CPUs

      3 minute read  

    Since version 0.13, LocalStack officially publishes a multi-architecture Docker manifest. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    ARM64 Support

    Running LocalStack on ARM64 CPUs

      3 minute read  

    Since version 0.13, LocalStack officially publishes a multi-architecture Docker manifest. This manifest contains links to a Linux AMD64 as well as a Linux ARM64 image.

    Pulling the LocalStack image

    With the multi-arch Docker manifest, your Docker client (and therefore the LocalStack CLI) now automatically selects the image according to your platform:

    $ docker pull localstack/localstack

    You can check the architecture of the pulled image by using docker inspect:

    $ docker inspect localstack/localstack | jq '.[0].Architecture'
 "arm64"

    Lambda multi-architecture support

    Since LocalStack 2.0, Lambda functions execute in Docker containers with the target platform linux/amd64 or linux/arm64 depending on the instruction set architecture configured for the function (x86_64 by default or arm64). diff --git a/references/changelog/index.html b/references/changelog/index.html index 3c3f930db5..b832d878ba 100644 --- a/references/changelog/index.html +++ b/references/changelog/index.html @@ -155,10 +155,10 @@

  • +

    • Changelog

    This page lists new features, highlights, and bug fixes for official LocalStack releases.

      2 minute read  

    Introduction

    This page documents the release notes for official LocalStack major and minor releases since LocalStack v1.0.0. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Changelog

    This page lists new features, highlights, and bug fixes for official LocalStack releases.

      2 minute read  

    Introduction

    This page documents the release notes for official LocalStack major and minor releases since LocalStack v1.0.0. If you are looking for information about nightly releases, preview features, or experimental features, pull the latest Docker image. The changelog is updated with every release. Updates that affect only LocalStack Web Application or features in preview or limited release may not be reflected.

    Features under Development

    LocalStack uses the following terminology to communicate features under development:

    • Preview refers to a feature under development that usually evolves into becoming a stable feature. diff --git a/references/configuration/index.html b/references/configuration/index.html index 7ca31d9f9c..cc41f9d529 100644 --- a/references/configuration/index.html +++ b/references/configuration/index.html @@ -155,10 +155,10 @@
  • +

    • Configuration

    Overview of configuration options in LocalStack

      25 minute read  

    LocalStack exposes various configuration options to control its behaviour.

    These options can be passed to LocalStack as environment variables like so:

    $ DEBUG=1 localstack start

    To facilitate interoperability, configuration variables can be prefixed with LOCALSTACK_ in docker. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Configuration

    Overview of configuration options in LocalStack

      25 minute read  

    LocalStack exposes various configuration options to control its behaviour.

    These options can be passed to LocalStack as environment variables like so:

    $ DEBUG=1 localstack start

    To facilitate interoperability, configuration variables can be prefixed with LOCALSTACK_ in docker. For instance, setting LOCALSTACK_PERSISTENCE=1 is equivalent to PERSISTENCE=1.

    You can also use Profiles.

    Configurations marked as Deprecated will be removed in the next major version. You can find previously removed configuration variables under Legacy.

    Core

    Options that affect the core LocalStack system.

    VariableExample ValuesDescription
    DEBUG0 (default) |1Flag to increase log level and print more verbose logs (useful for troubleshooting issues)
    IMAGE_NAMElocalstack/localstack (default), localstack/localstack:0.11.0Specific name and tag of LocalStack Docker image to use.
    GATEWAY_LISTEN0.0.0.0:4566 (default in Docker mode) 127.0.0.1:4566 (default in host mode)Configures the bind addresses of LocalStack. It has the form <ip address>:<port>(,<ip address>:<port>)*. LocalStack Pro adds port 443.
    LOCALSTACK_HOSTlocalhost.localstack.cloud:4566 (default)This is interpolated into URLs and addresses that are returned by LocalStack. It has the form <hostname>:<port>.
    USE_SSL0 (default)Whether to return URLs using HTTP (0) or HTTPS (1). Changed with 3.0.0. In earlier versions this was toggling SSL support on or off.
    PERSISTENCE0 (default)Enable persistence. See Persistence Mechanism and Filesystem Layout.
    MAIN_CONTAINER_NAMElocalstack-main (default)Specify the main docker container name
    LS_LOGtrace, trace-internal, debug, info, warn, error, warningSpecify the log level. Currently overrides the DEBUG configuration. trace for detailed request/response, trace-internal for internal calls, too.
    EXTERNAL_SERVICE_PORTS_START4510 (default)Start of the External Service Port Range (inclusive).
    EXTERNAL_SERVICE_PORTS_END4560 (default)End of the External Service Port Range (exclusive).
    EAGER_SERVICE_LOADING0 (default) |1Boolean that toggles lazy loading of services. If eager loading is enabled, services are started at LocalStack startup rather than their first use. Be aware that eager loading increases the LocalStack startup time.
    SERVICESs3,sqsA comma-delimited string of services. Check the internal health endpoint /_localstack/health for valid service names. If SERVICES is set LocalStack will only load the listed services. All other services will be disabled and cannot be used.
    ALLOW_NONSTANDARD_REGIONS0 (default)Allows the use of non-standard AWS regions. By default, LocalStack only accepts standard AWS regions.
    PARITY_AWS_ACCESS_KEY_ID0 (default)Enables the use production-like access key IDs. By default, LocalStack issues keys with LSIA... and LKIA... prefix, and will reject keys that start with ASIA... or AKIA....

    CLI

    These options are applicable when using the CLI to start LocalStack.

    VariableExample ValuesDescription
    LOCALSTACK_VOLUME_DIR~/.cache/localstack/volume (on Linux)The location on the host of the LocalStack volume directory mount. See Filesystem Layout
    CONFIG_PROFILEThe configuration profile to load. See Profiles
    CONFIG_DIR~/.localstackThe path where LocalStack can find configuration profiles and other CLI-specific configuration

    Docker

    Options to configure how LocalStack interacts with Docker.

    VariableExample ValuesDescription
    DOCKER_FLAGSAllows to pass custom flags (e.g., volume mounts) to “docker run” when running LocalStack in Docker.
    DOCKER_SOCK/var/run/docker.sockPath to local Docker UNIX domain socket
    DOCKER_BRIDGE_IP172.17.0.1IP of the docker bridge used to enable access between containers
    LEGACY_DOCKER_CLIENT0|1Whether LocalStack should use the command-line Docker client and subprocess execution to run Docker commands, rather than the Docker SDK.
    DOCKER_CMDdocker (default), sudo dockerShell command used to run Docker containers (only used in combination with LEGACY_DOCKER_CLIENT)
    FORCE_NONINTERACTIVEWhen running with Docker, disables the --interactive and --tty flags. Useful when running headless.

    Local AWS Services

    This section covers configuration options that are specific to certain AWS services.

    AppSync

    VariableExample ValuesDescription
    GRAPHQL_ENDPOINT_STRATEGYlegacy|domain|pathGoverns how AppSync endpoints are created to access a GraphQL API (see AppSync Endpoints)

    Batch

    VariableExample ValuesDescription
    BATCH_DOCKER_FLAGS-e TEST_ENV=1337Additional flags provided to the batch container. Same restrictions as LAMBDA_DOCKER_FLAGS.

    BigData (EMR, Athena, Glue)

    VariableExample ValuesDescription
    BIGDATA_DOCKER_NETWORKNetwork the bigdata should be connected to. The LocalStack container has to be connected to that network as well. Per default, the bigdata container will be connected to a network LocalStack is also connected to.
    BIGDATA_DOCKER_FLAGSAdditional flags for the bigdata container. Same restrictions as LAMBDA_DOCKER_FLAGS.

    CloudFormation

    VariableExample ValuesDescription
    CFN_LEGACY_TEMPLATE_DEPLOYER0 (default) |1Switch back to the old deployment engine. Note that this is only available temporarily to allow for a smoother roll-out of the new deployment order.
    CFN_PER_RESOURCE_TIMEOUT300 (default)Set the timeout to deploy each individual CloudFormation resource.
    CFN_VERBOSE_ERRORS0 (default) |1Show exceptions for CloudFormation deploy errors.
    CFN_STRING_REPLACEMENT_DENY_LIST"" (default) |https://api-1.execute-api.us-east-2.amazonaws.com/test-resource,https://api-2.execute-api.us-east-2.amazonaws.com/test-resourceComma-separated list of AWS URLs that should not be modified to point to Localstack. For example, when deploying a CloudFormation template we might want to leave certain resources pointing to actual AWS URLs, or even leave environment variables with URLs like that untouched.

    CloudWatch

    VariableExample ValuesDescription
    PROVIDER_OVERRIDE_CLOUDWATCHv2Use the new CloudWatch provider.

    DocumentDB

    VariableExample ValuesDescription
    DOCDB_PROXY_CONTAINER0 (default) |1Whether the DocumentDB starts the MongoDB container proxied over LocalStack container. When enabled lambda functions can use the Endpoint configuration of the DocDB cluster or instance to connect to the DocumentDB. By default the container starts without proxy as standalone container.

    DynamoDB

    VariableExample ValuesDescription
    DYNAMODB_ERROR_PROBABILITYDecimal value between 0.0(default) and 1.0Randomly inject ProvisionedThroughputExceededException errors into DynamoDB API responses.
    DYNAMODB_HEAP_SIZE256m (default), 1GSets the JAVA EE maximum memory size for DynamoDB; full table scans require more memory
    DYNAMODB_SHARE_DB0|1When activated, DynamodDB will use a single database instead of separate databases for each credential and region.
    DYNAMODB_IN_MEMORY0 (default) |1When activated, DynamodDB will start in in-memory mode, which can have a faster throughput. If you use this options, both persistence and cloud pods will not work for DynamoDB
    DYNAMODB_OPTIMIZE_DB_BEFORE_STARTUP0|1Optimize the database tables in the store before starting
    DYNAMODB_DELAY_TRANSIENT_STATUSES0|1When activated, DynamoDB will introduce artificial delays in resource creation to simulate the actual cloud service more closely. Currently works only for CREATING and DELETING online index statuses.
    DYNAMODB_CORS*Enable CORS support for specific allow-list list the domains separated by , use * for public access (default is *)
    DYNAMODB_REMOVE_EXPIRED_ITEMS0|1Enables Time to Live (TTL) feature

    ECR

    VariableExample ValuesDescription
    ECR_ENDPOINT_STRATEGYdomain (default)|off|Governs how the default ECR endpoints are returned

    ECS

    VariableExample ValuesDescription
    ECS_REMOVE_CONTAINERS0|1 (default)Remove Docker containers associated with ECS tasks after execution. Disabling this and dumping container logs might help with troubleshooting failing ECS tasks.
    ECS_DOCKER_FLAGS--privileged, --dns 1.2.3.4Additional flags passed to Docker when creating ECS task containers. Same restrictions as LAMBDA_DOCKER_FLAGS.
    ECS_DISABLE_AWS_ENDPOINT_URL0 (default) | 1Whether to disable injecting the environment variable AWS_ENDPOINT_URL, which automatically configures supported AWS SDKs.
    ECS_TASK_EXECUTORkubernetesWhether to run ECS tasks when LocalStack is deployed on Kubernetes. Tasks are added to ELB load balancer target groups.

    EC2

    VariableExample ValuesDescription
    EC2_DOCKER_FLAGS--privilegedAdditional flags passed to Docker when launching containerized instances. Same restrictions as LAMBDA_DOCKER_FLAGS.
    EC2_DOCKER_INIT0|1 (default)Start container instances with docker-init system, learn more here. Disable this if you want to use a custom init system.
    EC2_DOWNLOAD_DEFAULT_IMAGES0|1 (default)At startup, LocalStack Pro downloads latest Ubuntu images from Docker Hub for use as AMIs. This can be disabled for security reasons.
    EC2_EBS_MAX_VOLUME_SIZE1000 (default)Maximum size (in MiBs) of user-specified EBS block devices mounted into EC2 container instances.
    EC2_MOUNT_BLOCK_DEVICES1|0 (default)Whether to create and mount user-specified EBS block devices into EC2 container instances.
    EC2_REMOVE_CONTAINERS0|1 (default)Controls whether created Docker containers are removed at instance termination or LocalStack shuts down. Disable this if there is a need to examine the container filesystem for debugging.
    EC2_VM_MANAGERdocker(default)|libvirt|mockEmulation method to use in LocalStack Pro. This option is not available in LocalStack community.

    EKS

    VariableExample ValuesDescription
    EKS_LOADBALANCER_PORT8081 (default)Local port on which the Kubernetes load balancer is exposed on the host.
    EKS_K3S_IMAGE_TAGv1.22.6-k3s1 (default)Custom tag of the k8s/rancher image used to spin up Kubernetes clusters locally.

    ElastiCache

    VariableExample ValuesDescription
    PROVIDER_OVERRIDE_ELASTICACHElegacyUse the legacy ElastiCache provider.
    REDIS_CONTAINER_MODE1|0 (default)Start ElastiCache cache nodes in separate containers instead of in the LocalStack container

    Elasticsearch

    EventBridge

    VariableExample ValuesDescription
    PROVIDER_OVERRIDE_EVENTSv2Use the new EventBridge provider.

    IAM

    VariableExample ValuesDescription
    ENFORCE_IAM0 (default)|1Enable IAM policy evaluation and enforcement. If this is disabled (the default), IAM policies will have no effect to your requests.
    IAM_SOFT_MODE0 (default)|1Enable IAM soft mode. This leads to policy evaluation without actually denying access. Needs ENFORCE_IAM enabled as well. For more information, see Identity and Access Management.

    Kinesis

    VariableExample ValuesDescription
    KINESIS_ERROR_PROBABILITYDecimal value between 0.0(default) and 1.0Randomly inject ProvisionedThroughputExceededException errors into Kinesis API responses.
    KINESIS_SHARD_LIMIT100 (default), Infinity (to disable)Integer value , causing the Kinesis API to start throwing exceptions to mimic the default shard limit.
    KINESIS_ON_DEMAND_STREAM_COUNT_LIMIT10 (default), Infinity (to disable)Integer value , causing the Kinesis API to start throwing exceptions to mimic the default on demand stream count limit.
    KINESIS_LATENCY500 (default), 0 (to disable)Integer value of milliseconds, causing the Kinesis API to delay returning a response in order to mimic latency from a live AWS call.

    Lambda

    AWS Account Management

    Implementation details for API account

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Account Management

    Implementation details for API account

    Coverage Overview

    AWS Account Management is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptPrimaryEmailUpdate
    DeleteAlternateContact✔️pro✔️✔️✔️Show Tests
    DisableRegion
    EnableRegion
    GetAlternateContact✔️pro✔️✔️✔️Show Tests
    GetContactInformation✔️pro✔️✔️✔️Show Tests
    GetPrimaryEmail
    GetRegionOptStatus
    ListRegions
    PutAlternateContact✔️pro✔️✔️✔️Show Tests
    PutContactInformation✔️pro✔️✔️✔️Show Tests
    StartPrimaryEmailUpdate

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteAlternateContact

    Parameters: AlternateContactType

    • AWS Private Certificate Authority (CA)

    Implementation details for API acm-pca

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Private Certificate Authority (CA)

    Implementation details for API acm-pca

    Coverage Overview

    AWS Private Certificate Authority (CA) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateCertificateAuthority✔️pro✔️✔️Show Tests
    CreateCertificateAuthorityAuditReport
    CreatePermission
    DeleteCertificateAuthority✔️pro✔️✔️Show Tests
    DeletePermission
    DeletePolicy
    DescribeCertificateAuthority✔️pro✔️✔️Show Tests
    DescribeCertificateAuthorityAuditReport
    GetCertificate✔️pro
    GetCertificateAuthorityCertificate✔️pro
    GetCertificateAuthorityCsr✔️pro
    GetPolicy
    ImportCertificateAuthorityCertificate✔️pro
    IssueCertificate✔️pro
    ListCertificateAuthorities
    ListPermissions
    ListTags✔️pro✔️✔️Show Tests
    PutPolicy
    RestoreCertificateAuthority
    RevokeCertificate✔️pro
    TagCertificateAuthority✔️pro✔️✔️Show Tests
    UntagCertificateAuthority✔️pro
    UpdateCertificateAuthority✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCertificateAuthority

    Parameters: CertificateAuthorityConfiguration, CertificateAuthorityType, RevocationConfiguration, Tags

    • ACM (AWS Certificate Manager)

    Implementation details for API acm

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ACM (AWS Certificate Manager)

    Implementation details for API acm

    Coverage Overview

    AWS Certificate Manager (ACM) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTagsToCertificate✔️community✔️
    DeleteCertificate✔️community✔️✔️✔️✔️Show Tests
    DescribeCertificate✔️community✔️✔️✔️✔️Show Tests
    ExportCertificate✔️community✔️
    GetAccountConfiguration
    GetCertificate✔️community✔️
    ImportCertificate✔️community✔️✔️✔️✔️Show Tests
    ListCertificates✔️community✔️✔️✔️Show Tests
    ListTagsForCertificate✔️community✔️
    PutAccountConfiguration
    RemoveTagsFromCertificate✔️community✔️
    RenewCertificate
    RequestCertificate✔️community✔️✔️✔️✔️Show Tests
    ResendValidationEmail✔️community✔️
    UpdateCertificateOptions

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteCertificate

    Parameters: CertificateArn

    • Amplify

    Implementation details for API amplify

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Amplify

    Implementation details for API amplify

    Coverage Overview

    Amplify is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApp✔️pro✔️✔️✔️Show Tests
    CreateBackendEnvironment✔️pro✔️Show Tests
    CreateBranch✔️pro✔️✔️✔️Show Tests
    CreateDeployment
    CreateDomainAssociation
    CreateWebhook✔️pro✔️Show Tests
    DeleteApp✔️pro✔️✔️✔️Show Tests
    DeleteBackendEnvironment✔️pro✔️Show Tests
    DeleteBranch✔️pro✔️✔️✔️Show Tests
    DeleteDomainAssociation
    DeleteJob
    DeleteWebhook✔️pro✔️Show Tests
    GenerateAccessLogs
    GetApp✔️pro✔️✔️✔️Show Tests
    GetArtifactUrl
    GetBackendEnvironment✔️pro✔️Show Tests
    GetBranch✔️pro✔️Show Tests
    GetDomainAssociation
    GetJob
    GetWebhook✔️pro✔️Show Tests
    ListApps✔️pro✔️Show Tests
    ListArtifacts
    ListBackendEnvironments
    ListBranches✔️pro✔️✔️✔️Show Tests
    ListDomainAssociations
    ListJobs
    ListTagsForResource✔️pro✔️Show Tests
    ListWebhooks
    StartDeployment
    StartJob
    StopJob
    TagResource✔️pro✔️✔️✔️Show Tests
    UntagResource✔️pro✔️Show Tests
    UpdateApp✔️pro✔️Show Tests
    UpdateBranch
    UpdateDomainAssociation
    UpdateWebhook✔️pro✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApp

    Parameters: customRules, environmentVariables, name, tags

    • API Gateway

    Implementation details for API apigateway

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    API Gateway

    Implementation details for API apigateway

    Coverage Overview

    API Gateway is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApiKey✔️community✔️✔️✔️✔️Show Tests
    CreateAuthorizer✔️community✔️✔️✔️✔️Show Tests
    CreateBasePathMapping✔️community✔️✔️Show Tests
    CreateDeployment✔️community✔️✔️✔️✔️Show Tests
    CreateDocumentationPart✔️community✔️✔️✔️Show Tests
    CreateDocumentationVersion✔️community✔️✔️✔️Show Tests
    CreateDomainName✔️community✔️✔️Show Tests
    CreateModel✔️community✔️✔️✔️Show Tests
    CreateRequestValidator✔️community✔️✔️✔️✔️Show Tests
    CreateResource✔️community✔️✔️✔️✔️Show Tests
    CreateRestApi✔️community✔️✔️✔️✔️Show Tests
    CreateStage✔️community✔️✔️✔️✔️Show Tests
    CreateUsagePlan✔️community✔️✔️✔️✔️Show Tests
    CreateUsagePlanKey✔️community✔️✔️✔️✔️Show Tests
    CreateVpcLink✔️community✔️✔️✔️✔️Show Tests
    DeleteApiKey✔️community✔️✔️✔️✔️Show Tests
    DeleteAuthorizer✔️community✔️✔️✔️✔️Show Tests
    DeleteBasePathMapping✔️community✔️Show Tests
    DeleteClientCertificate✔️community
    DeleteDeployment✔️community✔️✔️✔️✔️Show Tests
    DeleteDocumentationPart✔️community✔️✔️✔️Show Tests
    DeleteDocumentationVersion✔️community
    DeleteDomainName✔️community✔️✔️Show Tests
    DeleteGatewayResponse✔️community✔️✔️✔️Show Tests
    DeleteIntegration✔️community✔️✔️✔️Show Tests
    DeleteIntegrationResponse✔️community✔️✔️✔️Show Tests
    DeleteMethod✔️community✔️✔️✔️✔️Show Tests
    DeleteMethodResponse✔️community✔️
    DeleteModel✔️community✔️✔️✔️Show Tests
    DeleteRequestValidator✔️community✔️✔️✔️Show Tests
    DeleteResource✔️community✔️✔️✔️✔️Show Tests
    DeleteRestApi✔️community✔️✔️✔️✔️Show Tests
    DeleteStage✔️community✔️✔️✔️✔️Show Tests
    DeleteUsagePlan✔️community✔️✔️✔️✔️Show Tests
    DeleteUsagePlanKey✔️community✔️✔️✔️✔️Show Tests
    DeleteVpcLink✔️community✔️✔️✔️✔️Show Tests
    FlushStageAuthorizersCache
    FlushStageCache
    GenerateClientCertificate✔️community
    GetAccount✔️community✔️✔️Show Tests
    GetApiKey✔️community✔️✔️✔️✔️Show Tests
    GetApiKeys✔️community✔️✔️✔️Show Tests
    GetAuthorizer✔️community✔️
    GetAuthorizers✔️community✔️✔️✔️✔️Show Tests
    GetBasePathMapping✔️community✔️✔️Show Tests
    GetBasePathMappings✔️community✔️✔️Show Tests
    GetClientCertificate✔️community
    GetClientCertificates✔️community
    GetDeployment✔️community✔️✔️✔️✔️Show Tests
    GetDeployments✔️community✔️✔️✔️✔️Show Tests
    GetDocumentationPart✔️community✔️✔️✔️Show Tests
    GetDocumentationParts✔️community✔️✔️✔️Show Tests
    GetDocumentationVersion✔️community✔️✔️✔️Show Tests
    GetDocumentationVersions✔️community
    GetDomainName✔️community✔️✔️Show Tests
    GetDomainNames✔️community✔️✔️Show Tests
    GetExport✔️community✔️✔️✔️Show Tests
    GetGatewayResponse✔️community✔️✔️✔️✔️Show Tests
    GetGatewayResponses✔️community✔️✔️✔️Show Tests
    GetIntegration✔️community✔️✔️✔️✔️Show Tests
    GetIntegrationResponse✔️community✔️✔️✔️✔️Show Tests
    GetMethod✔️community✔️✔️✔️✔️Show Tests
    GetMethodResponse✔️community✔️✔️✔️✔️Show Tests
    GetModel✔️community✔️✔️✔️Show Tests
    GetModelTemplate
    GetModels✔️community✔️✔️✔️Show Tests
    GetRequestValidator✔️community✔️✔️✔️✔️Show Tests
    GetRequestValidators✔️community✔️✔️✔️✔️Show Tests
    GetResource✔️community✔️✔️✔️✔️Show Tests
    GetResources✔️community✔️✔️✔️✔️Show Tests
    GetRestApi✔️community✔️✔️✔️✔️Show Tests
    GetRestApis✔️community✔️✔️✔️✔️Show Tests
    GetSdk
    GetSdkType
    GetSdkTypes
    GetStage✔️community✔️✔️✔️✔️Show Tests
    GetStages✔️community✔️✔️✔️✔️Show Tests
    GetTags✔️community✔️Show Tests
    GetUsage
    GetUsagePlan✔️community✔️✔️✔️✔️Show Tests
    GetUsagePlanKey✔️community✔️
    GetUsagePlanKeys✔️community✔️✔️✔️✔️Show Tests
    GetUsagePlans✔️community✔️✔️✔️✔️Show Tests
    GetVpcLink✔️community✔️✔️✔️Show Tests
    GetVpcLinks✔️community✔️
    ImportApiKeys✔️community
    ImportDocumentationParts✔️community✔️✔️✔️Show Tests
    ImportRestApi✔️community✔️✔️✔️✔️Show Tests
    PutGatewayResponse✔️community✔️✔️✔️✔️Show Tests
    PutIntegration✔️community✔️✔️✔️✔️Show Tests
    PutIntegrationResponse✔️community✔️✔️✔️✔️Show Tests
    PutMethod✔️community✔️✔️✔️✔️Show Tests
    PutMethodResponse✔️community✔️✔️✔️✔️Show Tests
    PutRestApi✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️Show Tests
    TestInvokeAuthorizer
    TestInvokeMethod✔️community✔️✔️✔️Show Tests
    UntagResource✔️community
    UpdateAccount✔️community✔️✔️✔️Show Tests
    UpdateApiKey✔️community✔️✔️✔️✔️Show Tests
    UpdateAuthorizer✔️community
    UpdateBasePathMapping✔️community✔️✔️Show Tests
    UpdateClientCertificate✔️community
    UpdateDeployment✔️community✔️✔️✔️Show Tests
    UpdateDocumentationPart✔️community✔️✔️✔️Show Tests
    UpdateDocumentationVersion✔️community✔️✔️✔️Show Tests
    UpdateDomainName
    UpdateGatewayResponse✔️community✔️✔️✔️Show Tests
    UpdateIntegration✔️community✔️✔️✔️Show Tests
    UpdateIntegrationResponse✔️community✔️✔️✔️Show Tests
    UpdateMethod✔️community✔️✔️✔️Show Tests
    UpdateMethodResponse
    UpdateModel✔️community✔️✔️✔️Show Tests
    UpdateRequestValidator✔️community✔️✔️✔️✔️Show Tests
    UpdateResource✔️community✔️✔️✔️Show Tests
    UpdateRestApi✔️community✔️✔️✔️✔️Show Tests
    UpdateStage✔️community✔️✔️✔️✔️Show Tests
    UpdateUsage
    UpdateUsagePlan✔️community✔️✔️✔️Show Tests
    UpdateVpcLink✔️community

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApiKey

    Parameters: enabled, name

    • API Gateway Management API

    Implementation details for API apigatewaymanagementapi

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    API Gateway Management API

    Implementation details for API apigatewaymanagementapi

    Coverage Overview

    API Gateway Management API is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DeleteConnection✔️pro✔️✔️✔️Show Tests
    GetConnection✔️pro✔️✔️✔️Show Tests
    PostToConnection✔️pro✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteConnection

    Parameters: ConnectionId

    • API Gateway v2

    Implementation details for API apigatewayv2

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    API Gateway v2

    Implementation details for API apigatewayv2

    Coverage Overview

    API Gateway v2 is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApi✔️pro✔️✔️✔️✔️Show Tests
    CreateApiMapping✔️pro✔️✔️✔️✔️Show Tests
    CreateAuthorizer✔️pro✔️✔️✔️✔️Show Tests
    CreateDeployment✔️pro✔️✔️✔️Show Tests
    CreateDomainName✔️pro✔️✔️✔️✔️Show Tests
    CreateIntegration✔️pro✔️✔️✔️Show Tests
    CreateIntegrationResponse✔️pro✔️✔️✔️Show Tests
    CreateModel✔️pro✔️✔️✔️✔️Show Tests
    CreateRoute✔️pro✔️✔️✔️✔️Show Tests
    CreateRouteResponse✔️pro✔️✔️✔️✔️Show Tests
    CreateStage✔️pro✔️✔️✔️Show Tests
    CreateVpcLink✔️pro✔️✔️✔️Show Tests
    DeleteAccessLogSettings
    DeleteApi✔️pro✔️✔️✔️✔️Show Tests
    DeleteApiMapping✔️pro✔️✔️Show Tests
    DeleteAuthorizer✔️pro✔️Show Tests
    DeleteCorsConfiguration✔️pro✔️
    DeleteDeployment✔️pro✔️Show Tests
    DeleteDomainName✔️pro✔️✔️✔️✔️Show Tests
    DeleteIntegration✔️pro✔️✔️Show Tests
    DeleteIntegrationResponse✔️pro✔️Show Tests
    DeleteModel✔️pro✔️
    DeleteRoute✔️pro✔️✔️✔️Show Tests
    DeleteRouteRequestParameter
    DeleteRouteResponse✔️pro✔️✔️Show Tests
    DeleteRouteSettings
    DeleteStage✔️pro✔️✔️✔️Show Tests
    DeleteVpcLink✔️pro✔️✔️✔️Show Tests
    ExportApi
    ResetAuthorizersCache
    GetApi✔️pro✔️✔️✔️✔️Show Tests
    GetApiMapping✔️pro✔️✔️✔️✔️Show Tests
    GetApiMappings✔️pro✔️
    GetApis✔️pro✔️✔️Show Tests
    GetAuthorizer✔️pro✔️✔️Show Tests
    GetAuthorizers✔️pro✔️Show Tests
    GetDeployment✔️pro✔️✔️✔️Show Tests
    GetDeployments✔️pro
    GetDomainName✔️pro✔️✔️✔️Show Tests
    GetDomainNames✔️pro✔️✔️✔️✔️Show Tests
    GetIntegration✔️pro✔️Show Tests
    GetIntegrationResponse✔️pro✔️Show Tests
    GetIntegrationResponses✔️pro✔️Show Tests
    GetIntegrations✔️pro✔️✔️✔️✔️Show Tests
    GetModel✔️pro✔️
    GetModelTemplate
    GetModels✔️pro✔️Show Tests
    GetRoute✔️pro✔️Show Tests
    GetRouteResponse✔️pro✔️✔️Show Tests
    GetRouteResponses✔️pro
    GetRoutes✔️pro✔️✔️✔️✔️Show Tests
    GetStage✔️pro✔️Show Tests
    GetStages✔️pro
    GetTags✔️pro
    GetVpcLink✔️pro
    GetVpcLinks✔️pro✔️
    ImportApi✔️pro✔️✔️✔️Show Tests
    ReimportApi✔️pro✔️Show Tests
    TagResource✔️pro
    UntagResource✔️pro
    UpdateApi✔️pro
    UpdateApiMapping✔️pro
    UpdateAuthorizer✔️pro✔️
    UpdateDeployment✔️pro
    UpdateDomainName✔️pro
    UpdateIntegration✔️pro✔️Show Tests
    UpdateIntegrationResponse✔️pro✔️✔️✔️Show Tests
    UpdateModel✔️pro✔️
    UpdateRoute✔️pro✔️✔️✔️✔️Show Tests
    UpdateRouteResponse✔️pro✔️Show Tests
    UpdateStage✔️pro✔️Show Tests
    UpdateVpcLink✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApi

    Parameters: ApiKeySelectionExpression, Name, ProtocolType, RouteSelectionExpression

    • AppConfig

    Implementation details for API appconfig

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    AppConfig

    Implementation details for API appconfig

    Coverage Overview

    AppConfig is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApplication✔️pro✔️✔️✔️✔️Show Tests
    CreateConfigurationProfile✔️pro✔️✔️✔️✔️Show Tests
    CreateDeploymentStrategy✔️pro✔️✔️✔️Show Tests
    CreateEnvironment✔️pro✔️✔️✔️Show Tests
    CreateExtension
    CreateExtensionAssociation
    CreateHostedConfigurationVersion✔️pro✔️✔️✔️✔️Show Tests
    DeleteApplication✔️pro✔️✔️✔️✔️Show Tests
    DeleteConfigurationProfile✔️pro✔️✔️✔️Show Tests
    DeleteDeploymentStrategy✔️pro✔️✔️✔️Show Tests
    DeleteEnvironment✔️pro✔️✔️✔️Show Tests
    DeleteExtension
    DeleteExtensionAssociation
    DeleteHostedConfigurationVersion✔️pro✔️✔️✔️✔️Show Tests
    GetApplication✔️pro✔️✔️✔️✔️Show Tests
    GetConfiguration✔️pro✔️✔️✔️Show Tests
    GetConfigurationProfile✔️pro✔️✔️✔️Show Tests
    GetDeployment✔️pro✔️✔️✔️Show Tests
    GetDeploymentStrategy✔️pro✔️✔️✔️Show Tests
    GetEnvironment✔️pro✔️✔️✔️Show Tests
    GetExtension
    GetExtensionAssociation
    GetHostedConfigurationVersion✔️pro✔️✔️✔️✔️Show Tests
    ListApplications✔️pro✔️✔️✔️Show Tests
    ListConfigurationProfiles✔️pro✔️✔️✔️Show Tests
    ListDeploymentStrategies✔️pro✔️Show Tests
    ListDeployments✔️pro✔️✔️✔️Show Tests
    ListEnvironments✔️pro✔️✔️✔️Show Tests
    ListExtensionAssociations
    ListExtensions
    ListHostedConfigurationVersions✔️pro✔️✔️✔️Show Tests
    ListTagsForResource✔️pro✔️Show Tests
    StartDeployment✔️pro✔️✔️✔️Show Tests
    StopDeployment✔️pro✔️✔️✔️Show Tests
    TagResource✔️pro
    UntagResource✔️pro
    UpdateApplication✔️pro✔️✔️Show Tests
    UpdateConfigurationProfile✔️pro✔️Show Tests
    UpdateDeploymentStrategy✔️pro✔️Show Tests
    UpdateEnvironment✔️pro✔️Show Tests
    UpdateExtension
    UpdateExtensionAssociation
    ValidateConfiguration✔️pro✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApplication

    Parameters: Description, Name, Tags

    • AppConfig Data

    Implementation details for API appconfigdata

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    AppConfig Data

    Implementation details for API appconfigdata

    Coverage Overview

    AppConfig Data is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    GetLatestConfiguration✔️pro✔️✔️✔️Show Tests
    StartConfigurationSession✔️pro✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    GetLatestConfiguration

    Parameters: ConfigurationToken

    • Application Auto Scaling

    Implementation details for API application-autoscaling

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Application Auto Scaling

    Implementation details for API application-autoscaling

    Coverage Overview

    Application Auto Scaling is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DeleteScalingPolicy✔️pro✔️✔️✔️Show Tests
    DeleteScheduledAction✔️pro✔️
    DeregisterScalableTarget✔️pro✔️✔️✔️Show Tests
    DescribeScalableTargets✔️pro✔️
    DescribeScalingActivities
    DescribeScalingPolicies✔️pro✔️
    DescribeScheduledActions✔️pro✔️
    ListTagsForResource
    PutScalingPolicy✔️pro✔️✔️✔️Show Tests
    PutScheduledAction✔️pro✔️
    RegisterScalableTarget✔️pro✔️✔️✔️Show Tests
    TagResource
    UntagResource

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteScalingPolicy

    Parameters: PolicyName, ResourceId, ScalableDimension, ServiceNamespace

    • AppSync

    Implementation details for API appsync

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    AppSync

    Implementation details for API appsync

    Coverage Overview

    AppSync is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateApi✔️pro✔️Show Tests
    AssociateMergedGraphqlApi
    AssociateSourceGraphqlApi
    CreateApiCache✔️pro✔️Show Tests
    CreateApiKey✔️pro✔️✔️✔️✔️Show Tests
    CreateDataSource✔️pro✔️✔️✔️Show Tests
    CreateDomainName✔️pro✔️Show Tests
    CreateFunction✔️pro✔️✔️✔️Show Tests
    CreateGraphqlApi✔️pro✔️✔️✔️✔️Show Tests
    CreateResolver✔️pro✔️✔️✔️Show Tests
    CreateType✔️pro
    DeleteApiCache✔️pro
    DeleteApiKey✔️pro✔️✔️✔️✔️Show Tests
    DeleteDataSource✔️pro✔️✔️✔️Show Tests
    DeleteDomainName✔️pro✔️Show Tests
    DeleteFunction✔️pro✔️✔️✔️Show Tests
    DeleteGraphqlApi✔️pro✔️✔️✔️✔️Show Tests
    DeleteResolver✔️pro✔️✔️✔️Show Tests
    DeleteType✔️pro
    DisassociateApi✔️pro✔️Show Tests
    DisassociateMergedGraphqlApi
    DisassociateSourceGraphqlApi
    EvaluateCode✔️pro✔️✔️✔️Show Tests
    EvaluateMappingTemplate✔️pro✔️✔️✔️Show Tests
    FlushApiCache✔️pro
    GetApiAssociation✔️pro✔️Show Tests
    GetApiCache✔️pro
    GetDataSource✔️pro
    GetDataSourceIntrospection
    GetDomainName✔️pro
    GetFunction✔️pro✔️✔️✔️Show Tests
    GetGraphqlApi✔️pro✔️✔️✔️✔️Show Tests
    GetGraphqlApiEnvironmentVariables
    GetIntrospectionSchema✔️pro✔️✔️✔️Show Tests
    GetResolver✔️pro✔️✔️✔️Show Tests
    GetSchemaCreationStatus✔️pro✔️✔️✔️Show Tests
    GetSourceApiAssociation
    GetType✔️pro✔️✔️✔️Show Tests
    ListApiKeys✔️pro✔️✔️✔️✔️Show Tests
    ListDataSources✔️pro
    ListDomainNames✔️pro✔️Show Tests
    ListFunctions✔️pro✔️✔️✔️Show Tests
    ListGraphqlApis✔️pro✔️
    ListResolvers✔️pro
    ListResolversByFunction✔️pro
    ListSourceApiAssociations
    ListTagsForResource✔️pro✔️✔️Show Tests
    ListTypes✔️pro
    ListTypesByAssociation
    PutGraphqlApiEnvironmentVariables
    StartDataSourceIntrospection
    StartSchemaCreation✔️pro✔️✔️✔️✔️Show Tests
    StartSchemaMerge
    TagResource✔️pro✔️✔️Show Tests
    UntagResource✔️pro✔️
    UpdateApiCache✔️pro✔️Show Tests
    UpdateApiKey✔️pro✔️✔️Show Tests
    UpdateDataSource✔️pro
    UpdateDomainName✔️pro
    UpdateFunction✔️pro
    UpdateGraphqlApi✔️pro
    UpdateResolver✔️pro✔️✔️✔️Show Tests
    UpdateSourceApiAssociation
    UpdateType✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AssociateApi

    Parameters: apiId, domainName

    • Athena

    Implementation details for API athena

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Athena

    Implementation details for API athena

    Coverage Overview

    Athena is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchGetNamedQuery
    BatchGetPreparedStatement
    BatchGetQueryExecution
    CancelCapacityReservation
    CreateCapacityReservation
    CreateDataCatalog✔️pro✔️✔️✔️✔️Show Tests
    CreateNamedQuery✔️pro✔️✔️✔️✔️Show Tests
    CreateNotebook
    CreatePreparedStatement✔️pro✔️
    CreatePresignedNotebookUrl
    CreateWorkGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteCapacityReservation
    DeleteDataCatalog✔️pro✔️✔️✔️Show Tests
    DeleteNamedQuery✔️pro✔️✔️✔️Show Tests
    DeleteNotebook
    DeletePreparedStatement✔️pro
    DeleteWorkGroup✔️pro✔️✔️✔️Show Tests
    ExportNotebook
    GetCalculationExecution
    GetCalculationExecutionCode
    GetCalculationExecutionStatus
    GetCapacityAssignmentConfiguration
    GetCapacityReservation
    GetDataCatalog✔️pro✔️✔️✔️✔️Show Tests
    GetDatabase✔️pro
    GetNamedQuery✔️pro✔️✔️✔️✔️Show Tests
    GetNotebookMetadata
    GetPreparedStatement✔️pro✔️
    GetQueryExecution✔️pro✔️
    GetQueryResults✔️pro
    GetQueryRuntimeStatistics
    GetSession
    GetSessionStatus
    GetTableMetadata
    GetWorkGroup✔️pro✔️✔️✔️Show Tests
    ImportNotebook
    ListApplicationDPUSizes
    ListCalculationExecutions
    ListCapacityReservations
    ListDataCatalogs✔️pro✔️Show Tests
    ListDatabases✔️pro
    ListEngineVersions
    ListExecutors
    ListNamedQueries✔️pro✔️Show Tests
    ListNotebookMetadata
    ListNotebookSessions
    ListPreparedStatements✔️pro
    ListQueryExecutions✔️pro✔️
    ListSessions
    ListTableMetadata
    ListTagsForResource✔️pro✔️Show Tests
    ListWorkGroups✔️pro✔️Show Tests
    PutCapacityAssignmentConfiguration
    StartCalculationExecution
    StartQueryExecution✔️pro✔️
    StartSession
    StopCalculationExecution
    StopQueryExecution✔️pro✔️
    TagResource✔️pro✔️Show Tests
    TerminateSession
    UntagResource✔️pro✔️Show Tests
    UpdateCapacityReservation
    UpdateDataCatalog
    UpdateNamedQuery
    UpdateNotebook
    UpdateNotebookMetadata
    UpdatePreparedStatement✔️pro
    UpdateWorkGroup

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDataCatalog

    Parameters: Description, Name, Parameters, Tags, Type

    • Auto Scaling

    Implementation details for API autoscaling

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Auto Scaling

    Implementation details for API autoscaling

    Coverage Overview

    Auto Scaling is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AttachInstances✔️pro✔️
    AttachLoadBalancerTargetGroups✔️pro✔️
    AttachLoadBalancers✔️pro✔️
    AttachTrafficSources
    BatchDeleteScheduledAction✔️pro✔️
    BatchPutScheduledUpdateGroupAction✔️pro✔️
    CancelInstanceRefresh
    CompleteLifecycleAction
    CreateAutoScalingGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateLaunchConfiguration✔️pro✔️✔️✔️✔️Show Tests
    CreateOrUpdateTags✔️pro✔️
    DeleteAutoScalingGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteLaunchConfiguration✔️pro✔️✔️✔️Show Tests
    DeleteLifecycleHook✔️pro✔️
    DeleteNotificationConfiguration
    DeletePolicy✔️pro✔️
    DeleteScheduledAction✔️pro✔️
    DeleteTags✔️pro✔️
    DeleteWarmPool✔️pro✔️
    DescribeAccountLimits
    DescribeAdjustmentTypes
    DescribeAutoScalingGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeAutoScalingInstances✔️pro✔️
    DescribeAutoScalingNotificationTypes
    DescribeInstanceRefreshes
    DescribeLaunchConfigurations✔️pro✔️
    DescribeLifecycleHookTypes
    DescribeLifecycleHooks✔️pro✔️
    DescribeLoadBalancerTargetGroups✔️pro✔️
    DescribeLoadBalancers✔️pro✔️
    DescribeMetricCollectionTypes✔️pro✔️✔️Show Tests
    DescribeNotificationConfigurations
    DescribePolicies✔️pro✔️
    DescribeScalingActivities✔️pro
    DescribeScalingProcessTypes
    DescribeScheduledActions✔️pro✔️
    DescribeTags✔️pro✔️
    DescribeTerminationPolicyTypes
    DescribeTrafficSources
    DescribeWarmPool✔️pro✔️
    DetachInstances✔️pro✔️
    DetachLoadBalancerTargetGroups✔️pro✔️
    DetachLoadBalancers✔️pro✔️
    DetachTrafficSources
    DisableMetricsCollection✔️pro✔️✔️Show Tests
    EnableMetricsCollection✔️pro✔️✔️Show Tests
    EnterStandby✔️pro✔️
    ExecutePolicy✔️pro✔️
    ExitStandby✔️pro✔️
    GetPredictiveScalingForecast
    PutLifecycleHook✔️pro✔️
    PutNotificationConfiguration
    PutScalingPolicy✔️pro✔️
    PutScheduledUpdateGroupAction✔️pro✔️
    PutWarmPool✔️pro✔️
    RecordLifecycleActionHeartbeat
    ResumeProcesses✔️pro✔️
    RollbackInstanceRefresh
    SetDesiredCapacity✔️pro✔️
    SetInstanceHealth✔️pro✔️
    SetInstanceProtection✔️pro✔️
    StartInstanceRefresh
    SuspendProcesses✔️pro✔️
    TerminateInstanceInAutoScalingGroup✔️pro✔️
    UpdateAutoScalingGroup✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateAutoScalingGroup

    Parameters: AutoScalingGroupName, AvailabilityZones, LaunchConfigurationName, MaxSize, MinSize

    • Backup

    Implementation details for API backup

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Backup

    Implementation details for API backup

    Coverage Overview

    Backup is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelLegalHold
    CreateBackupPlan✔️pro✔️✔️✔️✔️Show Tests
    CreateBackupSelection✔️pro✔️Show Tests
    CreateBackupVault✔️pro✔️✔️✔️✔️Show Tests
    CreateFramework
    CreateLegalHold
    CreateLogicallyAirGappedBackupVault
    CreateReportPlan
    CreateRestoreTestingPlan
    CreateRestoreTestingSelection
    DeleteBackupPlan✔️pro✔️✔️✔️✔️Show Tests
    DeleteBackupSelection✔️pro✔️Show Tests
    DeleteBackupVault✔️pro✔️✔️✔️Show Tests
    DeleteBackupVaultAccessPolicy
    DeleteBackupVaultLockConfiguration
    DeleteBackupVaultNotifications
    DeleteFramework
    DeleteRecoveryPoint
    DeleteReportPlan
    DeleteRestoreTestingPlan
    DeleteRestoreTestingSelection
    DescribeBackupJob
    DescribeBackupVault✔️pro✔️Show Tests
    DescribeCopyJob
    DescribeFramework
    DescribeGlobalSettings
    DescribeProtectedResource
    DescribeRecoveryPoint
    DescribeRegionSettings
    DescribeReportJob
    DescribeReportPlan
    DescribeRestoreJob✔️pro✔️Show Tests
    DisassociateRecoveryPoint
    DisassociateRecoveryPointFromParent
    ExportBackupPlanTemplate
    GetBackupPlan✔️pro✔️✔️✔️✔️Show Tests
    GetBackupPlanFromJSON
    GetBackupPlanFromTemplate
    GetBackupSelection✔️pro✔️Show Tests
    GetBackupVaultAccessPolicy✔️pro
    GetBackupVaultNotifications
    GetLegalHold
    GetRecoveryPointRestoreMetadata
    GetRestoreJobMetadata
    GetRestoreTestingInferredMetadata
    GetRestoreTestingPlan
    GetRestoreTestingSelection
    GetSupportedResourceTypes
    ListBackupJobSummaries
    ListBackupJobs
    ListBackupPlanTemplates
    ListBackupPlanVersions
    ListBackupPlans✔️pro✔️✔️✔️✔️Show Tests
    ListBackupSelections✔️pro✔️Show Tests
    ListBackupVaults✔️pro✔️✔️Show Tests
    ListCopyJobSummaries
    ListCopyJobs
    ListFrameworks
    ListLegalHolds
    ListProtectedResources
    ListProtectedResourcesByBackupVault
    ListRecoveryPointsByBackupVault✔️pro✔️Show Tests
    ListRecoveryPointsByLegalHold
    ListRecoveryPointsByResource✔️pro✔️Show Tests
    ListReportJobs
    ListReportPlans
    ListRestoreJobSummaries
    ListRestoreJobs
    ListRestoreJobsByProtectedResource
    ListRestoreTestingPlans
    ListRestoreTestingSelections
    ListTags
    PutBackupVaultAccessPolicy✔️pro
    PutBackupVaultLockConfiguration
    PutBackupVaultNotifications
    PutRestoreValidationResult
    StartBackupJob
    StartCopyJob
    StartReportJob
    StartRestoreJob✔️pro✔️Show Tests
    StopBackupJob
    TagResource
    UntagResource
    UpdateBackupPlan✔️pro✔️Show Tests
    UpdateFramework
    UpdateGlobalSettings
    UpdateRecoveryPointLifecycle
    UpdateRegionSettings
    UpdateReportPlan
    UpdateRestoreTestingPlan
    UpdateRestoreTestingSelection

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateBackupPlan

    Parameters: BackupPlan

    • Batch

    Implementation details for API batch

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Batch

    Implementation details for API batch

    Coverage Overview

    Batch is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelJob✔️pro✔️
    CreateComputeEnvironment✔️pro✔️✔️✔️Show Tests
    CreateJobQueue✔️pro✔️✔️✔️✔️Show Tests
    CreateSchedulingPolicy✔️pro✔️
    DeleteComputeEnvironment✔️pro✔️✔️Show Tests
    DeleteJobQueue✔️pro✔️✔️Show Tests
    DeleteSchedulingPolicy✔️pro✔️
    DeregisterJobDefinition✔️pro✔️✔️✔️Show Tests
    DescribeComputeEnvironments✔️pro✔️✔️✔️Show Tests
    DescribeJobDefinitions✔️pro✔️✔️✔️✔️Show Tests
    DescribeJobQueues✔️pro✔️✔️✔️✔️Show Tests
    DescribeJobs✔️pro✔️✔️✔️Show Tests
    DescribeSchedulingPolicies✔️pro✔️
    GetJobQueueSnapshot
    ListJobs✔️pro
    ListSchedulingPolicies✔️pro✔️
    ListTagsForResource✔️pro✔️
    RegisterJobDefinition✔️pro✔️✔️✔️✔️Show Tests
    SubmitJob✔️pro✔️✔️✔️Show Tests
    TagResource✔️pro✔️
    TerminateJob✔️pro✔️
    UntagResource✔️pro✔️
    UpdateComputeEnvironment✔️pro✔️Show Tests
    UpdateJobQueue✔️pro
    UpdateSchedulingPolicy✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateComputeEnvironment

    Parameters: computeEnvironmentName, computeResources, serviceRole, state, type

    • CE (Cost Explorer API)

    Implementation details for API ce

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CE (Cost Explorer API)

    Implementation details for API ce

    Coverage Overview

    Cost Explorer API (CE) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateAnomalyMonitor✔️pro✔️Show Tests
    CreateAnomalySubscription✔️pro✔️Show Tests
    CreateCostCategoryDefinition✔️pro✔️✔️Show Tests
    DeleteAnomalyMonitor✔️pro✔️Show Tests
    DeleteAnomalySubscription✔️pro✔️Show Tests
    DeleteCostCategoryDefinition✔️pro✔️Show Tests
    DescribeCostCategoryDefinition✔️pro✔️✔️Show Tests
    GetAnomalies
    GetAnomalyMonitors✔️pro✔️Show Tests
    GetAnomalySubscriptions✔️pro✔️Show Tests
    GetApproximateUsageRecords
    GetCostAndUsage✔️pro✔️
    GetCostAndUsageWithResources
    GetCostCategories
    GetCostForecast
    GetDimensionValues
    GetReservationCoverage
    GetReservationPurchaseRecommendation
    GetReservationUtilization
    GetRightsizingRecommendation
    GetSavingsPlanPurchaseRecommendationDetails
    GetSavingsPlansCoverage
    GetSavingsPlansPurchaseRecommendation
    GetSavingsPlansUtilization
    GetSavingsPlansUtilizationDetails
    GetTags
    GetUsageForecast
    ListCostAllocationTagBackfillHistory
    ListCostAllocationTags
    ListCostCategoryDefinitions✔️pro✔️Show Tests
    ListSavingsPlansPurchaseRecommendationGeneration
    ListTagsForResource✔️pro✔️
    ProvideAnomalyFeedback
    StartCostAllocationTagBackfill
    StartSavingsPlansPurchaseRecommendationGeneration
    TagResource✔️pro✔️
    UntagResource✔️pro
    UpdateAnomalyMonitor✔️pro✔️Show Tests
    UpdateAnomalySubscription✔️pro✔️Show Tests
    UpdateCostAllocationTagsStatus
    UpdateCostCategoryDefinition✔️pro✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateAnomalyMonitor

    Parameters: AnomalyMonitor

    • CloudFormation

    Implementation details for API cloudformation

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CloudFormation

    Implementation details for API cloudformation

    Coverage Overview

    CloudFormation is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    ActivateOrganizationsAccess
    ActivateType
    BatchDescribeTypeConfigurations
    CancelUpdateStack
    ContinueUpdateRollback
    CreateChangeSet✔️community✔️✔️✔️✔️Show Tests
    CreateGeneratedTemplate
    CreateStack✔️community✔️✔️✔️✔️Show Tests
    CreateStackInstances✔️community✔️✔️✔️✔️Show Tests
    CreateStackSet✔️community✔️✔️✔️✔️Show Tests
    DeactivateOrganizationsAccess
    DeactivateType
    DeleteChangeSet✔️community✔️✔️✔️✔️Show Tests
    DeleteGeneratedTemplate
    DeleteStack✔️community✔️✔️✔️✔️Show Tests
    DeleteStackInstances✔️community✔️✔️✔️✔️Show Tests
    DeleteStackSet✔️community✔️✔️✔️Show Tests
    DeregisterType
    DescribeAccountLimits
    DescribeChangeSet✔️community✔️✔️✔️Show Tests
    DescribeChangeSetHooks
    DescribeGeneratedTemplate
    DescribeOrganizationsAccess
    DescribePublisher
    DescribeResourceScan
    DescribeStackDriftDetectionStatus
    DescribeStackEvents✔️community✔️✔️✔️Show Tests
    DescribeStackInstance
    DescribeStackResource✔️community✔️✔️✔️Show Tests
    DescribeStackResourceDrifts
    DescribeStackResources✔️community✔️✔️✔️Show Tests
    DescribeStackSet✔️community✔️
    DescribeStackSetOperation✔️community✔️✔️✔️Show Tests
    DescribeStacks✔️community✔️✔️✔️✔️Show Tests
    DescribeType
    DescribeTypeRegistration
    DetectStackDrift
    DetectStackResourceDrift
    DetectStackSetDrift
    EstimateTemplateCost
    ExecuteChangeSet✔️community✔️✔️✔️✔️Show Tests
    GetGeneratedTemplate
    GetStackPolicy
    GetTemplate✔️community✔️✔️✔️✔️Show Tests
    GetTemplateSummary✔️community✔️✔️✔️✔️Show Tests
    ImportStacksToStackSet
    ListChangeSets✔️community✔️
    ListExports✔️community✔️Show Tests
    ListGeneratedTemplates
    ListImports✔️community
    ListResourceScanRelatedResources
    ListResourceScanResources
    ListResourceScans
    ListStackInstanceResourceDrifts
    ListStackInstances✔️community✔️
    ListStackResources✔️community✔️✔️✔️✔️Show Tests
    ListStackSetAutoDeploymentTargets
    ListStackSetOperationResults
    ListStackSetOperations
    ListStackSets✔️community✔️
    ListStacks✔️community✔️✔️Show Tests
    ListTypeRegistrations
    ListTypeVersions
    ListTypes
    PublishType
    RecordHandlerProgress
    RegisterPublisher
    RegisterType✔️community
    RollbackStack
    SetStackPolicy
    SetTypeConfiguration
    SetTypeDefaultVersion
    SignalResource
    StartResourceScan
    StopStackSetOperation
    TestType
    UpdateGeneratedTemplate
    UpdateStack✔️community✔️✔️✔️✔️Show Tests
    UpdateStackInstances
    UpdateStackSet✔️community✔️
    UpdateTerminationProtection✔️community✔️✔️✔️Show Tests
    ValidateTemplate✔️community✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateChangeSet

    Parameters: Capabilities, ChangeSetName, ChangeSetType, Description, Parameters, StackName, TemplateBody

    • CloudFront

    Implementation details for API cloudfront

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CloudFront

    Implementation details for API cloudfront

    Coverage Overview

    CloudFront is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateAlias
    CopyDistribution
    CreateCachePolicy✔️pro✔️✔️✔️Show Tests
    CreateCloudFrontOriginAccessIdentity✔️pro✔️✔️✔️Show Tests
    CreateContinuousDeploymentPolicy
    CreateDistribution✔️pro✔️✔️✔️✔️Show Tests
    CreateDistributionWithTags✔️pro✔️✔️✔️✔️Show Tests
    CreateFieldLevelEncryptionConfig
    CreateFieldLevelEncryptionProfile
    CreateFunction✔️pro✔️✔️✔️Show Tests
    CreateInvalidation✔️pro✔️Show Tests
    CreateKeyGroup
    CreateKeyValueStore
    CreateMonitoringSubscription
    CreateOriginAccessControl✔️pro✔️✔️✔️Show Tests
    CreateOriginRequestPolicy✔️pro✔️✔️✔️Show Tests
    CreatePublicKey
    CreateRealtimeLogConfig
    CreateResponseHeadersPolicy✔️pro✔️✔️✔️Show Tests
    CreateStreamingDistribution
    CreateStreamingDistributionWithTags
    DeleteCachePolicy✔️pro✔️✔️✔️Show Tests
    DeleteCloudFrontOriginAccessIdentity✔️pro✔️✔️✔️Show Tests
    DeleteContinuousDeploymentPolicy
    DeleteDistribution✔️pro✔️✔️✔️✔️Show Tests
    DeleteFieldLevelEncryptionConfig
    DeleteFieldLevelEncryptionProfile
    DeleteFunction✔️pro✔️✔️✔️Show Tests
    DeleteKeyGroup
    DeleteKeyValueStore
    DeleteMonitoringSubscription
    DeleteOriginAccessControl✔️pro✔️✔️✔️Show Tests
    DeleteOriginRequestPolicy✔️pro✔️✔️✔️Show Tests
    DeletePublicKey
    DeleteRealtimeLogConfig
    DeleteResponseHeadersPolicy✔️pro✔️✔️✔️Show Tests
    DeleteStreamingDistribution
    DescribeFunction✔️pro✔️✔️✔️Show Tests
    DescribeKeyValueStore
    GetCachePolicy✔️pro✔️✔️✔️Show Tests
    GetCachePolicyConfig
    GetCloudFrontOriginAccessIdentity✔️pro✔️Show Tests
    GetCloudFrontOriginAccessIdentityConfig
    GetContinuousDeploymentPolicy
    GetContinuousDeploymentPolicyConfig
    GetDistribution✔️pro✔️✔️✔️✔️Show Tests
    GetDistributionConfig✔️pro✔️✔️✔️✔️Show Tests
    GetFieldLevelEncryption
    GetFieldLevelEncryptionConfig
    GetFieldLevelEncryptionProfile
    GetFieldLevelEncryptionProfileConfig
    GetFunction✔️pro✔️✔️✔️Show Tests
    GetInvalidation✔️pro✔️Show Tests
    GetKeyGroup
    GetKeyGroupConfig
    GetMonitoringSubscription
    GetOriginAccessControl✔️pro✔️✔️✔️Show Tests
    GetOriginAccessControlConfig✔️pro✔️✔️✔️Show Tests
    GetOriginRequestPolicy✔️pro✔️✔️✔️Show Tests
    GetOriginRequestPolicyConfig
    GetPublicKey
    GetPublicKeyConfig
    GetRealtimeLogConfig
    GetResponseHeadersPolicy✔️pro✔️✔️✔️Show Tests
    GetResponseHeadersPolicyConfig
    GetStreamingDistribution
    GetStreamingDistributionConfig
    ListCachePolicies✔️pro
    ListCloudFrontOriginAccessIdentities✔️pro✔️Show Tests
    ListConflictingAliases
    ListContinuousDeploymentPolicies
    ListDistributions✔️pro✔️✔️Show Tests
    ListDistributionsByCachePolicyId
    ListDistributionsByKeyGroup
    ListDistributionsByOriginRequestPolicyId
    ListDistributionsByRealtimeLogConfig
    ListDistributionsByResponseHeadersPolicyId
    ListDistributionsByWebACLId
    ListFieldLevelEncryptionConfigs
    ListFieldLevelEncryptionProfiles
    ListFunctions✔️pro✔️✔️✔️Show Tests
    ListInvalidations✔️pro✔️Show Tests
    ListKeyGroups
    ListKeyValueStores
    ListOriginAccessControls
    ListOriginRequestPolicies✔️pro✔️Show Tests
    ListPublicKeys
    ListRealtimeLogConfigs
    ListResponseHeadersPolicies✔️pro✔️✔️✔️Show Tests
    ListStreamingDistributions
    ListTagsForResource✔️pro✔️✔️Show Tests
    PublishFunction
    TagResource✔️pro
    TestFunction
    UntagResource✔️pro✔️Show Tests
    UpdateCachePolicy✔️pro
    UpdateCloudFrontOriginAccessIdentity
    UpdateContinuousDeploymentPolicy
    UpdateDistribution✔️pro✔️✔️✔️✔️Show Tests
    UpdateDistributionWithStagingConfig
    UpdateFieldLevelEncryptionConfig
    UpdateFieldLevelEncryptionProfile
    UpdateFunction✔️pro✔️✔️✔️Show Tests
    UpdateKeyGroup
    UpdateKeyValueStore
    UpdateOriginAccessControl✔️pro✔️✔️✔️Show Tests
    UpdateOriginRequestPolicy✔️pro✔️Show Tests
    UpdatePublicKey
    UpdateRealtimeLogConfig
    UpdateResponseHeadersPolicy✔️pro✔️✔️✔️Show Tests
    UpdateStreamingDistribution

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCachePolicy

    Parameters: CachePolicyConfig

    • CloudTrail

    Implementation details for API cloudtrail

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CloudTrail

    Implementation details for API cloudtrail

    Coverage Overview

    CloudTrail is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTags✔️pro✔️
    CancelQuery
    CreateChannel
    CreateEventDataStore
    CreateTrail✔️pro✔️✔️✔️✔️Show Tests
    DeleteChannel
    DeleteEventDataStore
    DeleteResourcePolicy
    DeleteTrail✔️pro✔️✔️✔️✔️Show Tests
    DeregisterOrganizationDelegatedAdmin
    DescribeQuery
    DescribeTrails✔️pro✔️✔️✔️✔️Show Tests
    DisableFederation
    EnableFederation
    GetChannel
    GetEventDataStore
    GetEventSelectors✔️pro
    GetImport
    GetInsightSelectors✔️pro✔️
    GetQueryResults
    GetResourcePolicy
    GetTrail✔️pro✔️✔️✔️✔️Show Tests
    GetTrailStatus✔️pro✔️✔️✔️✔️Show Tests
    ListChannels
    ListEventDataStores
    ListImportFailures
    ListImports
    ListInsightsMetricData
    ListPublicKeys
    ListQueries
    ListTags✔️pro✔️✔️✔️✔️Show Tests
    ListTrails✔️pro✔️✔️✔️✔️Show Tests
    LookupEvents✔️pro✔️✔️✔️Show Tests
    PutEventSelectors✔️pro✔️✔️✔️✔️Show Tests
    PutInsightSelectors✔️pro✔️
    PutResourcePolicy
    RegisterOrganizationDelegatedAdmin
    RemoveTags✔️pro✔️
    RestoreEventDataStore
    StartEventDataStoreIngestion
    StartImport
    StartLogging✔️pro✔️✔️✔️Show Tests
    StartQuery
    StopEventDataStoreIngestion
    StopImport
    StopLogging✔️pro✔️✔️✔️Show Tests
    UpdateChannel
    UpdateEventDataStore
    UpdateTrail✔️pro✔️✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateTrail

    Parameters: CloudWatchLogsLogGroupArn, CloudWatchLogsRoleArn, EnableLogFileValidation, IncludeGlobalServiceEvents, IsMultiRegionTrail, Name, S3BucketName, TagsList

    • CloudWatch

    Implementation details for API cloudwatch

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CloudWatch

    Implementation details for API cloudwatch

    Coverage Overview

    CloudWatch is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DeleteAlarms✔️community✔️✔️✔️✔️Show Tests
    DeleteAnomalyDetector
    DeleteDashboards✔️community✔️✔️✔️✔️Show Tests
    DeleteInsightRules
    DeleteMetricStream
    DescribeAlarmHistory✔️pro
    DescribeAlarms✔️community✔️✔️✔️✔️Show Tests
    DescribeAlarmsForMetric✔️community✔️
    DescribeAnomalyDetectors
    DescribeInsightRules
    DisableAlarmActions✔️community✔️✔️✔️Show Tests
    DisableInsightRules
    EnableAlarmActions✔️community✔️✔️✔️Show Tests
    EnableInsightRules
    GetDashboard✔️community✔️✔️✔️✔️Show Tests
    GetInsightRuleReport
    GetMetricData✔️community✔️✔️✔️✔️Show Tests
    GetMetricStatistics✔️community✔️✔️✔️✔️Show Tests
    GetMetricStream
    GetMetricWidgetImage
    ListDashboards✔️community✔️✔️✔️✔️Show Tests
    ListManagedInsightRules
    ListMetricStreams
    ListMetrics✔️community✔️✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️✔️✔️✔️Show Tests
    PutAnomalyDetector
    PutCompositeAlarm✔️community✔️✔️✔️Show Tests
    PutDashboard✔️community✔️✔️✔️✔️Show Tests
    PutInsightRule
    PutManagedInsightRules
    PutMetricAlarm✔️community✔️✔️✔️✔️Show Tests
    PutMetricData✔️community✔️✔️✔️✔️Show Tests
    PutMetricStream
    SetAlarmState✔️community✔️✔️✔️Show Tests
    StartMetricStreams
    StopMetricStreams
    TagResource✔️community✔️✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteAlarms

    Parameters: AlarmNames

    • CodeCommit

    Implementation details for API codecommit

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CodeCommit

    Implementation details for API codecommit

    Coverage Overview

    CodeCommit is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateApprovalRuleTemplateWithRepository
    BatchAssociateApprovalRuleTemplateWithRepositories
    BatchDescribeMergeConflicts
    BatchDisassociateApprovalRuleTemplateFromRepositories
    BatchGetCommits
    BatchGetRepositories
    CreateApprovalRuleTemplate
    CreateBranch✔️pro✔️Show Tests
    CreateCommit✔️pro✔️Show Tests
    CreatePullRequest✔️pro✔️Show Tests
    CreatePullRequestApprovalRule
    CreateRepository✔️pro✔️✔️Show Tests
    CreateUnreferencedMergeCommit
    DeleteApprovalRuleTemplate
    DeleteBranch✔️pro✔️Show Tests
    DeleteCommentContent
    DeleteFile
    DeletePullRequestApprovalRule
    DeleteRepository✔️pro✔️Show Tests
    DescribeMergeConflicts
    DescribePullRequestEvents
    DisassociateApprovalRuleTemplateFromRepository
    EvaluatePullRequestApprovalRules
    GetApprovalRuleTemplate
    GetBlob
    GetBranch✔️pro✔️Show Tests
    GetComment
    GetCommentReactions
    GetCommentsForComparedCommit
    GetCommentsForPullRequest
    GetCommit
    GetDifferences
    GetFile✔️pro✔️Show Tests
    GetFolder✔️pro✔️Show Tests
    GetMergeCommit
    GetMergeConflicts
    GetMergeOptions
    GetPullRequest
    GetPullRequestApprovalStates
    GetPullRequestOverrideState
    GetRepository✔️pro✔️Show Tests
    GetRepositoryTriggers
    ListApprovalRuleTemplates
    ListAssociatedApprovalRuleTemplatesForRepository
    ListBranches
    ListFileCommitHistory
    ListPullRequests✔️pro✔️Show Tests
    ListRepositories✔️pro
    ListRepositoriesForApprovalRuleTemplate
    ListTagsForResource✔️pro✔️Show Tests
    MergeBranchesByFastForward
    MergeBranchesBySquash
    MergeBranchesByThreeWay
    MergePullRequestByFastForward
    MergePullRequestBySquash
    MergePullRequestByThreeWay
    OverridePullRequestApprovalRules
    PostCommentForComparedCommit
    PostCommentForPullRequest
    PostCommentReply
    PutCommentReaction
    PutFile
    PutRepositoryTriggers
    TagResource✔️pro✔️Show Tests
    TestRepositoryTriggers
    UntagResource✔️pro✔️Show Tests
    UpdateApprovalRuleTemplateContent
    UpdateApprovalRuleTemplateDescription
    UpdateApprovalRuleTemplateName
    UpdateComment
    UpdateDefaultBranch
    UpdatePullRequestApprovalRuleContent
    UpdatePullRequestApprovalState
    UpdatePullRequestDescription
    UpdatePullRequestStatus
    UpdatePullRequestTitle
    UpdateRepositoryDescription
    UpdateRepositoryEncryptionKey
    UpdateRepositoryName

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateBranch

    Parameters: branchName, commitId, repositoryName

    • Cognito Identity

    Implementation details for API cognito-identity

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Cognito Identity

    Implementation details for API cognito-identity

    Coverage Overview

    Cognito Identity is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateIdentityPool✔️pro✔️✔️✔️✔️Show Tests
    DeleteIdentities
    DeleteIdentityPool✔️pro✔️✔️✔️Show Tests
    DescribeIdentity
    DescribeIdentityPool✔️pro✔️✔️✔️✔️Show Tests
    GetCredentialsForIdentity✔️pro✔️✔️✔️✔️Show Tests
    GetId✔️pro✔️✔️✔️Show Tests
    GetIdentityPoolRoles✔️pro✔️Show Tests
    GetOpenIdToken✔️pro
    GetOpenIdTokenForDeveloperIdentity✔️pro✔️
    GetPrincipalTagAttributeMap
    ListIdentities✔️pro
    ListIdentityPools✔️pro✔️✔️Show Tests
    ListTagsForResource
    LookupDeveloperIdentity
    MergeDeveloperIdentities
    SetIdentityPoolRoles✔️pro✔️✔️✔️Show Tests
    SetPrincipalTagAttributeMap
    TagResource
    UnlinkDeveloperIdentity
    UnlinkIdentity
    UntagResource
    UpdateIdentityPool✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateIdentityPool

    Parameters: AllowUnauthenticatedIdentities, CognitoIdentityProviders, IdentityPoolName

    • Cognito IDP (Cognito User Pools API)

    Implementation details for API cognito-idp

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Cognito IDP (Cognito User Pools API)

    Implementation details for API cognito-idp

    Coverage Overview

    Cognito User Pools API (Cognito IDP) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddCustomAttributes✔️pro✔️✔️✔️Show Tests
    AdminAddUserToGroup✔️pro✔️✔️✔️✔️Show Tests
    AdminConfirmSignUp✔️pro✔️✔️✔️✔️Show Tests
    AdminCreateUser✔️pro✔️✔️✔️✔️Show Tests
    AdminDeleteUser✔️pro✔️✔️✔️✔️Show Tests
    AdminDeleteUserAttributes✔️pro✔️✔️Show Tests
    AdminDisableProviderForUser
    AdminDisableUser✔️pro✔️✔️✔️✔️Show Tests
    AdminEnableUser✔️pro✔️✔️✔️✔️Show Tests
    AdminForgetDevice
    AdminGetDevice
    AdminGetUser✔️pro✔️✔️✔️✔️Show Tests
    AdminInitiateAuth✔️pro✔️✔️✔️✔️Show Tests
    AdminLinkProviderForUser
    AdminListDevices
    AdminListGroupsForUser✔️pro✔️✔️Show Tests
    AdminListUserAuthEvents
    AdminRemoveUserFromGroup✔️pro✔️
    AdminResetUserPassword✔️pro
    AdminRespondToAuthChallenge✔️pro✔️✔️✔️Show Tests
    AdminSetUserMFAPreference✔️pro✔️✔️✔️Show Tests
    AdminSetUserPassword✔️pro✔️✔️✔️✔️Show Tests
    AdminSetUserSettings
    AdminUpdateAuthEventFeedback
    AdminUpdateDeviceStatus
    AdminUpdateUserAttributes✔️pro✔️✔️✔️✔️Show Tests
    AdminUserGlobalSignOut✔️pro✔️✔️✔️Show Tests
    AssociateSoftwareToken✔️pro✔️Show Tests
    ChangePassword✔️pro✔️✔️✔️Show Tests
    ConfirmDevice✔️pro
    ConfirmForgotPassword✔️pro✔️✔️✔️✔️Show Tests
    ConfirmSignUp✔️pro
    CreateGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateIdentityProvider✔️pro✔️✔️✔️✔️Show Tests
    CreateResourceServer✔️pro✔️✔️✔️✔️Show Tests
    CreateUserImportJob
    CreateUserPool✔️pro✔️✔️✔️✔️Show Tests
    CreateUserPoolClient✔️pro✔️✔️✔️✔️Show Tests
    CreateUserPoolDomain✔️pro✔️✔️✔️✔️Show Tests
    DeleteGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteIdentityProvider✔️pro✔️✔️Show Tests
    DeleteResourceServer✔️pro✔️✔️✔️Show Tests
    DeleteUser✔️pro✔️✔️✔️Show Tests
    DeleteUserAttributes✔️pro✔️✔️Show Tests
    DeleteUserPool✔️pro✔️✔️✔️✔️Show Tests
    DeleteUserPoolClient✔️pro✔️✔️✔️✔️Show Tests
    DeleteUserPoolDomain✔️pro✔️✔️✔️Show Tests
    DescribeIdentityProvider✔️pro✔️✔️✔️✔️Show Tests
    DescribeResourceServer✔️pro✔️Show Tests
    DescribeRiskConfiguration
    DescribeUserImportJob
    DescribeUserPool✔️pro✔️✔️✔️✔️Show Tests
    DescribeUserPoolClient✔️pro✔️✔️✔️✔️Show Tests
    DescribeUserPoolDomain✔️pro✔️✔️✔️Show Tests
    ForgetDevice
    ForgotPassword✔️pro✔️✔️✔️Show Tests
    GetCSVHeader
    GetDevice
    GetGroup✔️pro✔️✔️✔️✔️Show Tests
    GetIdentityProviderByIdentifier✔️pro✔️✔️✔️Show Tests
    GetLogDeliveryConfiguration
    GetSigningCertificate✔️pro✔️Show Tests
    GetUICustomization
    GetUser✔️pro✔️✔️✔️Show Tests
    GetUserAttributeVerificationCode
    GetUserPoolMfaConfig✔️pro✔️✔️✔️Show Tests
    GlobalSignOut✔️pro✔️✔️Show Tests
    InitiateAuth✔️pro✔️✔️✔️Show Tests
    ListDevices
    ListGroups✔️pro✔️✔️Show Tests
    ListIdentityProviders✔️pro✔️
    ListResourceServers✔️pro✔️✔️Show Tests
    ListTagsForResource✔️pro✔️✔️Show Tests
    ListUserImportJobs
    ListUserPoolClients✔️pro✔️✔️✔️✔️Show Tests
    ListUserPools✔️pro✔️✔️Show Tests
    ListUsers✔️pro✔️✔️✔️✔️Show Tests
    ListUsersInGroup✔️pro✔️✔️✔️✔️Show Tests
    ResendConfirmationCode
    RespondToAuthChallenge✔️pro✔️✔️✔️Show Tests
    RevokeToken
    SetLogDeliveryConfiguration
    SetRiskConfiguration
    SetUICustomization
    SetUserMFAPreference✔️pro✔️✔️✔️Show Tests
    SetUserPoolMfaConfig✔️pro✔️Show Tests
    SetUserSettings
    SignUp✔️pro✔️✔️✔️✔️Show Tests
    StartUserImportJob
    StopUserImportJob
    TagResource✔️pro✔️✔️Show Tests
    UntagResource✔️pro✔️✔️Show Tests
    UpdateAuthEventFeedback
    UpdateDeviceStatus
    UpdateGroup✔️pro✔️
    UpdateIdentityProvider✔️pro✔️✔️✔️✔️Show Tests
    UpdateResourceServer✔️pro
    UpdateUserAttributes✔️pro
    UpdateUserPool✔️pro✔️Show Tests
    UpdateUserPoolClient✔️pro✔️✔️✔️✔️Show Tests
    UpdateUserPoolDomain✔️pro
    VerifySoftwareToken✔️pro✔️Show Tests
    VerifyUserAttribute

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddCustomAttributes

    Parameters: CustomAttributes, UserPoolId

    • Config

    Implementation details for API config

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Config

    Implementation details for API config

    Coverage Overview

    Config is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchGetAggregateResourceConfig✔️community
    BatchGetResourceConfig✔️community
    DeleteAggregationAuthorization✔️community✔️
    DeleteConfigRule✔️community✔️
    DeleteConfigurationAggregator✔️community✔️
    DeleteConfigurationRecorder✔️community✔️✔️Show Tests
    DeleteConformancePack
    DeleteDeliveryChannel✔️community✔️✔️Show Tests
    DeleteEvaluationResults
    DeleteOrganizationConfigRule
    DeleteOrganizationConformancePack✔️community✔️
    DeletePendingAggregationRequest
    DeleteRemediationConfiguration
    DeleteRemediationExceptions
    DeleteResourceConfig
    DeleteRetentionConfiguration✔️community✔️
    DeleteStoredQuery
    DeliverConfigSnapshot
    DescribeAggregateComplianceByConfigRules
    DescribeAggregateComplianceByConformancePacks
    DescribeAggregationAuthorizations✔️community✔️
    DescribeComplianceByConfigRule
    DescribeComplianceByResource
    DescribeConfigRuleEvaluationStatus
    DescribeConfigRules✔️community✔️
    DescribeConfigurationAggregatorSourcesStatus
    DescribeConfigurationAggregators✔️community✔️
    DescribeConfigurationRecorderStatus✔️community✔️
    DescribeConfigurationRecorders✔️community✔️✔️Show Tests
    DescribeConformancePackCompliance
    DescribeConformancePackStatus
    DescribeConformancePacks
    DescribeDeliveryChannelStatus
    DescribeDeliveryChannels✔️community✔️✔️Show Tests
    DescribeOrganizationConfigRuleStatuses
    DescribeOrganizationConfigRules
    DescribeOrganizationConformancePackStatuses✔️community✔️
    DescribeOrganizationConformancePacks✔️community✔️
    DescribePendingAggregationRequests
    DescribeRemediationConfigurations
    DescribeRemediationExceptions
    DescribeRemediationExecutionStatus
    DescribeRetentionConfigurations✔️community✔️
    GetAggregateComplianceDetailsByConfigRule
    GetAggregateConfigRuleComplianceSummary
    GetAggregateConformancePackComplianceSummary
    GetAggregateDiscoveredResourceCounts
    GetAggregateResourceConfig
    GetComplianceDetailsByConfigRule
    GetComplianceDetailsByResource
    GetComplianceSummaryByConfigRule
    GetComplianceSummaryByResourceType
    GetConformancePackComplianceDetails
    GetConformancePackComplianceSummary
    GetCustomRulePolicy
    GetDiscoveredResourceCounts
    GetOrganizationConfigRuleDetailedStatus
    GetOrganizationConformancePackDetailedStatus✔️community✔️
    GetOrganizationCustomRulePolicy
    GetResourceConfigHistory✔️community
    GetResourceEvaluationSummary
    GetStoredQuery
    ListAggregateDiscoveredResources✔️community
    ListConformancePackComplianceScores
    ListDiscoveredResources✔️community
    ListResourceEvaluations
    ListStoredQueries
    ListTagsForResource✔️community✔️
    PutAggregationAuthorization✔️community✔️
    PutConfigRule✔️community✔️
    PutConfigurationAggregator✔️community✔️
    PutConfigurationRecorder✔️community✔️✔️Show Tests
    PutConformancePack
    PutDeliveryChannel✔️community✔️✔️Show Tests
    PutEvaluations✔️community
    PutExternalEvaluation
    PutOrganizationConfigRule
    PutOrganizationConformancePack✔️community✔️
    PutRemediationConfigurations
    PutRemediationExceptions
    PutResourceConfig
    PutRetentionConfiguration✔️community✔️
    PutStoredQuery
    SelectAggregateResourceConfig
    SelectResourceConfig
    StartConfigRulesEvaluation
    StartConfigurationRecorder✔️community✔️
    StartRemediationExecution
    StartResourceEvaluation
    StopConfigurationRecorder✔️community✔️
    TagResource✔️community✔️
    UntagResource✔️community✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteConfigurationRecorder

    Parameters: ConfigurationRecorderName

    • DMS (Database Migration Service)

    Implementation details for API dms

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    DMS (Database Migration Service)

    Implementation details for API dms

    Coverage Overview

    Database Migration Service (DMS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTagsToResource✔️pro✔️✔️✔️Show Tests
    ApplyPendingMaintenanceAction
    BatchStartRecommendations
    CancelReplicationTaskAssessmentRun
    CreateDataProvider
    CreateEndpoint✔️pro✔️✔️✔️Show Tests
    CreateEventSubscription
    CreateFleetAdvisorCollector
    CreateInstanceProfile
    CreateMigrationProject
    CreateReplicationConfig
    CreateReplicationInstance✔️pro✔️✔️✔️Show Tests
    CreateReplicationSubnetGroup✔️pro✔️✔️✔️Show Tests
    CreateReplicationTask✔️pro✔️✔️✔️Show Tests
    DeleteCertificate
    DeleteConnection✔️pro✔️✔️✔️Show Tests
    DeleteDataProvider
    DeleteEndpoint✔️pro✔️✔️✔️Show Tests
    DeleteEventSubscription
    DeleteFleetAdvisorCollector
    DeleteFleetAdvisorDatabases
    DeleteInstanceProfile
    DeleteMigrationProject
    DeleteReplicationConfig
    DeleteReplicationInstance✔️pro✔️✔️✔️Show Tests
    DeleteReplicationSubnetGroup✔️pro✔️✔️✔️Show Tests
    DeleteReplicationTask✔️pro✔️✔️✔️Show Tests
    DeleteReplicationTaskAssessmentRun
    DescribeAccountAttributes
    DescribeApplicableIndividualAssessments
    DescribeCertificates
    DescribeConnections✔️pro✔️✔️✔️Show Tests
    DescribeConversionConfiguration
    DescribeDataProviders
    DescribeEndpointSettings✔️pro✔️✔️✔️Show Tests
    DescribeEndpointTypes✔️pro✔️✔️✔️Show Tests
    DescribeEndpoints✔️pro✔️✔️✔️Show Tests
    DescribeEngineVersions
    DescribeEventCategories
    DescribeEventSubscriptions
    DescribeEvents
    DescribeExtensionPackAssociations
    DescribeFleetAdvisorCollectors
    DescribeFleetAdvisorDatabases
    DescribeFleetAdvisorLsaAnalysis
    DescribeFleetAdvisorSchemaObjectSummary
    DescribeFleetAdvisorSchemas
    DescribeInstanceProfiles
    DescribeMetadataModelAssessments
    DescribeMetadataModelConversions
    DescribeMetadataModelExportsAsScript
    DescribeMetadataModelExportsToTarget
    DescribeMetadataModelImports
    DescribeMigrationProjects
    DescribeOrderableReplicationInstances
    DescribePendingMaintenanceActions
    DescribeRecommendationLimitations
    DescribeRecommendations
    DescribeRefreshSchemasStatus
    DescribeReplicationConfigs
    DescribeReplicationInstanceTaskLogs
    DescribeReplicationInstances✔️pro✔️✔️✔️Show Tests
    DescribeReplicationSubnetGroups✔️pro✔️✔️✔️Show Tests
    DescribeReplicationTableStatistics
    DescribeReplicationTaskAssessmentResults
    DescribeReplicationTaskAssessmentRuns
    DescribeReplicationTaskIndividualAssessments
    DescribeReplicationTasks✔️pro✔️✔️✔️Show Tests
    DescribeReplications
    DescribeSchemas
    DescribeTableStatistics✔️pro✔️✔️✔️Show Tests
    ExportMetadataModelAssessment
    ImportCertificate
    ListTagsForResource✔️pro✔️✔️✔️Show Tests
    ModifyConversionConfiguration
    ModifyDataProvider
    ModifyEndpoint
    ModifyEventSubscription
    ModifyInstanceProfile
    ModifyMigrationProject
    ModifyReplicationConfig
    ModifyReplicationInstance
    ModifyReplicationSubnetGroup
    ModifyReplicationTask
    MoveReplicationTask
    RebootReplicationInstance
    RefreshSchemas
    ReloadReplicationTables
    ReloadTables
    RemoveTagsFromResource✔️pro✔️✔️✔️Show Tests
    RunFleetAdvisorLsaAnalysis
    StartExtensionPackAssociation
    StartMetadataModelAssessment
    StartMetadataModelConversion
    StartMetadataModelExportAsScript
    StartMetadataModelExportToTarget
    StartMetadataModelImport
    StartRecommendations
    StartReplication
    StartReplicationTask✔️pro✔️✔️✔️Show Tests
    StartReplicationTaskAssessment
    StartReplicationTaskAssessmentRun
    StopReplication
    StopReplicationTask✔️pro✔️✔️✔️Show Tests
    TestConnection✔️pro✔️✔️✔️Show Tests
    UpdateSubscriptionsToEventBridge

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTagsToResource

    Parameters: ResourceArn, Tags

    • DocumentDB

    Implementation details for API docdb

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    DocumentDB

    Implementation details for API docdb

    Coverage Overview

    DocumentDB is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddSourceIdentifierToSubscription
    AddTagsToResource✔️pro✔️
    ApplyPendingMaintenanceAction
    CopyDBClusterParameterGroup
    CopyDBClusterSnapshot✔️pro✔️
    CreateDBCluster✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterSnapshot✔️pro
    CreateDBInstance✔️pro✔️✔️✔️✔️Show Tests
    CreateDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateEventSubscription✔️pro✔️
    CreateGlobalCluster✔️pro
    DeleteDBCluster✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    DeleteDBClusterSnapshot✔️pro
    DeleteDBInstance✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteEventSubscription✔️pro✔️
    DeleteGlobalCluster✔️pro
    DescribeCertificates✔️pro
    DescribeDBClusterParameterGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBClusterParameters✔️pro✔️✔️✔️Show Tests
    DescribeDBClusterSnapshotAttributes✔️pro
    DescribeDBClusterSnapshots✔️pro
    DescribeDBClusters✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBEngineVersions✔️pro
    DescribeDBInstances✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBSubnetGroups✔️pro✔️
    DescribeEngineDefaultClusterParameters
    DescribeEventCategories
    DescribeEventSubscriptions✔️pro✔️
    DescribeEvents
    DescribeGlobalClusters✔️pro
    DescribeOrderableDBInstanceOptions✔️pro
    DescribePendingMaintenanceActions
    FailoverDBCluster
    ListTagsForResource✔️pro✔️
    ModifyDBCluster✔️pro✔️
    ModifyDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    ModifyDBClusterSnapshotAttribute✔️pro
    ModifyDBInstance✔️pro✔️
    ModifyDBSubnetGroup✔️pro✔️
    ModifyEventSubscription
    ModifyGlobalCluster✔️pro
    RebootDBInstance✔️pro✔️✔️Show Tests
    RemoveFromGlobalCluster✔️pro
    RemoveSourceIdentifierFromSubscription
    RemoveTagsFromResource✔️pro✔️
    ResetDBClusterParameterGroup✔️pro
    RestoreDBClusterFromSnapshot✔️pro
    RestoreDBClusterToPointInTime
    StartDBCluster✔️pro✔️
    StopDBCluster✔️pro✔️
    SwitchoverGlobalCluster

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDBCluster

    Parameters: CopyTagsToSnapshot, DBClusterIdentifier, DBClusterParameterGroupName, DBSubnetGroupName, DatabaseName, Engine, EngineVersion, MasterUserPassword, MasterUsername, Port, ServerlessV2ScalingConfiguration, VpcSecurityGroupIds

    • DynamoDB

    Implementation details for API dynamodb

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    DynamoDB

    Implementation details for API dynamodb

    Coverage Overview

    DynamoDB is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchExecuteStatement✔️community✔️✔️✔️✔️Show Tests
    BatchGetItem✔️community✔️✔️✔️✔️Show Tests
    BatchWriteItem✔️community✔️✔️✔️✔️Show Tests
    CreateBackup✔️pro✔️✔️Show Tests
    CreateGlobalTable✔️community✔️✔️✔️Show Tests
    CreateTable✔️community✔️✔️✔️✔️Show Tests
    DeleteBackup✔️pro✔️Show Tests
    DeleteItem✔️community✔️✔️✔️✔️Show Tests
    DeleteResourcePolicy
    DeleteTable✔️community✔️✔️✔️✔️Show Tests
    DescribeBackup
    DescribeContinuousBackups✔️community✔️✔️✔️✔️Show Tests
    DescribeContributorInsights
    DescribeEndpoints
    DescribeExport
    DescribeGlobalTable✔️community✔️✔️✔️Show Tests
    DescribeGlobalTableSettings
    DescribeImport
    DescribeKinesisStreamingDestination✔️community✔️✔️✔️Show Tests
    DescribeLimits✔️community
    DescribeTable✔️community✔️✔️✔️✔️Show Tests
    DescribeTableReplicaAutoScaling
    DescribeTimeToLive✔️community✔️✔️✔️✔️Show Tests
    DisableKinesisStreamingDestination✔️community✔️✔️✔️Show Tests
    EnableKinesisStreamingDestination✔️community✔️✔️✔️Show Tests
    ExecuteStatement✔️community✔️✔️✔️✔️Show Tests
    ExecuteTransaction✔️community✔️✔️✔️Show Tests
    ExportTableToPointInTime
    GetItem✔️community✔️✔️✔️✔️Show Tests
    GetResourcePolicy
    ImportTable
    ListBackups✔️pro✔️
    ListContributorInsights
    ListExports
    ListGlobalTables✔️community
    ListImports
    ListTables✔️community✔️✔️✔️✔️Show Tests
    ListTagsOfResource✔️community✔️✔️✔️✔️Show Tests
    PutItem✔️community✔️✔️✔️✔️Show Tests
    PutResourcePolicy
    Query✔️community✔️✔️✔️✔️Show Tests
    RestoreTableFromBackup✔️pro✔️✔️Show Tests
    RestoreTableToPointInTime
    Scan✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️✔️Show Tests
    TransactGetItems✔️community✔️✔️✔️✔️Show Tests
    TransactWriteItems✔️community✔️✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️✔️Show Tests
    UpdateContinuousBackups✔️community✔️✔️✔️Show Tests
    UpdateContributorInsights
    UpdateGlobalTable✔️community✔️✔️✔️Show Tests
    UpdateGlobalTableSettings
    UpdateItem✔️community✔️✔️✔️✔️Show Tests
    UpdateKinesisStreamingDestination
    UpdateTable✔️community✔️✔️✔️✔️Show Tests
    UpdateTableReplicaAutoScaling
    UpdateTimeToLive✔️community✔️✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    BatchExecuteStatement

    Parameters: Statements

    • DynamoDB Streams

    Implementation details for API dynamodbstreams

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    DynamoDB Streams

    Implementation details for API dynamodbstreams

    Coverage Overview

    DynamoDB Streams is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DescribeStream✔️community✔️✔️✔️✔️Show Tests
    GetRecords✔️community✔️✔️✔️✔️Show Tests
    GetShardIterator✔️community✔️✔️✔️✔️Show Tests
    ListStreams✔️community✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DescribeStream

    Parameters: ExclusiveStartShardId, StreamArn

    • EC2 (Elastic Compute Cloud)

    Implementation details for API ec2

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EC2 (Elastic Compute Cloud)

    Implementation details for API ec2

    Coverage Overview

    Elastic Compute Cloud (EC2) is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptAddressTransfer
    AcceptReservedInstancesExchangeQuote
    AcceptTransitGatewayMulticastDomainAssociations
    AcceptTransitGatewayPeeringAttachment✔️community
    AcceptTransitGatewayVpcAttachment
    AcceptVpcEndpointConnections
    AcceptVpcPeeringConnection✔️community✔️✔️✔️✔️Show Tests
    AdvertiseByoipCidr
    AllocateAddress✔️community✔️✔️✔️✔️Show Tests
    AllocateHosts✔️community✔️
    AllocateIpamPoolCidr
    ApplySecurityGroupsToClientVpnTargetNetwork
    AssignIpv6Addresses✔️community✔️
    AssignPrivateIpAddresses✔️community✔️
    AssignPrivateNatGatewayAddress
    AssociateAddress✔️community✔️
    AssociateClientVpnTargetNetwork
    AssociateDhcpOptions✔️community✔️
    AssociateEnclaveCertificateIamRole
    AssociateIamInstanceProfile✔️community✔️
    AssociateInstanceEventWindow
    AssociateIpamByoasn
    AssociateIpamResourceDiscovery
    AssociateNatGatewayAddress
    AssociateRouteTable✔️community✔️✔️✔️✔️Show Tests
    AssociateSubnetCidrBlock✔️community✔️
    AssociateTransitGatewayMulticastDomain
    AssociateTransitGatewayPolicyTable
    AssociateTransitGatewayRouteTable✔️community✔️
    AssociateTrunkInterface
    AssociateVpcCidrBlock✔️community✔️✔️✔️✔️Show Tests
    AttachClassicLinkVpc
    AttachInternetGateway✔️community✔️✔️✔️✔️Show Tests
    AttachNetworkInterface✔️community✔️
    AttachVerifiedAccessTrustProvider
    AttachVolume✔️community✔️
    AttachVpnGateway✔️community✔️✔️✔️✔️Show Tests
    AuthorizeClientVpnIngress
    AuthorizeSecurityGroupEgress✔️community✔️✔️✔️✔️Show Tests
    AuthorizeSecurityGroupIngress✔️community✔️✔️✔️✔️Show Tests
    BundleInstance
    CancelBundleTask
    CancelCapacityReservation
    CancelCapacityReservationFleets
    CancelConversionTask
    CancelExportTask
    CancelImageLaunchPermission
    CancelImportTask
    CancelReservedInstancesListing
    CancelSpotFleetRequests✔️community✔️
    CancelSpotInstanceRequests✔️community✔️
    ConfirmProductInstance
    CopyFpgaImage
    CopyImage✔️community
    CopySnapshot✔️community
    CreateCapacityReservation
    CreateCapacityReservationFleet
    CreateCarrierGateway✔️community✔️
    CreateClientVpnEndpoint
    CreateClientVpnRoute
    CreateCoipCidr
    CreateCoipPool
    CreateCustomerGateway✔️community✔️
    CreateDefaultSubnet
    CreateDefaultVpc✔️community✔️
    CreateDhcpOptions✔️community✔️✔️✔️✔️Show Tests
    CreateEgressOnlyInternetGateway✔️community✔️
    CreateFleet✔️community✔️
    CreateFlowLogs✔️community✔️
    CreateFpgaImage
    CreateImage✔️community✔️
    CreateInstanceConnectEndpoint
    CreateInstanceEventWindow
    CreateInstanceExportTask
    CreateInternetGateway✔️community✔️✔️✔️✔️Show Tests
    CreateIpam
    CreateIpamPool
    CreateIpamResourceDiscovery
    CreateIpamScope
    CreateKeyPair✔️community✔️✔️✔️✔️Show Tests
    CreateLaunchTemplate✔️community✔️✔️✔️✔️Show Tests
    CreateLaunchTemplateVersion✔️community✔️✔️✔️Show Tests
    CreateLocalGatewayRoute
    CreateLocalGatewayRouteTable
    CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
    CreateLocalGatewayRouteTableVpcAssociation
    CreateManagedPrefixList✔️community✔️✔️✔️✔️Show Tests
    CreateNatGateway✔️community✔️✔️✔️✔️Show Tests
    CreateNetworkAcl✔️community✔️✔️✔️✔️Show Tests
    CreateNetworkAclEntry✔️community✔️✔️✔️Show Tests
    CreateNetworkInsightsAccessScope
    CreateNetworkInsightsPath
    CreateNetworkInterface✔️community✔️✔️✔️✔️Show Tests
    CreateNetworkInterfacePermission
    CreatePlacementGroup
    CreatePublicIpv4Pool
    CreateReplaceRootVolumeTask
    CreateReservedInstancesListing
    CreateRestoreImageTask
    CreateRoute✔️community✔️✔️✔️✔️Show Tests
    CreateRouteTable✔️community✔️✔️✔️✔️Show Tests
    CreateSecurityGroup✔️community✔️✔️✔️✔️Show Tests
    CreateSnapshot✔️community✔️
    CreateSnapshots✔️community✔️
    CreateSpotDatafeedSubscription✔️community
    CreateStoreImageTask
    CreateSubnet✔️community✔️✔️✔️✔️Show Tests
    CreateSubnetCidrReservation
    CreateTags✔️community✔️✔️✔️✔️Show Tests
    CreateTrafficMirrorFilter
    CreateTrafficMirrorFilterRule
    CreateTrafficMirrorSession
    CreateTrafficMirrorTarget
    CreateTransitGateway✔️community✔️✔️✔️✔️Show Tests
    CreateTransitGatewayConnect
    CreateTransitGatewayConnectPeer
    CreateTransitGatewayMulticastDomain
    CreateTransitGatewayPeeringAttachment✔️community✔️
    CreateTransitGatewayPolicyTable
    CreateTransitGatewayPrefixListReference
    CreateTransitGatewayRoute✔️community✔️
    CreateTransitGatewayRouteTable✔️community✔️
    CreateTransitGatewayRouteTableAnnouncement
    CreateTransitGatewayVpcAttachment✔️community✔️✔️✔️✔️Show Tests
    CreateVerifiedAccessEndpoint
    CreateVerifiedAccessGroup
    CreateVerifiedAccessInstance
    CreateVerifiedAccessTrustProvider
    CreateVolume✔️community✔️
    CreateVpc✔️community✔️✔️✔️✔️Show Tests
    CreateVpcEndpoint✔️community✔️✔️✔️✔️Show Tests
    CreateVpcEndpointConnectionNotification
    CreateVpcEndpointServiceConfiguration✔️community✔️✔️✔️Show Tests
    CreateVpcPeeringConnection✔️community✔️✔️✔️✔️Show Tests
    CreateVpnConnection✔️community✔️
    CreateVpnConnectionRoute
    CreateVpnGateway✔️community✔️✔️✔️✔️Show Tests
    DeleteCarrierGateway✔️community✔️
    DeleteClientVpnEndpoint
    DeleteClientVpnRoute
    DeleteCoipCidr
    DeleteCoipPool
    DeleteCustomerGateway✔️community✔️
    DeleteDhcpOptions✔️community✔️✔️✔️✔️Show Tests
    DeleteEgressOnlyInternetGateway✔️community✔️
    DeleteFleets✔️community✔️
    DeleteFlowLogs✔️community✔️
    DeleteFpgaImage
    DeleteInstanceConnectEndpoint
    DeleteInstanceEventWindow
    DeleteInternetGateway✔️community✔️✔️✔️✔️Show Tests
    DeleteIpam
    DeleteIpamPool
    DeleteIpamResourceDiscovery
    DeleteIpamScope
    DeleteKeyPair✔️community✔️✔️✔️✔️Show Tests
    DeleteLaunchTemplate✔️community✔️✔️✔️✔️Show Tests
    DeleteLaunchTemplateVersions
    DeleteLocalGatewayRoute
    DeleteLocalGatewayRouteTable
    DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
    DeleteLocalGatewayRouteTableVpcAssociation
    DeleteManagedPrefixList✔️community✔️✔️✔️✔️Show Tests
    DeleteNatGateway✔️community✔️✔️✔️Show Tests
    DeleteNetworkAcl✔️community✔️✔️✔️✔️Show Tests
    DeleteNetworkAclEntry✔️community✔️
    DeleteNetworkInsightsAccessScope
    DeleteNetworkInsightsAccessScopeAnalysis
    DeleteNetworkInsightsAnalysis
    DeleteNetworkInsightsPath
    DeleteNetworkInterface✔️community✔️
    DeleteNetworkInterfacePermission
    DeletePlacementGroup
    DeletePublicIpv4Pool
    DeleteQueuedReservedInstances
    DeleteRoute✔️community✔️✔️✔️✔️Show Tests
    DeleteRouteTable✔️community✔️✔️✔️✔️Show Tests
    DeleteSecurityGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteSnapshot✔️community✔️
    DeleteSpotDatafeedSubscription✔️community
    DeleteSubnet✔️community✔️✔️✔️✔️Show Tests
    DeleteSubnetCidrReservation
    DeleteTags✔️community✔️
    DeleteTrafficMirrorFilter
    DeleteTrafficMirrorFilterRule
    DeleteTrafficMirrorSession
    DeleteTrafficMirrorTarget
    DeleteTransitGateway✔️community✔️✔️✔️✔️Show Tests
    DeleteTransitGatewayConnect
    DeleteTransitGatewayConnectPeer
    DeleteTransitGatewayMulticastDomain
    DeleteTransitGatewayPeeringAttachment✔️community✔️
    DeleteTransitGatewayPolicyTable
    DeleteTransitGatewayPrefixListReference
    DeleteTransitGatewayRoute✔️community✔️
    DeleteTransitGatewayRouteTable✔️community✔️
    DeleteTransitGatewayRouteTableAnnouncement
    DeleteTransitGatewayVpcAttachment✔️community✔️✔️✔️Show Tests
    DeleteVerifiedAccessEndpoint
    DeleteVerifiedAccessGroup
    DeleteVerifiedAccessInstance
    DeleteVerifiedAccessTrustProvider
    DeleteVolume✔️community✔️
    DeleteVpc✔️community✔️✔️✔️✔️Show Tests
    DeleteVpcEndpointConnectionNotifications
    DeleteVpcEndpointServiceConfigurations✔️community✔️✔️✔️Show Tests
    DeleteVpcEndpoints✔️community✔️✔️✔️✔️Show Tests
    DeleteVpcPeeringConnection✔️community✔️✔️✔️✔️Show Tests
    DeleteVpnConnection✔️community✔️
    DeleteVpnConnectionRoute
    DeleteVpnGateway✔️community✔️✔️✔️✔️Show Tests
    DeprovisionByoipCidr
    DeprovisionIpamByoasn
    DeprovisionIpamPoolCidr
    DeprovisionPublicIpv4PoolCidr
    DeregisterImage✔️community✔️
    DeregisterInstanceEventNotificationAttributes
    DeregisterTransitGatewayMulticastGroupMembers
    DeregisterTransitGatewayMulticastGroupSources
    DescribeAccountAttributes✔️community✔️✔️✔️✔️Show Tests
    DescribeAddressTransfers
    DescribeAddresses✔️community✔️
    DescribeAddressesAttribute✔️community✔️
    DescribeAggregateIdFormat
    DescribeAvailabilityZones✔️community✔️✔️✔️✔️Show Tests
    DescribeAwsNetworkPerformanceMetricSubscriptions
    DescribeBundleTasks
    DescribeByoipCidrs
    DescribeCapacityBlockOfferings
    DescribeCapacityReservationFleets
    DescribeCapacityReservations
    DescribeCarrierGateways✔️community✔️
    DescribeClassicLinkInstances
    DescribeClientVpnAuthorizationRules
    DescribeClientVpnConnections
    DescribeClientVpnEndpoints
    DescribeClientVpnRoutes
    DescribeClientVpnTargetNetworks
    DescribeCoipPools
    DescribeConversionTasks
    DescribeCustomerGateways✔️community✔️
    DescribeDhcpOptions✔️community✔️✔️✔️✔️Show Tests
    DescribeEgressOnlyInternetGateways✔️community✔️
    DescribeElasticGpus
    DescribeExportImageTasks
    DescribeExportTasks
    DescribeFastLaunchImages
    DescribeFastSnapshotRestores
    DescribeFleetHistory
    DescribeFleetInstances✔️community✔️
    DescribeFleets✔️community✔️
    DescribeFlowLogs✔️community✔️
    DescribeFpgaImageAttribute
    DescribeFpgaImages
    DescribeHostReservationOfferings
    DescribeHostReservations
    DescribeHosts✔️community✔️
    DescribeIamInstanceProfileAssociations✔️community✔️
    DescribeIdFormat
    DescribeIdentityIdFormat
    DescribeImageAttribute✔️community
    DescribeImages✔️community✔️✔️✔️Show Tests
    DescribeImportImageTasks
    DescribeImportSnapshotTasks
    DescribeInstanceAttribute✔️community✔️
    DescribeInstanceConnectEndpoints
    DescribeInstanceCreditSpecifications✔️community✔️
    DescribeInstanceEventNotificationAttributes
    DescribeInstanceEventWindows
    DescribeInstanceStatus✔️community✔️
    DescribeInstanceTopology
    DescribeInstanceTypeOfferings✔️community✔️
    DescribeInstanceTypes✔️community✔️
    DescribeInstances✔️community✔️✔️Show Tests
    DescribeInternetGateways✔️community✔️✔️✔️✔️Show Tests
    DescribeIpamByoasn
    DescribeIpamPools
    DescribeIpamResourceDiscoveries
    DescribeIpamResourceDiscoveryAssociations
    DescribeIpamScopes
    DescribeIpams
    DescribeIpv6Pools
    DescribeKeyPairs✔️community✔️✔️✔️✔️Show Tests
    DescribeLaunchTemplateVersions✔️community✔️
    DescribeLaunchTemplates✔️community✔️✔️✔️✔️Show Tests
    DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
    DescribeLocalGatewayRouteTableVpcAssociations
    DescribeLocalGatewayRouteTables
    DescribeLocalGatewayVirtualInterfaceGroups
    DescribeLocalGatewayVirtualInterfaces
    DescribeLocalGateways
    DescribeLockedSnapshots
    DescribeMacHosts
    DescribeManagedPrefixLists✔️community✔️✔️✔️✔️Show Tests
    DescribeMovingAddresses
    DescribeNatGateways✔️community✔️✔️✔️✔️Show Tests
    DescribeNetworkAcls✔️community✔️✔️✔️✔️Show Tests
    DescribeNetworkInsightsAccessScopeAnalyses
    DescribeNetworkInsightsAccessScopes
    DescribeNetworkInsightsAnalyses
    DescribeNetworkInsightsPaths
    DescribeNetworkInterfaceAttribute✔️community✔️
    DescribeNetworkInterfacePermissions
    DescribeNetworkInterfaces✔️community✔️
    DescribePlacementGroups
    DescribePrefixLists✔️community✔️
    DescribePrincipalIdFormat
    DescribePublicIpv4Pools
    DescribeRegions✔️community✔️
    DescribeReplaceRootVolumeTasks
    DescribeReservedInstances✔️community✔️Show Tests
    DescribeReservedInstancesListings
    DescribeReservedInstancesModifications
    DescribeReservedInstancesOfferings✔️community✔️Show Tests
    DescribeRouteTables✔️community✔️✔️✔️✔️Show Tests
    DescribeScheduledInstanceAvailability
    DescribeScheduledInstances
    DescribeSecurityGroupReferences
    DescribeSecurityGroupRules✔️community✔️✔️✔️✔️Show Tests
    DescribeSecurityGroups✔️community✔️✔️✔️✔️Show Tests
    DescribeSnapshotAttribute✔️community✔️
    DescribeSnapshotTierStatus
    DescribeSnapshots✔️community✔️
    DescribeSpotDatafeedSubscription
    DescribeSpotFleetInstances✔️community✔️
    DescribeSpotFleetRequestHistory
    DescribeSpotFleetRequests✔️community✔️
    DescribeSpotInstanceRequests✔️community✔️
    DescribeSpotPriceHistory✔️community✔️
    DescribeStaleSecurityGroups
    DescribeStoreImageTasks
    DescribeSubnets✔️community✔️✔️✔️✔️Show Tests
    DescribeTags✔️community✔️
    DescribeTrafficMirrorFilterRules
    DescribeTrafficMirrorFilters
    DescribeTrafficMirrorSessions
    DescribeTrafficMirrorTargets
    DescribeTransitGatewayAttachments✔️community✔️✔️✔️✔️Show Tests
    DescribeTransitGatewayConnectPeers
    DescribeTransitGatewayConnects
    DescribeTransitGatewayMulticastDomains
    DescribeTransitGatewayPeeringAttachments✔️community✔️
    DescribeTransitGatewayPolicyTables
    DescribeTransitGatewayRouteTableAnnouncements
    DescribeTransitGatewayRouteTables✔️community✔️
    DescribeTransitGatewayVpcAttachments✔️community✔️
    DescribeTransitGateways✔️community✔️✔️✔️✔️Show Tests
    DescribeTrunkInterfaceAssociations
    DescribeVerifiedAccessEndpoints
    DescribeVerifiedAccessGroups
    DescribeVerifiedAccessInstanceLoggingConfigurations
    DescribeVerifiedAccessInstances
    DescribeVerifiedAccessTrustProviders
    DescribeVolumeAttribute
    DescribeVolumeStatus
    DescribeVolumes✔️community✔️
    DescribeVolumesModifications✔️community✔️
    DescribeVpcAttribute✔️community✔️
    DescribeVpcClassicLink✔️community✔️
    DescribeVpcClassicLinkDnsSupport✔️community✔️
    DescribeVpcEndpointConnectionNotifications
    DescribeVpcEndpointConnections
    DescribeVpcEndpointServiceConfigurations✔️community✔️✔️✔️Show Tests
    DescribeVpcEndpointServicePermissions✔️community✔️
    DescribeVpcEndpointServices✔️community✔️✔️✔️✔️Show Tests
    DescribeVpcEndpoints✔️community✔️✔️✔️✔️Show Tests
    DescribeVpcPeeringConnections✔️community✔️✔️✔️✔️Show Tests
    DescribeVpcs✔️community✔️✔️✔️✔️Show Tests
    DescribeVpnConnections✔️community✔️
    DescribeVpnGateways✔️community✔️✔️✔️✔️Show Tests
    DetachClassicLinkVpc
    DetachInternetGateway✔️community✔️✔️✔️✔️Show Tests
    DetachNetworkInterface✔️community✔️
    DetachVerifiedAccessTrustProvider
    DetachVolume✔️community✔️
    DetachVpnGateway✔️community✔️✔️✔️✔️Show Tests
    DisableAddressTransfer
    DisableAwsNetworkPerformanceMetricSubscription
    DisableEbsEncryptionByDefault✔️community✔️
    DisableFastLaunch
    DisableFastSnapshotRestores
    DisableImage
    DisableImageBlockPublicAccess
    DisableImageDeprecation
    DisableImageDeregistrationProtection
    DisableIpamOrganizationAdminAccount
    DisableSerialConsoleAccess
    DisableSnapshotBlockPublicAccess
    DisableTransitGatewayRouteTablePropagation✔️community✔️
    DisableVgwRoutePropagation
    DisableVpcClassicLink✔️community✔️
    DisableVpcClassicLinkDnsSupport✔️community✔️
    DisassociateAddress✔️community✔️
    DisassociateClientVpnTargetNetwork
    DisassociateEnclaveCertificateIamRole
    DisassociateIamInstanceProfile✔️community✔️
    DisassociateInstanceEventWindow
    DisassociateIpamByoasn
    DisassociateIpamResourceDiscovery
    DisassociateNatGatewayAddress
    DisassociateRouteTable✔️community✔️✔️✔️✔️Show Tests
    DisassociateSubnetCidrBlock✔️community✔️
    DisassociateTransitGatewayMulticastDomain
    DisassociateTransitGatewayPolicyTable
    DisassociateTransitGatewayRouteTable✔️community✔️
    DisassociateTrunkInterface
    DisassociateVpcCidrBlock✔️community✔️✔️✔️✔️Show Tests
    EnableAddressTransfer
    EnableAwsNetworkPerformanceMetricSubscription
    EnableEbsEncryptionByDefault✔️community✔️
    EnableFastLaunch
    EnableFastSnapshotRestores
    EnableImage
    EnableImageBlockPublicAccess
    EnableImageDeprecation
    EnableImageDeregistrationProtection
    EnableIpamOrganizationAdminAccount
    EnableReachabilityAnalyzerOrganizationSharing
    EnableSerialConsoleAccess
    EnableSnapshotBlockPublicAccess
    EnableTransitGatewayRouteTablePropagation✔️community✔️
    EnableVgwRoutePropagation
    EnableVolumeIO✔️community
    EnableVpcClassicLink✔️community✔️
    EnableVpcClassicLinkDnsSupport✔️community✔️
    ExportClientVpnClientCertificateRevocationList
    ExportClientVpnClientConfiguration
    ExportImage
    ExportTransitGatewayRoutes
    GetAssociatedEnclaveCertificateIamRoles
    GetAssociatedIpv6PoolCidrs
    GetAwsNetworkPerformanceData
    GetCapacityReservationUsage
    GetCoipPoolUsage
    GetConsoleOutput✔️community✔️
    GetConsoleScreenshot
    GetDefaultCreditSpecification
    GetEbsDefaultKmsKeyId
    GetEbsEncryptionByDefault✔️community✔️
    GetFlowLogsIntegrationTemplate
    GetGroupsForCapacityReservation
    GetHostReservationPurchasePreview
    GetImageBlockPublicAccessState
    GetInstanceMetadataDefaults
    GetInstanceTpmEkPub
    GetInstanceTypesFromInstanceRequirements
    GetInstanceUefiData
    GetIpamAddressHistory
    GetIpamDiscoveredAccounts
    GetIpamDiscoveredPublicAddresses
    GetIpamDiscoveredResourceCidrs
    GetIpamPoolAllocations
    GetIpamPoolCidrs
    GetIpamResourceCidrs
    GetLaunchTemplateData✔️community✔️
    GetManagedPrefixListAssociations
    GetManagedPrefixListEntries✔️community✔️
    GetNetworkInsightsAccessScopeAnalysisFindings
    GetNetworkInsightsAccessScopeContent
    GetPasswordData✔️community
    GetReservedInstancesExchangeQuote
    GetSecurityGroupsForVpc
    GetSerialConsoleAccessStatus
    GetSnapshotBlockPublicAccessState
    GetSpotPlacementScores
    GetSubnetCidrReservations
    GetTransitGatewayAttachmentPropagations
    GetTransitGatewayMulticastDomainAssociations
    GetTransitGatewayPolicyTableAssociations
    GetTransitGatewayPolicyTableEntries
    GetTransitGatewayPrefixListReferences
    GetTransitGatewayRouteTableAssociations✔️community✔️
    GetTransitGatewayRouteTablePropagations✔️community✔️
    GetVerifiedAccessEndpointPolicy
    GetVerifiedAccessGroupPolicy
    GetVpnConnectionDeviceSampleConfiguration
    GetVpnConnectionDeviceTypes
    GetVpnTunnelReplacementStatus
    ImportClientVpnClientCertificateRevocationList
    ImportImage✔️pro
    ImportInstance
    ImportKeyPair✔️community✔️✔️Show Tests
    ImportSnapshot
    ImportVolume✔️community
    ListImagesInRecycleBin
    ListSnapshotsInRecycleBin
    LockSnapshot
    ModifyAddressAttribute
    ModifyAvailabilityZoneGroup
    ModifyCapacityReservation
    ModifyCapacityReservationFleet
    ModifyClientVpnEndpoint
    ModifyDefaultCreditSpecification
    ModifyEbsDefaultKmsKeyId
    ModifyFleet
    ModifyFpgaImageAttribute
    ModifyHosts✔️community✔️
    ModifyIdFormat
    ModifyIdentityIdFormat
    ModifyImageAttribute✔️community
    ModifyInstanceAttribute✔️community✔️✔️Show Tests
    ModifyInstanceCapacityReservationAttributes
    ModifyInstanceCreditSpecification
    ModifyInstanceEventStartTime
    ModifyInstanceEventWindow
    ModifyInstanceMaintenanceOptions
    ModifyInstanceMetadataDefaults
    ModifyInstanceMetadataOptions
    ModifyInstancePlacement
    ModifyIpam
    ModifyIpamPool
    ModifyIpamResourceCidr
    ModifyIpamResourceDiscovery
    ModifyIpamScope
    ModifyLaunchTemplate✔️community✔️✔️Show Tests
    ModifyLocalGatewayRoute
    ModifyManagedPrefixList✔️community✔️
    ModifyNetworkInterfaceAttribute✔️community✔️
    ModifyPrivateDnsNameOptions
    ModifyReservedInstances
    ModifySecurityGroupRules
    ModifySnapshotAttribute✔️community✔️
    ModifySnapshotTier
    ModifySpotFleetRequest✔️community✔️
    ModifySubnetAttribute✔️community✔️✔️✔️✔️Show Tests
    ModifyTrafficMirrorFilterNetworkServices
    ModifyTrafficMirrorFilterRule
    ModifyTrafficMirrorSession
    ModifyTransitGateway✔️community✔️
    ModifyTransitGatewayPrefixListReference
    ModifyTransitGatewayVpcAttachment✔️community✔️
    ModifyVerifiedAccessEndpoint
    ModifyVerifiedAccessEndpointPolicy
    ModifyVerifiedAccessGroup
    ModifyVerifiedAccessGroupPolicy
    ModifyVerifiedAccessInstance
    ModifyVerifiedAccessInstanceLoggingConfiguration
    ModifyVerifiedAccessTrustProvider
    ModifyVolume✔️community✔️
    ModifyVolumeAttribute✔️community
    ModifyVpcAttribute✔️community✔️
    ModifyVpcEndpoint✔️community
    ModifyVpcEndpointConnectionNotification
    ModifyVpcEndpointServiceConfiguration✔️community✔️
    ModifyVpcEndpointServicePayerResponsibility
    ModifyVpcEndpointServicePermissions✔️community✔️
    ModifyVpcPeeringConnectionOptions✔️community
    ModifyVpcTenancy✔️community✔️
    ModifyVpnConnection
    ModifyVpnConnectionOptions
    ModifyVpnTunnelCertificate
    ModifyVpnTunnelOptions
    MonitorInstances✔️community
    MoveAddressToVpc
    MoveByoipCidrToIpam
    ProvisionByoipCidr
    ProvisionIpamByoasn
    ProvisionIpamPoolCidr
    ProvisionPublicIpv4PoolCidr
    PurchaseCapacityBlock
    PurchaseHostReservation
    PurchaseReservedInstancesOffering✔️community✔️Show Tests
    PurchaseScheduledInstances
    RebootInstances✔️community✔️✔️Show Tests
    RegisterImage✔️community
    RegisterInstanceEventNotificationAttributes
    RegisterTransitGatewayMulticastGroupMembers
    RegisterTransitGatewayMulticastGroupSources
    RejectTransitGatewayMulticastDomainAssociations
    RejectTransitGatewayPeeringAttachment✔️community
    RejectTransitGatewayVpcAttachment
    RejectVpcEndpointConnections
    RejectVpcPeeringConnection✔️community✔️
    ReleaseAddress✔️community✔️✔️✔️✔️Show Tests
    ReleaseHosts✔️community✔️
    ReleaseIpamPoolAllocation
    ReplaceIamInstanceProfileAssociation✔️community✔️
    ReplaceNetworkAclAssociation✔️community✔️
    ReplaceNetworkAclEntry✔️community✔️
    ReplaceRoute✔️community✔️
    ReplaceRouteTableAssociation✔️community✔️
    ReplaceTransitGatewayRoute
    ReplaceVpnTunnel
    ReportInstanceStatus
    RequestSpotFleet✔️community✔️
    RequestSpotInstances✔️community✔️
    ResetAddressAttribute
    ResetEbsDefaultKmsKeyId
    ResetFpgaImageAttribute
    ResetImageAttribute✔️community
    ResetInstanceAttribute
    ResetNetworkInterfaceAttribute✔️community
    ResetSnapshotAttribute✔️community
    RestoreAddressToClassic
    RestoreImageFromRecycleBin
    RestoreManagedPrefixListVersion
    RestoreSnapshotFromRecycleBin
    RestoreSnapshotTier
    RevokeClientVpnIngress
    RevokeSecurityGroupEgress✔️community✔️✔️✔️✔️Show Tests
    RevokeSecurityGroupIngress✔️community✔️✔️✔️✔️Show Tests
    RunInstances✔️community✔️✔️Show Tests
    RunScheduledInstances
    SearchLocalGatewayRoutes
    SearchTransitGatewayMulticastGroups
    SearchTransitGatewayRoutes✔️community✔️
    SendDiagnosticInterrupt
    StartInstances✔️community✔️✔️Show Tests
    StartNetworkInsightsAccessScopeAnalysis
    StartNetworkInsightsAnalysis
    StartVpcEndpointServicePrivateDnsVerification
    StopInstances✔️community✔️✔️Show Tests
    TerminateClientVpnConnections
    TerminateInstances✔️community✔️✔️Show Tests
    UnassignIpv6Addresses✔️community✔️
    UnassignPrivateIpAddresses✔️community✔️
    UnassignPrivateNatGatewayAddress
    UnlockSnapshot
    UnmonitorInstances✔️community
    UpdateSecurityGroupRuleDescriptionsEgress✔️community✔️
    UpdateSecurityGroupRuleDescriptionsIngress✔️community✔️
    WithdrawByoipCidr

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AcceptVpcPeeringConnection

    Parameters: VpcPeeringConnectionId

    • ECR (Elastic Container Registry)

    Implementation details for API ecr

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ECR (Elastic Container Registry)

    Implementation details for API ecr

    Coverage Overview

    Elastic Container Registry (ECR) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchCheckLayerAvailability
    BatchDeleteImage✔️pro✔️✔️✔️Show Tests
    BatchGetImage✔️pro✔️✔️✔️Show Tests
    BatchGetRepositoryScanningConfiguration✔️pro✔️✔️✔️✔️Show Tests
    CompleteLayerUpload
    CreatePullThroughCacheRule
    CreateRepository✔️pro✔️✔️✔️✔️Show Tests
    DeleteLifecyclePolicy✔️pro✔️Show Tests
    DeletePullThroughCacheRule
    DeleteRegistryPolicy✔️pro
    DeleteRepository✔️pro✔️✔️✔️Show Tests
    DeleteRepositoryPolicy✔️pro
    DescribeImageReplicationStatus
    DescribeImageScanFindings✔️pro
    DescribeImages✔️pro✔️Show Tests
    DescribePullThroughCacheRules
    DescribeRegistry✔️pro✔️
    DescribeRepositories✔️pro✔️✔️✔️✔️Show Tests
    GetAuthorizationToken✔️pro✔️✔️✔️Show Tests
    GetDownloadUrlForLayer
    GetLifecyclePolicy✔️pro✔️Show Tests
    GetLifecyclePolicyPreview✔️pro
    GetRegistryPolicy✔️pro
    GetRegistryScanningConfiguration✔️pro✔️✔️✔️Show Tests
    GetRepositoryPolicy✔️pro
    InitiateLayerUpload
    ListImages✔️pro✔️✔️✔️Show Tests
    ListTagsForResource✔️pro✔️✔️Show Tests
    PutImage✔️pro✔️✔️✔️Show Tests
    PutImageScanningConfiguration✔️pro
    PutImageTagMutability✔️pro✔️✔️Show Tests
    PutLifecyclePolicy✔️pro✔️Show Tests
    PutRegistryPolicy✔️pro✔️
    PutRegistryScanningConfiguration✔️pro✔️✔️✔️✔️Show Tests
    PutReplicationConfiguration✔️pro✔️
    SetRepositoryPolicy✔️pro✔️
    StartImageScan✔️pro
    StartLifecyclePolicyPreview✔️pro
    TagResource✔️pro✔️✔️Show Tests
    UntagResource✔️pro✔️✔️Show Tests
    UpdatePullThroughCacheRule
    UploadLayerPart
    ValidatePullThroughCacheRule

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    BatchDeleteImage

    Parameters: imageIds, registryId, repositoryName

    • ECS (Elastic Container Service)

    Implementation details for API ecs

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ECS (Elastic Container Service)

    Implementation details for API ecs

    Coverage Overview

    Elastic Container Service (ECS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateCapacityProvider✔️pro✔️✔️✔️✔️Show Tests
    CreateCluster✔️pro✔️✔️✔️✔️Show Tests
    CreateService✔️pro✔️✔️✔️✔️Show Tests
    CreateTaskSet✔️pro✔️✔️✔️✔️Show Tests
    DeleteAccountSetting✔️pro✔️
    DeleteAttributes✔️pro✔️
    DeleteCapacityProvider✔️pro✔️✔️✔️Show Tests
    DeleteCluster✔️pro✔️✔️✔️✔️Show Tests
    DeleteService✔️pro✔️✔️✔️Show Tests
    DeleteTaskDefinitions
    DeleteTaskSet✔️pro✔️
    DeregisterContainerInstance✔️pro
    DeregisterTaskDefinition✔️pro✔️✔️✔️Show Tests
    DescribeCapacityProviders✔️pro✔️
    DescribeClusters✔️pro✔️✔️✔️Show Tests
    DescribeContainerInstances✔️pro✔️
    DescribeServices✔️pro✔️✔️✔️✔️Show Tests
    DescribeTaskDefinition✔️pro✔️✔️✔️✔️Show Tests
    DescribeTaskSets✔️pro✔️
    DescribeTasks✔️pro✔️✔️✔️✔️Show Tests
    DiscoverPollEndpoint
    ExecuteCommand
    GetTaskProtection
    ListAccountSettings✔️pro✔️
    ListAttributes✔️pro✔️
    ListClusters✔️pro
    ListContainerInstances✔️pro✔️✔️Show Tests
    ListServices✔️pro✔️✔️✔️✔️Show Tests
    ListServicesByNamespace
    ListTagsForResource✔️pro✔️✔️✔️Show Tests
    ListTaskDefinitionFamilies✔️pro✔️
    ListTaskDefinitions✔️pro✔️Show Tests
    ListTasks✔️pro✔️✔️✔️✔️Show Tests
    PutAccountSetting✔️pro✔️
    PutAccountSettingDefault
    PutAttributes✔️pro✔️
    PutClusterCapacityProviders✔️pro✔️✔️✔️✔️Show Tests
    RegisterContainerInstance✔️pro✔️✔️Show Tests
    RegisterTaskDefinition✔️pro✔️✔️✔️✔️Show Tests
    RunTask✔️pro✔️✔️✔️✔️Show Tests
    StartTask✔️pro✔️✔️Show Tests
    StopTask✔️pro✔️✔️✔️✔️Show Tests
    SubmitAttachmentStateChanges
    SubmitContainerStateChange
    SubmitTaskStateChange
    TagResource✔️pro✔️✔️✔️Show Tests
    UntagResource✔️pro✔️
    UpdateCapacityProvider✔️pro
    UpdateCluster✔️pro✔️✔️✔️✔️Show Tests
    UpdateClusterSettings
    UpdateContainerAgent
    UpdateContainerInstancesState✔️pro✔️
    UpdateService✔️pro✔️✔️✔️✔️Show Tests
    UpdateServicePrimaryTaskSet✔️pro✔️
    UpdateTaskProtection
    UpdateTaskSet✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCapacityProvider

    Parameters: autoScalingGroupProvider, name

    • EFS (Elastic File System)

    Implementation details for API efs

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EFS (Elastic File System)

    Implementation details for API efs

    Coverage Overview

    Elastic File System (EFS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateAccessPoint✔️pro✔️✔️✔️✔️Show Tests
    CreateFileSystem✔️pro✔️✔️✔️✔️Show Tests
    CreateMountTarget✔️pro✔️✔️✔️Show Tests
    CreateReplicationConfiguration
    CreateTags
    DeleteAccessPoint✔️pro✔️✔️✔️Show Tests
    DeleteFileSystem✔️pro✔️✔️✔️Show Tests
    DeleteFileSystemPolicy
    DeleteMountTarget✔️pro✔️✔️✔️Show Tests
    DeleteReplicationConfiguration
    DeleteTags
    DescribeAccessPoints✔️pro✔️✔️✔️Show Tests
    DescribeAccountPreferences
    DescribeBackupPolicy
    DescribeFileSystemPolicy✔️pro
    DescribeFileSystems✔️pro✔️✔️✔️Show Tests
    DescribeLifecycleConfiguration✔️pro✔️✔️✔️Show Tests
    DescribeMountTargetSecurityGroups✔️pro
    DescribeMountTargets✔️pro✔️✔️✔️Show Tests
    DescribeReplicationConfigurations
    DescribeTags
    ListTagsForResource✔️pro
    ModifyMountTargetSecurityGroups✔️pro
    PutAccountPreferences
    PutBackupPolicy
    PutFileSystemPolicy✔️pro
    PutLifecycleConfiguration✔️pro✔️✔️✔️Show Tests
    TagResource✔️pro
    UntagResource✔️pro
    UpdateFileSystem
    UpdateFileSystemProtection

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateAccessPoint

    Parameters: ClientToken, FileSystemId, PosixUser, RootDirectory

    • EKS (Elastic Kubernetes Service)

    Implementation details for API eks

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EKS (Elastic Kubernetes Service)

    Implementation details for API eks

    Coverage Overview

    Elastic Kubernetes Service (EKS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateAccessPolicy
    AssociateEncryptionConfig
    AssociateIdentityProviderConfig
    CreateAccessEntry
    CreateAddon
    CreateCluster✔️pro✔️✔️✔️Show Tests
    CreateEksAnywhereSubscription
    CreateFargateProfile✔️pro✔️✔️✔️Show Tests
    CreateNodegroup✔️pro✔️✔️✔️Show Tests
    CreatePodIdentityAssociation
    DeleteAccessEntry
    DeleteAddon
    DeleteCluster✔️pro✔️✔️✔️Show Tests
    DeleteEksAnywhereSubscription
    DeleteFargateProfile✔️pro
    DeleteNodegroup✔️pro✔️✔️✔️Show Tests
    DeletePodIdentityAssociation
    DeregisterCluster
    DescribeAccessEntry
    DescribeAddon
    DescribeAddonConfiguration
    DescribeAddonVersions
    DescribeCluster✔️pro✔️✔️✔️Show Tests
    DescribeEksAnywhereSubscription
    DescribeFargateProfile✔️pro✔️✔️✔️Show Tests
    DescribeIdentityProviderConfig
    DescribeInsight
    DescribeNodegroup✔️pro✔️✔️✔️Show Tests
    DescribePodIdentityAssociation
    DescribeUpdate
    DisassociateAccessPolicy
    DisassociateIdentityProviderConfig
    ListAccessEntries
    ListAccessPolicies
    ListAddons
    ListAssociatedAccessPolicies
    ListClusters✔️pro✔️✔️Show Tests
    ListEksAnywhereSubscriptions
    ListFargateProfiles✔️pro
    ListIdentityProviderConfigs
    ListInsights
    ListNodegroups✔️pro
    ListPodIdentityAssociations
    ListTagsForResource
    ListUpdates
    RegisterCluster
    TagResource
    UntagResource
    UpdateAccessEntry
    UpdateAddon
    UpdateClusterConfig✔️pro
    UpdateClusterVersion
    UpdateEksAnywhereSubscription
    UpdateNodegroupConfig✔️pro
    UpdateNodegroupVersion✔️pro
    UpdatePodIdentityAssociation

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCluster

    Parameters: clientRequestToken, kubernetesNetworkConfig, name, resourcesVpcConfig, roleArn, tags, version

    • ElastiCache

    Implementation details for API elasticache

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ElastiCache

    Implementation details for API elasticache

    Coverage Overview

    ElastiCache is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTagsToResource✔️pro
    AuthorizeCacheSecurityGroupIngress
    BatchApplyUpdateAction
    BatchStopUpdateAction
    CompleteMigration
    CopyServerlessCacheSnapshot
    CopySnapshot
    CreateCacheCluster✔️pro✔️✔️✔️Show Tests
    CreateCacheParameterGroup✔️pro✔️✔️✔️Show Tests
    CreateCacheSecurityGroup✔️pro✔️✔️✔️Show Tests
    CreateCacheSubnetGroup✔️pro✔️✔️✔️Show Tests
    CreateGlobalReplicationGroup
    CreateReplicationGroup✔️pro✔️✔️✔️Show Tests
    CreateServerlessCache
    CreateServerlessCacheSnapshot
    CreateSnapshot
    CreateUser
    CreateUserGroup
    DecreaseNodeGroupsInGlobalReplicationGroup
    DecreaseReplicaCount
    DeleteCacheCluster✔️pro✔️✔️✔️Show Tests
    DeleteCacheParameterGroup✔️pro✔️✔️✔️Show Tests
    DeleteCacheSecurityGroup✔️pro✔️✔️✔️Show Tests
    DeleteCacheSubnetGroup✔️pro✔️✔️✔️Show Tests
    DeleteGlobalReplicationGroup
    DeleteReplicationGroup✔️pro✔️✔️✔️Show Tests
    DeleteServerlessCache
    DeleteServerlessCacheSnapshot
    DeleteSnapshot
    DeleteUser
    DeleteUserGroup
    DescribeCacheClusters✔️pro✔️✔️✔️Show Tests
    DescribeCacheEngineVersions
    DescribeCacheParameterGroups✔️pro✔️✔️✔️Show Tests
    DescribeCacheParameters✔️pro
    DescribeCacheSecurityGroups✔️pro
    DescribeCacheSubnetGroups✔️pro
    DescribeEngineDefaultParameters
    DescribeEvents
    DescribeGlobalReplicationGroups
    DescribeReplicationGroups✔️pro✔️✔️✔️Show Tests
    DescribeReservedCacheNodes
    DescribeReservedCacheNodesOfferings
    DescribeServerlessCacheSnapshots
    DescribeServerlessCaches
    DescribeServiceUpdates
    DescribeSnapshots
    DescribeUpdateActions
    DescribeUserGroups
    DescribeUsers
    DisassociateGlobalReplicationGroup
    ExportServerlessCacheSnapshot
    FailoverGlobalReplicationGroup
    IncreaseNodeGroupsInGlobalReplicationGroup
    IncreaseReplicaCount
    ListAllowedNodeTypeModifications
    ListTagsForResource✔️pro
    ModifyCacheCluster✔️pro
    ModifyCacheParameterGroup✔️pro✔️✔️✔️Show Tests
    ModifyCacheSubnetGroup✔️pro
    ModifyGlobalReplicationGroup
    ModifyReplicationGroup✔️pro
    ModifyReplicationGroupShardConfiguration
    ModifyServerlessCache
    ModifyUser
    ModifyUserGroup
    PurchaseReservedCacheNodesOffering
    RebalanceSlotsInGlobalReplicationGroup
    RebootCacheCluster
    RemoveTagsFromResource✔️pro
    ResetCacheParameterGroup
    RevokeCacheSecurityGroupIngress
    StartMigration
    TestFailover
    TestMigration

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCacheCluster

    Parameters: AutoMinorVersionUpgrade, CacheClusterId, CacheNodeType, CacheSubnetGroupName, Engine, NumCacheNodes, SecurityGroupIds

    • Elastic Beanstalk

    Implementation details for API elasticbeanstalk

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Elastic Beanstalk

    Implementation details for API elasticbeanstalk

    Coverage Overview

    Elastic Beanstalk is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AbortEnvironmentUpdate
    ApplyEnvironmentManagedAction
    AssociateEnvironmentOperationsRole
    CheckDNSAvailability
    ComposeEnvironments
    CreateApplication✔️pro✔️✔️✔️✔️Show Tests
    CreateApplicationVersion✔️pro✔️✔️✔️Show Tests
    CreateConfigurationTemplate✔️pro✔️✔️✔️Show Tests
    CreateEnvironment✔️pro✔️✔️✔️Show Tests
    CreatePlatformVersion
    CreateStorageLocation
    DeleteApplication✔️pro✔️✔️✔️✔️Show Tests
    DeleteApplicationVersion✔️pro✔️✔️✔️Show Tests
    DeleteConfigurationTemplate✔️pro✔️✔️✔️Show Tests
    DeleteEnvironmentConfiguration✔️pro✔️Show Tests
    DeletePlatformVersion
    DescribeAccountAttributes
    DescribeApplicationVersions✔️pro✔️✔️✔️Show Tests
    DescribeApplications✔️pro✔️✔️✔️✔️Show Tests
    DescribeConfigurationOptions
    DescribeConfigurationSettings✔️pro✔️✔️✔️Show Tests
    DescribeEnvironmentHealth
    DescribeEnvironmentManagedActionHistory
    DescribeEnvironmentManagedActions
    DescribeEnvironmentResources
    DescribeEnvironments✔️pro✔️✔️✔️Show Tests
    DescribeEvents
    DescribeInstancesHealth
    DescribePlatformVersion
    DisassociateEnvironmentOperationsRole
    ListAvailableSolutionStacks
    ListPlatformBranches
    ListPlatformVersions
    ListTagsForResource
    RebuildEnvironment
    RequestEnvironmentInfo
    RestartAppServer
    RetrieveEnvironmentInfo
    SwapEnvironmentCNAMEs
    TerminateEnvironment✔️pro✔️✔️✔️Show Tests
    UpdateApplication✔️pro✔️Show Tests
    UpdateApplicationResourceLifecycle
    UpdateApplicationVersion✔️pro✔️Show Tests
    UpdateConfigurationTemplate
    UpdateEnvironment✔️pro✔️Show Tests
    UpdateTagsForResource
    ValidateConfigurationSettings

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApplication

    Parameters: ApplicationName

    • elastictranscoder

    Implementation details for API elastictranscoder

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelJob
    CreateJob
    CreatePipeline✔️pro✔️✔️✔️✔️Show Tests
    CreatePreset
    DeletePipeline✔️pro✔️✔️✔️✔️Show Tests
    DeletePreset
    ListJobsByPipeline
    ListJobsByStatus
    ListPipelines✔️pro✔️✔️✔️✔️Show Tests
    ListPresets
    ReadJob
    ReadPipeline✔️pro✔️✔️✔️Show Tests
    ReadPreset
    TestRole
    UpdatePipeline✔️pro✔️
    UpdatePipelineNotifications
    UpdatePipelineStatus

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    elastictranscoder

    Implementation details for API elastictranscoder

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelJob
    CreateJob
    CreatePipeline✔️pro✔️✔️✔️✔️Show Tests
    CreatePreset
    DeletePipeline✔️pro✔️✔️✔️✔️Show Tests
    DeletePreset
    ListJobsByPipeline
    ListJobsByStatus
    ListPipelines✔️pro✔️✔️✔️✔️Show Tests
    ListPresets
    ReadJob
    ReadPipeline✔️pro✔️✔️✔️Show Tests
    ReadPreset
    TestRole
    UpdatePipeline✔️pro✔️
    UpdatePipelineNotifications
    UpdatePipelineStatus

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreatePipeline

    Parameters: InputBucket, Name, OutputBucket, Role

    • ELB (Elastic Load Balancer)

    Implementation details for API elb

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ELB (Elastic Load Balancer)

    Implementation details for API elb

    Coverage Overview

    Elastic Load Balancer (ELB) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTags✔️pro✔️
    ApplySecurityGroupsToLoadBalancer✔️pro✔️
    AttachLoadBalancerToSubnets✔️pro✔️
    ConfigureHealthCheck✔️pro✔️
    CreateAppCookieStickinessPolicy✔️pro✔️
    CreateLBCookieStickinessPolicy✔️pro✔️
    CreateLoadBalancer✔️pro✔️
    CreateLoadBalancerListeners✔️pro✔️
    CreateLoadBalancerPolicy✔️pro✔️
    DeleteLoadBalancer✔️pro✔️
    DeleteLoadBalancerListeners✔️pro✔️
    DeleteLoadBalancerPolicy✔️pro✔️
    DeregisterInstancesFromLoadBalancer✔️pro✔️
    DescribeAccountLimits
    DescribeInstanceHealth✔️pro✔️
    DescribeLoadBalancerAttributes✔️pro✔️
    DescribeLoadBalancerPolicies✔️pro✔️
    DescribeLoadBalancerPolicyTypes
    DescribeLoadBalancers✔️pro✔️
    DescribeTags✔️pro✔️
    DetachLoadBalancerFromSubnets✔️pro✔️
    DisableAvailabilityZonesForLoadBalancer✔️pro✔️
    EnableAvailabilityZonesForLoadBalancer✔️pro✔️
    ModifyLoadBalancerAttributes✔️pro✔️
    RegisterInstancesWithLoadBalancer✔️pro✔️
    RemoveTags✔️pro✔️
    SetLoadBalancerListenerSSLCertificate✔️pro✔️
    SetLoadBalancerPoliciesForBackendServer✔️pro✔️
    SetLoadBalancerPoliciesOfListener✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_elbv2/index.html b/references/coverage/coverage_elbv2/index.html index 4828a7dca6..c229794953 100644 --- a/references/coverage/coverage_elbv2/index.html +++ b/references/coverage/coverage_elbv2/index.html @@ -155,10 +155,10 @@
  • +

    • ELB v2 (Elastic Load Balancer v2)

    Implementation details for API elbv2

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ELB v2 (Elastic Load Balancer v2)

    Implementation details for API elbv2

    Coverage Overview

    Elastic Load Balancer v2 (ELB v2) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddListenerCertificates✔️pro✔️
    AddTags✔️pro✔️
    AddTrustStoreRevocations
    CreateListener✔️pro✔️✔️✔️✔️Show Tests
    CreateLoadBalancer✔️pro✔️✔️✔️✔️Show Tests
    CreateRule✔️pro✔️✔️✔️✔️Show Tests
    CreateTargetGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateTrustStore
    DeleteListener✔️pro✔️✔️✔️✔️Show Tests
    DeleteLoadBalancer✔️pro✔️✔️✔️✔️Show Tests
    DeleteRule✔️pro✔️✔️✔️Show Tests
    DeleteTargetGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteTrustStore
    DeregisterTargets✔️pro✔️✔️✔️✔️Show Tests
    DescribeAccountLimits✔️pro✔️
    DescribeListenerCertificates✔️pro✔️
    DescribeListeners✔️pro✔️✔️✔️✔️Show Tests
    DescribeLoadBalancerAttributes✔️pro✔️✔️✔️✔️Show Tests
    DescribeLoadBalancers✔️pro✔️✔️✔️✔️Show Tests
    DescribeRules✔️pro✔️
    DescribeSSLPolicies✔️pro✔️
    DescribeTags✔️pro✔️
    DescribeTargetGroupAttributes✔️pro✔️
    DescribeTargetGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeTargetHealth✔️pro✔️✔️✔️✔️Show Tests
    DescribeTrustStoreAssociations
    DescribeTrustStoreRevocations
    DescribeTrustStores
    GetTrustStoreCaCertificatesBundle
    GetTrustStoreRevocationContent
    ModifyListener✔️pro✔️
    ModifyLoadBalancerAttributes✔️pro✔️✔️✔️✔️Show Tests
    ModifyRule✔️pro✔️
    ModifyTargetGroup✔️pro✔️
    ModifyTargetGroupAttributes✔️pro✔️✔️✔️✔️Show Tests
    ModifyTrustStore
    RegisterTargets✔️pro✔️✔️✔️✔️Show Tests
    RemoveListenerCertificates✔️pro✔️
    RemoveTags✔️pro✔️
    RemoveTrustStoreRevocations
    SetIpAddressType✔️pro✔️✔️✔️✔️Show Tests
    SetRulePriorities✔️pro✔️
    SetSecurityGroups✔️pro✔️
    SetSubnets✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateListener

    Parameters: Certificates, DefaultActions, LoadBalancerArn, Port, Protocol

    • EMR (EMR Serverless)

    Implementation details for API emr-serverless

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EMR (EMR Serverless)

    Implementation details for API emr-serverless

    Coverage Overview

    EMR Serverless (EMR) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelJobRun✔️pro✔️
    CreateApplication✔️pro✔️
    DeleteApplication✔️pro✔️
    GetApplication✔️pro
    GetDashboardForJobRun
    GetJobRun✔️pro✔️
    ListApplications✔️pro✔️
    ListJobRunAttempts
    ListJobRuns✔️pro✔️
    ListTagsForResource✔️pro
    StartApplication✔️pro✔️
    StartJobRun✔️pro✔️
    StopApplication✔️pro✔️
    TagResource✔️pro
    UntagResource✔️pro
    UpdateApplication✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_emr/index.html b/references/coverage/coverage_emr/index.html index eadf0c198c..1c525d1229 100644 --- a/references/coverage/coverage_emr/index.html +++ b/references/coverage/coverage_emr/index.html @@ -155,10 +155,10 @@
  • +

    • EMR (Elastic MapReduce)

    Implementation details for API emr

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EMR (Elastic MapReduce)

    Implementation details for API emr

    Coverage Overview

    Elastic MapReduce (EMR) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddInstanceFleet✔️pro✔️Show Tests
    AddInstanceGroups✔️pro✔️
    AddJobFlowSteps✔️pro
    AddTags✔️pro✔️
    CancelSteps
    CreateSecurityConfiguration✔️pro✔️
    CreateStudio
    CreateStudioSessionMapping
    DeleteSecurityConfiguration✔️pro✔️
    DeleteStudio
    DeleteStudioSessionMapping
    DescribeCluster✔️pro✔️
    DescribeJobFlows✔️pro✔️
    DescribeNotebookExecution
    DescribeReleaseLabel
    DescribeSecurityConfiguration✔️pro✔️
    DescribeStep✔️pro
    DescribeStudio
    GetAutoTerminationPolicy✔️pro✔️Show Tests
    GetBlockPublicAccessConfiguration✔️pro
    GetClusterSessionCredentials
    GetManagedScalingPolicy
    GetStudioSessionMapping
    ListBootstrapActions✔️pro✔️
    ListClusters✔️pro✔️
    ListInstanceFleets✔️pro✔️Show Tests
    ListInstanceGroups✔️pro✔️
    ListInstances✔️pro✔️
    ListNotebookExecutions
    ListReleaseLabels
    ListSecurityConfigurations
    ListSteps✔️pro
    ListStudioSessionMappings
    ListStudios
    ListSupportedInstanceTypes
    ModifyCluster✔️pro✔️
    ModifyInstanceFleet✔️pro✔️Show Tests
    ModifyInstanceGroups✔️pro✔️
    PutAutoScalingPolicy✔️pro
    PutAutoTerminationPolicy✔️pro✔️Show Tests
    PutBlockPublicAccessConfiguration
    PutManagedScalingPolicy
    RemoveAutoScalingPolicy✔️pro
    RemoveAutoTerminationPolicy✔️pro✔️Show Tests
    RemoveManagedScalingPolicy
    RemoveTags✔️pro✔️
    RunJobFlow✔️pro✔️✔️Show Tests
    SetKeepJobFlowAliveWhenNoSteps
    SetTerminationProtection✔️pro✔️
    SetUnhealthyNodeReplacement
    SetVisibleToAllUsers✔️pro✔️
    StartNotebookExecution
    StopNotebookExecution
    TerminateJobFlows✔️pro✔️
    UpdateStudio
    UpdateStudioSessionMapping

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddInstanceFleet

    Parameters: ClusterId, InstanceFleet

    • ES (OpenSearch, legacy Elasticsearch)

    Implementation details for API es

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ES (OpenSearch, legacy Elasticsearch)

    Implementation details for API es

    Coverage Overview

    OpenSearch, legacy Elasticsearch (ES) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptInboundCrossClusterSearchConnection
    AddTags✔️community✔️Show Tests
    AssociatePackage
    AuthorizeVpcEndpointAccess
    CancelDomainConfigChange
    CancelElasticsearchServiceSoftwareUpdate
    CreateElasticsearchDomain✔️community✔️✔️Show Tests
    CreateOutboundCrossClusterSearchConnection
    CreatePackage
    CreateVpcEndpoint
    DeleteElasticsearchDomain✔️community✔️✔️Show Tests
    DeleteElasticsearchServiceRole
    DeleteInboundCrossClusterSearchConnection
    DeleteOutboundCrossClusterSearchConnection
    DeletePackage
    DeleteVpcEndpoint
    DescribeDomainAutoTunes
    DescribeDomainChangeProgress
    DescribeElasticsearchDomain✔️community✔️✔️Show Tests
    DescribeElasticsearchDomainConfig✔️community
    DescribeElasticsearchDomains✔️community✔️✔️Show Tests
    DescribeElasticsearchInstanceTypeLimits
    DescribeInboundCrossClusterSearchConnections
    DescribeOutboundCrossClusterSearchConnections
    DescribePackages
    DescribeReservedElasticsearchInstanceOfferings
    DescribeReservedElasticsearchInstances
    DescribeVpcEndpoints
    DissociatePackage
    GetCompatibleElasticsearchVersions✔️community
    GetPackageVersionHistory
    GetUpgradeHistory
    GetUpgradeStatus
    ListDomainNames✔️community✔️
    ListDomainsForPackage
    ListElasticsearchInstanceTypes
    ListElasticsearchVersions✔️community
    ListPackagesForDomain
    ListTags✔️community✔️Show Tests
    ListVpcEndpointAccess
    ListVpcEndpoints
    ListVpcEndpointsForDomain
    PurchaseReservedElasticsearchInstanceOffering
    RejectInboundCrossClusterSearchConnection
    RemoveTags✔️community
    RevokeVpcEndpointAccess
    StartElasticsearchServiceSoftwareUpdate
    UpdateElasticsearchDomainConfig✔️community
    UpdatePackage
    UpdateVpcEndpoint
    UpgradeElasticsearchDomain

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTags

    Parameters: ARN, TagList

    • EventBridge

    Implementation details for API events

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    EventBridge

    Implementation details for API events

    Coverage Overview

    EventBridge is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    ActivateEventSource
    CancelReplay✔️community✔️
    CreateApiDestination✔️community✔️✔️✔️Show Tests
    CreateArchive✔️community✔️✔️✔️✔️Show Tests
    CreateConnection✔️community✔️✔️✔️Show Tests
    CreateEndpoint
    CreateEventBus✔️community✔️✔️✔️✔️Show Tests
    CreatePartnerEventSource✔️community✔️
    DeactivateEventSource
    DeauthorizeConnection
    DeleteApiDestination✔️community✔️✔️✔️Show Tests
    DeleteArchive✔️community✔️✔️✔️✔️Show Tests
    DeleteConnection✔️community✔️✔️✔️Show Tests
    DeleteEndpoint
    DeleteEventBus✔️community✔️✔️✔️✔️Show Tests
    DeletePartnerEventSource✔️community
    DeleteRule✔️community✔️✔️✔️✔️Show Tests
    DescribeApiDestination✔️community✔️✔️Show Tests
    DescribeArchive✔️community✔️✔️✔️✔️Show Tests
    DescribeConnection✔️community✔️
    DescribeEndpoint
    DescribeEventBus✔️community✔️✔️✔️✔️Show Tests
    DescribeEventSource✔️community
    DescribePartnerEventSource✔️community✔️
    DescribeReplay✔️community✔️✔️✔️✔️Show Tests
    DescribeRule✔️community✔️✔️✔️✔️Show Tests
    DisableRule✔️community✔️✔️✔️✔️Show Tests
    EnableRule✔️community✔️✔️✔️✔️Show Tests
    ListApiDestinations✔️community✔️✔️✔️Show Tests
    ListArchives✔️community✔️✔️✔️✔️Show Tests
    ListConnections✔️community✔️✔️✔️Show Tests
    ListEndpoints
    ListEventBuses✔️community✔️✔️Show Tests
    ListEventSources
    ListPartnerEventSourceAccounts
    ListPartnerEventSources
    ListReplays✔️community✔️
    ListRuleNamesByTarget✔️community✔️
    ListRules✔️community✔️✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️✔️✔️✔️Show Tests
    ListTargetsByRule✔️community✔️✔️✔️✔️Show Tests
    PutEvents✔️community✔️✔️✔️✔️Show Tests
    PutPartnerEvents✔️community
    PutPermission✔️community✔️✔️✔️Show Tests
    PutRule✔️community✔️✔️✔️✔️Show Tests
    PutTargets✔️community✔️✔️✔️✔️Show Tests
    RemovePermission✔️community✔️✔️✔️Show Tests
    RemoveTargets✔️community✔️✔️✔️✔️Show Tests
    StartReplay✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️✔️Show Tests
    TestEventPattern✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️✔️Show Tests
    UpdateApiDestination✔️community✔️
    UpdateArchive✔️community✔️✔️✔️✔️Show Tests
    UpdateConnection✔️community✔️
    UpdateEndpoint
    UpdateEventBus

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateApiDestination

    Parameters: ConnectionArn, Description, HttpMethod, InvocationEndpoint, Name

    • Kinesis Data Firehose

    Implementation details for API firehose

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis Data Firehose

    Implementation details for API firehose

    Coverage Overview

    Kinesis Data Firehose is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateDeliveryStream✔️community✔️✔️✔️✔️Show Tests
    DeleteDeliveryStream✔️community✔️✔️✔️Show Tests
    DescribeDeliveryStream✔️community✔️✔️✔️Show Tests
    ListDeliveryStreams✔️community✔️Show Tests
    ListTagsForDeliveryStream✔️community✔️✔️Show Tests
    PutRecord✔️community✔️✔️✔️Show Tests
    PutRecordBatch✔️community
    StartDeliveryStreamEncryption
    StopDeliveryStreamEncryption
    TagDeliveryStream✔️community
    UntagDeliveryStream✔️community✔️
    UpdateDestination✔️community✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDeliveryStream

    Parameters: DeliveryStreamName, DeliveryStreamType, ElasticsearchDestinationConfiguration, KinesisStreamSourceConfiguration

    • FIS (Fault Injection Simulator)

    Implementation details for API fis

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    FIS (Fault Injection Simulator)

    Implementation details for API fis

    Coverage Overview

    Fault Injection Simulator (FIS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateExperimentTemplate✔️pro✔️Show Tests
    CreateTargetAccountConfiguration
    DeleteExperimentTemplate✔️pro✔️Show Tests
    DeleteTargetAccountConfiguration
    GetAction
    GetExperiment✔️pro✔️Show Tests
    GetExperimentTargetAccountConfiguration
    GetExperimentTemplate✔️pro✔️Show Tests
    GetTargetAccountConfiguration
    GetTargetResourceType
    ListActions
    ListExperimentResolvedTargets
    ListExperimentTargetAccountConfigurations
    ListExperimentTemplates✔️pro✔️Show Tests
    ListExperiments✔️pro✔️Show Tests
    ListTagsForResource
    ListTargetAccountConfigurations
    ListTargetResourceTypes
    StartExperiment✔️pro✔️Show Tests
    StopExperiment✔️pro✔️Show Tests
    TagResource
    UntagResource
    UpdateExperimentTemplate
    UpdateTargetAccountConfiguration

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateExperimentTemplate

    Parameters: actions, clientToken, description, roleArn, stopConditions

    • Glacier (S3 Glacier)

    Implementation details for API glacier

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Glacier (S3 Glacier)

    Implementation details for API glacier

    Coverage Overview

    S3 Glacier (Glacier) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AbortMultipartUpload
    AbortVaultLock
    AddTagsToVault✔️pro✔️Show Tests
    CompleteMultipartUpload
    CompleteVaultLock
    CreateVault✔️pro✔️✔️✔️✔️Show Tests
    DeleteArchive✔️pro✔️
    DeleteVault✔️pro✔️✔️✔️✔️Show Tests
    DeleteVaultAccessPolicy✔️pro
    DeleteVaultNotifications✔️pro
    DescribeJob✔️pro
    DescribeVault✔️pro✔️
    GetDataRetrievalPolicy
    GetJobOutput✔️pro✔️Show Tests
    GetVaultAccessPolicy✔️pro
    GetVaultLock
    GetVaultNotifications✔️pro✔️Show Tests
    InitiateJob✔️pro✔️✔️✔️✔️Show Tests
    InitiateMultipartUpload
    InitiateVaultLock
    ListJobs✔️pro✔️
    ListMultipartUploads
    ListParts
    ListProvisionedCapacity
    ListTagsForVault✔️pro
    ListVaults✔️pro
    PurchaseProvisionedCapacity
    RemoveTagsFromVault✔️pro
    SetDataRetrievalPolicy
    SetVaultAccessPolicy✔️pro
    SetVaultNotifications✔️pro
    UploadArchive✔️pro✔️✔️✔️✔️Show Tests
    UploadMultipartPart

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTagsToVault

    Parameters: accountId, vaultName

    • Glue

    Implementation details for API glue

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Glue

    Implementation details for API glue

    Coverage Overview

    Glue is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchCreatePartition✔️pro
    BatchDeleteConnection
    BatchDeletePartition✔️pro
    BatchDeleteTable✔️pro
    BatchDeleteTableVersion
    BatchGetBlueprints
    BatchGetCrawlers
    BatchGetCustomEntityTypes
    BatchGetDataQualityResult
    BatchGetDevEndpoints
    BatchGetJobs
    BatchGetPartition✔️pro
    BatchGetTableOptimizer
    BatchGetTriggers
    BatchGetWorkflows
    BatchStopJobRun
    BatchUpdatePartition✔️pro
    CancelDataQualityRuleRecommendationRun
    CancelDataQualityRulesetEvaluationRun
    CancelMLTaskRun
    CancelStatement
    CheckSchemaVersionValidity✔️pro
    CreateBlueprint
    CreateClassifier✔️pro✔️✔️✔️Show Tests
    CreateConnection✔️pro✔️✔️✔️Show Tests
    CreateCrawler✔️pro✔️✔️Show Tests
    CreateCustomEntityType
    CreateDataQualityRuleset
    CreateDatabase✔️pro✔️✔️✔️Show Tests
    CreateDevEndpoint
    CreateJob✔️pro✔️✔️✔️✔️Show Tests
    CreateMLTransform
    CreatePartition✔️pro
    CreatePartitionIndex✔️pro
    CreateRegistry✔️pro✔️✔️✔️Show Tests
    CreateSchema✔️pro✔️✔️✔️Show Tests
    CreateScript
    CreateSecurityConfiguration✔️pro✔️Show Tests
    CreateSession
    CreateTable✔️pro✔️✔️✔️Show Tests
    CreateTableOptimizer
    CreateTrigger✔️pro✔️✔️✔️✔️Show Tests
    CreateUsageProfile
    CreateUserDefinedFunction
    CreateWorkflow✔️pro✔️✔️✔️Show Tests
    DeleteBlueprint
    DeleteClassifier✔️pro✔️✔️✔️Show Tests
    DeleteColumnStatisticsForPartition
    DeleteColumnStatisticsForTable
    DeleteConnection✔️pro✔️✔️✔️Show Tests
    DeleteCrawler✔️pro✔️Show Tests
    DeleteCustomEntityType
    DeleteDataQualityRuleset
    DeleteDatabase✔️pro✔️✔️✔️Show Tests
    DeleteDevEndpoint
    DeleteJob✔️pro✔️✔️✔️✔️Show Tests
    DeleteMLTransform
    DeletePartition✔️pro
    DeletePartitionIndex✔️pro
    DeleteRegistry✔️pro✔️✔️✔️Show Tests
    DeleteResourcePolicy✔️pro✔️Show Tests
    DeleteSchema✔️pro✔️✔️✔️Show Tests
    DeleteSchemaVersions✔️pro✔️✔️✔️Show Tests
    DeleteSecurityConfiguration✔️pro✔️Show Tests
    DeleteSession
    DeleteTable✔️pro✔️✔️✔️Show Tests
    DeleteTableOptimizer
    DeleteTableVersion
    DeleteTrigger✔️pro✔️✔️✔️✔️Show Tests
    DeleteUsageProfile
    DeleteUserDefinedFunction
    DeleteWorkflow✔️pro✔️✔️✔️Show Tests
    GetBlueprint
    GetBlueprintRun
    GetBlueprintRuns
    GetCatalogImportStatus✔️pro
    GetClassifier✔️pro✔️✔️✔️Show Tests
    GetClassifiers✔️pro✔️Show Tests
    GetColumnStatisticsForPartition
    GetColumnStatisticsForTable
    GetColumnStatisticsTaskRun
    GetColumnStatisticsTaskRuns
    GetConnection✔️pro✔️✔️✔️Show Tests
    GetConnections✔️pro✔️Show Tests
    GetCrawler✔️pro✔️Show Tests
    GetCrawlerMetrics
    GetCrawlers✔️pro✔️Show Tests
    GetCustomEntityType
    GetDataCatalogEncryptionSettings
    GetDataQualityResult
    GetDataQualityRuleRecommendationRun
    GetDataQualityRuleset
    GetDataQualityRulesetEvaluationRun
    GetDatabase✔️pro✔️✔️✔️Show Tests
    GetDatabases✔️pro
    GetDataflowGraph
    GetDevEndpoint
    GetDevEndpoints
    GetJob✔️pro✔️✔️✔️✔️Show Tests
    GetJobBookmark
    GetJobRun✔️pro✔️
    GetJobRuns✔️pro
    GetJobs✔️pro✔️✔️Show Tests
    GetMLTaskRun
    GetMLTaskRuns
    GetMLTransform
    GetMLTransforms
    GetMapping
    GetPartition✔️pro
    GetPartitionIndexes✔️pro
    GetPartitions✔️pro
    GetPlan
    GetRegistry✔️pro✔️✔️✔️Show Tests
    GetResourcePolicies
    GetResourcePolicy✔️pro✔️Show Tests
    GetSchema✔️pro✔️✔️✔️Show Tests
    GetSchemaByDefinition✔️pro
    GetSchemaVersion✔️pro✔️✔️✔️Show Tests
    GetSchemaVersionsDiff✔️pro
    GetSecurityConfiguration✔️pro✔️Show Tests
    GetSecurityConfigurations✔️pro✔️Show Tests
    GetSession
    GetStatement
    GetTable✔️pro✔️✔️✔️Show Tests
    GetTableOptimizer
    GetTableVersion✔️pro
    GetTableVersions✔️pro
    GetTables✔️pro
    GetTags✔️pro✔️
    GetTrigger✔️pro✔️✔️✔️✔️Show Tests
    GetTriggers✔️pro✔️✔️Show Tests
    GetUnfilteredPartitionMetadata
    GetUnfilteredPartitionsMetadata
    GetUnfilteredTableMetadata
    GetUsageProfile
    GetUserDefinedFunction
    GetUserDefinedFunctions
    GetWorkflow✔️pro✔️✔️✔️Show Tests
    GetWorkflowRun
    GetWorkflowRunProperties
    GetWorkflowRuns
    ImportCatalogToGlue✔️pro
    ListBlueprints
    ListColumnStatisticsTaskRuns
    ListCrawlers✔️pro✔️✔️Show Tests
    ListCrawls✔️pro
    ListCustomEntityTypes
    ListDataQualityResults
    ListDataQualityRuleRecommendationRuns
    ListDataQualityRulesetEvaluationRuns
    ListDataQualityRulesets
    ListDevEndpoints
    ListJobs✔️pro✔️✔️Show Tests
    ListMLTransforms
    ListRegistries✔️pro✔️Show Tests
    ListSchemaVersions✔️pro✔️Show Tests
    ListSchemas✔️pro✔️Show Tests
    ListSessions
    ListStatements
    ListTableOptimizerRuns
    ListTriggers
    ListUsageProfiles
    ListWorkflows✔️pro✔️Show Tests
    PutDataCatalogEncryptionSettings
    PutResourcePolicy✔️pro✔️Show Tests
    PutSchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
    PutWorkflowRunProperties
    QuerySchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
    RegisterSchemaVersion✔️pro✔️✔️✔️Show Tests
    RemoveSchemaVersionMetadata✔️pro✔️✔️✔️Show Tests
    ResetJobBookmark
    ResumeWorkflowRun
    RunStatement
    SearchTables
    StartBlueprintRun
    StartColumnStatisticsTaskRun
    StartCrawler✔️pro
    StartCrawlerSchedule
    StartDataQualityRuleRecommendationRun
    StartDataQualityRulesetEvaluationRun
    StartExportLabelsTaskRun
    StartImportLabelsTaskRun
    StartJobRun✔️pro✔️
    StartMLEvaluationTaskRun
    StartMLLabelingSetGenerationTaskRun
    StartTrigger✔️pro✔️
    StartWorkflowRun
    StopColumnStatisticsTaskRun
    StopCrawler✔️pro
    StopCrawlerSchedule
    StopSession
    StopTrigger✔️pro✔️
    StopWorkflowRun
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateBlueprint
    UpdateClassifier✔️pro
    UpdateColumnStatisticsForPartition
    UpdateColumnStatisticsForTable
    UpdateConnection✔️pro✔️Show Tests
    UpdateCrawler✔️pro✔️Show Tests
    UpdateCrawlerSchedule
    UpdateDataQualityRuleset
    UpdateDatabase✔️pro
    UpdateDevEndpoint
    UpdateJob✔️pro✔️Show Tests
    UpdateJobFromSourceControl
    UpdateMLTransform
    UpdatePartition✔️pro
    UpdateRegistry✔️pro✔️Show Tests
    UpdateSchema✔️pro✔️✔️Show Tests
    UpdateSourceControlFromJob
    UpdateTable✔️pro
    UpdateTableOptimizer
    UpdateTrigger✔️pro✔️Show Tests
    UpdateUsageProfile
    UpdateUserDefinedFunction
    UpdateWorkflow✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateClassifier

    Parameters: CsvClassifier

    • IAM (Identity and Access Management)

    Implementation details for API iam

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    IAM (Identity and Access Management)

    Implementation details for API iam

    Coverage Overview

    Identity and Access Management (IAM) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddClientIDToOpenIDConnectProvider
    AddRoleToInstanceProfile✔️community✔️✔️✔️✔️Show Tests
    AddUserToGroup✔️community✔️✔️✔️✔️Show Tests
    AttachGroupPolicy✔️community✔️✔️Show Tests
    AttachRolePolicy✔️community✔️✔️✔️✔️Show Tests
    AttachUserPolicy✔️community✔️✔️✔️✔️Show Tests
    ChangePassword
    CreateAccessKey✔️community✔️✔️✔️✔️Show Tests
    CreateAccountAlias✔️community✔️
    CreateGroup✔️community✔️✔️✔️✔️Show Tests
    CreateInstanceProfile✔️community✔️✔️✔️✔️Show Tests
    CreateLoginProfile✔️community✔️
    CreateOpenIDConnectProvider✔️community✔️
    CreatePolicy✔️community✔️✔️✔️✔️Show Tests
    CreatePolicyVersion✔️community
    CreateRole✔️community✔️✔️✔️✔️Show Tests
    CreateSAMLProvider✔️community✔️
    CreateServiceLinkedRole✔️community✔️✔️✔️✔️Show Tests
    CreateServiceSpecificCredential
    CreateUser✔️community✔️✔️✔️✔️Show Tests
    CreateVirtualMFADevice✔️community✔️
    DeactivateMFADevice✔️community✔️
    DeleteAccessKey✔️community✔️✔️✔️✔️Show Tests
    DeleteAccountAlias✔️community✔️
    DeleteAccountPasswordPolicy✔️community✔️
    DeleteGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteGroupPolicy✔️community✔️✔️Show Tests
    DeleteInstanceProfile✔️community✔️✔️✔️Show Tests
    DeleteLoginProfile✔️community✔️
    DeleteOpenIDConnectProvider✔️community✔️
    DeletePolicy✔️community✔️✔️✔️✔️Show Tests
    DeletePolicyVersion✔️community
    DeleteRole✔️community✔️✔️✔️✔️Show Tests
    DeleteRolePermissionsBoundary✔️community✔️✔️✔️Show Tests
    DeleteRolePolicy✔️community✔️✔️✔️✔️Show Tests
    DeleteSAMLProvider✔️community✔️
    DeleteSSHPublicKey✔️community✔️
    DeleteServerCertificate✔️community✔️✔️✔️✔️Show Tests
    DeleteServiceLinkedRole✔️community✔️✔️✔️Show Tests
    DeleteServiceSpecificCredential
    DeleteSigningCertificate✔️community✔️
    DeleteUser✔️community✔️✔️✔️✔️Show Tests
    DeleteUserPermissionsBoundary✔️community✔️✔️Show Tests
    DeleteUserPolicy✔️community✔️✔️✔️✔️Show Tests
    DeleteVirtualMFADevice✔️community✔️
    DetachGroupPolicy✔️community✔️✔️✔️Show Tests
    DetachRolePolicy✔️community✔️✔️✔️✔️Show Tests
    DetachUserPolicy✔️community✔️✔️✔️✔️Show Tests
    EnableMFADevice✔️community✔️
    GenerateCredentialReport✔️community✔️
    GenerateOrganizationsAccessReport
    GenerateServiceLastAccessedDetails
    GetAccessKeyLastUsed✔️community✔️
    GetAccountAuthorizationDetails✔️community
    GetAccountPasswordPolicy✔️community✔️
    GetAccountSummary✔️community
    GetContextKeysForCustomPolicy
    GetContextKeysForPrincipalPolicy
    GetCredentialReport✔️community✔️
    GetGroup✔️community✔️
    GetGroupPolicy✔️community✔️
    GetInstanceProfile✔️community✔️✔️✔️✔️Show Tests
    GetLoginProfile✔️community✔️
    GetMFADevice
    GetOpenIDConnectProvider✔️community✔️
    GetOrganizationsAccessReport
    GetPolicy✔️community✔️✔️✔️Show Tests
    GetPolicyVersion✔️community✔️✔️✔️Show Tests
    GetRole✔️community✔️✔️✔️✔️Show Tests
    GetRolePolicy✔️community✔️✔️✔️Show Tests
    GetSAMLProvider✔️community✔️
    GetSSHPublicKey✔️community✔️
    GetServerCertificate✔️community✔️✔️✔️✔️Show Tests
    GetServiceLastAccessedDetails
    GetServiceLastAccessedDetailsWithEntities
    GetServiceLinkedRoleDeletionStatus✔️community✔️
    GetUser✔️community✔️✔️✔️✔️Show Tests
    GetUserPolicy✔️community✔️✔️✔️✔️Show Tests
    ListAccessKeys✔️community✔️✔️✔️✔️Show Tests
    ListAccountAliases✔️community✔️
    ListAttachedGroupPolicies✔️community✔️✔️✔️Show Tests
    ListAttachedRolePolicies✔️community✔️✔️✔️✔️Show Tests
    ListAttachedUserPolicies✔️community✔️✔️✔️✔️Show Tests
    ListEntitiesForPolicy✔️community
    ListGroupPolicies✔️community✔️✔️✔️Show Tests
    ListGroups✔️community✔️
    ListGroupsForUser✔️community✔️✔️✔️✔️Show Tests
    ListInstanceProfileTags✔️community✔️✔️Show Tests
    ListInstanceProfiles✔️community✔️
    ListInstanceProfilesForRole✔️community
    ListMFADeviceTags
    ListMFADevices✔️community✔️
    ListOpenIDConnectProviderTags✔️community✔️
    ListOpenIDConnectProviders✔️community✔️
    ListPolicies✔️community✔️✔️Show Tests
    ListPoliciesGrantingServiceAccess
    ListPolicyTags✔️community
    ListPolicyVersions✔️community
    ListRolePolicies✔️community✔️✔️✔️Show Tests
    ListRoleTags✔️community✔️
    ListRoles✔️community✔️✔️✔️✔️Show Tests
    ListSAMLProviderTags
    ListSAMLProviders✔️community✔️
    ListSSHPublicKeys✔️community✔️
    ListServerCertificateTags
    ListServerCertificates✔️community
    ListServiceSpecificCredentials
    ListSigningCertificates✔️community✔️
    ListUserPolicies✔️community✔️✔️✔️✔️Show Tests
    ListUserTags✔️community✔️
    ListUsers✔️community✔️
    ListVirtualMFADevices✔️community✔️
    PutGroupPolicy✔️community✔️✔️✔️Show Tests
    PutRolePermissionsBoundary✔️community✔️✔️✔️Show Tests
    PutRolePolicy✔️community✔️✔️✔️✔️Show Tests
    PutUserPermissionsBoundary✔️community✔️✔️Show Tests
    PutUserPolicy✔️community✔️✔️✔️✔️Show Tests
    RemoveClientIDFromOpenIDConnectProvider
    RemoveRoleFromInstanceProfile✔️community✔️✔️✔️Show Tests
    RemoveUserFromGroup✔️community✔️
    ResetServiceSpecificCredential
    ResyncMFADevice
    SetDefaultPolicyVersion✔️community
    SetSecurityTokenServicePreferences
    SimulateCustomPolicy
    SimulatePrincipalPolicy✔️community✔️Show Tests
    TagInstanceProfile✔️community✔️✔️✔️Show Tests
    TagMFADevice
    TagOpenIDConnectProvider✔️community✔️
    TagPolicy✔️community✔️
    TagRole✔️community✔️
    TagSAMLProvider
    TagServerCertificate
    TagUser✔️community✔️
    UntagInstanceProfile✔️community✔️✔️✔️Show Tests
    UntagMFADevice
    UntagOpenIDConnectProvider✔️community✔️
    UntagPolicy✔️community
    UntagRole✔️community✔️
    UntagSAMLProvider
    UntagServerCertificate
    UntagUser✔️community✔️
    UpdateAccessKey✔️community✔️✔️✔️✔️Show Tests
    UpdateAccountPasswordPolicy✔️community✔️
    UpdateAssumeRolePolicy✔️community✔️✔️✔️Show Tests
    UpdateGroup✔️community✔️
    UpdateLoginProfile✔️community✔️
    UpdateOpenIDConnectProviderThumbprint✔️community✔️
    UpdateRole✔️community
    UpdateRoleDescription✔️community
    UpdateSAMLProvider✔️community
    UpdateSSHPublicKey✔️community✔️
    UpdateServerCertificate
    UpdateServiceSpecificCredential
    UpdateSigningCertificate✔️community✔️
    UpdateUser✔️community✔️
    UploadSSHPublicKey✔️community✔️
    UploadServerCertificate✔️community✔️✔️✔️✔️Show Tests
    UploadSigningCertificate✔️community✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddRoleToInstanceProfile

    Parameters: InstanceProfileName, RoleName

    • identitystore

    Implementation details for API identitystore

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateGroup✔️pro✔️
    CreateGroupMembership✔️pro✔️
    CreateUser✔️pro✔️
    DeleteGroup✔️pro✔️
    DeleteGroupMembership✔️pro✔️
    DeleteUser✔️pro✔️
    DescribeGroup✔️pro✔️
    DescribeGroupMembership
    DescribeUser✔️pro✔️
    GetGroupId✔️pro✔️
    GetGroupMembershipId
    GetUserId
    IsMemberInGroups
    ListGroupMemberships✔️pro✔️
    ListGroupMembershipsForMember✔️pro✔️
    ListGroups✔️pro✔️
    ListUsers✔️pro✔️
    UpdateGroup
    UpdateUser

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    identitystore

    Implementation details for API identitystore

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateGroup✔️pro✔️
    CreateGroupMembership✔️pro✔️
    CreateUser✔️pro✔️
    DeleteGroup✔️pro✔️
    DeleteGroupMembership✔️pro✔️
    DeleteUser✔️pro✔️
    DescribeGroup✔️pro✔️
    DescribeGroupMembership
    DescribeUser✔️pro✔️
    GetGroupId✔️pro✔️
    GetGroupMembershipId
    GetUserId
    IsMemberInGroups
    ListGroupMemberships✔️pro✔️
    ListGroupMembershipsForMember✔️pro✔️
    ListGroups✔️pro✔️
    ListUsers✔️pro✔️
    UpdateGroup
    UpdateUser

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_iot-data/index.html b/references/coverage/coverage_iot-data/index.html index b7525d9adb..a4aae3c786 100644 --- a/references/coverage/coverage_iot-data/index.html +++ b/references/coverage/coverage_iot-data/index.html @@ -155,10 +155,10 @@
  • +

    • IoT Data

    Implementation details for API iot-data

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    IoT Data

    Implementation details for API iot-data

    Coverage Overview

    IoT Data is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DeleteThingShadow✔️pro✔️
    GetRetainedMessage
    GetThingShadow✔️pro✔️
    ListNamedShadowsForThing✔️pro
    ListRetainedMessages
    Publish✔️pro✔️
    UpdateThingShadow✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_iot/index.html b/references/coverage/coverage_iot/index.html index e2505fa404..aea944ec1b 100644 --- a/references/coverage/coverage_iot/index.html +++ b/references/coverage/coverage_iot/index.html @@ -155,10 +155,10 @@
  • +

    • IoT (Internet of Things)

    Implementation details for API iot

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    IoT (Internet of Things)

    Implementation details for API iot

    Coverage Overview

    Internet of Things (IoT) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptCertificateTransfer
    AddThingToBillingGroup
    AddThingToThingGroup✔️pro
    AssociateTargetsWithJob
    AttachPolicy✔️pro✔️
    AttachPrincipalPolicy✔️pro
    AttachSecurityProfile
    AttachThingPrincipal✔️pro
    CancelAuditMitigationActionsTask
    CancelAuditTask
    CancelCertificateTransfer
    CancelDetectMitigationActionsTask
    CancelJob✔️pro
    CancelJobExecution✔️pro
    ClearDefaultAuthorizer
    ConfirmTopicRuleDestination
    CreateAuditSuppression
    CreateAuthorizer
    CreateBillingGroup
    CreateCertificateFromCsr✔️pro✔️
    CreateCertificateProvider
    CreateCustomMetric
    CreateDimension
    CreateDomainConfiguration✔️pro✔️
    CreateDynamicThingGroup✔️pro
    CreateFleetMetric
    CreateJob✔️pro✔️
    CreateJobTemplate
    CreateKeysAndCertificate✔️pro✔️
    CreateMitigationAction
    CreateOTAUpdate
    CreatePackage
    CreatePackageVersion
    CreatePolicy✔️pro✔️
    CreatePolicyVersion✔️pro
    CreateProvisioningClaim
    CreateProvisioningTemplate
    CreateProvisioningTemplateVersion
    CreateRoleAlias✔️pro✔️✔️✔️Show Tests
    CreateScheduledAudit
    CreateSecurityProfile
    CreateStream
    CreateThing✔️pro✔️
    CreateThingGroup✔️pro✔️
    CreateThingType✔️pro✔️
    CreateTopicRule✔️pro✔️✔️✔️Show Tests
    CreateTopicRuleDestination✔️pro
    DeleteAccountAuditConfiguration
    DeleteAuditSuppression
    DeleteAuthorizer
    DeleteBillingGroup
    DeleteCACertificate✔️pro✔️
    DeleteCertificate✔️pro✔️
    DeleteCertificateProvider
    DeleteCustomMetric
    DeleteDimension
    DeleteDomainConfiguration✔️pro✔️
    DeleteDynamicThingGroup✔️pro
    DeleteFleetMetric
    DeleteJob✔️pro✔️
    DeleteJobExecution✔️pro
    DeleteJobTemplate
    DeleteMitigationAction
    DeleteOTAUpdate
    DeletePackage
    DeletePackageVersion
    DeletePolicy✔️pro
    DeletePolicyVersion✔️pro
    DeleteProvisioningTemplate
    DeleteProvisioningTemplateVersion
    DeleteRegistrationCode
    DeleteRoleAlias✔️pro✔️✔️✔️Show Tests
    DeleteScheduledAudit
    DeleteSecurityProfile
    DeleteStream
    DeleteThing✔️pro✔️
    DeleteThingGroup✔️pro
    DeleteThingType✔️pro✔️
    DeleteTopicRule✔️pro✔️✔️✔️Show Tests
    DeleteTopicRuleDestination✔️pro
    DeleteV2LoggingLevel
    DeprecateThingType✔️pro✔️
    DescribeAccountAuditConfiguration
    DescribeAuditFinding
    DescribeAuditMitigationActionsTask
    DescribeAuditSuppression
    DescribeAuditTask
    DescribeAuthorizer
    DescribeBillingGroup
    DescribeCACertificate✔️pro✔️
    DescribeCertificate✔️pro✔️
    DescribeCertificateProvider
    DescribeCustomMetric
    DescribeDefaultAuthorizer
    DescribeDetectMitigationActionsTask
    DescribeDimension
    DescribeDomainConfiguration✔️pro✔️
    DescribeEndpoint✔️pro✔️
    DescribeEventConfigurations
    DescribeFleetMetric
    DescribeIndex
    DescribeJob✔️pro✔️
    DescribeJobExecution✔️pro
    DescribeJobTemplate
    DescribeManagedJobTemplate
    DescribeMitigationAction
    DescribeProvisioningTemplate
    DescribeProvisioningTemplateVersion
    DescribeRoleAlias✔️pro
    DescribeScheduledAudit
    DescribeSecurityProfile
    DescribeStream
    DescribeThing✔️pro✔️
    DescribeThingGroup✔️pro
    DescribeThingRegistrationTask
    DescribeThingType✔️pro✔️
    DetachPolicy✔️pro
    DetachPrincipalPolicy✔️pro
    DetachSecurityProfile
    DetachThingPrincipal✔️pro
    DisableTopicRule✔️pro
    EnableTopicRule✔️pro
    GetBehaviorModelTrainingSummaries
    GetBucketsAggregation
    GetCardinality
    GetEffectivePolicies
    GetIndexingConfiguration
    GetJobDocument✔️pro
    GetLoggingOptions
    GetOTAUpdate
    GetPackage
    GetPackageConfiguration
    GetPackageVersion
    GetPercentiles
    GetPolicy✔️pro
    GetPolicyVersion✔️pro
    GetRegistrationCode✔️pro✔️
    GetStatistics
    GetTopicRule✔️pro✔️✔️✔️Show Tests
    GetTopicRuleDestination✔️pro
    GetV2LoggingOptions
    ListActiveViolations
    ListAttachedPolicies✔️pro✔️
    ListAuditFindings
    ListAuditMitigationActionsExecutions
    ListAuditMitigationActionsTasks
    ListAuditSuppressions
    ListAuditTasks
    ListAuthorizers
    ListBillingGroups
    ListCACertificates
    ListCertificateProviders
    ListCertificates✔️pro✔️
    ListCertificatesByCA✔️pro✔️
    ListCustomMetrics
    ListDetectMitigationActionsExecutions
    ListDetectMitigationActionsTasks
    ListDimensions
    ListDomainConfigurations✔️pro✔️
    ListFleetMetrics
    ListIndices
    ListJobExecutionsForJob✔️pro
    ListJobExecutionsForThing✔️pro
    ListJobTemplates
    ListJobs✔️pro✔️
    ListManagedJobTemplates
    ListMetricValues
    ListMitigationActions
    ListOTAUpdates
    ListOutgoingCertificates
    ListPackageVersions
    ListPackages
    ListPolicies✔️pro
    ListPolicyPrincipals✔️pro
    ListPolicyVersions✔️pro
    ListPrincipalPolicies✔️pro
    ListPrincipalThings✔️pro
    ListProvisioningTemplateVersions
    ListProvisioningTemplates
    ListRelatedResourcesForAuditFinding
    ListRoleAliases✔️pro
    ListScheduledAudits
    ListSecurityProfiles
    ListSecurityProfilesForTarget
    ListStreams
    ListTagsForResource✔️pro
    ListTargetsForPolicy✔️pro✔️
    ListTargetsForSecurityProfile
    ListThingGroups✔️pro✔️
    ListThingGroupsForThing✔️pro
    ListThingPrincipals✔️pro
    ListThingRegistrationTaskReports
    ListThingRegistrationTasks
    ListThingTypes✔️pro✔️
    ListThings✔️pro✔️
    ListThingsInBillingGroup
    ListThingsInThingGroup✔️pro
    ListTopicRuleDestinations
    ListTopicRules✔️pro
    ListV2LoggingLevels
    ListViolationEvents
    PutVerificationStateOnViolation
    RegisterCACertificate✔️pro✔️
    RegisterCertificate✔️pro✔️
    RegisterCertificateWithoutCA✔️pro✔️
    RegisterThing
    RejectCertificateTransfer
    RemoveThingFromBillingGroup
    RemoveThingFromThingGroup✔️pro
    ReplaceTopicRule✔️pro
    SearchIndex✔️pro✔️
    SetDefaultAuthorizer
    SetDefaultPolicyVersion✔️pro
    SetLoggingOptions
    SetV2LoggingLevel
    SetV2LoggingOptions
    StartAuditMitigationActionsTask
    StartDetectMitigationActionsTask
    StartOnDemandAuditTask
    StartThingRegistrationTask
    StopThingRegistrationTask
    TagResource✔️pro
    TestAuthorization
    TestInvokeAuthorizer
    TransferCertificate
    UntagResource
    UpdateAccountAuditConfiguration
    UpdateAuditSuppression
    UpdateAuthorizer
    UpdateBillingGroup
    UpdateCACertificate✔️pro✔️
    UpdateCertificate✔️pro✔️
    UpdateCertificateProvider
    UpdateCustomMetric
    UpdateDimension
    UpdateDomainConfiguration✔️pro✔️
    UpdateDynamicThingGroup✔️pro
    UpdateEventConfigurations✔️pro
    UpdateFleetMetric
    UpdateIndexingConfiguration✔️pro
    UpdateJob
    UpdateMitigationAction
    UpdatePackage
    UpdatePackageConfiguration
    UpdatePackageVersion
    UpdateProvisioningTemplate
    UpdateRoleAlias✔️pro
    UpdateScheduledAudit
    UpdateSecurityProfile
    UpdateStream
    UpdateThing✔️pro✔️
    UpdateThingGroup✔️pro
    UpdateThingGroupsForThing✔️pro
    UpdateTopicRuleDestination
    ValidateSecurityProfileBehaviors

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateRoleAlias

    Parameters: credentialDurationSeconds, roleAlias, roleArn, tags

    • IoT Analytics

    Implementation details for API iotanalytics

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    IoT Analytics

    Implementation details for API iotanalytics

    Coverage Overview

    IoT Analytics is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchPutMessage
    CancelPipelineReprocessing
    CreateChannel✔️pro
    CreateDataset✔️pro
    CreateDatasetContent
    CreateDatastore✔️pro
    CreatePipeline✔️pro
    DeleteChannel✔️pro
    DeleteDataset✔️pro
    DeleteDatasetContent
    DeleteDatastore✔️pro
    DeletePipeline✔️pro
    DescribeChannel✔️pro
    DescribeDataset✔️pro
    DescribeDatastore✔️pro
    DescribeLoggingOptions
    DescribePipeline✔️pro
    GetDatasetContent
    ListChannels✔️pro
    ListDatasetContents
    ListDatasets✔️pro
    ListDatastores✔️pro
    ListPipelines✔️pro
    ListTagsForResource
    PutLoggingOptions
    RunPipelineActivity
    SampleChannelData
    StartPipelineReprocessing
    TagResource
    UntagResource
    UpdateChannel
    UpdateDataset
    UpdateDatastore
    UpdatePipeline

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_iotwireless/index.html b/references/coverage/coverage_iotwireless/index.html index 9d372d60a6..2451074ec7 100644 --- a/references/coverage/coverage_iotwireless/index.html +++ b/references/coverage/coverage_iotwireless/index.html @@ -155,10 +155,10 @@
  • +

    • IoT Wireless

    Implementation details for API iotwireless

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    IoT Wireless

    Implementation details for API iotwireless

    Coverage Overview

    IoT Wireless is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateAwsAccountWithPartnerAccount
    AssociateMulticastGroupWithFuotaTask
    AssociateWirelessDeviceWithFuotaTask
    AssociateWirelessDeviceWithMulticastGroup
    AssociateWirelessDeviceWithThing
    AssociateWirelessGatewayWithCertificate
    AssociateWirelessGatewayWithThing
    CancelMulticastGroupSession
    CreateDestination
    CreateDeviceProfile✔️pro
    CreateFuotaTask
    CreateMulticastGroup
    CreateNetworkAnalyzerConfiguration
    CreateServiceProfile
    CreateWirelessDevice✔️pro
    CreateWirelessGateway✔️pro
    CreateWirelessGatewayTask
    CreateWirelessGatewayTaskDefinition
    DeleteDestination
    DeleteDeviceProfile✔️pro
    DeleteFuotaTask
    DeleteMulticastGroup
    DeleteNetworkAnalyzerConfiguration
    DeleteQueuedMessages
    DeleteServiceProfile
    DeleteWirelessDevice✔️pro
    DeleteWirelessDeviceImportTask
    DeleteWirelessGateway✔️pro
    DeleteWirelessGatewayTask
    DeleteWirelessGatewayTaskDefinition
    DeregisterWirelessDevice
    DisassociateAwsAccountFromPartnerAccount
    DisassociateMulticastGroupFromFuotaTask
    DisassociateWirelessDeviceFromFuotaTask
    DisassociateWirelessDeviceFromMulticastGroup
    DisassociateWirelessDeviceFromThing
    DisassociateWirelessGatewayFromCertificate
    DisassociateWirelessGatewayFromThing
    GetDestination
    GetDeviceProfile✔️pro
    GetEventConfigurationByResourceTypes
    GetFuotaTask
    GetLogLevelsByResourceTypes
    GetMetricConfiguration
    GetMetrics
    GetMulticastGroup
    GetMulticastGroupSession
    GetNetworkAnalyzerConfiguration
    GetPartnerAccount
    GetPosition
    GetPositionConfiguration
    GetPositionEstimate
    GetResourceEventConfiguration
    GetResourceLogLevel
    GetResourcePosition
    GetServiceEndpoint
    GetServiceProfile
    GetWirelessDevice✔️pro
    GetWirelessDeviceImportTask
    GetWirelessDeviceStatistics
    GetWirelessGateway✔️pro
    GetWirelessGatewayCertificate
    GetWirelessGatewayFirmwareInformation
    GetWirelessGatewayStatistics
    GetWirelessGatewayTask
    GetWirelessGatewayTaskDefinition
    ListDestinations
    ListDeviceProfiles✔️pro
    ListDevicesForWirelessDeviceImportTask
    ListEventConfigurations
    ListFuotaTasks
    ListMulticastGroups
    ListMulticastGroupsByFuotaTask
    ListNetworkAnalyzerConfigurations
    ListPartnerAccounts
    ListPositionConfigurations
    ListQueuedMessages
    ListServiceProfiles
    ListTagsForResource
    ListWirelessDeviceImportTasks
    ListWirelessDevices✔️pro
    ListWirelessGatewayTaskDefinitions
    ListWirelessGateways✔️pro
    PutPositionConfiguration
    PutResourceLogLevel
    ResetAllResourceLogLevels
    ResetResourceLogLevel
    SendDataToMulticastGroup
    SendDataToWirelessDevice
    StartBulkAssociateWirelessDeviceWithMulticastGroup
    StartBulkDisassociateWirelessDeviceFromMulticastGroup
    StartFuotaTask
    StartMulticastGroupSession
    StartSingleWirelessDeviceImportTask
    StartWirelessDeviceImportTask
    TagResource
    TestWirelessDevice
    UntagResource
    UpdateDestination
    UpdateEventConfigurationByResourceTypes
    UpdateFuotaTask
    UpdateLogLevelsByResourceTypes
    UpdateMetricConfiguration
    UpdateMulticastGroup
    UpdateNetworkAnalyzerConfiguration
    UpdatePartnerAccount
    UpdatePosition
    UpdateResourceEventConfiguration
    UpdateResourcePosition
    UpdateWirelessDevice✔️pro
    UpdateWirelessDeviceImportTask
    UpdateWirelessGateway✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_kafka/index.html b/references/coverage/coverage_kafka/index.html index 94fcdd9d4b..7114f82db7 100644 --- a/references/coverage/coverage_kafka/index.html +++ b/references/coverage/coverage_kafka/index.html @@ -155,10 +155,10 @@
  • +

    • MSK (Managed Streaming for Apache Kafka)

    Implementation details for API kafka

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    MSK (Managed Streaming for Apache Kafka)

    Implementation details for API kafka

    Coverage Overview

    Managed Streaming for Apache Kafka (MSK) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchAssociateScramSecret
    CreateCluster✔️pro✔️Show Tests
    CreateClusterV2✔️pro
    CreateConfiguration✔️pro
    CreateReplicator
    CreateVpcConnection
    DeleteCluster✔️pro✔️Show Tests
    DeleteClusterPolicy
    DeleteConfiguration✔️pro
    DeleteReplicator
    DeleteVpcConnection
    DescribeCluster✔️pro✔️Show Tests
    DescribeClusterV2✔️pro
    DescribeClusterOperation✔️pro
    DescribeClusterOperationV2
    DescribeConfiguration✔️pro
    DescribeConfigurationRevision✔️pro
    DescribeReplicator
    DescribeVpcConnection
    BatchDisassociateScramSecret
    GetBootstrapBrokers✔️pro
    GetCompatibleKafkaVersions
    GetClusterPolicy
    ListClusterOperations
    ListClusterOperationsV2
    ListClusters✔️pro✔️Show Tests
    ListClustersV2✔️pro
    ListConfigurationRevisions✔️pro
    ListConfigurations✔️pro
    ListKafkaVersions
    ListNodes✔️pro
    ListReplicators
    ListScramSecrets
    ListTagsForResource
    ListClientVpcConnections
    ListVpcConnections
    RejectClientVpcConnection
    PutClusterPolicy
    RebootBroker
    TagResource
    UntagResource
    UpdateBrokerCount
    UpdateBrokerType
    UpdateBrokerStorage
    UpdateConfiguration✔️pro
    UpdateConnectivity
    UpdateClusterConfiguration✔️pro
    UpdateClusterKafkaVersion✔️pro
    UpdateMonitoring
    UpdateReplicationInfo
    UpdateSecurity
    UpdateStorage

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCluster

    Parameters: BrokerNodeGroupInfo, ClusterName, KafkaVersion, NumberOfBrokerNodes

    • Kinesis

    Implementation details for API kinesis

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis

    Implementation details for API kinesis

    Coverage Overview

    Kinesis is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTagsToStream✔️community✔️✔️✔️✔️Show Tests
    CreateStream✔️community✔️✔️✔️✔️Show Tests
    DecreaseStreamRetentionPeriod✔️community
    DeleteResourcePolicy✔️community
    DeleteStream✔️community✔️✔️✔️✔️Show Tests
    DeregisterStreamConsumer✔️community✔️✔️✔️Show Tests
    DescribeLimits✔️community
    DescribeStream✔️community✔️✔️✔️✔️Show Tests
    DescribeStreamConsumer✔️community✔️✔️✔️Show Tests
    DescribeStreamSummary✔️community✔️✔️✔️Show Tests
    DisableEnhancedMonitoring✔️community✔️
    EnableEnhancedMonitoring✔️community✔️
    GetRecords✔️community✔️✔️✔️✔️Show Tests
    GetResourcePolicy✔️community
    GetShardIterator✔️community✔️✔️✔️✔️Show Tests
    IncreaseStreamRetentionPeriod✔️community
    ListShards✔️community✔️✔️✔️Show Tests
    ListStreamConsumers✔️community✔️✔️✔️✔️Show Tests
    ListStreams✔️community✔️✔️✔️Show Tests
    ListTagsForStream✔️community✔️✔️✔️✔️Show Tests
    MergeShards✔️community
    PutRecord✔️community✔️✔️✔️Show Tests
    PutRecords✔️community✔️✔️✔️✔️Show Tests
    PutResourcePolicy✔️community
    RegisterStreamConsumer✔️community✔️✔️✔️Show Tests
    RemoveTagsFromStream✔️community✔️
    SplitShard✔️community
    StartStreamEncryption✔️community
    StopStreamEncryption✔️community
    SubscribeToShard✔️community✔️✔️✔️Show Tests
    UpdateShardCount✔️community
    UpdateStreamMode✔️community

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTagsToStream

    Parameters: StreamName, Tags

    • Kinesis Data Analytics API

    Implementation details for API kinesisanalytics

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis Data Analytics API

    Implementation details for API kinesisanalytics

    Coverage Overview

    Kinesis Data Analytics API is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddApplicationCloudWatchLoggingOption
    AddApplicationInput
    AddApplicationInputProcessingConfiguration✔️pro
    AddApplicationOutput✔️pro✔️✔️✔️Show Tests
    AddApplicationReferenceDataSource
    CreateApplication✔️pro✔️✔️✔️Show Tests
    DeleteApplication✔️pro✔️✔️✔️Show Tests
    DeleteApplicationCloudWatchLoggingOption
    DeleteApplicationInputProcessingConfiguration✔️pro
    DeleteApplicationOutput✔️pro✔️✔️✔️Show Tests
    DeleteApplicationReferenceDataSource
    DescribeApplication✔️pro✔️✔️✔️Show Tests
    DiscoverInputSchema
    ListApplications✔️pro
    ListTagsForResource✔️pro
    StartApplication✔️pro
    StopApplication
    TagResource✔️pro
    UntagResource✔️pro
    UpdateApplication✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddApplicationOutput

    Parameters: ApplicationName, CurrentApplicationVersionId, Output

    • Kinesis Data Analytics API v2

    Implementation details for API kinesisanalyticsv2

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis Data Analytics API v2

    Implementation details for API kinesisanalyticsv2

    Coverage Overview

    Kinesis Data Analytics API v2 is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddApplicationCloudWatchLoggingOption
    AddApplicationInput
    AddApplicationInputProcessingConfiguration✔️pro
    AddApplicationOutput✔️pro
    AddApplicationReferenceDataSource
    AddApplicationVpcConfiguration
    CreateApplication✔️pro
    CreateApplicationPresignedUrl
    CreateApplicationSnapshot
    DeleteApplication✔️pro
    DeleteApplicationCloudWatchLoggingOption
    DeleteApplicationInputProcessingConfiguration✔️pro
    DeleteApplicationOutput
    DeleteApplicationReferenceDataSource
    DeleteApplicationSnapshot
    DeleteApplicationVpcConfiguration
    DescribeApplication✔️pro
    DescribeApplicationOperation
    DescribeApplicationSnapshot
    DescribeApplicationVersion
    DiscoverInputSchema
    ListApplicationOperations
    ListApplicationSnapshots
    ListApplicationVersions
    ListApplications✔️pro
    ListTagsForResource✔️pro
    RollbackApplication
    StartApplication
    StopApplication
    TagResource✔️pro
    UntagResource✔️pro
    UpdateApplication✔️pro
    UpdateApplicationMaintenanceConfiguration

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_kms/index.html b/references/coverage/coverage_kms/index.html index 5147f8900c..bc2f3800be 100644 --- a/references/coverage/coverage_kms/index.html +++ b/references/coverage/coverage_kms/index.html @@ -155,10 +155,10 @@
  • +

    • KMS (Key Management Service)

    Implementation details for API kms

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    KMS (Key Management Service)

    Implementation details for API kms

    Coverage Overview

    Key Management Service (KMS) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelKeyDeletion✔️community✔️✔️✔️✔️Show Tests
    ConnectCustomKeyStore
    CreateAlias✔️community✔️✔️✔️✔️Show Tests
    CreateCustomKeyStore
    CreateGrant✔️community✔️✔️✔️Show Tests
    CreateKey✔️community✔️✔️✔️✔️Show Tests
    Decrypt✔️community✔️✔️✔️✔️Show Tests
    DeleteAlias✔️community✔️✔️✔️✔️Show Tests
    DeleteCustomKeyStore
    DeleteImportedKeyMaterial✔️community✔️✔️✔️Show Tests
    DeriveSharedSecret
    DescribeCustomKeyStores
    DescribeKey✔️community✔️✔️✔️✔️Show Tests
    DisableKey✔️community✔️✔️✔️✔️Show Tests
    DisableKeyRotation✔️community✔️✔️✔️✔️Show Tests
    DisconnectCustomKeyStore
    EnableKey✔️community✔️✔️✔️✔️Show Tests
    EnableKeyRotation✔️community✔️✔️✔️✔️Show Tests
    Encrypt✔️community✔️✔️✔️✔️Show Tests
    GenerateDataKey✔️community✔️✔️✔️✔️Show Tests
    GenerateDataKeyPair✔️community✔️✔️✔️Show Tests
    GenerateDataKeyPairWithoutPlaintext✔️community✔️✔️✔️Show Tests
    GenerateDataKeyWithoutPlaintext✔️community✔️✔️✔️✔️Show Tests
    GenerateMac✔️community✔️✔️✔️Show Tests
    GenerateRandom✔️community✔️✔️✔️✔️Show Tests
    GetKeyPolicy✔️community✔️✔️✔️✔️Show Tests
    GetKeyRotationStatus✔️community✔️✔️✔️✔️Show Tests
    GetParametersForImport✔️community✔️✔️✔️Show Tests
    GetPublicKey✔️community✔️✔️✔️✔️Show Tests
    ImportKeyMaterial✔️community✔️✔️✔️Show Tests
    ListAliases✔️community✔️✔️✔️✔️Show Tests
    ListGrants✔️community✔️✔️✔️Show Tests
    ListKeyPolicies✔️community✔️✔️✔️✔️Show Tests
    ListKeyRotations
    ListKeys✔️community✔️✔️✔️✔️Show Tests
    ListResourceTags✔️community✔️✔️✔️✔️Show Tests
    ListRetirableGrants✔️community✔️✔️✔️Show Tests
    PutKeyPolicy✔️community✔️✔️✔️✔️Show Tests
    ReEncrypt
    ReplicateKey✔️community✔️✔️✔️Show Tests
    RetireGrant✔️community✔️✔️✔️Show Tests
    RevokeGrant✔️community✔️✔️✔️Show Tests
    RotateKeyOnDemand
    ScheduleKeyDeletion✔️community✔️✔️✔️✔️Show Tests
    Sign✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️✔️Show Tests
    UpdateAlias✔️community✔️✔️✔️Show Tests
    UpdateCustomKeyStore
    UpdateKeyDescription✔️community✔️✔️✔️✔️Show Tests
    UpdatePrimaryRegion
    Verify✔️community✔️✔️✔️✔️Show Tests
    VerifyMac✔️community✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CancelKeyDeletion

    Parameters: KeyId

    • Lake Formation

    Implementation details for API lakeformation

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Lake Formation

    Implementation details for API lakeformation

    Coverage Overview

    Lake Formation is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddLFTagsToResource
    AssumeDecoratedRoleWithSAML
    BatchGrantPermissions
    BatchRevokePermissions
    CancelTransaction
    CommitTransaction
    CreateDataCellsFilter
    CreateLFTag
    CreateLakeFormationIdentityCenterConfiguration
    CreateLakeFormationOptIn
    DeleteDataCellsFilter
    DeleteLFTag
    DeleteLakeFormationIdentityCenterConfiguration
    DeleteLakeFormationOptIn
    DeleteObjectsOnCancel
    DeregisterResource✔️pro✔️
    DescribeLakeFormationIdentityCenterConfiguration
    DescribeResource✔️pro✔️
    DescribeTransaction
    ExtendTransaction
    GetDataCellsFilter
    GetDataLakePrincipal
    GetDataLakeSettings✔️pro
    GetEffectivePermissionsForPath
    GetLFTag
    GetQueryState
    GetQueryStatistics
    GetResourceLFTags
    GetTableObjects
    GetTemporaryGluePartitionCredentials
    GetTemporaryGlueTableCredentials
    GetWorkUnitResults
    GetWorkUnits
    GrantPermissions✔️pro✔️
    ListDataCellsFilter
    ListLFTags
    ListLakeFormationOptIns
    ListPermissions✔️pro✔️
    ListResources✔️pro✔️
    ListTableStorageOptimizers
    ListTransactions
    PutDataLakeSettings✔️pro
    RegisterResource✔️pro✔️
    RemoveLFTagsFromResource
    RevokePermissions✔️pro
    SearchDatabasesByLFTags
    SearchTablesByLFTags
    StartQueryPlanning
    StartTransaction
    UpdateDataCellsFilter
    UpdateLFTag
    UpdateLakeFormationIdentityCenterConfiguration
    UpdateResource
    UpdateTableObjects
    UpdateTableStorageOptimizer

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_lambda/index.html b/references/coverage/coverage_lambda/index.html index a1aaa007a8..ac9c96faa4 100644 --- a/references/coverage/coverage_lambda/index.html +++ b/references/coverage/coverage_lambda/index.html @@ -155,10 +155,10 @@
  • +

    • Lambda

    Implementation details for API lambda

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Lambda

    Implementation details for API lambda

    Coverage Overview

    Lambda is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddLayerVersionPermission✔️community✔️✔️✔️Show Tests
    AddPermission✔️community✔️✔️✔️Show Tests
    CreateAlias✔️community✔️✔️✔️Show Tests
    CreateCodeSigningConfig✔️community✔️✔️✔️Show Tests
    CreateEventSourceMapping✔️community✔️✔️✔️Show Tests
    CreateFunction✔️community✔️✔️✔️Show Tests
    CreateFunctionUrlConfig✔️community✔️✔️✔️Show Tests
    DeleteAlias✔️community✔️✔️✔️Show Tests
    DeleteCodeSigningConfig✔️community✔️✔️✔️Show Tests
    DeleteEventSourceMapping✔️community✔️✔️✔️Show Tests
    DeleteFunction✔️community✔️✔️✔️Show Tests
    DeleteFunctionCodeSigningConfig✔️community✔️✔️✔️Show Tests
    DeleteFunctionConcurrency✔️community✔️✔️✔️Show Tests
    DeleteFunctionEventInvokeConfig✔️community✔️✔️✔️Show Tests
    DeleteFunctionUrlConfig✔️community✔️✔️✔️Show Tests
    DeleteLayerVersion✔️community✔️✔️✔️Show Tests
    DeleteProvisionedConcurrencyConfig✔️community✔️✔️✔️Show Tests
    GetAccountSettings✔️community✔️✔️✔️Show Tests
    GetAlias✔️community✔️✔️✔️Show Tests
    GetCodeSigningConfig✔️community✔️✔️✔️Show Tests
    GetEventSourceMapping✔️community✔️✔️✔️Show Tests
    GetFunction✔️community✔️✔️✔️Show Tests
    GetFunctionCodeSigningConfig✔️community✔️✔️✔️Show Tests
    GetFunctionConcurrency✔️community✔️✔️✔️Show Tests
    GetFunctionConfiguration✔️community✔️✔️✔️Show Tests
    GetFunctionEventInvokeConfig✔️community✔️✔️✔️Show Tests
    GetFunctionUrlConfig✔️community✔️✔️✔️Show Tests
    GetLayerVersion✔️community✔️✔️✔️Show Tests
    GetLayerVersionByArn✔️community✔️✔️✔️Show Tests
    GetLayerVersionPolicy✔️community✔️✔️✔️Show Tests
    GetPolicy✔️community✔️✔️✔️Show Tests
    GetProvisionedConcurrencyConfig✔️community✔️✔️✔️Show Tests
    GetRuntimeManagementConfig
    Invoke✔️community✔️✔️✔️Show Tests
    InvokeAsync
    InvokeWithResponseStream
    ListAliases✔️community✔️✔️✔️Show Tests
    ListCodeSigningConfigs✔️community✔️✔️✔️Show Tests
    ListEventSourceMappings✔️community✔️✔️✔️Show Tests
    ListFunctionEventInvokeConfigs✔️community✔️✔️✔️Show Tests
    ListFunctionUrlConfigs✔️community✔️✔️✔️Show Tests
    ListFunctions✔️community✔️✔️✔️Show Tests
    ListFunctionsByCodeSigningConfig✔️community✔️✔️✔️Show Tests
    ListLayerVersions✔️community✔️✔️✔️Show Tests
    ListLayers✔️community✔️✔️✔️Show Tests
    ListProvisionedConcurrencyConfigs✔️community✔️✔️✔️Show Tests
    ListTags✔️community✔️✔️✔️Show Tests
    ListVersionsByFunction✔️community✔️✔️✔️Show Tests
    PublishLayerVersion✔️community✔️✔️✔️Show Tests
    PublishVersion✔️community✔️✔️✔️Show Tests
    PutFunctionCodeSigningConfig✔️community✔️✔️✔️Show Tests
    PutFunctionConcurrency✔️community✔️✔️✔️Show Tests
    PutFunctionEventInvokeConfig✔️community✔️✔️✔️Show Tests
    PutProvisionedConcurrencyConfig✔️community✔️✔️✔️Show Tests
    PutRuntimeManagementConfig
    RemoveLayerVersionPermission✔️community✔️✔️✔️Show Tests
    RemovePermission✔️community✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️Show Tests
    UpdateAlias✔️community✔️✔️✔️Show Tests
    UpdateCodeSigningConfig✔️community✔️✔️✔️Show Tests
    UpdateEventSourceMapping✔️community✔️✔️✔️Show Tests
    UpdateFunctionCode✔️community✔️✔️✔️Show Tests
    UpdateFunctionConfiguration✔️community✔️✔️✔️Show Tests
    UpdateFunctionEventInvokeConfig✔️community✔️✔️✔️Show Tests
    UpdateFunctionUrlConfig✔️community✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddLayerVersionPermission

    Parameters: Action, LayerName, Principal, RevisionId, StatementId, VersionNumber

    • CloudWatch Logs

    Implementation details for API logs

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    CloudWatch Logs

    Implementation details for API logs

    Coverage Overview

    CloudWatch Logs is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateKmsKey
    CancelExportTask
    CreateDelivery
    CreateExportTask✔️community
    CreateLogAnomalyDetector
    CreateLogGroup✔️community✔️✔️✔️✔️Show Tests
    CreateLogStream✔️community✔️✔️✔️✔️Show Tests
    DeleteAccountPolicy
    DeleteDataProtectionPolicy
    DeleteDelivery
    DeleteDeliveryDestination
    DeleteDeliveryDestinationPolicy
    DeleteDeliverySource
    DeleteDestination✔️community✔️
    DeleteLogAnomalyDetector
    DeleteLogGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteLogStream✔️community✔️✔️✔️✔️Show Tests
    DeleteMetricFilter✔️community✔️
    DeleteQueryDefinition
    DeleteResourcePolicy✔️community✔️
    DeleteRetentionPolicy✔️community✔️
    DeleteSubscriptionFilter✔️community✔️✔️Show Tests
    DescribeAccountPolicies
    DescribeDeliveries
    DescribeDeliveryDestinations
    DescribeDeliverySources
    DescribeDestinations✔️community✔️
    DescribeExportTasks✔️community
    DescribeLogGroups✔️community✔️✔️✔️✔️Show Tests
    DescribeLogStreams✔️community✔️✔️✔️✔️Show Tests
    DescribeMetricFilters✔️community✔️
    DescribeQueries✔️community
    DescribeQueryDefinitions
    DescribeResourcePolicies✔️community✔️✔️✔️✔️Show Tests
    DescribeSubscriptionFilters✔️community✔️✔️✔️✔️Show Tests
    DisassociateKmsKey
    FilterLogEvents✔️community✔️✔️✔️✔️Show Tests
    GetDataProtectionPolicy
    GetDelivery
    GetDeliveryDestination
    GetDeliveryDestinationPolicy
    GetDeliverySource
    GetLogAnomalyDetector
    GetLogEvents✔️community✔️✔️✔️✔️Show Tests
    GetLogGroupFields
    GetLogRecord
    GetQueryResults✔️community
    ListAnomalies
    ListLogAnomalyDetectors
    ListTagsForResource✔️community✔️✔️✔️Show Tests
    ListTagsLogGroup✔️community✔️✔️✔️✔️Show Tests
    PutAccountPolicy
    PutDataProtectionPolicy
    PutDeliveryDestination
    PutDeliveryDestinationPolicy
    PutDeliverySource
    PutDestination✔️community✔️
    PutDestinationPolicy✔️community✔️
    PutLogEvents✔️community✔️✔️✔️✔️Show Tests
    PutMetricFilter✔️community✔️
    PutQueryDefinition
    PutResourcePolicy✔️community✔️✔️✔️Show Tests
    PutRetentionPolicy✔️community✔️
    PutSubscriptionFilter✔️community✔️✔️✔️Show Tests
    StartLiveTail
    StartQuery✔️community
    StopQuery
    TagLogGroup✔️community✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️Show Tests
    TestMetricFilter
    UntagLogGroup✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️Show Tests
    UpdateAnomaly
    UpdateLogAnomalyDetector

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateLogGroup

    Parameters: logGroupName

    • managedblockchain

    Implementation details for API managedblockchain

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateAccessor
    CreateMember✔️pro✔️
    CreateNetwork✔️pro✔️
    CreateNode✔️pro
    CreateProposal✔️pro✔️
    DeleteAccessor
    DeleteMember✔️pro
    DeleteNode✔️pro
    GetAccessor
    GetMember✔️pro✔️
    GetNetwork✔️pro✔️
    GetNode✔️pro
    GetProposal✔️pro✔️
    ListAccessors
    ListInvitations✔️pro✔️
    ListMembers✔️pro✔️
    ListNetworks✔️pro✔️
    ListNodes✔️pro
    ListProposalVotes✔️pro✔️
    ListProposals✔️pro✔️
    ListTagsForResource
    RejectInvitation✔️pro
    TagResource
    UntagResource
    UpdateMember✔️pro✔️
    UpdateNode✔️pro
    VoteOnProposal✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    managedblockchain

    Implementation details for API managedblockchain

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateAccessor
    CreateMember✔️pro✔️
    CreateNetwork✔️pro✔️
    CreateNode✔️pro
    CreateProposal✔️pro✔️
    DeleteAccessor
    DeleteMember✔️pro
    DeleteNode✔️pro
    GetAccessor
    GetMember✔️pro✔️
    GetNetwork✔️pro✔️
    GetNode✔️pro
    GetProposal✔️pro✔️
    ListAccessors
    ListInvitations✔️pro✔️
    ListMembers✔️pro✔️
    ListNetworks✔️pro✔️
    ListNodes✔️pro
    ListProposalVotes✔️pro✔️
    ListProposals✔️pro✔️
    ListTagsForResource
    RejectInvitation✔️pro
    TagResource
    UntagResource
    UpdateMember✔️pro✔️
    UpdateNode✔️pro
    VoteOnProposal✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_mediastore-data/index.html b/references/coverage/coverage_mediastore-data/index.html index 59720e0903..f34380e6a9 100644 --- a/references/coverage/coverage_mediastore-data/index.html +++ b/references/coverage/coverage_mediastore-data/index.html @@ -155,10 +155,10 @@
  • +

    • Elemental MediaStore Data

    Implementation details for API mediastore-data

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Elemental MediaStore Data

    Implementation details for API mediastore-data

    Coverage Overview

    Elemental MediaStore Data is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DeleteObject✔️pro
    DescribeObject✔️pro
    GetObject✔️pro
    ListItems
    PutObject✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_mediastore/index.html b/references/coverage/coverage_mediastore/index.html index f226d7a6f7..d40a1526e4 100644 --- a/references/coverage/coverage_mediastore/index.html +++ b/references/coverage/coverage_mediastore/index.html @@ -155,10 +155,10 @@
  • +

    • Elemental MediaStore

    Implementation details for API mediastore

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Elemental MediaStore

    Implementation details for API mediastore

    Coverage Overview

    Elemental MediaStore is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateContainer✔️pro
    DeleteContainer✔️pro
    DeleteContainerPolicy
    DeleteCorsPolicy
    DeleteLifecyclePolicy
    DeleteMetricPolicy
    DescribeContainer✔️pro
    GetContainerPolicy
    GetCorsPolicy
    GetLifecyclePolicy
    GetMetricPolicy
    ListContainers✔️pro
    ListTagsForResource
    PutContainerPolicy
    PutCorsPolicy
    PutLifecyclePolicy
    PutMetricPolicy
    StartAccessLogging
    StopAccessLogging
    TagResource
    UntagResource

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_memorydb/index.html b/references/coverage/coverage_memorydb/index.html index 3affb2a58a..1507e921c8 100644 --- a/references/coverage/coverage_memorydb/index.html +++ b/references/coverage/coverage_memorydb/index.html @@ -155,10 +155,10 @@
  • +

    • MemoryDB for Redis

    Implementation details for API memorydb

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    MemoryDB for Redis

    Implementation details for API memorydb

    Coverage Overview

    MemoryDB for Redis is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchUpdateCluster
    CopySnapshot
    CreateACL✔️pro
    CreateCluster✔️pro
    CreateParameterGroup
    CreateSnapshot
    CreateSubnetGroup✔️pro
    CreateUser
    DeleteACL✔️pro
    DeleteCluster✔️pro
    DeleteParameterGroup
    DeleteSnapshot
    DeleteSubnetGroup✔️pro
    DeleteUser
    DescribeACLs✔️pro
    DescribeClusters✔️pro
    DescribeEngineVersions
    DescribeEvents
    DescribeParameterGroups
    DescribeParameters
    DescribeReservedNodes
    DescribeReservedNodesOfferings
    DescribeServiceUpdates
    DescribeSnapshots
    DescribeSubnetGroups✔️pro
    DescribeUsers
    FailoverShard
    ListAllowedNodeTypeUpdates
    ListTags
    PurchaseReservedNodesOffering
    ResetParameterGroup
    TagResource
    UntagResource
    UpdateACL✔️pro
    UpdateCluster✔️pro
    UpdateParameterGroup
    UpdateSubnetGroup✔️pro
    UpdateUser

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_mq/index.html b/references/coverage/coverage_mq/index.html index 2e8a7844b1..b386545360 100644 --- a/references/coverage/coverage_mq/index.html +++ b/references/coverage/coverage_mq/index.html @@ -155,10 +155,10 @@
  • +

    • Amazon MQ

    Implementation details for API mq

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Amazon MQ

    Implementation details for API mq

    Coverage Overview

    Amazon MQ is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateBroker✔️pro
    CreateConfiguration✔️pro✔️
    CreateTags✔️pro
    CreateUser
    DeleteBroker✔️pro
    DeleteTags✔️pro
    DeleteUser
    DescribeBroker✔️pro
    DescribeBrokerEngineTypes✔️pro
    DescribeBrokerInstanceOptions
    DescribeConfiguration✔️pro
    DescribeConfigurationRevision
    DescribeUser
    ListBrokers✔️pro✔️
    ListConfigurationRevisions
    ListConfigurations✔️pro✔️
    ListTags✔️pro
    ListUsers
    Promote
    RebootBroker
    UpdateBroker
    UpdateConfiguration
    UpdateUser

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_mwaa/index.html b/references/coverage/coverage_mwaa/index.html index 45bbdedf57..68e320d096 100644 --- a/references/coverage/coverage_mwaa/index.html +++ b/references/coverage/coverage_mwaa/index.html @@ -155,10 +155,10 @@
  • +

    • MWAA (Managed Workflows for Apache Airflow)

    Implementation details for API mwaa

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    MWAA (Managed Workflows for Apache Airflow)

    Implementation details for API mwaa

    Coverage Overview

    Managed Workflows for Apache Airflow (MWAA) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateCliToken
    CreateEnvironment✔️pro
    CreateWebLoginToken
    DeleteEnvironment✔️pro
    GetEnvironment✔️pro
    ListEnvironments✔️pro
    ListTagsForResource✔️pro
    PublishMetrics
    TagResource✔️pro
    UntagResource✔️pro
    UpdateEnvironment✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_neptune/index.html b/references/coverage/coverage_neptune/index.html index 97deea7cc4..ef762bde3c 100644 --- a/references/coverage/coverage_neptune/index.html +++ b/references/coverage/coverage_neptune/index.html @@ -155,10 +155,10 @@
  • +

    • Neptune

    Implementation details for API neptune

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Neptune

    Implementation details for API neptune

    Coverage Overview

    Neptune is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddRoleToDBCluster✔️pro
    AddSourceIdentifierToSubscription
    AddTagsToResource✔️pro✔️
    ApplyPendingMaintenanceAction
    CopyDBClusterParameterGroup
    CopyDBClusterSnapshot✔️pro✔️
    CopyDBParameterGroup✔️pro
    CreateDBCluster✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterEndpoint✔️pro
    CreateDBClusterParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterSnapshot✔️pro
    CreateDBInstance✔️pro✔️✔️✔️✔️Show Tests
    CreateDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateEventSubscription✔️pro✔️
    CreateGlobalCluster✔️pro
    DeleteDBCluster✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBClusterEndpoint✔️pro
    DeleteDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    DeleteDBClusterSnapshot✔️pro
    DeleteDBInstance✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteEventSubscription✔️pro✔️
    DeleteGlobalCluster✔️pro
    DescribeDBClusterEndpoints✔️pro
    DescribeDBClusterParameterGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBClusterParameters✔️pro✔️✔️✔️Show Tests
    DescribeDBClusterSnapshotAttributes✔️pro
    DescribeDBClusterSnapshots✔️pro
    DescribeDBClusters✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBEngineVersions✔️pro
    DescribeDBInstances✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBParameterGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBParameters✔️pro✔️
    DescribeDBSubnetGroups✔️pro✔️
    DescribeEngineDefaultClusterParameters
    DescribeEngineDefaultParameters
    DescribeEventCategories
    DescribeEventSubscriptions✔️pro✔️
    DescribeEvents
    DescribeGlobalClusters✔️pro
    DescribeOrderableDBInstanceOptions✔️pro
    DescribePendingMaintenanceActions
    DescribeValidDBInstanceModifications
    FailoverDBCluster
    FailoverGlobalCluster✔️pro
    ListTagsForResource✔️pro✔️
    ModifyDBCluster✔️pro✔️
    ModifyDBClusterEndpoint✔️pro
    ModifyDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    ModifyDBClusterSnapshotAttribute✔️pro
    ModifyDBInstance✔️pro✔️
    ModifyDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    ModifyDBSubnetGroup✔️pro✔️
    ModifyEventSubscription
    ModifyGlobalCluster✔️pro
    PromoteReadReplicaDBCluster✔️pro
    RebootDBInstance✔️pro✔️✔️Show Tests
    RemoveFromGlobalCluster✔️pro
    RemoveRoleFromDBCluster✔️pro
    RemoveSourceIdentifierFromSubscription
    RemoveTagsFromResource✔️pro✔️
    ResetDBClusterParameterGroup✔️pro
    ResetDBParameterGroup
    RestoreDBClusterFromSnapshot✔️pro
    RestoreDBClusterToPointInTime
    StartDBCluster✔️pro✔️
    StopDBCluster✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDBCluster

    Parameters: CopyTagsToSnapshot, DBClusterIdentifier, DBClusterParameterGroupName, DBSubnetGroupName, DatabaseName, Engine, EngineVersion, MasterUserPassword, MasterUsername, Port, ServerlessV2ScalingConfiguration, VpcSecurityGroupIds

    • OpenSearch

    Implementation details for API opensearch

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    OpenSearch

    Implementation details for API opensearch

    Coverage Overview

    OpenSearch is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptInboundConnection
    AddDataSource
    AddTags✔️community✔️✔️✔️Show Tests
    AssociatePackage
    AuthorizeVpcEndpointAccess
    CancelDomainConfigChange
    CancelServiceSoftwareUpdate
    CreateDomain✔️community✔️✔️✔️✔️Show Tests
    CreateOutboundConnection
    CreatePackage
    CreateVpcEndpoint
    DeleteDataSource
    DeleteDomain✔️community✔️✔️✔️✔️Show Tests
    DeleteInboundConnection
    DeleteOutboundConnection
    DeletePackage
    DeleteVpcEndpoint
    DescribeDomain✔️community✔️✔️✔️✔️Show Tests
    DescribeDomainAutoTunes
    DescribeDomainChangeProgress
    DescribeDomainConfig✔️community✔️✔️✔️Show Tests
    DescribeDomainHealth
    DescribeDomainNodes
    DescribeDomains✔️community✔️✔️✔️Show Tests
    DescribeDryRunProgress
    DescribeInboundConnections
    DescribeInstanceTypeLimits
    DescribeOutboundConnections
    DescribePackages
    DescribeReservedInstanceOfferings
    DescribeReservedInstances
    DescribeVpcEndpoints
    DissociatePackage
    GetCompatibleVersions✔️community✔️✔️✔️✔️Show Tests
    GetDataSource
    GetDomainMaintenanceStatus
    GetPackageVersionHistory
    GetUpgradeHistory
    GetUpgradeStatus
    ListDataSources
    ListDomainMaintenances
    ListDomainNames✔️community✔️✔️✔️✔️Show Tests
    ListDomainsForPackage
    ListInstanceTypeDetails
    ListPackagesForDomain
    ListScheduledActions
    ListTags✔️community✔️✔️✔️Show Tests
    ListVersions✔️community✔️✔️✔️Show Tests
    ListVpcEndpointAccess
    ListVpcEndpoints
    ListVpcEndpointsForDomain
    PurchaseReservedInstanceOffering
    RejectInboundConnection
    RemoveTags✔️community✔️✔️✔️Show Tests
    RevokeVpcEndpointAccess
    StartDomainMaintenance
    StartServiceSoftwareUpdate
    UpdateDataSource
    UpdateDomainConfig✔️community✔️Show Tests
    UpdatePackage
    UpdateScheduledAction
    UpdateVpcEndpoint
    UpgradeDomain

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTags

    Parameters: ARN, TagList

    • Organizations

    Implementation details for API organizations

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Organizations

    Implementation details for API organizations

    Coverage Overview

    Organizations is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptHandshake
    AttachPolicy✔️pro✔️
    CancelHandshake
    CloseAccount✔️pro✔️
    CreateAccount✔️pro✔️
    CreateGovCloudAccount
    CreateOrganization✔️pro✔️
    CreateOrganizationalUnit✔️pro✔️
    CreatePolicy✔️pro✔️
    DeclineHandshake
    DeleteOrganization✔️pro✔️
    DeleteOrganizationalUnit✔️pro✔️
    DeletePolicy✔️pro✔️
    DeleteResourcePolicy
    DeregisterDelegatedAdministrator✔️pro✔️
    DescribeAccount✔️pro✔️
    DescribeCreateAccountStatus✔️pro✔️
    DescribeEffectivePolicy
    DescribeHandshake
    DescribeOrganization✔️pro✔️
    DescribeOrganizationalUnit✔️pro✔️
    DescribePolicy✔️pro✔️
    DescribeResourcePolicy
    DetachPolicy✔️pro✔️
    DisableAWSServiceAccess✔️pro✔️
    DisablePolicyType✔️pro✔️
    EnableAWSServiceAccess✔️pro✔️
    EnableAllFeatures
    EnablePolicyType✔️pro✔️
    InviteAccountToOrganization
    LeaveOrganization
    ListAWSServiceAccessForOrganization✔️pro✔️
    ListAccounts✔️pro✔️
    ListAccountsForParent✔️pro✔️
    ListChildren✔️pro✔️
    ListCreateAccountStatus✔️pro✔️
    ListDelegatedAdministrators✔️pro✔️
    ListDelegatedServicesForAccount✔️pro✔️
    ListHandshakesForAccount
    ListHandshakesForOrganization
    ListOrganizationalUnitsForParent✔️pro✔️
    ListParents✔️pro✔️
    ListPolicies✔️pro✔️
    ListPoliciesForTarget✔️pro✔️
    ListRoots✔️pro✔️
    ListTagsForResource✔️pro✔️
    ListTargetsForPolicy✔️pro✔️
    MoveAccount✔️pro✔️
    PutResourcePolicy
    RegisterDelegatedAdministrator✔️pro✔️
    RemoveAccountFromOrganization✔️pro✔️
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateOrganizationalUnit✔️pro✔️
    UpdatePolicy✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_pinpoint/index.html b/references/coverage/coverage_pinpoint/index.html index 3d7ae1e599..b0e217ea41 100644 --- a/references/coverage/coverage_pinpoint/index.html +++ b/references/coverage/coverage_pinpoint/index.html @@ -155,10 +155,10 @@
  • +

    • pinpoint

    Implementation details for API pinpoint

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApp✔️pro✔️
    CreateCampaign
    CreateEmailTemplate
    CreateExportJob
    CreateImportJob
    CreateInAppTemplate
    CreateJourney
    CreatePushTemplate
    CreateRecommenderConfiguration
    CreateSegment
    CreateSmsTemplate
    CreateVoiceTemplate
    DeleteAdmChannel
    DeleteApnsChannel
    DeleteApnsSandboxChannel
    DeleteApnsVoipChannel
    DeleteApnsVoipSandboxChannel
    DeleteApp✔️pro✔️
    DeleteBaiduChannel
    DeleteCampaign
    DeleteEmailChannel
    DeleteEmailTemplate
    DeleteEndpoint
    DeleteEventStream✔️pro✔️
    DeleteGcmChannel
    DeleteInAppTemplate
    DeleteJourney
    DeletePushTemplate
    DeleteRecommenderConfiguration
    DeleteSegment
    DeleteSmsChannel
    DeleteSmsTemplate
    DeleteUserEndpoints
    DeleteVoiceChannel
    DeleteVoiceTemplate
    GetAdmChannel
    GetApnsChannel
    GetApnsSandboxChannel
    GetApnsVoipChannel
    GetApnsVoipSandboxChannel
    GetApp✔️pro✔️
    GetApplicationDateRangeKpi
    GetApplicationSettings✔️pro✔️
    GetApps✔️pro✔️
    GetBaiduChannel
    GetCampaign
    GetCampaignActivities
    GetCampaignDateRangeKpi
    GetCampaignVersion
    GetCampaignVersions
    GetCampaigns
    GetChannels
    GetEmailChannel
    GetEmailTemplate
    GetEndpoint
    GetEventStream✔️pro✔️
    GetExportJob
    GetExportJobs
    GetGcmChannel
    GetImportJob
    GetImportJobs
    GetInAppMessages
    GetInAppTemplate
    GetJourney
    GetJourneyDateRangeKpi
    GetJourneyExecutionActivityMetrics
    GetJourneyExecutionMetrics
    GetJourneyRunExecutionActivityMetrics
    GetJourneyRunExecutionMetrics
    GetJourneyRuns
    GetPushTemplate
    GetRecommenderConfiguration
    GetRecommenderConfigurations
    GetSegment
    GetSegmentExportJobs
    GetSegmentImportJobs
    GetSegmentVersion
    GetSegmentVersions
    GetSegments
    GetSmsChannel
    GetSmsTemplate
    GetUserEndpoints
    GetVoiceChannel
    GetVoiceTemplate
    ListJourneys
    ListTagsForResource✔️pro✔️
    ListTemplateVersions
    ListTemplates
    PhoneNumberValidate
    PutEventStream✔️pro✔️
    PutEvents
    RemoveAttributes
    SendMessages
    SendOTPMessage
    SendUsersMessages
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateAdmChannel
    UpdateApnsChannel
    UpdateApnsSandboxChannel
    UpdateApnsVoipChannel
    UpdateApnsVoipSandboxChannel
    UpdateApplicationSettings✔️pro✔️
    UpdateBaiduChannel
    UpdateCampaign
    UpdateEmailChannel
    UpdateEmailTemplate
    UpdateEndpoint
    UpdateEndpointsBatch
    UpdateGcmChannel
    UpdateInAppTemplate
    UpdateJourney
    UpdateJourneyState
    UpdatePushTemplate
    UpdateRecommenderConfiguration
    UpdateSegment
    UpdateSmsChannel
    UpdateSmsTemplate
    UpdateTemplateActiveVersion
    UpdateVoiceChannel
    UpdateVoiceTemplate
    VerifyOTPMessage

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    pinpoint

    Implementation details for API pinpoint

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApp✔️pro✔️
    CreateCampaign
    CreateEmailTemplate
    CreateExportJob
    CreateImportJob
    CreateInAppTemplate
    CreateJourney
    CreatePushTemplate
    CreateRecommenderConfiguration
    CreateSegment
    CreateSmsTemplate
    CreateVoiceTemplate
    DeleteAdmChannel
    DeleteApnsChannel
    DeleteApnsSandboxChannel
    DeleteApnsVoipChannel
    DeleteApnsVoipSandboxChannel
    DeleteApp✔️pro✔️
    DeleteBaiduChannel
    DeleteCampaign
    DeleteEmailChannel
    DeleteEmailTemplate
    DeleteEndpoint
    DeleteEventStream✔️pro✔️
    DeleteGcmChannel
    DeleteInAppTemplate
    DeleteJourney
    DeletePushTemplate
    DeleteRecommenderConfiguration
    DeleteSegment
    DeleteSmsChannel
    DeleteSmsTemplate
    DeleteUserEndpoints
    DeleteVoiceChannel
    DeleteVoiceTemplate
    GetAdmChannel
    GetApnsChannel
    GetApnsSandboxChannel
    GetApnsVoipChannel
    GetApnsVoipSandboxChannel
    GetApp✔️pro✔️
    GetApplicationDateRangeKpi
    GetApplicationSettings✔️pro✔️
    GetApps✔️pro✔️
    GetBaiduChannel
    GetCampaign
    GetCampaignActivities
    GetCampaignDateRangeKpi
    GetCampaignVersion
    GetCampaignVersions
    GetCampaigns
    GetChannels
    GetEmailChannel
    GetEmailTemplate
    GetEndpoint
    GetEventStream✔️pro✔️
    GetExportJob
    GetExportJobs
    GetGcmChannel
    GetImportJob
    GetImportJobs
    GetInAppMessages
    GetInAppTemplate
    GetJourney
    GetJourneyDateRangeKpi
    GetJourneyExecutionActivityMetrics
    GetJourneyExecutionMetrics
    GetJourneyRunExecutionActivityMetrics
    GetJourneyRunExecutionMetrics
    GetJourneyRuns
    GetPushTemplate
    GetRecommenderConfiguration
    GetRecommenderConfigurations
    GetSegment
    GetSegmentExportJobs
    GetSegmentImportJobs
    GetSegmentVersion
    GetSegmentVersions
    GetSegments
    GetSmsChannel
    GetSmsTemplate
    GetUserEndpoints
    GetVoiceChannel
    GetVoiceTemplate
    ListJourneys
    ListTagsForResource✔️pro✔️
    ListTemplateVersions
    ListTemplates
    PhoneNumberValidate
    PutEventStream✔️pro✔️
    PutEvents
    RemoveAttributes
    SendMessages
    SendOTPMessage
    SendUsersMessages
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateAdmChannel
    UpdateApnsChannel
    UpdateApnsSandboxChannel
    UpdateApnsVoipChannel
    UpdateApnsVoipSandboxChannel
    UpdateApplicationSettings✔️pro✔️
    UpdateBaiduChannel
    UpdateCampaign
    UpdateEmailChannel
    UpdateEmailTemplate
    UpdateEndpoint
    UpdateEndpointsBatch
    UpdateGcmChannel
    UpdateInAppTemplate
    UpdateJourney
    UpdateJourneyState
    UpdatePushTemplate
    UpdateRecommenderConfiguration
    UpdateSegment
    UpdateSmsChannel
    UpdateSmsTemplate
    UpdateTemplateActiveVersion
    UpdateVoiceChannel
    UpdateVoiceTemplate
    VerifyOTPMessage

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_pipes/index.html b/references/coverage/coverage_pipes/index.html index c1f6a64e0a..e8688a82fd 100644 --- a/references/coverage/coverage_pipes/index.html +++ b/references/coverage/coverage_pipes/index.html @@ -155,10 +155,10 @@
  • +

    • Pipes (EventBridge Pipes)

    Implementation details for API pipes

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Pipes (EventBridge Pipes)

    Implementation details for API pipes

    Coverage Overview

    EventBridge Pipes (Pipes) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreatePipe✔️pro✔️✔️✔️Show Tests
    DeletePipe✔️pro✔️✔️✔️Show Tests
    DescribePipe✔️pro✔️✔️✔️Show Tests
    ListPipes✔️pro
    ListTagsForResource
    StartPipe
    StopPipe
    TagResource
    UntagResource
    UpdatePipe

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreatePipe

    Parameters: Name, RoleArn, Source, Target

    • QLDB Session (Quantum Ledger Database Session)

    Implementation details for API qldb-session

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    QLDB Session (Quantum Ledger Database Session)

    Implementation details for API qldb-session

    Coverage Overview

    Quantum Ledger Database Session (QLDB Session) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    SendCommand✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_qldb/index.html b/references/coverage/coverage_qldb/index.html index ce551d9f33..1e88fcc8ce 100644 --- a/references/coverage/coverage_qldb/index.html +++ b/references/coverage/coverage_qldb/index.html @@ -155,10 +155,10 @@
  • +

    • QLDB (Quantum Ledger Database)

    Implementation details for API qldb

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    QLDB (Quantum Ledger Database)

    Implementation details for API qldb

    Coverage Overview

    Quantum Ledger Database (QLDB) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelJournalKinesisStream
    CreateLedger✔️pro✔️✔️✔️Show Tests
    DeleteLedger✔️pro✔️✔️✔️Show Tests
    DescribeJournalKinesisStream✔️pro
    DescribeJournalS3Export✔️pro
    DescribeLedger✔️pro✔️✔️✔️Show Tests
    ExportJournalToS3✔️pro
    GetBlock
    GetDigest
    GetRevision
    ListJournalKinesisStreamsForLedger
    ListJournalS3Exports
    ListJournalS3ExportsForLedger
    ListLedgers✔️pro
    ListTagsForResource✔️pro
    StreamJournalToKinesis✔️pro
    TagResource✔️pro
    UntagResource✔️pro
    UpdateLedger✔️pro
    UpdateLedgerPermissionsMode

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateLedger

    Parameters: DeletionProtection, Name, PermissionsMode

    • ram (Resource Access Manager)

    Implementation details for API ram

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    ram (Resource Access Manager)

    Implementation details for API ram

    Coverage Overview

    Resource Access Manager (ram) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptResourceShareInvitation
    AssociateResourceShare
    AssociateResourceSharePermission
    CreatePermission✔️pro
    CreatePermissionVersion
    CreateResourceShare✔️pro✔️
    DeletePermission✔️pro
    DeletePermissionVersion
    DeleteResourceShare✔️pro✔️
    DisassociateResourceShare
    DisassociateResourceSharePermission
    EnableSharingWithAwsOrganization✔️pro✔️
    GetPermission✔️pro
    GetResourcePolicies
    GetResourceShareAssociations
    GetResourceShareInvitations
    GetResourceShares✔️pro✔️
    ListPendingInvitationResources
    ListPermissionAssociations
    ListPermissionVersions
    ListPermissions✔️pro
    ListPrincipals
    ListReplacePermissionAssociationsWork
    ListResourceSharePermissions✔️pro
    ListResourceTypes✔️pro
    ListResources✔️pro
    PromotePermissionCreatedFromPolicy
    PromoteResourceShareCreatedFromPolicy
    RejectResourceShareInvitation
    ReplacePermissionAssociations
    SetDefaultPermissionVersion
    TagResource
    UntagResource
    UpdateResourceShare✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_rds-data/index.html b/references/coverage/coverage_rds-data/index.html index 2cc143f077..2a6a9a328d 100644 --- a/references/coverage/coverage_rds-data/index.html +++ b/references/coverage/coverage_rds-data/index.html @@ -155,10 +155,10 @@
  • +

    • RDS data (Relational Database Service Data)

    Implementation details for API rds-data

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    RDS data (Relational Database Service Data)

    Implementation details for API rds-data

    Coverage Overview

    Relational Database Service Data (RDS data) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchExecuteStatement✔️pro
    BeginTransaction✔️pro
    CommitTransaction✔️pro
    ExecuteSql✔️pro
    ExecuteStatement✔️pro✔️✔️✔️Show Tests
    RollbackTransaction✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    ExecuteStatement

    Parameters: database, includeResultMetadata, parameters, resourceArn, secretArn, sql

    • RDS (Relational Database Service)

    Implementation details for API rds

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    RDS (Relational Database Service)

    Implementation details for API rds

    Coverage Overview

    Relational Database Service (RDS) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddRoleToDBCluster✔️pro
    AddRoleToDBInstance✔️pro
    AddSourceIdentifierToSubscription
    AddTagsToResource✔️pro✔️
    ApplyPendingMaintenanceAction
    AuthorizeDBSecurityGroupIngress✔️pro✔️
    BacktrackDBCluster
    CancelExportTask✔️pro✔️
    CopyDBClusterParameterGroup
    CopyDBClusterSnapshot✔️pro✔️
    CopyDBParameterGroup✔️pro
    CopyDBSnapshot✔️pro✔️
    CopyOptionGroup✔️pro
    CreateBlueGreenDeployment
    CreateCustomDBEngineVersion
    CreateDBCluster✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterEndpoint✔️pro
    CreateDBClusterParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateDBClusterSnapshot✔️pro
    CreateDBInstance✔️pro✔️✔️✔️✔️Show Tests
    CreateDBInstanceReadReplica✔️pro✔️
    CreateDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateDBProxy✔️pro✔️✔️Show Tests
    CreateDBProxyEndpoint
    CreateDBSecurityGroup✔️pro✔️
    CreateDBShardGroup
    CreateDBSnapshot✔️pro✔️
    CreateDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    CreateEventSubscription✔️pro✔️
    CreateGlobalCluster✔️pro
    CreateIntegration
    CreateOptionGroup✔️pro✔️
    CreateTenantDatabase
    DeleteBlueGreenDeployment
    DeleteCustomDBEngineVersion
    DeleteDBCluster✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBClusterAutomatedBackup
    DeleteDBClusterEndpoint✔️pro
    DeleteDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    DeleteDBClusterSnapshot✔️pro
    DeleteDBInstance✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBInstanceAutomatedBackup
    DeleteDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteDBProxy✔️pro✔️Show Tests
    DeleteDBProxyEndpoint
    DeleteDBSecurityGroup✔️pro✔️
    DeleteDBShardGroup
    DeleteDBSnapshot✔️pro✔️
    DeleteDBSubnetGroup✔️pro✔️✔️✔️✔️Show Tests
    DeleteEventSubscription✔️pro✔️
    DeleteGlobalCluster✔️pro
    DeleteIntegration
    DeleteOptionGroup✔️pro✔️
    DeleteTenantDatabase
    DeregisterDBProxyTargets✔️pro✔️Show Tests
    DescribeAccountAttributes
    DescribeBlueGreenDeployments
    DescribeCertificates✔️pro
    DescribeDBClusterAutomatedBackups
    DescribeDBClusterBacktracks
    DescribeDBClusterEndpoints✔️pro
    DescribeDBClusterParameterGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBClusterParameters✔️pro✔️✔️✔️Show Tests
    DescribeDBClusterSnapshotAttributes✔️pro
    DescribeDBClusterSnapshots✔️pro
    DescribeDBClusters✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBEngineVersions✔️pro
    DescribeDBInstanceAutomatedBackups
    DescribeDBInstances✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBLogFiles
    DescribeDBParameterGroups✔️pro✔️✔️✔️✔️Show Tests
    DescribeDBParameters✔️pro✔️
    DescribeDBProxies✔️pro✔️Show Tests
    DescribeDBProxyEndpoints
    DescribeDBProxyTargetGroups✔️pro
    DescribeDBProxyTargets✔️pro✔️Show Tests
    DescribeDBRecommendations
    DescribeDBSecurityGroups✔️pro✔️
    DescribeDBShardGroups
    DescribeDBSnapshotAttributes✔️pro✔️
    DescribeDBSnapshotTenantDatabases
    DescribeDBSnapshots✔️pro✔️
    DescribeDBSubnetGroups✔️pro✔️
    DescribeEngineDefaultClusterParameters
    DescribeEngineDefaultParameters
    DescribeEventCategories
    DescribeEventSubscriptions✔️pro✔️
    DescribeEvents
    DescribeExportTasks✔️pro✔️
    DescribeGlobalClusters✔️pro
    DescribeIntegrations
    DescribeOptionGroupOptions✔️pro✔️
    DescribeOptionGroups✔️pro✔️
    DescribeOrderableDBInstanceOptions✔️pro
    DescribePendingMaintenanceActions
    DescribeReservedDBInstances
    DescribeReservedDBInstancesOfferings
    DescribeSourceRegions
    DescribeTenantDatabases
    DescribeValidDBInstanceModifications
    DisableHttpEndpoint
    DownloadDBLogFilePortion
    EnableHttpEndpoint
    FailoverDBCluster
    FailoverGlobalCluster✔️pro
    ListTagsForResource✔️pro✔️
    ModifyActivityStream
    ModifyCertificates✔️pro
    ModifyCurrentDBClusterCapacity✔️pro
    ModifyCustomDBEngineVersion
    ModifyDBCluster✔️pro✔️
    ModifyDBClusterEndpoint✔️pro
    ModifyDBClusterParameterGroup✔️pro✔️✔️✔️Show Tests
    ModifyDBClusterSnapshotAttribute✔️pro
    ModifyDBInstance✔️pro✔️
    ModifyDBParameterGroup✔️pro✔️✔️✔️✔️Show Tests
    ModifyDBProxy
    ModifyDBProxyEndpoint
    ModifyDBProxyTargetGroup✔️pro✔️Show Tests
    ModifyDBRecommendation
    ModifyDBShardGroup
    ModifyDBSnapshot
    ModifyDBSnapshotAttribute✔️pro✔️
    ModifyDBSubnetGroup✔️pro✔️
    ModifyEventSubscription
    ModifyGlobalCluster✔️pro
    ModifyIntegration
    ModifyOptionGroup✔️pro✔️
    ModifyTenantDatabase
    PromoteReadReplica✔️pro✔️
    PromoteReadReplicaDBCluster✔️pro
    PurchaseReservedDBInstancesOffering
    RebootDBCluster
    RebootDBInstance✔️pro✔️✔️Show Tests
    RebootDBShardGroup
    RegisterDBProxyTargets✔️pro✔️Show Tests
    RemoveFromGlobalCluster✔️pro
    RemoveRoleFromDBCluster✔️pro
    RemoveRoleFromDBInstance✔️pro
    RemoveSourceIdentifierFromSubscription
    RemoveTagsFromResource✔️pro✔️
    ResetDBClusterParameterGroup✔️pro
    ResetDBParameterGroup
    RestoreDBClusterFromS3
    RestoreDBClusterFromSnapshot✔️pro
    RestoreDBClusterToPointInTime
    RestoreDBInstanceFromDBSnapshot✔️pro
    RestoreDBInstanceFromS3
    RestoreDBInstanceToPointInTime✔️pro
    RevokeDBSecurityGroupIngress
    StartActivityStream
    StartDBCluster✔️pro✔️
    StartDBInstance✔️pro✔️
    StartDBInstanceAutomatedBackupsReplication
    StartExportTask✔️pro✔️
    StopActivityStream
    StopDBCluster✔️pro✔️
    StopDBInstance✔️pro✔️
    StopDBInstanceAutomatedBackupsReplication
    SwitchoverBlueGreenDeployment
    SwitchoverGlobalCluster
    SwitchoverReadReplica

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDBCluster

    Parameters: CopyTagsToSnapshot, DBClusterIdentifier, DBClusterParameterGroupName, DBSubnetGroupName, DatabaseName, Engine, EngineVersion, MasterUserPassword, MasterUsername, Port, ServerlessV2ScalingConfiguration, VpcSecurityGroupIds

    • Redshift Data

    Implementation details for API redshift-data

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Redshift Data

    Implementation details for API redshift-data

    Coverage Overview

    Redshift Data is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchExecuteStatement
    CancelStatement
    DescribeStatement✔️pro✔️Show Tests
    DescribeTable✔️pro
    ExecuteStatement✔️pro✔️✔️✔️Show Tests
    GetStatementResult✔️pro✔️Show Tests
    ListDatabases✔️pro✔️Show Tests
    ListSchemas
    ListStatements
    ListTables✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DescribeStatement

    Parameters: Id

    • Redshift

    Implementation details for API redshift

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Redshift

    Implementation details for API redshift

    Coverage Overview

    Redshift is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AcceptReservedNodeExchange
    AddPartner
    AssociateDataShareConsumer
    AuthorizeClusterSecurityGroupIngress✔️community✔️✔️✔️Show Tests
    AuthorizeDataShare
    AuthorizeEndpointAccess
    AuthorizeSnapshotAccess
    BatchDeleteClusterSnapshots
    BatchModifyClusterSnapshots
    CancelResize
    CopyClusterSnapshot
    CreateAuthenticationProfile
    CreateCluster✔️community✔️✔️✔️✔️Show Tests
    CreateClusterParameterGroup✔️community✔️✔️✔️Show Tests
    CreateClusterSecurityGroup✔️community✔️✔️✔️✔️Show Tests
    CreateClusterSnapshot✔️community✔️
    CreateClusterSubnetGroup✔️community✔️✔️✔️✔️Show Tests
    CreateCustomDomainAssociation
    CreateEndpointAccess
    CreateEventSubscription
    CreateHsmClientCertificate
    CreateHsmConfiguration
    CreateRedshiftIdcApplication
    CreateScheduledAction
    CreateSnapshotCopyGrant✔️community✔️
    CreateSnapshotSchedule
    CreateTags✔️community
    CreateUsageLimit
    DeauthorizeDataShare
    DeleteAuthenticationProfile
    DeleteCluster✔️community✔️✔️✔️Show Tests
    DeleteClusterParameterGroup✔️community✔️✔️✔️Show Tests
    DeleteClusterSecurityGroup✔️community✔️
    DeleteClusterSnapshot✔️community
    DeleteClusterSubnetGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteCustomDomainAssociation
    DeleteEndpointAccess
    DeleteEventSubscription
    DeleteHsmClientCertificate
    DeleteHsmConfiguration
    DeletePartner
    DeleteRedshiftIdcApplication
    DeleteResourcePolicy
    DeleteScheduledAction
    DeleteSnapshotCopyGrant✔️community✔️
    DeleteSnapshotSchedule
    DeleteTags✔️community✔️
    DeleteUsageLimit
    DescribeAccountAttributes
    DescribeAuthenticationProfiles
    DescribeClusterDbRevisions
    DescribeClusterParameterGroups✔️community✔️
    DescribeClusterParameters✔️pro
    DescribeClusterSecurityGroups✔️community✔️✔️✔️✔️Show Tests
    DescribeClusterSnapshots✔️community✔️
    DescribeClusterSubnetGroups✔️community✔️
    DescribeClusterTracks
    DescribeClusterVersions
    DescribeClusters✔️community✔️✔️✔️✔️Show Tests
    DescribeCustomDomainAssociations
    DescribeDataShares
    DescribeDataSharesForConsumer
    DescribeDataSharesForProducer
    DescribeDefaultClusterParameters✔️pro
    DescribeEndpointAccess
    DescribeEndpointAuthorization
    DescribeEventCategories
    DescribeEventSubscriptions
    DescribeEvents
    DescribeHsmClientCertificates
    DescribeHsmConfigurations
    DescribeInboundIntegrations
    DescribeLoggingStatus✔️pro
    DescribeNodeConfigurationOptions
    DescribeOrderableClusterOptions
    DescribePartners
    DescribeRedshiftIdcApplications
    DescribeReservedNodeExchangeStatus
    DescribeReservedNodeOfferings
    DescribeReservedNodes
    DescribeResize
    DescribeScheduledActions
    DescribeSnapshotCopyGrants✔️community✔️
    DescribeSnapshotSchedules
    DescribeStorage
    DescribeTableRestoreStatus
    DescribeTags✔️community✔️
    DescribeUsageLimits
    DisableLogging
    DisableSnapshotCopy✔️community
    DisassociateDataShareConsumer
    EnableLogging
    EnableSnapshotCopy✔️community
    FailoverPrimaryCompute
    GetClusterCredentials✔️community✔️
    GetClusterCredentialsWithIAM
    GetReservedNodeExchangeConfigurationOptions
    GetReservedNodeExchangeOfferings
    GetResourcePolicy
    ListRecommendations
    ModifyAquaConfiguration
    ModifyAuthenticationProfile
    ModifyCluster✔️community
    ModifyClusterDbRevision
    ModifyClusterIamRoles
    ModifyClusterMaintenance
    ModifyClusterParameterGroup
    ModifyClusterSnapshot
    ModifyClusterSnapshotSchedule
    ModifyClusterSubnetGroup
    ModifyCustomDomainAssociation
    ModifyEndpointAccess
    ModifyEventSubscription
    ModifyRedshiftIdcApplication
    ModifyScheduledAction
    ModifySnapshotCopyRetentionPeriod✔️community
    ModifySnapshotSchedule
    ModifyUsageLimit
    PauseCluster✔️community✔️
    PurchaseReservedNodeOffering
    PutResourcePolicy
    RebootCluster
    RejectDataShare
    ResetClusterParameterGroup
    ResizeCluster
    RestoreFromClusterSnapshot✔️community✔️
    RestoreTableFromClusterSnapshot
    ResumeCluster✔️community✔️
    RevokeClusterSecurityGroupIngress
    RevokeEndpointAccess
    RevokeSnapshotAccess
    RotateEncryptionKey
    UpdatePartnerStatus

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AuthorizeClusterSecurityGroupIngress

    Parameters: CIDRIP, ClusterSecurityGroupName

    • Resource Groups

    Implementation details for API resource-groups

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Resource Groups

    Implementation details for API resource-groups

    Coverage Overview

    Resource Groups is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteGroup✔️community✔️✔️✔️✔️Show Tests
    GetAccountSettings
    GetGroup✔️community✔️✔️✔️✔️Show Tests
    GetGroupConfiguration✔️community✔️
    GetGroupQuery✔️community✔️
    GetTags✔️
    GroupResources
    ListGroupResources
    ListGroups✔️community✔️✔️✔️✔️Show Tests
    PutGroupConfiguration✔️community✔️
    SearchResources
    Tag✔️
    UngroupResources
    Untag✔️
    UpdateAccountSettings
    UpdateGroup✔️community✔️
    UpdateGroupQuery✔️community✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateGroup

    Parameters: Description, Name

    • Resource Groups Tagging API

    Implementation details for API resourcegroupstaggingapi

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Resource Groups Tagging API

    Implementation details for API resourcegroupstaggingapi

    Coverage Overview

    Resource Groups Tagging API is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    DescribeReportCreation
    GetComplianceSummary
    GetResources✔️community✔️✔️✔️✔️Show Tests
    GetTagKeys✔️community✔️
    GetTagValues✔️community✔️
    StartReportCreation
    TagResources✔️community✔️
    UntagResources

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    GetResources

    Parameters: TagFilters

    • Route 53

    Implementation details for API route53

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Route 53

    Implementation details for API route53

    Coverage Overview

    Route 53 is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    ActivateKeySigningKey
    AssociateVPCWithHostedZone✔️community✔️✔️✔️✔️Show Tests
    ChangeCidrCollection
    ChangeResourceRecordSets✔️community✔️✔️✔️✔️Show Tests
    ChangeTagsForResource✔️community✔️
    CreateCidrCollection
    CreateHealthCheck✔️community✔️✔️✔️✔️Show Tests
    CreateHostedZone✔️community✔️✔️✔️✔️Show Tests
    CreateKeySigningKey
    CreateQueryLoggingConfig✔️community✔️
    CreateReusableDelegationSet✔️community✔️✔️✔️✔️Show Tests
    CreateTrafficPolicy
    CreateTrafficPolicyInstance
    CreateTrafficPolicyVersion
    CreateVPCAssociationAuthorization
    DeactivateKeySigningKey
    DeleteCidrCollection
    DeleteHealthCheck✔️community✔️✔️✔️✔️Show Tests
    DeleteHostedZone✔️community✔️✔️✔️✔️Show Tests
    DeleteKeySigningKey
    DeleteQueryLoggingConfig✔️community✔️
    DeleteReusableDelegationSet✔️community✔️✔️✔️✔️Show Tests
    DeleteTrafficPolicy
    DeleteTrafficPolicyInstance
    DeleteVPCAssociationAuthorization
    DisableHostedZoneDNSSEC
    DisassociateVPCFromHostedZone✔️community✔️✔️✔️✔️Show Tests
    EnableHostedZoneDNSSEC
    GetAccountLimit
    GetChange✔️community✔️✔️✔️✔️Show Tests
    GetCheckerIpRanges
    GetDNSSEC✔️community✔️
    GetGeoLocation
    GetHealthCheck✔️community✔️✔️✔️Show Tests
    GetHealthCheckCount
    GetHealthCheckLastFailureReason
    GetHealthCheckStatus✔️community
    GetHostedZone✔️community✔️✔️✔️✔️Show Tests
    GetHostedZoneCount✔️community✔️
    GetHostedZoneLimit
    GetQueryLoggingConfig✔️community✔️
    GetReusableDelegationSet✔️community✔️✔️✔️✔️Show Tests
    GetReusableDelegationSetLimit
    GetTrafficPolicy
    GetTrafficPolicyInstance
    GetTrafficPolicyInstanceCount
    ListCidrBlocks
    ListCidrCollections
    ListCidrLocations
    ListGeoLocations
    ListHealthChecks✔️community✔️
    ListHostedZones✔️community✔️✔️✔️✔️Show Tests
    ListHostedZonesByName✔️community✔️✔️✔️✔️Show Tests
    ListHostedZonesByVPC✔️community✔️✔️✔️✔️Show Tests
    ListQueryLoggingConfigs✔️community✔️
    ListResourceRecordSets✔️community✔️✔️✔️✔️Show Tests
    ListReusableDelegationSets✔️community✔️✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️
    ListTagsForResources
    ListTrafficPolicies
    ListTrafficPolicyInstances
    ListTrafficPolicyInstancesByHostedZone
    ListTrafficPolicyInstancesByPolicy
    ListTrafficPolicyVersions
    ListVPCAssociationAuthorizations
    TestDNSAnswer
    UpdateHealthCheck✔️community
    UpdateHostedZoneComment✔️community✔️
    UpdateTrafficPolicyComment
    UpdateTrafficPolicyInstance

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AssociateVPCWithHostedZone

    Parameters: Comment, HostedZoneId, VPC

    • Route 53 Resolver

    Implementation details for API route53resolver

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Route 53 Resolver

    Implementation details for API route53resolver

    Coverage Overview

    Route 53 Resolver is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateFirewallRuleGroup✔️community
    AssociateResolverEndpointIpAddress✔️community✔️
    AssociateResolverQueryLogConfig✔️community
    AssociateResolverRule✔️community✔️✔️✔️✔️Show Tests
    CreateFirewallDomainList✔️community✔️✔️✔️Show Tests
    CreateFirewallRule✔️community
    CreateFirewallRuleGroup✔️community
    CreateOutpostResolver
    CreateResolverEndpoint✔️community✔️✔️✔️✔️Show Tests
    CreateResolverQueryLogConfig✔️community✔️✔️✔️Show Tests
    CreateResolverRule✔️community✔️✔️✔️✔️Show Tests
    DeleteFirewallDomainList✔️community✔️✔️✔️Show Tests
    DeleteFirewallRule✔️community
    DeleteFirewallRuleGroup✔️community
    DeleteOutpostResolver
    DeleteResolverEndpoint✔️community✔️✔️✔️✔️Show Tests
    DeleteResolverQueryLogConfig✔️community✔️✔️✔️Show Tests
    DeleteResolverRule✔️community✔️✔️✔️✔️Show Tests
    DisassociateFirewallRuleGroup✔️community
    DisassociateResolverEndpointIpAddress✔️community✔️
    DisassociateResolverQueryLogConfig✔️community
    DisassociateResolverRule✔️community✔️✔️✔️✔️Show Tests
    GetFirewallConfig✔️community
    GetFirewallDomainList✔️community
    GetFirewallRuleGroup✔️community
    GetFirewallRuleGroupAssociation✔️community
    GetFirewallRuleGroupPolicy
    GetOutpostResolver
    GetResolverConfig
    GetResolverDnssecConfig
    GetResolverEndpoint✔️community✔️✔️✔️✔️Show Tests
    GetResolverQueryLogConfig✔️community
    GetResolverQueryLogConfigAssociation✔️community
    GetResolverQueryLogConfigPolicy
    GetResolverRule✔️community✔️
    GetResolverRuleAssociation✔️community✔️✔️✔️✔️Show Tests
    GetResolverRulePolicy
    ImportFirewallDomains
    ListFirewallConfigs✔️community
    ListFirewallDomainLists✔️community✔️✔️✔️Show Tests
    ListFirewallDomains✔️community
    ListFirewallRuleGroupAssociations
    ListFirewallRuleGroups✔️community
    ListFirewallRules✔️community
    ListOutpostResolvers
    ListResolverConfigs
    ListResolverDnssecConfigs
    ListResolverEndpointIpAddresses✔️community✔️
    ListResolverEndpoints✔️community✔️✔️✔️✔️Show Tests
    ListResolverQueryLogConfigAssociations✔️community
    ListResolverQueryLogConfigs✔️community✔️✔️✔️Show Tests
    ListResolverRuleAssociations✔️community✔️✔️✔️✔️Show Tests
    ListResolverRules✔️community✔️
    ListTagsForResource✔️community✔️✔️✔️✔️Show Tests
    PutFirewallRuleGroupPolicy
    PutResolverQueryLogConfigPolicy
    PutResolverRulePolicy
    TagResource✔️community
    UntagResource✔️community✔️
    UpdateFirewallConfig✔️community
    UpdateFirewallDomains✔️community
    UpdateFirewallRule✔️community
    UpdateFirewallRuleGroupAssociation✔️community
    UpdateOutpostResolver
    UpdateResolverConfig
    UpdateResolverDnssecConfig
    UpdateResolverEndpoint✔️community✔️✔️✔️✔️Show Tests
    UpdateResolverRule

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AssociateResolverRule

    Parameters: Name, ResolverRuleId, VPCId

    • S3 (Simple Storage Service)

    Implementation details for API s3

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    S3 (Simple Storage Service)

    Implementation details for API s3

    Coverage Overview

    Simple Storage Service (S3) is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AbortMultipartUpload✔️community✔️✔️✔️✔️Show Tests
    CompleteMultipartUpload✔️community✔️✔️✔️✔️Show Tests
    CopyObject✔️community✔️✔️✔️✔️Show Tests
    CreateBucket✔️community✔️✔️✔️✔️Show Tests
    CreateMultipartUpload✔️community✔️✔️✔️✔️Show Tests
    CreateSession
    DeleteBucket✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketAnalyticsConfiguration✔️community✔️✔️✔️Show Tests
    DeleteBucketCors✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketEncryption✔️community✔️✔️✔️Show Tests
    DeleteBucketIntelligentTieringConfiguration✔️community✔️✔️✔️Show Tests
    DeleteBucketInventoryConfiguration✔️community✔️✔️✔️Show Tests
    DeleteBucketLifecycle✔️community✔️✔️✔️Show Tests
    DeleteBucketMetricsConfiguration
    DeleteBucketOwnershipControls✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketPolicy✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketReplication✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketTagging✔️community✔️✔️✔️✔️Show Tests
    DeleteBucketWebsite✔️community✔️✔️✔️Show Tests
    DeleteObject✔️community✔️✔️✔️✔️Show Tests
    DeleteObjectTagging✔️community✔️✔️✔️Show Tests
    DeleteObjects✔️community✔️✔️✔️✔️Show Tests
    DeletePublicAccessBlock✔️community✔️✔️✔️Show Tests
    GetBucketAccelerateConfiguration✔️community✔️✔️✔️Show Tests
    GetBucketAcl✔️community✔️✔️✔️✔️Show Tests
    GetBucketAnalyticsConfiguration✔️community✔️✔️✔️Show Tests
    GetBucketCors✔️community✔️✔️✔️✔️Show Tests
    GetBucketEncryption✔️community✔️✔️✔️Show Tests
    GetBucketIntelligentTieringConfiguration✔️community✔️✔️✔️Show Tests
    GetBucketInventoryConfiguration✔️community✔️✔️✔️Show Tests
    GetBucketLifecycle✔️community
    GetBucketLifecycleConfiguration✔️community✔️✔️✔️✔️Show Tests
    GetBucketLocation✔️community✔️✔️✔️✔️Show Tests
    GetBucketLogging✔️community✔️✔️✔️✔️Show Tests
    GetBucketMetricsConfiguration
    GetBucketNotification✔️community
    GetBucketNotificationConfiguration✔️community✔️✔️✔️Show Tests
    GetBucketOwnershipControls✔️community✔️✔️✔️✔️Show Tests
    GetBucketPolicy✔️community✔️✔️✔️✔️Show Tests
    GetBucketPolicyStatus
    GetBucketReplication✔️community✔️✔️✔️✔️Show Tests
    GetBucketRequestPayment✔️community✔️✔️✔️Show Tests
    GetBucketTagging✔️community✔️✔️✔️✔️Show Tests
    GetBucketVersioning✔️community✔️✔️✔️✔️Show Tests
    GetBucketWebsite✔️community✔️✔️✔️✔️Show Tests
    GetObject✔️community✔️✔️✔️✔️Show Tests
    GetObjectAcl✔️community✔️✔️✔️✔️Show Tests
    GetObjectAttributes✔️community✔️✔️✔️✔️Show Tests
    GetObjectLegalHold✔️community✔️✔️✔️Show Tests
    GetObjectLockConfiguration✔️community✔️✔️✔️✔️Show Tests
    GetObjectRetention✔️community✔️✔️✔️Show Tests
    GetObjectTagging✔️community✔️✔️✔️✔️Show Tests
    GetObjectTorrent
    GetPublicAccessBlock✔️community✔️✔️✔️Show Tests
    HeadBucket✔️community✔️✔️✔️✔️Show Tests
    HeadObject✔️community✔️✔️✔️✔️Show Tests
    ListBucketAnalyticsConfigurations✔️community✔️✔️✔️Show Tests
    ListBucketIntelligentTieringConfigurations✔️community✔️✔️✔️Show Tests
    ListBucketInventoryConfigurations✔️community✔️✔️✔️Show Tests
    ListBucketMetricsConfigurations
    ListBuckets✔️community✔️✔️✔️✔️Show Tests
    ListDirectoryBuckets✔️community
    ListMultipartUploads✔️community✔️✔️✔️✔️Show Tests
    ListObjectVersions✔️community✔️✔️✔️✔️Show Tests
    ListObjects✔️community✔️✔️✔️✔️Show Tests
    ListObjectsV2✔️community✔️✔️✔️✔️Show Tests
    ListParts✔️community✔️✔️✔️✔️Show Tests
    PutBucketAccelerateConfiguration✔️community✔️✔️✔️✔️Show Tests
    PutBucketAcl✔️community✔️✔️✔️✔️Show Tests
    PutBucketAnalyticsConfiguration✔️community✔️✔️✔️Show Tests
    PutBucketCors✔️community✔️✔️✔️✔️Show Tests
    PutBucketEncryption✔️community✔️✔️✔️✔️Show Tests
    PutBucketIntelligentTieringConfiguration✔️community✔️✔️✔️Show Tests
    PutBucketInventoryConfiguration✔️community✔️✔️✔️Show Tests
    PutBucketLifecycle✔️community
    PutBucketLifecycleConfiguration✔️community✔️✔️✔️✔️Show Tests
    PutBucketLogging✔️community✔️✔️✔️✔️Show Tests
    PutBucketMetricsConfiguration
    PutBucketNotification✔️community
    PutBucketNotificationConfiguration✔️community✔️✔️✔️Show Tests
    PutBucketOwnershipControls✔️community✔️✔️✔️✔️Show Tests
    PutBucketPolicy✔️community✔️✔️✔️✔️Show Tests
    PutBucketReplication✔️community✔️✔️✔️Show Tests
    PutBucketRequestPayment✔️community✔️✔️✔️Show Tests
    PutBucketTagging✔️community✔️✔️✔️✔️Show Tests
    PutBucketVersioning✔️community✔️✔️✔️✔️Show Tests
    PutBucketWebsite✔️community✔️✔️✔️✔️Show Tests
    PutObject✔️community✔️✔️✔️✔️Show Tests
    PutObjectAcl✔️community✔️✔️✔️✔️Show Tests
    PutObjectLegalHold✔️community✔️✔️✔️✔️Show Tests
    PutObjectLockConfiguration✔️community✔️✔️✔️✔️Show Tests
    PutObjectRetention✔️community✔️✔️✔️✔️Show Tests
    PutObjectTagging✔️community✔️✔️✔️✔️Show Tests
    PutPublicAccessBlock✔️community✔️✔️✔️Show Tests
    RestoreObject✔️community✔️✔️✔️✔️Show Tests
    SelectObjectContent✔️pro✔️✔️✔️✔️Show Tests
    UploadPart✔️community✔️✔️✔️✔️Show Tests
    UploadPartCopy✔️community✔️✔️✔️Show Tests
    WriteGetObjectResponse

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AbortMultipartUpload

    Parameters: Bucket, ExpectedBucketOwner, Key, RequestPayer, UploadId

    • S3 Control (Simple Storage Service Control)

    Implementation details for API s3control

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    S3 Control (Simple Storage Service Control)

    Implementation details for API s3control

    Coverage Overview

    Simple Storage Service Control (S3 Control) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateAccessGrantsIdentityCenter
    CreateAccessGrant
    CreateAccessGrantsInstance
    CreateAccessGrantsLocation
    CreateAccessPoint✔️community✔️
    CreateAccessPointForObjectLambda
    CreateBucket✔️community
    CreateJob
    CreateMultiRegionAccessPoint
    CreateStorageLensGroup
    DeleteAccessGrant
    DeleteAccessGrantsInstance
    DeleteAccessGrantsInstanceResourcePolicy
    DeleteAccessGrantsLocation
    DeleteAccessPoint✔️community✔️
    DeleteAccessPointForObjectLambda
    DeleteAccessPointPolicy✔️community✔️
    DeleteAccessPointPolicyForObjectLambda
    DeleteBucket
    DeleteBucketLifecycleConfiguration
    DeleteBucketPolicy
    DeleteBucketReplication
    DeleteBucketTagging
    DeleteJobTagging
    DeleteMultiRegionAccessPoint
    DeletePublicAccessBlock✔️community✔️✔️Show Tests
    DeleteStorageLensConfiguration
    DeleteStorageLensConfigurationTagging
    DeleteStorageLensGroup
    DescribeJob
    DescribeMultiRegionAccessPointOperation
    DissociateAccessGrantsIdentityCenter
    GetAccessGrant
    GetAccessGrantsInstance
    GetAccessGrantsInstanceForPrefix
    GetAccessGrantsInstanceResourcePolicy
    GetAccessGrantsLocation
    GetAccessPoint✔️community✔️
    GetAccessPointConfigurationForObjectLambda
    GetAccessPointForObjectLambda
    GetAccessPointPolicy✔️community✔️
    GetAccessPointPolicyForObjectLambda
    GetAccessPointPolicyStatus✔️community✔️
    GetAccessPointPolicyStatusForObjectLambda
    GetBucket
    GetBucketLifecycleConfiguration
    GetBucketPolicy
    GetBucketReplication
    GetBucketTagging
    GetBucketVersioning
    GetDataAccess
    GetJobTagging
    GetMultiRegionAccessPoint
    GetMultiRegionAccessPointPolicy
    GetMultiRegionAccessPointPolicyStatus
    GetMultiRegionAccessPointRoutes
    GetPublicAccessBlock✔️community✔️✔️Show Tests
    GetStorageLensConfiguration
    GetStorageLensConfigurationTagging
    GetStorageLensGroup
    ListAccessGrants
    ListAccessGrantsInstances
    ListAccessGrantsLocations
    ListAccessPoints
    ListAccessPointsForObjectLambda
    ListJobs
    ListMultiRegionAccessPoints
    ListRegionalBuckets✔️community
    ListStorageLensConfigurations
    ListStorageLensGroups
    ListTagsForResource
    PutAccessGrantsInstanceResourcePolicy
    PutAccessPointConfigurationForObjectLambda
    PutAccessPointPolicy✔️community✔️
    PutAccessPointPolicyForObjectLambda
    PutBucketLifecycleConfiguration
    PutBucketPolicy
    PutBucketReplication
    PutBucketTagging
    PutBucketVersioning
    PutJobTagging
    PutMultiRegionAccessPointPolicy
    PutPublicAccessBlock✔️community✔️✔️Show Tests
    PutStorageLensConfiguration
    PutStorageLensConfigurationTagging
    SubmitMultiRegionAccessPointRoutes
    TagResource
    UntagResource
    UpdateAccessGrantsLocation
    UpdateJobPriority
    UpdateJobStatus
    UpdateStorageLensGroup

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeletePublicAccessBlock

    Parameters: AccountId

    • SageMaker Runtime

    Implementation details for API sagemaker-runtime

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SageMaker Runtime

    Implementation details for API sagemaker-runtime

    Coverage Overview

    SageMaker Runtime is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    InvokeEndpoint✔️pro
    InvokeEndpointAsync
    InvokeEndpointWithResponseStream

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_sagemaker/index.html b/references/coverage/coverage_sagemaker/index.html index a2702d165d..50b6d2b216 100644 --- a/references/coverage/coverage_sagemaker/index.html +++ b/references/coverage/coverage_sagemaker/index.html @@ -155,10 +155,10 @@
  • +

    • SageMaker

    Implementation details for API sagemaker

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SageMaker

    Implementation details for API sagemaker

    Coverage Overview

    SageMaker is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddAssociation
    AddTags✔️pro
    AssociateTrialComponent✔️pro
    BatchDescribeModelPackage
    CreateAction
    CreateAlgorithm
    CreateApp
    CreateAppImageConfig
    CreateArtifact
    CreateAutoMLJob
    CreateAutoMLJobV2
    CreateCluster✔️pro✔️
    CreateCodeRepository
    CreateCompilationJob
    CreateContext
    CreateDataQualityJobDefinition
    CreateDeviceFleet
    CreateDomain
    CreateEdgeDeploymentPlan
    CreateEdgeDeploymentStage
    CreateEdgePackagingJob
    CreateEndpoint✔️pro✔️✔️✔️Show Tests
    CreateEndpointConfig✔️pro✔️✔️✔️Show Tests
    CreateExperiment✔️pro✔️
    CreateFeatureGroup✔️pro
    CreateFlowDefinition
    CreateHub
    CreateHubContentReference
    CreateHumanTaskUi
    CreateHyperParameterTuningJob
    CreateImage
    CreateImageVersion
    CreateInferenceComponent
    CreateInferenceExperiment
    CreateInferenceRecommendationsJob
    CreateLabelingJob
    CreateMlflowTrackingServer
    CreateModel✔️pro✔️✔️✔️Show Tests
    CreateModelBiasJobDefinition
    CreateModelCard
    CreateModelCardExportJob
    CreateModelExplainabilityJobDefinition
    CreateModelPackage✔️pro✔️
    CreateModelPackageGroup✔️pro✔️
    CreateModelQualityJobDefinition
    CreateMonitoringSchedule
    CreateNotebookInstance✔️pro✔️
    CreateNotebookInstanceLifecycleConfig✔️pro
    CreateOptimizationJob
    CreatePipeline✔️pro✔️
    CreatePresignedDomainUrl
    CreatePresignedMlflowTrackingServerUrl
    CreatePresignedNotebookInstanceUrl
    CreateProcessingJob✔️pro✔️
    CreateProject
    CreateSpace
    CreateStudioLifecycleConfig
    CreateTrainingJob✔️pro
    CreateTransformJob✔️pro✔️
    CreateTrial✔️pro✔️
    CreateTrialComponent✔️pro✔️
    CreateUserProfile
    CreateWorkforce
    CreateWorkteam
    DeleteAction
    DeleteAlgorithm
    DeleteApp
    DeleteAppImageConfig
    DeleteArtifact
    DeleteAssociation
    DeleteCluster✔️pro✔️
    DeleteCodeRepository
    DeleteCompilationJob
    DeleteContext
    DeleteDataQualityJobDefinition
    DeleteDeviceFleet
    DeleteDomain
    DeleteEdgeDeploymentPlan
    DeleteEdgeDeploymentStage
    DeleteEndpoint✔️pro✔️✔️Show Tests
    DeleteEndpointConfig✔️pro✔️✔️Show Tests
    DeleteExperiment✔️pro✔️
    DeleteFeatureGroup
    DeleteFlowDefinition
    DeleteHub
    DeleteHubContent
    DeleteHubContentReference
    DeleteHumanTaskUi
    DeleteHyperParameterTuningJob
    DeleteImage
    DeleteImageVersion
    DeleteInferenceComponent
    DeleteInferenceExperiment
    DeleteMlflowTrackingServer
    DeleteModel✔️pro✔️✔️Show Tests
    DeleteModelBiasJobDefinition
    DeleteModelCard
    DeleteModelExplainabilityJobDefinition
    DeleteModelPackage
    DeleteModelPackageGroup
    DeleteModelPackageGroupPolicy
    DeleteModelQualityJobDefinition
    DeleteMonitoringSchedule
    DeleteNotebookInstance✔️pro
    DeleteNotebookInstanceLifecycleConfig✔️pro
    DeleteOptimizationJob
    DeletePipeline✔️pro✔️
    DeleteProject
    DeleteSpace
    DeleteStudioLifecycleConfig
    DeleteTags✔️pro
    DeleteTrial✔️pro✔️
    DeleteTrialComponent✔️pro✔️
    DeleteUserProfile
    DeleteWorkforce
    DeleteWorkteam
    DeregisterDevices
    DescribeAction
    DescribeAlgorithm
    DescribeApp
    DescribeAppImageConfig
    DescribeArtifact
    DescribeAutoMLJob
    DescribeAutoMLJobV2
    DescribeCluster✔️pro✔️
    DescribeClusterNode✔️pro✔️
    DescribeCodeRepository
    DescribeCompilationJob
    DescribeContext
    DescribeDataQualityJobDefinition
    DescribeDevice
    DescribeDeviceFleet
    DescribeDomain
    DescribeEdgeDeploymentPlan
    DescribeEdgePackagingJob
    DescribeEndpoint✔️pro✔️✔️✔️Show Tests
    DescribeEndpointConfig✔️pro✔️✔️✔️Show Tests
    DescribeExperiment✔️pro
    DescribeFeatureGroup✔️pro
    DescribeFeatureMetadata
    DescribeFlowDefinition
    DescribeHub
    DescribeHubContent
    DescribeHumanTaskUi
    DescribeHyperParameterTuningJob
    DescribeImage
    DescribeImageVersion
    DescribeInferenceComponent
    DescribeInferenceExperiment
    DescribeInferenceRecommendationsJob
    DescribeLabelingJob
    DescribeLineageGroup
    DescribeMlflowTrackingServer
    DescribeModel✔️pro✔️✔️✔️✔️Show Tests
    DescribeModelBiasJobDefinition
    DescribeModelCard
    DescribeModelCardExportJob
    DescribeModelExplainabilityJobDefinition
    DescribeModelPackage✔️pro✔️
    DescribeModelPackageGroup✔️pro
    DescribeModelQualityJobDefinition
    DescribeMonitoringSchedule
    DescribeNotebookInstance✔️pro
    DescribeNotebookInstanceLifecycleConfig✔️pro
    DescribeOptimizationJob
    DescribePipeline✔️pro✔️
    DescribePipelineDefinitionForExecution✔️pro✔️
    DescribePipelineExecution✔️pro✔️
    DescribeProcessingJob✔️pro✔️
    DescribeProject
    DescribeSpace
    DescribeStudioLifecycleConfig
    DescribeSubscribedWorkteam
    DescribeTrainingJob✔️pro
    DescribeTransformJob✔️pro✔️
    DescribeTrial✔️pro
    DescribeTrialComponent✔️pro✔️
    DescribeUserProfile
    DescribeWorkforce
    DescribeWorkteam
    DisableSagemakerServicecatalogPortfolio
    DisassociateTrialComponent✔️pro
    EnableSagemakerServicecatalogPortfolio
    GetDeviceFleetReport
    GetLineageGroupPolicy
    GetModelPackageGroupPolicy
    GetSagemakerServicecatalogPortfolioStatus
    GetScalingConfigurationRecommendation
    GetSearchSuggestions
    ImportHubContent
    ListActions
    ListAlgorithms
    ListAliases
    ListAppImageConfigs
    ListApps
    ListArtifacts
    ListAssociations
    ListAutoMLJobs
    ListCandidatesForAutoMLJob
    ListClusterNodes✔️pro✔️
    ListClusters✔️pro✔️
    ListCodeRepositories
    ListCompilationJobs
    ListContexts
    ListDataQualityJobDefinitions
    ListDeviceFleets
    ListDevices
    ListDomains
    ListEdgeDeploymentPlans
    ListEdgePackagingJobs
    ListEndpointConfigs✔️pro
    ListEndpoints✔️pro
    ListExperiments✔️pro✔️
    ListFeatureGroups
    ListFlowDefinitions
    ListHubContentVersions
    ListHubContents
    ListHubs
    ListHumanTaskUis
    ListHyperParameterTuningJobs
    ListImageVersions
    ListImages
    ListInferenceComponents
    ListInferenceExperiments
    ListInferenceRecommendationsJobSteps
    ListInferenceRecommendationsJobs
    ListLabelingJobs
    ListLabelingJobsForWorkteam
    ListLineageGroups
    ListMlflowTrackingServers
    ListModelBiasJobDefinitions
    ListModelCardExportJobs
    ListModelCardVersions
    ListModelCards
    ListModelExplainabilityJobDefinitions
    ListModelMetadata
    ListModelPackageGroups✔️pro✔️
    ListModelPackages✔️pro✔️
    ListModelQualityJobDefinitions
    ListModels✔️pro✔️
    ListMonitoringAlertHistory
    ListMonitoringAlerts
    ListMonitoringExecutions
    ListMonitoringSchedules
    ListNotebookInstanceLifecycleConfigs
    ListNotebookInstances✔️pro✔️
    ListOptimizationJobs
    ListPipelineExecutionSteps
    ListPipelineExecutions✔️pro✔️
    ListPipelineParametersForExecution✔️pro✔️
    ListPipelines✔️pro✔️
    ListProcessingJobs✔️pro✔️
    ListProjects
    ListResourceCatalogs
    ListSpaces
    ListStageDevices
    ListStudioLifecycleConfigs
    ListSubscribedWorkteams
    ListTags✔️pro
    ListTrainingJobs✔️pro✔️
    ListTrainingJobsForHyperParameterTuningJob
    ListTransformJobs✔️pro✔️
    ListTrialComponents✔️pro✔️
    ListTrials✔️pro✔️
    ListUserProfiles
    ListWorkforces
    ListWorkteams
    PutModelPackageGroupPolicy
    QueryLineage
    RegisterDevices
    RenderUiTemplate
    RetryPipelineExecution
    Search✔️pro
    SendPipelineExecutionStepFailure
    SendPipelineExecutionStepSuccess
    StartEdgeDeploymentStage
    StartInferenceExperiment
    StartMlflowTrackingServer
    StartMonitoringSchedule
    StartNotebookInstance✔️pro
    StartPipelineExecution✔️pro✔️
    StopAutoMLJob
    StopCompilationJob
    StopEdgeDeploymentStage
    StopEdgePackagingJob
    StopHyperParameterTuningJob
    StopInferenceExperiment
    StopInferenceRecommendationsJob
    StopLabelingJob
    StopMlflowTrackingServer
    StopMonitoringSchedule
    StopNotebookInstance✔️pro✔️
    StopOptimizationJob
    StopPipelineExecution
    StopProcessingJob
    StopTrainingJob
    StopTransformJob
    UpdateAction
    UpdateAppImageConfig
    UpdateArtifact
    UpdateCluster
    UpdateClusterSoftware
    UpdateCodeRepository
    UpdateContext
    UpdateDeviceFleet
    UpdateDevices
    UpdateDomain
    UpdateEndpoint
    UpdateEndpointWeightsAndCapacities✔️pro
    UpdateExperiment
    UpdateFeatureGroup
    UpdateFeatureMetadata
    UpdateHub
    UpdateImage
    UpdateImageVersion
    UpdateInferenceComponent
    UpdateInferenceComponentRuntimeConfig
    UpdateInferenceExperiment
    UpdateMlflowTrackingServer
    UpdateModelCard
    UpdateModelPackage✔️pro✔️
    UpdateMonitoringAlert
    UpdateMonitoringSchedule
    UpdateNotebookInstance
    UpdateNotebookInstanceLifecycleConfig
    UpdatePipeline✔️pro✔️
    UpdatePipelineExecution
    UpdateProject
    UpdateSpace
    UpdateTrainingJob
    UpdateTrial
    UpdateTrialComponent✔️pro✔️
    UpdateUserProfile
    UpdateWorkforce
    UpdateWorkteam

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateEndpoint

    Parameters: EndpointConfigName, EndpointName

    • scheduler (EventBridge Scheduler)

    Implementation details for API scheduler

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    scheduler (EventBridge Scheduler)

    Implementation details for API scheduler

    Coverage Overview

    EventBridge Scheduler (scheduler) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateSchedule✔️community✔️✔️✔️✔️Show Tests
    CreateScheduleGroup✔️community✔️✔️✔️✔️Show Tests
    DeleteSchedule✔️community✔️✔️✔️✔️Show Tests
    DeleteScheduleGroup✔️community✔️✔️✔️Show Tests
    GetSchedule✔️community✔️✔️✔️✔️Show Tests
    GetScheduleGroup✔️community✔️✔️✔️Show Tests
    ListScheduleGroups✔️community
    ListSchedules✔️community✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️
    TagResource✔️community✔️
    UntagResource✔️community✔️
    UpdateSchedule✔️community✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateSchedule

    Parameters: ClientToken, FlexibleTimeWindow, GroupName, Name, ScheduleExpression, Target

    • Secrets Manager

    Implementation details for API secretsmanager

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Secrets Manager

    Implementation details for API secretsmanager

    Coverage Overview

    Secrets Manager is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchGetSecretValue✔️community✔️
    CancelRotateSecret✔️community✔️
    CreateSecret✔️community✔️✔️✔️✔️Show Tests
    DeleteResourcePolicy✔️community✔️✔️✔️Show Tests
    DeleteSecret✔️community✔️✔️✔️✔️Show Tests
    DescribeSecret✔️community✔️✔️✔️✔️Show Tests
    GetRandomPassword✔️community✔️✔️✔️Show Tests
    GetResourcePolicy✔️community✔️✔️✔️Show Tests
    GetSecretValue✔️community✔️✔️✔️✔️Show Tests
    ListSecretVersionIds✔️community✔️✔️✔️✔️Show Tests
    ListSecrets✔️community✔️✔️✔️✔️Show Tests
    PutResourcePolicy✔️community✔️✔️✔️Show Tests
    PutSecretValue✔️community✔️✔️✔️✔️Show Tests
    RemoveRegionsFromReplication✔️community
    ReplicateSecretToRegions✔️community
    RestoreSecret✔️community✔️✔️✔️✔️Show Tests
    RotateSecret✔️community✔️✔️✔️✔️Show Tests
    StopReplicationToReplica
    TagResource✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️Show Tests
    UpdateSecret✔️community✔️✔️✔️✔️Show Tests
    UpdateSecretVersionStage✔️community✔️✔️✔️✔️Show Tests
    ValidateResourcePolicy✔️community✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateSecret

    Parameters: ClientRequestToken, Description, Name

    • Serverless Application Repository

    Implementation details for API serverlessrepo

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Serverless Application Repository

    Implementation details for API serverlessrepo

    Coverage Overview

    Serverless Application Repository is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateApplication✔️pro
    CreateApplicationVersion✔️pro
    CreateCloudFormationChangeSet✔️pro
    CreateCloudFormationTemplate✔️pro
    DeleteApplication✔️pro
    GetApplication✔️pro
    GetApplicationPolicy
    GetCloudFormationTemplate✔️pro
    ListApplicationDependencies
    ListApplicationVersions✔️pro
    ListApplications✔️pro
    PutApplicationPolicy
    UnshareApplication
    UpdateApplication

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_servicediscovery/index.html b/references/coverage/coverage_servicediscovery/index.html index a024c5ff53..efcee4531b 100644 --- a/references/coverage/coverage_servicediscovery/index.html +++ b/references/coverage/coverage_servicediscovery/index.html @@ -155,10 +155,10 @@
  • +

    • Service Discovery (Cloud Map)

    Implementation details for API servicediscovery

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Service Discovery (Cloud Map)

    Implementation details for API servicediscovery

    Coverage Overview

    Cloud Map (Service Discovery) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateHttpNamespace✔️pro✔️
    CreatePrivateDnsNamespace✔️pro✔️Show Tests
    CreatePublicDnsNamespace✔️pro
    CreateService✔️pro✔️✔️Show Tests
    DeleteNamespace✔️pro✔️Show Tests
    DeleteService✔️pro✔️Show Tests
    DeregisterInstance✔️pro
    DiscoverInstances✔️pro
    DiscoverInstancesRevision
    GetInstance✔️pro
    GetInstancesHealthStatus
    GetNamespace✔️pro✔️Show Tests
    GetOperation✔️pro✔️✔️Show Tests
    GetService✔️pro✔️✔️Show Tests
    ListInstances✔️pro✔️Show Tests
    ListNamespaces✔️pro✔️
    ListOperations
    ListServices✔️pro✔️Show Tests
    ListTagsForResource✔️pro✔️
    RegisterInstance✔️pro✔️Show Tests
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateHttpNamespace
    UpdateInstanceCustomHealthStatus
    UpdatePrivateDnsNamespace
    UpdatePublicDnsNamespace
    UpdateService✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreatePrivateDnsNamespace

    Parameters: CreatorRequestId, Name, Vpc

    • SES (Simple Email Service)

    Implementation details for API ses

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SES (Simple Email Service)

    Implementation details for API ses

    Coverage Overview

    Simple Email Service (SES) is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CloneReceiptRuleSet✔️community✔️✔️✔️Show Tests
    CreateConfigurationSet✔️community✔️✔️✔️✔️Show Tests
    CreateConfigurationSetEventDestination✔️community✔️✔️✔️Show Tests
    CreateConfigurationSetTrackingOptions
    CreateCustomVerificationEmailTemplate
    CreateReceiptFilter
    CreateReceiptRule✔️community✔️✔️✔️✔️Show Tests
    CreateReceiptRuleSet✔️community✔️✔️✔️✔️Show Tests
    CreateTemplate✔️community✔️✔️✔️✔️Show Tests
    DeleteConfigurationSet✔️community✔️✔️✔️Show Tests
    DeleteConfigurationSetEventDestination✔️community✔️✔️✔️Show Tests
    DeleteConfigurationSetTrackingOptions
    DeleteCustomVerificationEmailTemplate
    DeleteIdentity✔️community✔️
    DeleteIdentityPolicy
    DeleteReceiptFilter
    DeleteReceiptRule✔️pro✔️✔️✔️Show Tests
    DeleteReceiptRuleSet✔️pro✔️✔️✔️Show Tests
    DeleteTemplate✔️community✔️✔️✔️✔️Show Tests
    DeleteVerifiedEmailAddress
    DescribeActiveReceiptRuleSet✔️pro
    DescribeConfigurationSet✔️community✔️
    DescribeReceiptRule✔️community✔️✔️✔️✔️Show Tests
    DescribeReceiptRuleSet✔️community✔️✔️✔️✔️Show Tests
    GetAccountSendingEnabled
    GetCustomVerificationEmailTemplate
    GetIdentityDkimAttributes
    GetIdentityMailFromDomainAttributes✔️community✔️
    GetIdentityNotificationAttributes✔️community✔️
    GetIdentityPolicies
    GetIdentityVerificationAttributes✔️community✔️✔️✔️Show Tests
    GetSendQuota✔️community✔️✔️✔️✔️Show Tests
    GetSendStatistics✔️community✔️
    GetTemplate✔️community✔️✔️✔️✔️Show Tests
    ListConfigurationSets
    ListCustomVerificationEmailTemplates
    ListIdentities✔️community✔️
    ListIdentityPolicies
    ListReceiptFilters
    ListReceiptRuleSets✔️pro
    ListTemplates✔️community✔️✔️✔️✔️Show Tests
    ListVerifiedEmailAddresses✔️community✔️
    PutConfigurationSetDeliveryOptions
    PutIdentityPolicy
    ReorderReceiptRuleSet
    SendBounce
    SendBulkTemplatedEmail✔️community
    SendCustomVerificationEmail
    SendEmail✔️community✔️✔️✔️✔️Show Tests
    SendRawEmail✔️community✔️✔️✔️✔️Show Tests
    SendTemplatedEmail✔️community✔️✔️✔️✔️Show Tests
    SetActiveReceiptRuleSet✔️pro
    SetIdentityDkimEnabled
    SetIdentityFeedbackForwardingEnabled✔️community✔️
    SetIdentityHeadersInNotificationsEnabled
    SetIdentityMailFromDomain✔️community✔️
    SetIdentityNotificationTopic✔️community✔️
    SetReceiptRulePosition
    TestRenderTemplate✔️community✔️
    UpdateAccountSendingEnabled
    UpdateConfigurationSetEventDestination
    UpdateConfigurationSetReputationMetricsEnabled
    UpdateConfigurationSetSendingEnabled
    UpdateConfigurationSetTrackingOptions
    UpdateCustomVerificationEmailTemplate
    UpdateReceiptRule✔️community✔️
    UpdateTemplate✔️community✔️
    VerifyDomainDkim✔️community✔️
    VerifyDomainIdentity✔️community✔️
    VerifyEmailAddress✔️community✔️✔️Show Tests
    VerifyEmailIdentity✔️community✔️✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CloneReceiptRuleSet

    Parameters: OriginalRuleSetName, RuleSetName

    • SES v2 (Simple Email Service v2)

    Implementation details for API sesv2

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SES v2 (Simple Email Service v2)

    Implementation details for API sesv2

    Coverage Overview

    Simple Email Service v2 (SES v2) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchGetMetricData
    CancelExportJob
    CreateConfigurationSet
    CreateConfigurationSetEventDestination
    CreateContact
    CreateContactList
    CreateCustomVerificationEmailTemplate
    CreateDedicatedIpPool
    CreateDeliverabilityTestReport
    CreateEmailIdentity✔️pro
    CreateEmailIdentityPolicy
    CreateEmailTemplate✔️pro
    CreateExportJob
    CreateImportJob
    DeleteConfigurationSet
    DeleteConfigurationSetEventDestination
    DeleteContact
    DeleteContactList
    DeleteCustomVerificationEmailTemplate
    DeleteDedicatedIpPool
    DeleteEmailIdentity✔️pro
    DeleteEmailIdentityPolicy
    DeleteEmailTemplate✔️pro
    DeleteSuppressedDestination
    GetAccount
    GetBlacklistReports
    GetConfigurationSet
    GetConfigurationSetEventDestinations
    GetContact
    GetContactList
    GetCustomVerificationEmailTemplate
    GetDedicatedIp
    GetDedicatedIpPool
    GetDedicatedIps
    GetDeliverabilityDashboardOptions
    GetDeliverabilityTestReport
    GetDomainDeliverabilityCampaign
    GetDomainStatisticsReport
    GetEmailIdentity✔️pro
    GetEmailIdentityPolicies
    GetEmailTemplate
    GetExportJob
    GetImportJob
    GetMessageInsights
    GetSuppressedDestination
    ListConfigurationSets
    ListContactLists
    ListContacts
    ListCustomVerificationEmailTemplates
    ListDedicatedIpPools
    ListDeliverabilityTestReports
    ListDomainDeliverabilityCampaigns
    ListEmailIdentities✔️pro
    ListEmailTemplates✔️pro
    ListExportJobs
    ListImportJobs
    ListRecommendations
    ListSuppressedDestinations
    ListTagsForResource
    PutAccountDedicatedIpWarmupAttributes
    PutAccountDetails
    PutAccountSendingAttributes
    PutAccountSuppressionAttributes
    PutAccountVdmAttributes
    PutConfigurationSetDeliveryOptions
    PutConfigurationSetReputationOptions
    PutConfigurationSetSendingOptions
    PutConfigurationSetSuppressionOptions
    PutConfigurationSetTrackingOptions
    PutConfigurationSetVdmOptions
    PutDedicatedIpInPool
    PutDedicatedIpPoolScalingAttributes
    PutDedicatedIpWarmupAttributes
    PutDeliverabilityDashboardOption
    PutEmailIdentityConfigurationSetAttributes
    PutEmailIdentityDkimAttributes
    PutEmailIdentityDkimSigningAttributes✔️pro
    PutEmailIdentityFeedbackAttributes
    PutEmailIdentityMailFromAttributes
    PutSuppressedDestination
    SendBulkEmail✔️pro
    SendCustomVerificationEmail
    SendEmail✔️pro
    TagResource
    TestRenderEmailTemplate
    UntagResource
    UpdateConfigurationSetEventDestination
    UpdateContact
    UpdateContactList
    UpdateCustomVerificationEmailTemplate
    UpdateEmailIdentityPolicy
    UpdateEmailTemplate

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_sns/index.html b/references/coverage/coverage_sns/index.html index 90aa0f8d92..c9d57185b8 100644 --- a/references/coverage/coverage_sns/index.html +++ b/references/coverage/coverage_sns/index.html @@ -155,10 +155,10 @@
  • +

    • SNS (Simple Notification Service)

    Implementation details for API sns

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SNS (Simple Notification Service)

    Implementation details for API sns

    Coverage Overview

    Simple Notification Service (SNS) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddPermission✔️community✔️✔️✔️Show Tests
    CheckIfPhoneNumberIsOptedOut✔️community
    ConfirmSubscription✔️community✔️✔️✔️Show Tests
    CreatePlatformApplication✔️community✔️✔️✔️Show Tests
    CreatePlatformEndpoint✔️community✔️✔️✔️Show Tests
    CreateSMSSandboxPhoneNumber
    CreateTopic✔️community✔️✔️✔️✔️Show Tests
    DeleteEndpoint✔️community✔️✔️✔️Show Tests
    DeletePlatformApplication✔️community✔️✔️✔️Show Tests
    DeleteSMSSandboxPhoneNumber
    DeleteTopic✔️community✔️✔️✔️Show Tests
    GetDataProtectionPolicy
    GetEndpointAttributes✔️community✔️✔️✔️Show Tests
    GetPlatformApplicationAttributes✔️community
    GetSMSAttributes✔️community
    GetSMSSandboxAccountStatus
    GetSubscriptionAttributes✔️community✔️✔️✔️Show Tests
    GetTopicAttributes✔️community✔️✔️✔️Show Tests
    ListEndpointsByPlatformApplication✔️community✔️✔️✔️Show Tests
    ListOriginationNumbers
    ListPhoneNumbersOptedOut✔️community
    ListPlatformApplications✔️community
    ListSMSSandboxPhoneNumbers
    ListSubscriptions✔️community✔️✔️✔️Show Tests
    ListSubscriptionsByTopic✔️community✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️✔️✔️Show Tests
    ListTopics✔️community✔️✔️✔️Show Tests
    OptInPhoneNumber✔️community
    Publish✔️community✔️✔️✔️Show Tests
    PublishBatch✔️community✔️✔️✔️Show Tests
    PutDataProtectionPolicy
    RemovePermission✔️community✔️✔️✔️Show Tests
    SetEndpointAttributes✔️community✔️✔️✔️Show Tests
    SetPlatformApplicationAttributes✔️community
    SetSMSAttributes✔️community
    SetSubscriptionAttributes✔️community✔️✔️✔️Show Tests
    SetTopicAttributes✔️community✔️✔️✔️Show Tests
    Subscribe✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️Show Tests
    Unsubscribe✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️Show Tests
    VerifySMSSandboxPhoneNumber

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddPermission

    Parameters: AWSAccountId, ActionName, Label, TopicArn

    • SQS (Simple Queue Service)

    Implementation details for API sqs

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SQS (Simple Queue Service)

    Implementation details for API sqs

    Coverage Overview

    Simple Queue Service (SQS) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddPermission✔️community✔️✔️✔️Show Tests
    CancelMessageMoveTask✔️community✔️✔️✔️Show Tests
    ChangeMessageVisibility✔️community✔️✔️✔️✔️Show Tests
    ChangeMessageVisibilityBatch✔️community✔️✔️✔️✔️Show Tests
    CreateQueue✔️community✔️✔️✔️✔️Show Tests
    DeleteMessage✔️community✔️✔️✔️✔️Show Tests
    DeleteMessageBatch✔️community✔️✔️✔️Show Tests
    DeleteQueue✔️community✔️✔️✔️✔️Show Tests
    GetQueueAttributes✔️community✔️✔️✔️✔️Show Tests
    GetQueueUrl✔️community✔️✔️✔️✔️Show Tests
    ListDeadLetterSourceQueues✔️community✔️✔️✔️Show Tests
    ListMessageMoveTasks✔️community✔️✔️✔️Show Tests
    ListQueueTags✔️community✔️✔️✔️✔️Show Tests
    ListQueues✔️community✔️✔️✔️✔️Show Tests
    PurgeQueue✔️community✔️✔️✔️✔️Show Tests
    ReceiveMessage✔️community✔️✔️✔️✔️Show Tests
    RemovePermission✔️community✔️✔️✔️Show Tests
    SendMessage✔️community✔️✔️✔️✔️Show Tests
    SendMessageBatch✔️community✔️✔️✔️✔️Show Tests
    SetQueueAttributes✔️community✔️✔️✔️✔️Show Tests
    StartMessageMoveTask✔️community✔️✔️✔️Show Tests
    TagQueue✔️community✔️✔️✔️✔️Show Tests
    UntagQueue✔️community✔️✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddPermission

    Parameters: AWSAccountIds, Actions, Label, QueueUrl

    • SSM (Web Services Systems Manager)

    Implementation details for API ssm

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SSM (Web Services Systems Manager)

    Implementation details for API ssm

    Coverage Overview

    Web Services Systems Manager (SSM) is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddTagsToResource✔️community✔️✔️✔️Show Tests
    AssociateOpsItemRelatedItem
    CancelCommand✔️pro
    CancelMaintenanceWindowExecution
    CreateActivation
    CreateAssociation
    CreateAssociationBatch
    CreateDocument✔️community✔️
    CreateMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    CreateOpsItem
    CreateOpsMetadata
    CreatePatchBaseline✔️community✔️✔️✔️✔️Show Tests
    CreateResourceDataSync
    DeleteActivation
    DeleteAssociation
    DeleteDocument✔️community✔️
    DeleteInventory
    DeleteMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    DeleteOpsItem
    DeleteOpsMetadata
    DeleteParameter✔️community✔️✔️✔️✔️Show Tests
    DeleteParameters✔️community✔️
    DeletePatchBaseline✔️community✔️✔️✔️✔️Show Tests
    DeleteResourceDataSync
    DeleteResourcePolicy
    DeregisterManagedInstance
    DeregisterPatchBaselineForPatchGroup
    DeregisterTargetFromMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    DeregisterTaskFromMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    DescribeActivations
    DescribeAssociation
    DescribeAssociationExecutionTargets
    DescribeAssociationExecutions
    DescribeAutomationExecutions
    DescribeAutomationStepExecutions
    DescribeAvailablePatches
    DescribeDocument✔️community✔️
    DescribeDocumentPermission✔️community✔️
    DescribeEffectiveInstanceAssociations
    DescribeEffectivePatchesForPatchBaseline
    DescribeInstanceAssociationsStatus
    DescribeInstanceInformation✔️pro
    DescribeInstancePatchStates
    DescribeInstancePatchStatesForPatchGroup
    DescribeInstancePatches
    DescribeInstanceProperties
    DescribeInventoryDeletions
    DescribeMaintenanceWindowExecutionTaskInvocations
    DescribeMaintenanceWindowExecutionTasks
    DescribeMaintenanceWindowExecutions
    DescribeMaintenanceWindowSchedule
    DescribeMaintenanceWindowTargets✔️community✔️
    DescribeMaintenanceWindowTasks✔️community✔️
    DescribeMaintenanceWindows✔️community✔️
    DescribeMaintenanceWindowsForTarget
    DescribeOpsItems
    DescribeParameters✔️community✔️✔️✔️✔️Show Tests
    DescribePatchBaselines✔️community✔️
    DescribePatchGroupState
    DescribePatchGroups
    DescribePatchProperties
    DescribeSessions
    DisassociateOpsItemRelatedItem
    GetAutomationExecution
    GetCalendarState
    GetCommandInvocation✔️community
    GetConnectionStatus
    GetDefaultPatchBaseline
    GetDeployablePatchSnapshotForInstance
    GetDocument✔️community✔️
    GetInventory
    GetInventorySchema
    GetMaintenanceWindow✔️community✔️✔️✔️Show Tests
    GetMaintenanceWindowExecution
    GetMaintenanceWindowExecutionTask
    GetMaintenanceWindowExecutionTaskInvocation
    GetMaintenanceWindowTask
    GetOpsItem
    GetOpsMetadata
    GetOpsSummary
    GetParameter✔️community✔️✔️✔️✔️Show Tests
    GetParameterHistory✔️community✔️
    GetParameters✔️community✔️✔️✔️Show Tests
    GetParametersByPath✔️community✔️✔️✔️Show Tests
    GetPatchBaseline
    GetPatchBaselineForPatchGroup
    GetResourcePolicies
    GetServiceSetting
    LabelParameterVersion✔️community✔️✔️✔️Show Tests
    ListAssociationVersions
    ListAssociations
    ListCommandInvocations✔️pro
    ListCommands✔️community
    ListComplianceItems
    ListComplianceSummaries
    ListDocumentMetadataHistory
    ListDocumentVersions
    ListDocuments✔️community✔️
    ListInventoryEntries
    ListOpsItemEvents
    ListOpsItemRelatedItems
    ListOpsMetadata
    ListResourceComplianceSummaries
    ListResourceDataSync
    ListTagsForResource✔️community✔️✔️✔️Show Tests
    ModifyDocumentPermission✔️community✔️
    PutComplianceItems
    PutInventory
    PutParameter✔️community✔️✔️✔️✔️Show Tests
    PutResourcePolicy
    RegisterDefaultPatchBaseline
    RegisterPatchBaselineForPatchGroup
    RegisterTargetWithMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    RegisterTaskWithMaintenanceWindow✔️community✔️✔️✔️✔️Show Tests
    RemoveTagsFromResource✔️community✔️
    ResetServiceSetting
    ResumeSession
    SendAutomationSignal
    SendCommand✔️community
    StartAssociationsOnce
    StartAutomationExecution
    StartChangeRequestExecution
    StartSession
    StopAutomationExecution
    TerminateSession
    UnlabelParameterVersion
    UpdateAssociation
    UpdateAssociationStatus
    UpdateDocument✔️community✔️
    UpdateDocumentDefaultVersion✔️community✔️
    UpdateDocumentMetadata
    UpdateMaintenanceWindow
    UpdateMaintenanceWindowTarget
    UpdateMaintenanceWindowTask
    UpdateManagedInstanceRole
    UpdateOpsItem
    UpdateOpsMetadata
    UpdatePatchBaseline
    UpdateResourceDataSync
    UpdateServiceSetting

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AddTagsToResource

    Parameters: ResourceId, ResourceType, Tags

    • sso-admin (IAM Identity Center (successor to Single Sign-On))

    Implementation details for API sso-admin

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    sso-admin (IAM Identity Center (successor to Single Sign-On))

    Implementation details for API sso-admin

    Coverage Overview

    IAM Identity Center (successor to Single Sign-On) (sso-admin) is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AttachCustomerManagedPolicyReferenceToPermissionSet✔️pro✔️
    AttachManagedPolicyToPermissionSet✔️pro✔️
    CreateAccountAssignment✔️pro✔️
    CreateApplication
    CreateApplicationAssignment
    CreateInstance
    CreateInstanceAccessControlAttributeConfiguration
    CreatePermissionSet✔️pro✔️
    CreateTrustedTokenIssuer
    DeleteAccountAssignment✔️pro✔️
    DeleteApplication
    DeleteApplicationAccessScope
    DeleteApplicationAssignment
    DeleteApplicationAuthenticationMethod
    DeleteApplicationGrant
    DeleteInlinePolicyFromPermissionSet✔️pro✔️
    DeleteInstance
    DeleteInstanceAccessControlAttributeConfiguration
    DeletePermissionSet✔️pro✔️
    DeletePermissionsBoundaryFromPermissionSet
    DeleteTrustedTokenIssuer
    DescribeAccountAssignmentCreationStatus✔️pro✔️
    DescribeAccountAssignmentDeletionStatus✔️pro✔️
    DescribeApplication
    DescribeApplicationAssignment
    DescribeApplicationProvider
    DescribeInstance
    DescribeInstanceAccessControlAttributeConfiguration
    DescribePermissionSet✔️pro✔️
    DescribePermissionSetProvisioningStatus
    DescribeTrustedTokenIssuer
    DetachCustomerManagedPolicyReferenceFromPermissionSet✔️pro✔️
    DetachManagedPolicyFromPermissionSet✔️pro✔️
    GetApplicationAccessScope
    GetApplicationAssignmentConfiguration
    GetApplicationAuthenticationMethod
    GetApplicationGrant
    GetInlinePolicyForPermissionSet✔️pro✔️
    GetPermissionsBoundaryForPermissionSet
    ListAccountAssignmentCreationStatus
    ListAccountAssignmentDeletionStatus
    ListAccountAssignments✔️pro✔️
    ListAccountAssignmentsForPrincipal✔️pro✔️
    ListAccountsForProvisionedPermissionSet✔️pro
    ListApplicationAccessScopes
    ListApplicationAssignments
    ListApplicationAssignmentsForPrincipal
    ListApplicationAuthenticationMethods
    ListApplicationGrants
    ListApplicationProviders
    ListApplications
    ListCustomerManagedPolicyReferencesInPermissionSet✔️pro✔️
    ListInstances✔️pro✔️
    ListManagedPoliciesInPermissionSet✔️pro✔️
    ListPermissionSetProvisioningStatus
    ListPermissionSets✔️pro✔️
    ListPermissionSetsProvisionedToAccount✔️pro
    ListTagsForResource
    ListTrustedTokenIssuers
    ProvisionPermissionSet✔️pro
    PutApplicationAccessScope
    PutApplicationAssignmentConfiguration
    PutApplicationAuthenticationMethod
    PutApplicationGrant
    PutInlinePolicyToPermissionSet✔️pro✔️
    PutPermissionsBoundaryToPermissionSet
    TagResource
    UntagResource
    UpdateApplication
    UpdateInstance✔️pro✔️
    UpdateInstanceAccessControlAttributeConfiguration
    UpdatePermissionSet✔️pro✔️
    UpdateTrustedTokenIssuer

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_stepfunctions/index.html b/references/coverage/coverage_stepfunctions/index.html index 08e9e45719..0fbca69ab8 100644 --- a/references/coverage/coverage_stepfunctions/index.html +++ b/references/coverage/coverage_stepfunctions/index.html @@ -155,10 +155,10 @@
  • +

    • Step Functions

    Implementation details for API stepfunctions

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Step Functions

    Implementation details for API stepfunctions

    Coverage Overview

    Step Functions is supported by LocalStack in the community image with additional features available in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateActivity✔️community✔️✔️✔️Show Tests
    CreateStateMachine✔️community✔️✔️✔️✔️Show Tests
    CreateStateMachineAlias
    DeleteActivity✔️community✔️✔️✔️Show Tests
    DeleteStateMachine✔️community✔️✔️✔️✔️Show Tests
    DeleteStateMachineAlias
    DeleteStateMachineVersion✔️community✔️✔️✔️Show Tests
    DescribeActivity✔️community✔️✔️✔️Show Tests
    DescribeExecution✔️community✔️✔️✔️✔️Show Tests
    DescribeMapRun✔️community✔️✔️✔️Show Tests
    DescribeStateMachine✔️community✔️✔️✔️✔️Show Tests
    DescribeStateMachineAlias
    DescribeStateMachineForExecution✔️community✔️✔️✔️✔️Show Tests
    GetActivityTask✔️community✔️✔️✔️Show Tests
    GetExecutionHistory✔️community✔️✔️✔️✔️Show Tests
    ListActivities✔️community✔️✔️✔️Show Tests
    ListExecutions✔️community✔️✔️✔️✔️Show Tests
    ListMapRuns✔️community✔️✔️✔️Show Tests
    ListStateMachineAliases
    ListStateMachineVersions✔️community✔️✔️✔️Show Tests
    ListStateMachines✔️community✔️✔️✔️✔️Show Tests
    ListTagsForResource✔️community✔️✔️✔️✔️Show Tests
    PublishStateMachineVersion✔️community✔️✔️✔️Show Tests
    RedriveExecution
    SendTaskFailure✔️community✔️✔️✔️✔️Show Tests
    SendTaskHeartbeat✔️community✔️✔️✔️✔️Show Tests
    SendTaskSuccess✔️community✔️✔️✔️✔️Show Tests
    StartExecution✔️community✔️✔️✔️✔️Show Tests
    StartSyncExecution✔️pro
    StopExecution✔️community✔️✔️✔️✔️Show Tests
    TagResource✔️community✔️✔️✔️✔️Show Tests
    TestState✔️community✔️✔️✔️Show Tests
    UntagResource✔️community✔️✔️✔️✔️Show Tests
    UpdateMapRun
    UpdateStateMachine✔️community✔️✔️✔️✔️Show Tests
    UpdateStateMachineAlias
    ValidateStateMachineDefinition

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateActivity

    Parameters: name

    • STS (Security Token Service)

    Implementation details for API sts

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    STS (Security Token Service)

    Implementation details for API sts

    Coverage Overview

    Security Token Service (STS) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssumeRole✔️community✔️✔️✔️Show Tests
    AssumeRoleWithSAML✔️community✔️✔️Show Tests
    AssumeRoleWithWebIdentity✔️community✔️Show Tests
    DecodeAuthorizationMessage
    GetAccessKeyInfo
    GetCallerIdentity✔️community✔️✔️✔️✔️Show Tests
    GetFederationToken✔️community✔️✔️✔️✔️Show Tests
    GetSessionToken✔️community✔️✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AssumeRole

    Parameters: DurationSeconds, RoleArn, RoleSessionName

    • Support API

    Implementation details for API support

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Support API

    Implementation details for API support

    Coverage Overview

    Support API is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AddAttachmentsToSet
    AddCommunicationToCase
    CreateCase✔️community✔️✔️Show Tests
    DescribeAttachment
    DescribeCases✔️community✔️✔️Show Tests
    DescribeCommunications
    DescribeCreateCaseOptions
    DescribeServices
    DescribeSeverityLevels
    DescribeSupportedLanguages
    DescribeTrustedAdvisorCheckRefreshStatuses
    DescribeTrustedAdvisorCheckResult
    DescribeTrustedAdvisorCheckSummaries
    DescribeTrustedAdvisorChecks✔️community✔️
    RefreshTrustedAdvisorCheck✔️community✔️
    ResolveCase✔️community✔️✔️Show Tests

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateCase

    Parameters: categoryCode, ccEmailAddresses, communicationBody, issueType, language, serviceCode, severityCode, subject

    • SWF (Simple Workflow Service)

    Implementation details for API swf

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    SWF (Simple Workflow Service)

    Implementation details for API swf

    Coverage Overview

    Simple Workflow Service (SWF) is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CountClosedWorkflowExecutions
    CountOpenWorkflowExecutions
    CountPendingActivityTasks✔️community
    CountPendingDecisionTasks✔️community
    DeleteActivityType
    DeleteWorkflowType
    DeprecateActivityType✔️community
    DeprecateDomain✔️community
    DeprecateWorkflowType✔️community
    DescribeActivityType✔️community
    DescribeDomain✔️community
    DescribeWorkflowExecution✔️community
    DescribeWorkflowType✔️community
    GetWorkflowExecutionHistory✔️community✔️Show Tests
    ListActivityTypes✔️community
    ListClosedWorkflowExecutions✔️community
    ListDomains✔️community
    ListOpenWorkflowExecutions✔️community
    ListTagsForResource
    ListWorkflowTypes✔️community✔️Show Tests
    PollForActivityTask✔️community✔️Show Tests
    PollForDecisionTask✔️community✔️Show Tests
    RecordActivityTaskHeartbeat✔️community
    RegisterActivityType✔️community✔️Show Tests
    RegisterDomain✔️community✔️Show Tests
    RegisterWorkflowType✔️community✔️Show Tests
    RequestCancelWorkflowExecution
    RespondActivityTaskCanceled
    RespondActivityTaskCompleted✔️community✔️Show Tests
    RespondActivityTaskFailed✔️community
    RespondDecisionTaskCompleted✔️community✔️Show Tests
    SignalWorkflowExecution✔️community
    StartWorkflowExecution✔️community✔️Show Tests
    TagResource
    TerminateWorkflowExecution✔️community
    UndeprecateActivityType✔️community
    UndeprecateDomain✔️community
    UndeprecateWorkflowType✔️community
    UntagResource

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    GetWorkflowExecutionHistory

    Parameters: domain, execution

    • textract

    Implementation details for API textract

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AnalyzeDocument
    AnalyzeExpense
    AnalyzeID
    CreateAdapter
    CreateAdapterVersion
    DeleteAdapter
    DeleteAdapterVersion
    DetectDocumentText✔️pro✔️
    GetAdapter
    GetAdapterVersion
    GetDocumentAnalysis
    GetDocumentTextDetection✔️pro✔️
    GetExpenseAnalysis
    GetLendingAnalysis
    GetLendingAnalysisSummary
    ListAdapterVersions
    ListAdapters
    ListTagsForResource
    StartDocumentAnalysis
    StartDocumentTextDetection✔️pro✔️
    StartExpenseAnalysis
    StartLendingAnalysis
    TagResource
    UntagResource
    UpdateAdapter

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    textract

    Implementation details for API textract

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AnalyzeDocument
    AnalyzeExpense
    AnalyzeID
    CreateAdapter
    CreateAdapterVersion
    DeleteAdapter
    DeleteAdapterVersion
    DetectDocumentText✔️pro✔️
    GetAdapter
    GetAdapterVersion
    GetDocumentAnalysis
    GetDocumentTextDetection✔️pro✔️
    GetExpenseAnalysis
    GetLendingAnalysis
    GetLendingAnalysisSummary
    ListAdapterVersions
    ListAdapters
    ListTagsForResource
    StartDocumentAnalysis
    StartDocumentTextDetection✔️pro✔️
    StartExpenseAnalysis
    StartLendingAnalysis
    TagResource
    UntagResource
    UpdateAdapter

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_timestream-query/index.html b/references/coverage/coverage_timestream-query/index.html index 527e6a013d..258bbeb9f7 100644 --- a/references/coverage/coverage_timestream-query/index.html +++ b/references/coverage/coverage_timestream-query/index.html @@ -155,10 +155,10 @@
  • +

    • Timestream Query

    Implementation details for API timestream-query

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Timestream Query

    Implementation details for API timestream-query

    Coverage Overview

    Timestream Query is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CancelQuery
    CreateScheduledQuery
    DeleteScheduledQuery
    DescribeAccountSettings
    DescribeEndpoints✔️pro
    DescribeScheduledQuery
    ExecuteScheduledQuery
    ListScheduledQueries
    ListTagsForResource✔️pro
    PrepareQuery
    Query✔️pro
    TagResource✔️pro
    UntagResource✔️pro
    UpdateAccountSettings
    UpdateScheduledQuery

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_timestream-write/index.html b/references/coverage/coverage_timestream-write/index.html index 97dea09518..ed4baf2573 100644 --- a/references/coverage/coverage_timestream-write/index.html +++ b/references/coverage/coverage_timestream-write/index.html @@ -155,10 +155,10 @@
  • +

    • Timestream Write

    Implementation details for API timestream-write

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Timestream Write

    Implementation details for API timestream-write

    Coverage Overview

    Timestream Write is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateBatchLoadTask
    CreateDatabase✔️pro✔️✔️✔️✔️Show Tests
    CreateTable✔️pro✔️✔️✔️✔️Show Tests
    DeleteDatabase✔️pro✔️✔️✔️✔️Show Tests
    DeleteTable✔️pro✔️✔️✔️✔️Show Tests
    DescribeBatchLoadTask
    DescribeDatabase✔️pro✔️✔️✔️Show Tests
    DescribeEndpoints✔️pro
    DescribeTable✔️pro
    ListBatchLoadTasks
    ListDatabases✔️pro
    ListTables✔️pro✔️✔️✔️Show Tests
    ListTagsForResource✔️pro
    ResumeBatchLoadTask
    TagResource✔️pro
    UntagResource✔️pro
    UpdateDatabase
    UpdateTable
    WriteRecords✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    CreateDatabase

    Parameters: DatabaseName

    • Transcribe

    Implementation details for API transcribe

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Transcribe

    Implementation details for API transcribe

    Coverage Overview

    Transcribe is supported by LocalStack in the community image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateCallAnalyticsCategory
    CreateLanguageModel
    CreateMedicalVocabulary✔️community✔️
    CreateVocabulary✔️community✔️
    CreateVocabularyFilter
    DeleteCallAnalyticsCategory
    DeleteCallAnalyticsJob
    DeleteLanguageModel
    DeleteMedicalScribeJob
    DeleteMedicalTranscriptionJob✔️community✔️
    DeleteMedicalVocabulary✔️community✔️
    DeleteTranscriptionJob✔️community✔️✔️✔️Show Tests
    DeleteVocabulary✔️community✔️
    DeleteVocabularyFilter
    DescribeLanguageModel
    GetCallAnalyticsCategory
    GetCallAnalyticsJob
    GetMedicalScribeJob
    GetMedicalTranscriptionJob✔️community✔️
    GetMedicalVocabulary✔️community✔️
    GetTranscriptionJob✔️community✔️✔️✔️Show Tests
    GetVocabulary✔️community✔️
    GetVocabularyFilter
    ListCallAnalyticsCategories
    ListCallAnalyticsJobs
    ListLanguageModels
    ListMedicalScribeJobs
    ListMedicalTranscriptionJobs✔️community✔️
    ListMedicalVocabularies✔️community✔️
    ListTagsForResource
    ListTranscriptionJobs✔️community✔️✔️✔️Show Tests
    ListVocabularies✔️community✔️
    ListVocabularyFilters
    StartCallAnalyticsJob
    StartMedicalScribeJob
    StartMedicalTranscriptionJob✔️community✔️
    StartTranscriptionJob✔️community✔️✔️✔️✔️Show Tests
    TagResource
    UntagResource
    UpdateCallAnalyticsCategory
    UpdateMedicalVocabulary
    UpdateVocabulary
    UpdateVocabularyFilter

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    DeleteTranscriptionJob

    Parameters: TranscriptionJobName

    • Transfer

    Implementation details for API transfer

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    Transfer

    Implementation details for API transfer

    Coverage Overview

    Transfer is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    CreateAccess
    CreateAgreement
    CreateConnector
    CreateProfile
    CreateServer✔️pro
    CreateUser✔️pro
    CreateWorkflow
    DeleteAccess
    DeleteAgreement
    DeleteCertificate
    DeleteConnector
    DeleteHostKey
    DeleteProfile
    DeleteServer✔️pro
    DeleteSshPublicKey✔️pro
    DeleteUser✔️pro
    DeleteWorkflow
    DescribeAccess
    DescribeAgreement
    DescribeCertificate
    DescribeConnector
    DescribeExecution
    DescribeHostKey
    DescribeProfile
    DescribeSecurityPolicy
    DescribeServer✔️pro
    DescribeUser✔️pro
    DescribeWorkflow
    ImportCertificate
    ImportHostKey
    ImportSshPublicKey✔️pro
    ListAccesses
    ListAgreements
    ListCertificates
    ListConnectors
    ListExecutions
    ListHostKeys
    ListProfiles
    ListSecurityPolicies
    ListServers✔️pro
    ListTagsForResource
    ListUsers✔️pro
    ListWorkflows
    SendWorkflowStepState
    StartDirectoryListing
    StartFileTransfer
    StartServer
    StopServer
    TagResource
    TestConnection
    TestIdentityProvider
    UntagResource
    UpdateAccess
    UpdateAgreement
    UpdateCertificate
    UpdateConnector
    UpdateHostKey
    UpdateProfile
    UpdateServer
    UpdateUser✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/coverage_wafv2/index.html b/references/coverage/coverage_wafv2/index.html index b812e202ba..5c7fd70503 100644 --- a/references/coverage/coverage_wafv2/index.html +++ b/references/coverage/coverage_wafv2/index.html @@ -155,10 +155,10 @@
  • +

    • wafv2

    Implementation details for API wafv2

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateWebACL✔️pro✔️✔️✔️✔️Show Tests
    CheckCapacity
    CreateAPIKey
    CreateIPSet✔️pro✔️✔️✔️✔️Show Tests
    CreateRegexPatternSet
    CreateRuleGroup
    CreateWebACL✔️pro✔️✔️✔️✔️Show Tests
    DeleteAPIKey
    DeleteFirewallManagerRuleGroups
    DeleteIPSet✔️pro✔️
    DeleteLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    DeletePermissionPolicy
    DeleteRegexPatternSet
    DeleteRuleGroup
    DeleteWebACL✔️pro✔️
    DescribeAllManagedProducts
    DescribeManagedProductsByVendor
    DescribeManagedRuleGroup
    DisassociateWebACL✔️pro✔️
    GenerateMobileSdkReleaseUrl
    GetDecryptedAPIKey
    GetIPSet✔️pro✔️✔️✔️✔️Show Tests
    GetLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    GetManagedRuleSet
    GetMobileSdkRelease
    GetPermissionPolicy
    GetRateBasedStatementManagedKeys
    GetRegexPatternSet
    GetRuleGroup
    GetSampledRequests
    GetWebACL✔️pro✔️✔️✔️✔️Show Tests
    GetWebACLForResource✔️pro✔️✔️✔️✔️Show Tests
    ListAPIKeys
    ListAvailableManagedRuleGroupVersions
    ListAvailableManagedRuleGroups
    ListIPSets✔️pro✔️
    ListLoggingConfigurations✔️pro✔️
    ListManagedRuleSets
    ListMobileSdkReleases
    ListRegexPatternSets
    ListResourcesForWebACL
    ListRuleGroups✔️pro✔️
    ListTagsForResource✔️pro✔️
    ListWebACLs✔️pro✔️
    PutLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    PutManagedRuleSetVersions
    PutPermissionPolicy
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateIPSet✔️pro✔️
    UpdateManagedRuleSetVersionExpiryDate
    UpdateRegexPatternSet
    UpdateRuleGroup
    UpdateWebACL✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    wafv2

    Implementation details for API wafv2

    Coverage Overview


    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    AssociateWebACL✔️pro✔️✔️✔️✔️Show Tests
    CheckCapacity
    CreateAPIKey
    CreateIPSet✔️pro✔️✔️✔️✔️Show Tests
    CreateRegexPatternSet
    CreateRuleGroup
    CreateWebACL✔️pro✔️✔️✔️✔️Show Tests
    DeleteAPIKey
    DeleteFirewallManagerRuleGroups
    DeleteIPSet✔️pro✔️
    DeleteLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    DeletePermissionPolicy
    DeleteRegexPatternSet
    DeleteRuleGroup
    DeleteWebACL✔️pro✔️
    DescribeAllManagedProducts
    DescribeManagedProductsByVendor
    DescribeManagedRuleGroup
    DisassociateWebACL✔️pro✔️
    GenerateMobileSdkReleaseUrl
    GetDecryptedAPIKey
    GetIPSet✔️pro✔️✔️✔️✔️Show Tests
    GetLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    GetManagedRuleSet
    GetMobileSdkRelease
    GetPermissionPolicy
    GetRateBasedStatementManagedKeys
    GetRegexPatternSet
    GetRuleGroup
    GetSampledRequests
    GetWebACL✔️pro✔️✔️✔️✔️Show Tests
    GetWebACLForResource✔️pro✔️✔️✔️✔️Show Tests
    ListAPIKeys
    ListAvailableManagedRuleGroupVersions
    ListAvailableManagedRuleGroups
    ListIPSets✔️pro✔️
    ListLoggingConfigurations✔️pro✔️
    ListManagedRuleSets
    ListMobileSdkReleases
    ListRegexPatternSets
    ListResourcesForWebACL
    ListRuleGroups✔️pro✔️
    ListTagsForResource✔️pro✔️
    ListWebACLs✔️pro✔️
    PutLoggingConfiguration✔️pro✔️✔️✔️✔️Show Tests
    PutManagedRuleSetVersions
    PutPermissionPolicy
    TagResource✔️pro✔️
    UntagResource✔️pro✔️
    UpdateIPSet✔️pro✔️
    UpdateManagedRuleSetVersionExpiryDate
    UpdateRegexPatternSet
    UpdateRuleGroup
    UpdateWebACL✔️pro✔️

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    AssociateWebACL

    Parameters: ResourceArn, WebACLArn

    • X-Ray

    Implementation details for API xray

    Coverage Overview

    Table of Contents
    Categories
    Persistence
    Tags

    X-Ray

    Implementation details for API xray

    Coverage Overview

    X-Ray is supported by LocalStack only in the pro image.

    AvailabilityTesting*
    OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
    BatchGetTraces✔️pro✔️
    CreateGroup
    CreateSamplingRule✔️pro
    DeleteGroup
    DeleteResourcePolicy
    DeleteSamplingRule✔️pro
    GetEncryptionConfig
    GetGroup
    GetGroups
    GetInsight
    GetInsightEvents
    GetInsightImpactGraph
    GetInsightSummaries
    GetSamplingRules✔️pro
    GetSamplingStatisticSummaries
    GetSamplingTargets
    GetServiceGraph✔️pro✔️
    GetTimeSeriesServiceStatistics
    GetTraceGraph✔️pro
    GetTraceSummaries✔️pro✔️
    ListResourcePolicies
    ListTagsForResource
    PutEncryptionConfig
    PutResourcePolicy
    PutTelemetryRecords✔️pro✔️
    PutTraceSegments✔️pro✔️
    TagResource
    UntagResource
    UpdateGroup
    UpdateSamplingRule✔️pro

    Terminology

    • Internal Test Suite: tested by LocalStack's internal integration test suite
    • External Test Suite: covered by an external integration test suite, that runs against LocalStack
    • Terraform Validated: operation tested with Terraform
    • AWS Validated: the integration test that includes this operation call was validated against AWS
    • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

    Testing Details

    This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

    How to read the test details?

    For each operation we put up a list of the related integration test cases.
    Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

    • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
    • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
      • test name
      • status code returned (which is the expected one for the test case)
      • information about validation:
        • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
        • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


    Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)
    \ No newline at end of file diff --git a/references/coverage/index.html b/references/coverage/index.html index 7f2fb18648..b34713419a 100644 --- a/references/coverage/index.html +++ b/references/coverage/index.html @@ -155,10 +155,10 @@
  • +

    • LocalStack Coverage

    Overview of the implemented AWS APIs in LocalStack
    AWS Account Management

    Implementation details for API account

    ACM (AWS Certificate Manager)

    Implementation details for API acm

    AWS Private Certificate Authority (CA)

    Implementation details for API acm-pca

    Amplify

    Implementation details for API amplify

    API Gateway

    Implementation details for API apigateway

    API Gateway Management API

    Implementation details for API apigatewaymanagementapi

    API Gateway v2

    Implementation details for API apigatewayv2

    AppConfig

    Implementation details for API appconfig

    AppConfig Data

    Implementation details for API appconfigdata

    Application Auto Scaling

    Implementation details for API application-autoscaling

    AppSync

    Implementation details for API appsync

    Athena

    Implementation details for API athena

    Auto Scaling

    Implementation details for API autoscaling

    Backup

    Implementation details for API backup

    Batch

    Implementation details for API batch

    CE (Cost Explorer API)

    Implementation details for API ce

    CloudFormation

    Implementation details for API cloudformation

    CloudFront

    Implementation details for API cloudfront

    CloudTrail

    Implementation details for API cloudtrail

    CloudWatch

    Implementation details for API cloudwatch

    CodeCommit

    Implementation details for API codecommit

    Cognito Identity

    Implementation details for API cognito-identity

    Cognito IDP (Cognito User Pools API)

    Implementation details for API cognito-idp

    Config

    Implementation details for API config

    DMS (Database Migration Service)

    Implementation details for API dms

    DocumentDB

    Implementation details for API docdb

    DynamoDB

    Implementation details for API dynamodb

    DynamoDB Streams

    Implementation details for API dynamodbstreams

    EC2 (Elastic Compute Cloud)

    Implementation details for API ec2

    ECR (Elastic Container Registry)

    Implementation details for API ecr

    ECS (Elastic Container Service)

    Implementation details for API ecs

    EFS (Elastic File System)

    Implementation details for API efs

    EKS (Elastic Kubernetes Service)

    Implementation details for API eks

    ElastiCache

    Implementation details for API elasticache

    Elastic Beanstalk

    Implementation details for API elasticbeanstalk

    elastictranscoder

    Implementation details for API elastictranscoder

    ELB (Elastic Load Balancer)

    Implementation details for API elb

    ELB v2 (Elastic Load Balancer v2)

    Implementation details for API elbv2

    EMR (Elastic MapReduce)

    Implementation details for API emr

    EMR (EMR Serverless)

    Implementation details for API emr-serverless

    ES (OpenSearch, legacy Elasticsearch)

    Implementation details for API es

    EventBridge

    Implementation details for API events

    Kinesis Data Firehose

    Implementation details for API firehose

    FIS (Fault Injection Simulator)

    Implementation details for API fis

    Glacier (S3 Glacier)

    Implementation details for API glacier

    Glue

    Implementation details for API glue

    IAM (Identity and Access Management)

    Implementation details for API iam

    identitystore

    Implementation details for API identitystore

    IoT (Internet of Things)

    Implementation details for API iot

    IoT Data

    Implementation details for API iot-data

    IoT Analytics

    Implementation details for API iotanalytics

    IoT Wireless

    Implementation details for API iotwireless

    MSK (Managed Streaming for Apache Kafka)

    Implementation details for API kafka

    Kinesis

    Implementation details for API kinesis

    Kinesis Data Analytics API

    Implementation details for API kinesisanalytics

    Kinesis Data Analytics API v2

    Implementation details for API kinesisanalyticsv2

    KMS (Key Management Service)

    Implementation details for API kms

    Lake Formation

    Implementation details for API lakeformation

    Lambda

    Implementation details for API lambda

    CloudWatch Logs

    Implementation details for API logs

    managedblockchain

    Implementation details for API managedblockchain

    Elemental MediaStore

    Implementation details for API mediastore

    Elemental MediaStore Data

    Implementation details for API mediastore-data

    MemoryDB for Redis

    Implementation details for API memorydb

    Amazon MQ

    Implementation details for API mq

    MWAA (Managed Workflows for Apache Airflow)

    Implementation details for API mwaa

    Neptune

    Implementation details for API neptune

    OpenSearch

    Implementation details for API opensearch

    Organizations

    Implementation details for API organizations

    pinpoint

    Implementation details for API pinpoint

    Pipes (EventBridge Pipes)

    Implementation details for API pipes

    QLDB (Quantum Ledger Database)

    Implementation details for API qldb

    QLDB Session (Quantum Ledger Database Session)

    Implementation details for API qldb-session

    ram (Resource Access Manager)

    Implementation details for API ram

    RDS (Relational Database Service)

    Implementation details for API rds

    RDS data (Relational Database Service Data)

    Implementation details for API rds-data

    Redshift

    Implementation details for API redshift

    Redshift Data

    Implementation details for API redshift-data

    Resource Groups

    Implementation details for API resource-groups

    Resource Groups Tagging API

    Implementation details for API resourcegroupstaggingapi

    Route 53

    Implementation details for API route53

    Route 53 Resolver

    Implementation details for API route53resolver

    S3 (Simple Storage Service)

    Implementation details for API s3

    S3 Control (Simple Storage Service Control)

    Implementation details for API s3control

    SageMaker

    Implementation details for API sagemaker

    SageMaker Runtime

    Implementation details for API sagemaker-runtime

    scheduler (EventBridge Scheduler)

    Implementation details for API scheduler

    Secrets Manager

    Implementation details for API secretsmanager

    Serverless Application Repository

    Implementation details for API serverlessrepo

    Service Discovery (Cloud Map)

    Implementation details for API servicediscovery

    SES (Simple Email Service)

    Implementation details for API ses

    SES v2 (Simple Email Service v2)

    Implementation details for API sesv2

    SNS (Simple Notification Service)

    Implementation details for API sns

    SQS (Simple Queue Service)

    Implementation details for API sqs

    SSM (Web Services Systems Manager)

    Implementation details for API ssm

    sso-admin (IAM Identity Center (successor to Single Sign-On))

    Implementation details for API sso-admin

    Step Functions

    Implementation details for API stepfunctions

    STS (Security Token Service)

    Implementation details for API sts

    Support API

    Implementation details for API support

    SWF (Simple Workflow Service)

    Implementation details for API swf

    textract

    Implementation details for API textract

    Timestream Query

    Implementation details for API timestream-query

    Timestream Write

    Implementation details for API timestream-write

    Transcribe

    Implementation details for API transcribe

    Transfer

    Implementation details for API transfer

    wafv2

    Implementation details for API wafv2

    X-Ray

    Implementation details for API xray

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    LocalStack Coverage

    Overview of the implemented AWS APIs in LocalStack
    AWS Account Management

    Implementation details for API account

    ACM (AWS Certificate Manager)

    Implementation details for API acm

    AWS Private Certificate Authority (CA)

    Implementation details for API acm-pca

    Amplify

    Implementation details for API amplify

    API Gateway

    Implementation details for API apigateway

    API Gateway Management API

    Implementation details for API apigatewaymanagementapi

    API Gateway v2

    Implementation details for API apigatewayv2

    AppConfig

    Implementation details for API appconfig

    AppConfig Data

    Implementation details for API appconfigdata

    Application Auto Scaling

    Implementation details for API application-autoscaling

    AppSync

    Implementation details for API appsync

    Athena

    Implementation details for API athena

    Auto Scaling

    Implementation details for API autoscaling

    Backup

    Implementation details for API backup

    Batch

    Implementation details for API batch

    CE (Cost Explorer API)

    Implementation details for API ce

    CloudFormation

    Implementation details for API cloudformation

    CloudFront

    Implementation details for API cloudfront

    CloudTrail

    Implementation details for API cloudtrail

    CloudWatch

    Implementation details for API cloudwatch

    CodeCommit

    Implementation details for API codecommit

    Cognito Identity

    Implementation details for API cognito-identity

    Cognito IDP (Cognito User Pools API)

    Implementation details for API cognito-idp

    Config

    Implementation details for API config

    DMS (Database Migration Service)

    Implementation details for API dms

    DocumentDB

    Implementation details for API docdb

    DynamoDB

    Implementation details for API dynamodb

    DynamoDB Streams

    Implementation details for API dynamodbstreams

    EC2 (Elastic Compute Cloud)

    Implementation details for API ec2

    ECR (Elastic Container Registry)

    Implementation details for API ecr

    ECS (Elastic Container Service)

    Implementation details for API ecs

    EFS (Elastic File System)

    Implementation details for API efs

    EKS (Elastic Kubernetes Service)

    Implementation details for API eks

    ElastiCache

    Implementation details for API elasticache

    Elastic Beanstalk

    Implementation details for API elasticbeanstalk

    elastictranscoder

    Implementation details for API elastictranscoder

    ELB (Elastic Load Balancer)

    Implementation details for API elb

    ELB v2 (Elastic Load Balancer v2)

    Implementation details for API elbv2

    EMR (Elastic MapReduce)

    Implementation details for API emr

    EMR (EMR Serverless)

    Implementation details for API emr-serverless

    ES (OpenSearch, legacy Elasticsearch)

    Implementation details for API es

    EventBridge

    Implementation details for API events

    Kinesis Data Firehose

    Implementation details for API firehose

    FIS (Fault Injection Simulator)

    Implementation details for API fis

    Glacier (S3 Glacier)

    Implementation details for API glacier

    Glue

    Implementation details for API glue

    IAM (Identity and Access Management)

    Implementation details for API iam

    identitystore

    Implementation details for API identitystore

    IoT (Internet of Things)

    Implementation details for API iot

    IoT Data

    Implementation details for API iot-data

    IoT Analytics

    Implementation details for API iotanalytics

    IoT Wireless

    Implementation details for API iotwireless

    MSK (Managed Streaming for Apache Kafka)

    Implementation details for API kafka

    Kinesis

    Implementation details for API kinesis

    Kinesis Data Analytics API

    Implementation details for API kinesisanalytics

    Kinesis Data Analytics API v2

    Implementation details for API kinesisanalyticsv2

    KMS (Key Management Service)

    Implementation details for API kms

    Lake Formation

    Implementation details for API lakeformation

    Lambda

    Implementation details for API lambda

    CloudWatch Logs

    Implementation details for API logs

    managedblockchain

    Implementation details for API managedblockchain

    Elemental MediaStore

    Implementation details for API mediastore

    Elemental MediaStore Data

    Implementation details for API mediastore-data

    MemoryDB for Redis

    Implementation details for API memorydb

    Amazon MQ

    Implementation details for API mq

    MWAA (Managed Workflows for Apache Airflow)

    Implementation details for API mwaa

    Neptune

    Implementation details for API neptune

    OpenSearch

    Implementation details for API opensearch

    Organizations

    Implementation details for API organizations

    pinpoint

    Implementation details for API pinpoint

    Pipes (EventBridge Pipes)

    Implementation details for API pipes

    QLDB (Quantum Ledger Database)

    Implementation details for API qldb

    QLDB Session (Quantum Ledger Database Session)

    Implementation details for API qldb-session

    ram (Resource Access Manager)

    Implementation details for API ram

    RDS (Relational Database Service)

    Implementation details for API rds

    RDS data (Relational Database Service Data)

    Implementation details for API rds-data

    Redshift

    Implementation details for API redshift

    Redshift Data

    Implementation details for API redshift-data

    Resource Groups

    Implementation details for API resource-groups

    Resource Groups Tagging API

    Implementation details for API resourcegroupstaggingapi

    Route 53

    Implementation details for API route53

    Route 53 Resolver

    Implementation details for API route53resolver

    S3 (Simple Storage Service)

    Implementation details for API s3

    S3 Control (Simple Storage Service Control)

    Implementation details for API s3control

    SageMaker

    Implementation details for API sagemaker

    SageMaker Runtime

    Implementation details for API sagemaker-runtime

    scheduler (EventBridge Scheduler)

    Implementation details for API scheduler

    Secrets Manager

    Implementation details for API secretsmanager

    Serverless Application Repository

    Implementation details for API serverlessrepo

    Service Discovery (Cloud Map)

    Implementation details for API servicediscovery

    SES (Simple Email Service)

    Implementation details for API ses

    SES v2 (Simple Email Service v2)

    Implementation details for API sesv2

    SNS (Simple Notification Service)

    Implementation details for API sns

    SQS (Simple Queue Service)

    Implementation details for API sqs

    SSM (Web Services Systems Manager)

    Implementation details for API ssm

    sso-admin (IAM Identity Center (successor to Single Sign-On))

    Implementation details for API sso-admin

    Step Functions

    Implementation details for API stepfunctions

    STS (Security Token Service)

    Implementation details for API sts

    Support API

    Implementation details for API support

    SWF (Simple Workflow Service)

    Implementation details for API swf

    textract

    Implementation details for API textract

    Timestream Query

    Implementation details for API timestream-query

    Timestream Write

    Implementation details for API timestream-write

    Transcribe

    Implementation details for API transcribe

    Transfer

    Implementation details for API transfer

    wafv2

    Implementation details for API wafv2

    X-Ray

    Implementation details for API xray

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/credentials/index.html b/references/credentials/index.html index 5fd3d7e4b6..21a28f9caf 100644 --- a/references/credentials/index.html +++ b/references/credentials/index.html @@ -155,10 +155,10 @@
  • +

    • Credentials

    Credentials for accessing LocalStack AWS API

      2 minute read  

    Like AWS, LocalStack requires access key IDs to be set in all operations. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Credentials

    Credentials for accessing LocalStack AWS API

      2 minute read  

    Like AWS, LocalStack requires access key IDs to be set in all operations. The choice of access key ID will affect multi-account namespacing. Values of secret access keys are currently ignored by LocalStack.

    Access key IDs can be one of following patterns:

    Accounts IDs

    You can specify a 12-digit number which will be taken by LocalStack as the account ID. For example, 112233445566.

    Structured access key ID

    You can specify a structured key like LSIAQAAAAAAVNCBMPNSG (which translates to account ID 000000000042). diff --git a/references/cross-account-access/index.html b/references/cross-account-access/index.html index 24b51804ce..44c8bb5b60 100644 --- a/references/cross-account-access/index.html +++ b/references/cross-account-access/index.html @@ -155,10 +155,10 @@

  • +

    • Cross-Account and Cross-Region Access

    Accessing resources in another account or region

      3 minute read  

    LocalStack automatically namespaces all resources based on the account ID and, in some cases, the region. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Cross-Account and Cross-Region Access

    Accessing resources in another account or region

      3 minute read  

    LocalStack automatically namespaces all resources based on the account ID and, in some cases, the region. However, there are certain resource types that can be accessed across multiple accounts or regions. This document provides information to help design such setups.

    Cross-account/cross-region access happens when a client attempts to access a resource in another account or region than what it is configured with:

    # Create a queue in one account and region
diff --git a/references/custom-tls-certificates/index.html b/references/custom-tls-certificates/index.html
index 54b2bc41d5..68373d0a55 100644
--- a/references/custom-tls-certificates/index.html
+++ b/references/custom-tls-certificates/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Custom TLS certificates

    Using custom TLS certificates with LocalStack
    Tags:

      3 minute read  

    Background

    LocalStack sometimes performs on-demand fetching of resources from the public internet. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Custom TLS certificates

    Using custom TLS certificates with LocalStack
    Tags:

      3 minute read  

    Background

    LocalStack sometimes performs on-demand fetching of resources from the public internet. This requires that LocalStack is able to access public URLs. If there is a proxy server in your network that uses a non-standard TLS certificate, LocalStack will not be able to download any files on demand. You may see errors in the logs relating to TLS such as “unable to get local issuer certificate”.

    There are three options when running LocalStack:

    1. creating a custom Docker image,
    2. using init hooks or
    3. when running in host mode.

    They all can be summarised as:

    1. get your proxy’s custom certificate into the system certificate store, and
    2. configure requests to use the custom certificate,
    3. configure curl to use the custom certificate, and
    4. configure node.js to use the custom certificate.

    Creating a custom docker image

    If you run LocalStack in a docker container (which includes using the CLI, docker, docker-compose, or helm), to include a custom TLS root certificate a new docker image should be created.

    Create a Dockerfile containing the following commands:

    FROM localstack/localstack:latest
diff --git a/references/docker-images/index.html b/references/docker-images/index.html
index 46bfea0a36..f474c08ae8 100644
--- a/references/docker-images/index.html
+++ b/references/docker-images/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Docker Images

    Overview of LocalStack Docker images and their purpose
    Tags:

      3 minute read  

    LocalStack functions as a local “mini-cloud” operating system that runs inside a Docker container. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Docker Images

    Overview of LocalStack Docker images and their purpose
    Tags:

      3 minute read  

    LocalStack functions as a local “mini-cloud” operating system that runs inside a Docker container. LocalStack has multiple components, which include process management, file system abstraction, event processing, schedulers, and more. Running inside a Docker container, LocalStack exposes external network ports for integrations, SDKs, or CLI interfaces to connect to LocalStack APIs. The LocalStack & LocalStack Pro Docker images have been downloaded over 130+ million times and provide a multi-arch build compatible with AMD/x86 and ARM-based CPU architectures. diff --git a/references/external-ports/index.html b/references/external-ports/index.html index 8878bb58cd..4e8c44f4f4 100644 --- a/references/external-ports/index.html +++ b/references/external-ports/index.html @@ -155,10 +155,10 @@

  • +

    • External Service Port Range

    The range of ports used by services not directly provided by LocalStack

      3 minute read  

    Introduction

    LocalStack provides local cloud services, such as OpenSearch or Elasticsearch, which might utilize external software bound to specific ports. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    External Service Port Range

    The range of ports used by services not directly provided by LocalStack

      3 minute read  

    Introduction

    LocalStack provides local cloud services, such as OpenSearch or Elasticsearch, which might utilize external software bound to specific ports. This documentation discusses two approaches to access these external services within LocalStack and explores the concept of an external service port range.

    Proxy Functionality for External Services

    LocalStack offers a proxy functionality to access external services indirectly. In this approach, LocalStack assigns local domains to the external services based on the individual service’s configuration.

    For instance, if OpenSearch is configured to use the OPENSEARCH_ENDPOINT_STRATEGY=domain setting, a cluster can be reached using the domain name <domain-name>.<region>.<engine-type>.localhost.localstack.cloud. Incoming messages to these domains are relayed to servers running on ports that do not require external accessibility.

    Direct Access with External Service Port Range

    An alternative approach to accessing external services is by utilizing the external service port range. diff --git a/references/filesystem/index.html b/references/filesystem/index.html index e415418712..53f3318bae 100644 --- a/references/filesystem/index.html +++ b/references/filesystem/index.html @@ -155,10 +155,10 @@

  • +

    • Filesystem Layout

    Overview of runtime directory structure

      3 minute read  

    This page describes the filesystem directory layout used internally by LocalStack.

    LocalStack uses following directory layout when running within a container.

    /
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Filesystem Layout

    Overview of runtime directory structure

      3 minute read  

    This page describes the filesystem directory layout used internally by LocalStack.

    LocalStack uses following directory layout when running within a container.

    /
 ├── etc
 │   └── localstack
 │       └── init
diff --git a/references/iam-coverage/index.html b/references/iam-coverage/index.html
index 93745f3308..e06dfc2dd1 100644
--- a/references/iam-coverage/index.html
+++ b/references/iam-coverage/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • IAM Coverage

    This page lists the IAM Enforcement Feature Coverage for LocalStack’s emulation of AWS services.

      4 minute read  

    Supported Services

    In principle, LocalStack supports all operations. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IAM Coverage

    This page lists the IAM Enforcement Feature Coverage for LocalStack’s emulation of AWS services.

      4 minute read  

    Supported Services

    In principle, LocalStack supports all operations. However, not all services and their operations have been tested yet. The table below lists all IAM services and operations that have been tested, noting if they were ever denied or allowed during testing. It only includes operations performed with a principal, not as root, so test setups are excluded.

    NameoperationAccess deniedAccess allowed
    acmListCertificatesYesYes
    apigatewayDeleteRestApiNoYes
    apigatewayCreateRestApiYesYes
    backupDescribeBackupVaultYesYes
    batchCreateComputeEnvironmentNoYes
    cloudformationListStacksYesYes
    cloudwatchPutMetricDataYesYes
    dynamodbDescribeTableNoYes
    dynamodbCreateTableYesYes
    dynamodbDeleteTableNoYes
    ecrDescribeImagesYesNo
    efsDescribeFileSystemsYesYes
    esDescribeElasticsearchDomainsYesYes
    eventsDeleteEventBusNoYes
    eventsPutEventsYesYes
    eventsCreateEventBusYesYes
    kinesisCreateStreamYesYes
    kinesisDeleteStreamNoYes
    kmsCreateKeyYesYes
    kmsDescribeKeyYesYes
    lambdaDeleteFunctionNoYes
    lambdaInvokeYesYes
    lambdaGetLayerVersionYesYes
    lambdaCreateFunctionYesYes
    logsCreateLogGroupYesYes
    logsPutLogEventsNoYes
    logsCreateLogStreamNoYes
    logsDeleteLogGroupNoYes
    redshiftDescribeClustersYesYes
    redshift-dataListDatabasesYesYes
    s3UploadPartNoYes
    s3GetObjectYesYes
    s3DeleteBucketNoYes
    s3CreateBucketYesYes
    s3ListBucketsYesYes
    s3CreateMultipartUploadYesYes
    s3CompleteMultipartUploadNoYes
    s3DeleteObjectNoYes
    s3ListObjectsYesYes
    s3PutObjectYesYes
    secretsmanagerCreateSecretYesYes
    secretsmanagerGetSecretValueYesYes
    secretsmanagerDeleteSecretNoYes
    snsPublishNoYes
    sqsGetQueueAttributesYesNo
    sqsCreateQueueYesYes
    sqsSendMessageYesYes
    sqsReceiveMessageYesYes
    sqsDeleteQueueNoYes
    stepfunctionsDeleteStateMachineNoYes
    stepfunctionsCreateStateMachineYesYes
    stsGetCallerIdentityNoYes

    Inter Service Enforcement

    Source ServiceTarget ServiceFeatureOperationImplementedTested
    snssqsSNS subscriptionsqs.SendMessageYesYes
    snslambdaSNS subscriptionlambda.InvokeYesYes
    lambdasqsEvent destinationssqs.SendMessageYesYes
    lambdalogsStoring Lambda logslogs.CreateLogGroup, logs.CreateLogStream, logs.PutLogEventsYesNo
    lambdasnsEvent destinationssns.PublishYesNo
    lambdasqsEvent source mappingYesYes
    lambdakinesisEvent source mappingYesYes
    lambdadynamodbEvent source mappingYesYes
    lambdakafkaEvent source mappingNoNo
    eventslambdaEvent rule targetYesYes
    snssesSNS subscriptionYesYes
    snsfirehoseSNS subscriptionYesYes
    eventssnsEvent rule targetYesYes
    eventssqsEvent rule targetYesYes
    eventslogsEvent rule targetYesYes
    eventsfirehoseEvent rule targetYesYes
    eventseventsEvent rule targetYesYes
    eventskinesisEvent rule targetYesYes
    eventsstepfunctionsEvent rule targetYesYes
    apigatewaylambdaAPI integrationYesYes
    apigatewaydynamodbAPI integrationYesYes
    apigatewaykinesisAPI integrationYesYes
    apigateways3API integrationNoNo
    apigatewaysnsAPI integrationNoYes
    apigatewaysqsAPI integrationYesYes
    apigatewaystepfunctionsAPI integrationNoNo
    apigatewayappsyncAPI integrationNoNo
    cloudformation*Resource ModificationNoNo
    lambdastsAssuming execution roleYesYes
    s3sqsBucket notificationYesYes
    s3snsBucket notificationYesYes

    Supported Policy Types

    Permission TypeDetails
    Identity Based Permissions
    - Roles
    - Users
    Resource Based Permissions
    - Lambda
    - ECR (Elastic Container Registry)
    - EFS (Elastic File System)
    - SQS (Simple Queue Service)
    - SNS (Simple Notification Service)
    - KMS (Key Management Service)
    - S3 (Simple Storage Service)
    - Backup
    - Events
    - Secrets Manager
    - IAM/STS (Identity and Access Management/Security Token Service)
    Permission Boundaries
    - Roles
    - Users

    Supported Policy Features

    CategoryDescription
    VersionNot evaluated, but only "2012-10-17" supported/tested.
    IdThe policy ID is currently ignored.
    StatementsSupported with the following policy elements:
    EffectFully supported. Allow + Deny
    SidCurrently ignored
    Action, NotActionSupported including placeholder *
    Principal, NotPrincipalSupported principals:
    - Service
    - (Assumed) role (ARN only)
    - User (ARN only)
    Organizations, Federated, CanonicalUsers etc. are currently not supported
    Resource, NotResourceIn general supported, including placeholders * and ?.
    No support for policy variables
    ConditionSupported condition operators:
    - StringEquals
    - StringEqualsIgnoreCase
    - StringLike
    - ArnLike/ArnEquals
    Supported condition keys:
    - aws:SourceArn

    Current Limitations

    • CloudFormation stack permissions do not work as expected.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/index.html b/references/index.html index e1f4b6a759..268bab5a04 100644 --- a/references/index.html +++ b/references/index.html @@ -155,10 +155,10 @@
  • +

    • References

    Learn about the references in this section for more technical descriptions about LocalStack and the related tools.

    The documents in this section are dedicated to the internals, the configuration options, and the limitations of LocalStack.
    The following figure shows an overview of the covered topics:


    Overview of LocalStack internals
    Network troubleshooting

    How to troubleshoot common network problems

    LocalStack Coverage

    Overview of the implemented AWS APIs in LocalStack

    Configuration

    Overview of configuration options in LocalStack

    Changelog

    This page lists new features, highlights, and bug fixes for official LocalStack releases.

    IAM Coverage

    This page lists the IAM Enforcement Feature Coverage for LocalStack’s emulation of AWS services.

    ARM64 Support

    Running LocalStack on ARM64 CPUs

    Credentials

    Credentials for accessing LocalStack AWS API

    Cross-Account and Cross-Region Access

    Accessing resources in another account or region

    Custom TLS certificates

    Using custom TLS certificates with LocalStack

    Docker Images

    Overview of LocalStack Docker images and their purpose

    External Service Port Range

    The range of ports used by services not directly provided by LocalStack

    Filesystem Layout

    Overview of runtime directory structure

    Initialization Hooks

    Writing shell or Python scripts to customize or initialize your LocalStack instance

    Internal Endpoints

    Overview of LocalStack and AWS specific internal endpoints for local development and testing

    Logging

    Overview of LocalStack logging and error reporting

    Multi-Account Setups

    Using LocalStack in multi-tenant setups

    Podman

    Running LocalStack inside Podman

    Usage Tracking

    Understand what data LocalStack collects and how you can opt out of usage tracking

    API Key (Deprecated)

    Configure your API key to start LocalStack

    Last modified February 3, 2023: Implement Consistent formatting (#452) (ce0cc12c9)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    References

    Learn about the references in this section for more technical descriptions about LocalStack and the related tools.

    The documents in this section are dedicated to the internals, the configuration options, and the limitations of LocalStack.
    The following figure shows an overview of the covered topics:


    Overview of LocalStack internals
    Network troubleshooting

    How to troubleshoot common network problems

    LocalStack Coverage

    Overview of the implemented AWS APIs in LocalStack

    Configuration

    Overview of configuration options in LocalStack

    Changelog

    This page lists new features, highlights, and bug fixes for official LocalStack releases.

    IAM Coverage

    This page lists the IAM Enforcement Feature Coverage for LocalStack’s emulation of AWS services.

    ARM64 Support

    Running LocalStack on ARM64 CPUs

    Credentials

    Credentials for accessing LocalStack AWS API

    Cross-Account and Cross-Region Access

    Accessing resources in another account or region

    Custom TLS certificates

    Using custom TLS certificates with LocalStack

    Docker Images

    Overview of LocalStack Docker images and their purpose

    External Service Port Range

    The range of ports used by services not directly provided by LocalStack

    Filesystem Layout

    Overview of runtime directory structure

    Initialization Hooks

    Writing shell or Python scripts to customize or initialize your LocalStack instance

    Internal Endpoints

    Overview of LocalStack and AWS specific internal endpoints for local development and testing

    Logging

    Overview of LocalStack logging and error reporting

    Multi-Account Setups

    Using LocalStack in multi-tenant setups

    Podman

    Running LocalStack inside Podman

    Usage Tracking

    Understand what data LocalStack collects and how you can opt out of usage tracking

    API Key (Deprecated)

    Configure your API key to start LocalStack

    Last modified February 3, 2023: Implement Consistent formatting (#452) (ce0cc12c9)
    \ No newline at end of file diff --git a/references/init-hooks/index.html b/references/init-hooks/index.html index 31cd3009cb..d0c0b27e54 100644 --- a/references/init-hooks/index.html +++ b/references/init-hooks/index.html @@ -155,10 +155,10 @@
  • +

    • Initialization Hooks

    Writing shell or Python scripts to customize or initialize your LocalStack instance

      6 minute read  

    Lifecycle stages and hooks

    LocalStack has four well-known lifecycle phases or stages:

    • BOOT: the container is running but the LocalStack runtime has not been started
    • START: the Python process is running and the LocalStack runtime is starting
    • READY: LocalStack is ready to serve requests
    • SHUTDOWN: LocalStack is shutting down

    You can hook into each of these lifecycle phases using custom shell or Python scripts. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Initialization Hooks

    Writing shell or Python scripts to customize or initialize your LocalStack instance

      6 minute read  

    Lifecycle stages and hooks

    LocalStack has four well-known lifecycle phases or stages:

    • BOOT: the container is running but the LocalStack runtime has not been started
    • START: the Python process is running and the LocalStack runtime is starting
    • READY: LocalStack is ready to serve requests
    • SHUTDOWN: LocalStack is shutting down

    You can hook into each of these lifecycle phases using custom shell or Python scripts. Each lifecycle phase has its own directory in /etc/localstack/init. You can mount individual files, stage directories, or the entire init directory from your host into the container.

    /etc
 └── localstack
diff --git a/references/internal-endpoints/index.html b/references/internal-endpoints/index.html
index c451f29b9f..4cd5ce3258 100644
--- a/references/internal-endpoints/index.html
+++ b/references/internal-endpoints/index.html
@@ -1,7 +1,7 @@
 Internal Endpoints | Docs
 
    Internal Endpoints
    Overview of LocalStack and AWS specific internal endpoints for local development and testing
    Tags:
      2 minute read  
    LocalStack provides several internal endpoints for various local AWS services and LocalStack-specific features.
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags
    Internal Endpoints
    Overview of LocalStack and AWS specific internal endpoints for local development and testing
    Tags:
      2 minute read  
    LocalStack provides several internal endpoints for various local AWS services and LocalStack-specific features.
 These endpoints are not part of the official AWS API and are available in the /_localstack and /_aws paths.
 You can use cURL or your favourite HTTP REST client to access endpoints.
    LocalStack endpoints
    The API path for the LocalStack internal resources is /_localstack.
-The following endpoints are available:
    EndpointDescription
    /_localstack/healthTo check the available and running AWS services in LocalStack. You can use the endpoint to restart the LocalStack services.
    /_localstack/pluginsShows the Plux plugins information in LocalStack.
    /_localstack/initShows the initialization status after setting up Init hooks.
    /_localstack/cloudformation/deployEnables you to deploy CloudFormation templates locally through a web interface.
    /_localstack/diagnoseReports extensive and sensitive data from LocalStack instance, enabled via the DEBUG=1 configuration variable.
    /_localstack/configEnables dynamic configuration updates at runtime, enabled via the ENABLE_CONFIG_UPDATES configuration variable.
    /_localstack/state/<service>/saveGet a snapshot of the given AWS service using the Persistence mechanism.
    /_localstack/state/<service>/loadLoad the most recent snapshot of the given service using the Persistence mechanism.
    /_localstack/state/resetReset the state of the services using the Persistence mechanism.
    /_localstack/state/<service>/resetReset the state of the given service using the Persistence mechanism.
    
\ No newline at end of file
+The following endpoints are available:
    EndpointDescription
    /_aws/lambda/runtimesList Lambda runtimes. See Lambda – Special Tools
    /_aws/sqs/messagesAccess all messages within a SQS queue
    /_aws/sns/platform-endpoint-messagesAccess and delete all the published SNS platform messages
    /_aws/sesAccess and delete all the sent SES emails
    /_aws/cloudwatch/metrics/rawAccess all the raw CloudWatch metrics
    /_aws/cognito-idpAccess the local Cognito login form
    /_aws/dynamodb/expiredTrigger the DynamoDB TTL worker at convenience
    Last modified July 25, 2024: Update chaos engg docs with recent product changes (#1256) (0e4708aff)
    \ No newline at end of file diff --git a/references/lambda-provider-v2/index.html b/references/lambda-provider-v2/index.html index a27bb73221..35f579e14b 100644 --- a/references/lambda-provider-v2/index.html +++ b/references/lambda-provider-v2/index.html @@ -155,10 +155,10 @@
  • +

    • Lambda Provider Behavioral Changes

    Behavioral changes of the new lambda provider

      less than a minute  

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    Lambda Provider Behavioral Changes

    Behavioral changes of the new lambda provider

      less than a minute  

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/logging/index.html b/references/logging/index.html index e511617ef7..9d5cfca49e 100644 --- a/references/logging/index.html +++ b/references/logging/index.html @@ -155,10 +155,10 @@
  • +

    • Logging

    Overview of LocalStack logging and error reporting
    Tags:

      2 minute read  

    LocalStack supports logging output and error reporting through the localstack CLI or a Docker/Docker Compose based setup. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Logging

    Overview of LocalStack logging and error reporting
    Tags:

      2 minute read  

    LocalStack supports logging output and error reporting through the localstack CLI or a Docker/Docker Compose based setup. LocalStack’s logging setup allows you to:

    • Discover errors in your code during development & testing.
    • Get visibility into how and why your API calls are failing.
    • Figure out unexpected errors such as Lambda timeouts and more!

    With LocalStack logging, you can easily retrieve additional detail around errors using various configuration variables to specify the verbosity and the log level.

    Log Level

    You can explicitly set a log level via two configuration variables: DEBUG and LS_LOG. You can configure them while starting the LocalStack container, either with the CLI or a Docker/Docker-Compose setup.

    DEBUG can be either 0 or 1 (0 is the default). With DEBUG, you can print more verbose logs, useful for troubleshooting issues. diff --git a/references/multi-account-setups/index.html b/references/multi-account-setups/index.html index 9ef6bf1517..e3456a2b15 100644 --- a/references/multi-account-setups/index.html +++ b/references/multi-account-setups/index.html @@ -155,10 +155,10 @@

  • +

    • Multi-Account Setups

    Using LocalStack in multi-tenant setups

      less than a minute  

    Table of Contents
    Categories
    Persistence
    Tags

    Multi-Account Setups

    Using LocalStack in multi-tenant setups

      less than a minute  

    LocalStack ships with multi-account support which allows namespacing based on AWS account ID.

    LocalStack uses the value in the AWS Access Key ID field for the purpose of namespacing over account ID. For more information, see Credentials.

    The Access Key ID field can be configured in the AWS CLI in multiple ways: please refer to AWS CLI documentation.

    Examples

    In following examples, we configure the AWS CLI account ID via environment variable.

    $ AWS_ACCESS_KEY_ID=000000000001 awslocal ec2 create-key-pair --key-name green-hospital
 
diff --git a/references/network-troubleshooting/created-resources/index.html b/references/network-troubleshooting/created-resources/index.html
index 92b9dd7efa..75190e4e66 100644
--- a/references/network-troubleshooting/created-resources/index.html
+++ b/references/network-troubleshooting/created-resources/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Accessing a resource created by LocalStack

    Tags:

      2 minute read  

    If you have created a resource using LocalStack, such as an OpenSearch cluster or RDS database, you may need to access it from your application. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Accessing a resource created by LocalStack

    Tags:

      2 minute read  

    If you have created a resource using LocalStack, such as an OpenSearch cluster or RDS database, you may need to access it from your application. Typically, these resources are accessible through a URL or a hostname provided by LocalStack. By default, LocalStack returns the hostname localhost.localstack.cloud, which resolves to LocalStack using DNS. For special environments (e.g., proxies), the configuration LOCALSTACK_HOST customizes the URLs returned by LocalStack. diff --git a/references/network-troubleshooting/endpoint-url/index.html b/references/network-troubleshooting/endpoint-url/index.html index 0e8173d827..7a2c593d54 100644 --- a/references/network-troubleshooting/endpoint-url/index.html +++ b/references/network-troubleshooting/endpoint-url/index.html @@ -154,10 +154,10 @@

  • +

    • Accessing LocalStack via the endpoint URL

    Tags:

      5 minute read  

    This documentation provides step-by-step guidance on how to access LocalStack services via the endpoint URL and troubleshoot common issues.

    From the same computer

    Suppose you have LocalStack installed on your machine and want to access it using the AWS CLI. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Accessing LocalStack via the endpoint URL

    Tags:

      5 minute read  

    This documentation provides step-by-step guidance on how to access LocalStack services via the endpoint URL and troubleshoot common issues.

    From the same computer

    Suppose you have LocalStack installed on your machine and want to access it using the AWS CLI. To connect, you must expose port 4566 from your LocalStack instance and connect to localhost or a domain name that points to localhost. While the LocalStack CLI does this automatically, when running the Docker container directly or with docker compose, you must configure it manually. Check out the getting started documentation for more information.

    You can also use the GATEWAY_LISTEN configuration variable to change the exposed port if necessary.

    From a container LocalStack created

    Suppose your code is running inside an ECS container that LocalStack has created.

    The LocalStack instance is available at the domain localhost.localstack.cloud. diff --git a/references/network-troubleshooting/index.html b/references/network-troubleshooting/index.html index 593b11eea8..9c06229898 100644 --- a/references/network-troubleshooting/index.html +++ b/references/network-troubleshooting/index.html @@ -155,10 +155,10 @@

  • +

    • Network troubleshooting

    How to troubleshoot common network problems
    Tags:

      less than a minute  

    If you have difficulties connecting your application code to LocalStack, please choose the scenario below that best describes your networking layout.

    Using the endpoint URL

    For example, setting the endpoint_url parameter with an AWS SDK.

    From the same computer

    From a container LocalStack created

    From your container

    From a separate host

    Using transparent endpoint injection

    See the lambda documentation for more information about the capability.

    From your host

    From a lambda function

    Accessing a resource created by LocalStack

    For example, you have created an OpenSearch cluster and are trying to access that resource by its URL.

    From your host

    From a container LocalStack created

    From your container

    From a separate host

    Accessing LocalStack via the endpoint URL

    Transparent endpoint injection

    Accessing a resource created by LocalStack

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Network troubleshooting

    How to troubleshoot common network problems
    Tags:

      less than a minute  

    If you have difficulties connecting your application code to LocalStack, please choose the scenario below that best describes your networking layout.

    Using the endpoint URL

    For example, setting the endpoint_url parameter with an AWS SDK.

    From the same computer

    From a container LocalStack created

    From your container

    From a separate host

    Using transparent endpoint injection

    See the lambda documentation for more information about the capability.

    From your host

    From a lambda function

    Accessing a resource created by LocalStack

    For example, you have created an OpenSearch cluster and are trying to access that resource by its URL.

    From your host

    From a container LocalStack created

    From your container

    From a separate host

    Accessing LocalStack via the endpoint URL

    Transparent endpoint injection

    Accessing a resource created by LocalStack

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/network-troubleshooting/readme/index.html b/references/network-troubleshooting/readme/index.html index bc4492ea83..23beeabcf7 100644 --- a/references/network-troubleshooting/readme/index.html +++ b/references/network-troubleshooting/readme/index.html @@ -152,10 +152,10 @@
  • +

    •   less than a minute  

    README for the network troubleshooting section

    Images for the Network Troubleshooting section are generated using the d2 tool. + Create project issue

    Categories
    Persistence
    Tags

      less than a minute  

    README for the network troubleshooting section

    Images for the Network Troubleshooting section are generated using the d2 tool. Install using your package manager, then run make in the content/en/references/network-troubleshooting directory.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/network-troubleshooting/transparent-endpoint-injection/index.html b/references/network-troubleshooting/transparent-endpoint-injection/index.html index 66b1fea81e..ad1e650ab4 100644 --- a/references/network-troubleshooting/transparent-endpoint-injection/index.html +++ b/references/network-troubleshooting/transparent-endpoint-injection/index.html @@ -156,10 +156,10 @@
  • +

    • Transparent endpoint injection

    Tags:

      less than a minute  

    Suppose you’re attempting to access LocalStack, but you’re relying on transparent endpoint injection to redirect AWS (*.amazonaws.com) requests. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Transparent endpoint injection

    Tags:

      less than a minute  

    Suppose you’re attempting to access LocalStack, but you’re relying on transparent endpoint injection to redirect AWS (*.amazonaws.com) requests. In such cases, there are different approaches you can take depending on your setup.

    From your host

    If you’re using LocalStack with an auth token, then you can utilize the DNS server to perform requests to LocalStack as if it were AWS. You need to make two changes:

    • Publish port 53 from the LocalStack docker container to your host.
    • Configure your host to use the LocalStack DNS server by default.

    For more details, see your DNS server documentation.

    For the community image of LocalStack, you can employ your own DNS server to achieve a similar outcome, but it won’t be managed by LocalStack. Note that in both cases, SSL verification must be disabled.

    From a lambda function

    Check out our documentation on using transparent endpoint injection for Lambda in LocalStack.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/references/podman/index.html b/references/podman/index.html index 861952ccdc..3f00696db7 100644 --- a/references/podman/index.html +++ b/references/podman/index.html @@ -155,10 +155,10 @@
  • +

    • Podman

    Running LocalStack inside Podman

      3 minute read  

    Introduction

    By default, the LocalStack CLI starts the LocalStack runtime inside a Docker container. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Podman

    Running LocalStack inside Podman

      3 minute read  

    Introduction

    By default, the LocalStack CLI starts the LocalStack runtime inside a Docker container. Docker may not be available on your system, and a popular alternative is Podman which you can use to run LocalStack. Podman support is still experimental, and the following docs give you an overview of the current state.

    From the Podman docs:

    Podman is a daemonless, open source, Linux native tool designed to make it easy to find, run, build, share and deploy applications using Open Containers Initiative (OCI) Containers and Container Images. Podman provides a command line interface (CLI) familiar to anyone who has used the Docker Container Engine. diff --git a/references/usage-tracking/index.html b/references/usage-tracking/index.html index a02038e5a0..ce406c57ff 100644 --- a/references/usage-tracking/index.html +++ b/references/usage-tracking/index.html @@ -155,10 +155,10 @@

  • +

    • Usage Tracking

    Understand what data LocalStack collects and how you can opt out of usage tracking

      3 minute read  

    Overview

    For license activations, we track the timestamp and the licensing credentials. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Usage Tracking

    Understand what data LocalStack collects and how you can opt out of usage tracking

      3 minute read  

    Overview

    For license activations, we track the timestamp and the licensing credentials. We need to do this to make CI credits work. It is tracked regardless of whether the user disables event tracking since we collect this in the backend, not the client.

    LocalStack usage statistics

    For Pro users, most of the information is collected to populate the Stack Insights dashboard. Collecting basic anonymized usage of AWS services helps us better direct engineering efforts to services that are used the most or cause the most issues.

    Session information

    The current usage event collection on the client side includes:

    • A randomly generated ID pertaining to the session
    • The auth token or legacyAPI key (if any)
    • A randomly generated machine ID is kept throughout the session but deleted once the LocalStack cache directory is removed
    • The operating system (mostly Linux since LocalStack typically runs in our Debian container)
    • The LocalStack version being used
    • Whether LocalStack is running in a CI environment
    • Whether LocalStack is running in Docker
    • Whether this is an internal test run (LocalStack development flag)

    Here is an example of a usage event:

    {
diff --git a/sitemap.xml b/sitemap.xml
index 2f03234d6f..41262093cb 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-/user-guide/lambda-tools/hot-reloading/2024-07-18T20:24:20+05:30/user-guide/aws/feature-coverage/2024-07-18T20:24:20+05:30/references/network-troubleshooting/endpoint-url/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/2024-07-18T20:24:20+05:30/academy/localstack-101/course-overview/2024-04-10T21:36:53-07:00/academy/localstack-deployment/course-overview/2024-04-10T21:36:53-07:00/user-guide/cloud-sandbox/ephemeral-instance/2024-07-18T23:00:32+05:30/user-guide/extensions/getting-started/2024-07-18T20:24:20+05:30/user-guide/security-testing/iam-enforcement/2024-07-18T20:24:20+05:30/user-guide/aws/2022-12-01T14:30:06+05:30/references/network-troubleshooting/2024-07-18T20:24:20+05:30/developer-hub/2023-03-30T17:05:01+02:00/overview/2024-01-26T21:31:43+05:30/tutorials/schema-evolution-glue-msk/2024-07-18T20:24:20+05:30/legal/third-party-software-tools/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/fault-injection-service/2024-07-18T20:24:20+05:30/user-guide/cloud-sandbox/application-previews/2024-07-23T18:12:24+05:30/user-guide/chaos-engineering/web-application-dashboard/2024-07-18T20:24:20+05:30/user-guide/state-management/cloud-pods/2024-07-24T20:46:26+05:30/academy/localstack-deployment/deploy-app-ls/2024-07-18T20:24:20+05:30/tutorials/lambda-ecr-container-images/2024-07-18T20:24:20+05:30/user-guide/security-testing/explainable-iam/2024-07-18T20:24:20+05:30/getting-started/2024-07-18T20:24:20+05:30/user-guide/integrations/2022-12-01T14:30:06+05:30/user-guide/extensions/managing-extensions/2024-07-24T17:43:26+05:30/user-guide/state-management/persistence/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/debugging/2024-07-18T20:24:20+05:30/references/network-troubleshooting/transparent-endpoint-injection/2024-07-18T20:24:20+05:30/academy/localstack-101/what-is-localstack/2024-07-18T20:24:20+05:30/references/network-troubleshooting/created-resources/2023-11-09T11:28:48+01:00/tutorials/java-notification-app/2024-07-18T20:24:20+05:30/user-guide/ci/2024-07-18T20:24:20+05:30/user-guide/extensions/developing-extensions/2024-07-18T20:24:20+05:30/user-guide/state-management/export-import-state/2024-07-18T20:24:20+05:30/user-guide/extensions/2024-07-18T20:24:20+05:30/user-guide/security-testing/iam-policy-stream/2024-07-18T20:24:20+05:30/academy/localstack-deployment/ls-integrations/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/outages-extension/2024-07-18T20:24:20+05:30/tutorials/elb-load-balancing/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/vscode-extension/2024-07-18T20:24:20+05:30/academy/localstack-101/why-localstack/2024-07-18T20:24:20+05:30/user-guide/ci/circle-ci/2024-07-18T20:24:20+05:30/academy/localstack-deployment/infra-terraform/2024-07-18T20:24:20+05:30/user-guide/extensions/extensions-library/2024-07-18T20:24:20+05:30/academy/localstack-101/getting-started/2024-07-18T20:24:20+05:30/tutorials/s3-static-website-terraform/2024-07-18T20:24:20+05:30/user-guide/state-management/launchpad/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/special-configs/2024-07-18T20:24:20+05:30/user-guide/ci/bitbucket/2024-07-18T20:24:20+05:30/user-guide/state-management/pods-cli/2024-07-18T20:24:20+05:30/academy/localstack-deployment/infra-cloudformation/2024-07-18T20:24:20+05:30/tutorials/reproducible-machine-learning-cloud-pods/2024-07-18T20:24:20+05:30/user-guide/ci/github-actions/2024-07-18T20:24:20+05:30/references/lambda-provider-v2/2024-07-18T20:24:20+05:30/references/coverage/2024-07-18T20:24:20+05:30/user-guide/extensions/official-extensions/2024-05-15T17:29:55+05:30/user-guide/web-application/single-sign-on/azure-ad/2024-07-18T20:24:20+05:30/user-guide/tools/testing-utils/2024-07-18T20:24:20+05:30/academy/localstack-101/web-app-resource-browser/2024-07-18T20:24:20+05:30/tutorials/ecs-ecr-container-app/2024-07-18T20:24:20+05:30/academy/localstack-101/full-project-demo/2024-07-18T20:24:20+05:30/user-guide/ci/gitlab-ci/2024-07-23T09:21:53-07:00/academy/localstack-101/2023-08-23T14:33:03+05:00/academy/localstack-deployment/iam-policy-stream/2024-07-18T20:24:20+05:30/academy/localstack-101/cloud-pods/2024-07-18T20:24:20+05:30/user-guide/ci/codebuild/2024-07-18T20:24:20+05:30/tutorials/cloud-pods-collaborative-debugging/2024-07-18T20:24:20+05:30/user-guide/tools/localsurf/2024-07-18T20:24:20+05:30/tutorials/replicate-aws-resources-localstack-extension/2024-07-18T20:24:20+05:30/academy/localstack-deployment/github-action-ls/2024-07-18T20:24:20+05:30/user-guide/ci/travis-ci/2024-07-18T20:24:20+05:30/user-guide/2023-11-09T13:00:00+05:30/tutorials/fault-injection-service-experiments/2024-07-18T20:24:20+05:30/academy/localstack-deployment/cloud-pods/2024-07-18T20:24:20+05:30/tutorials/ephemeral-application-previews/2024-07-18T20:24:20+05:30/academy/localstack-development/2024-02-19T15:56:51+05:30/user-guide/tools/localstack-desktop/2024-07-18T20:24:20+05:30/user-guide/tools/localstack-docker-extension/2024-07-18T20:24:20+05:30/tutorials/route53-failover-with-fis/2024-07-18T20:24:20+05:30/user-guide/web-application/accounts/2024-07-18T20:24:20+05:30/tutorials/simulating-outages-in-your-application-stack/2024-07-18T20:24:20+05:30/references/configuration/2024-07-18T20:24:20+05:30/getting-started/installation/2024-07-18T20:24:20+05:30/user-guide/state-management/2024-07-18T20:24:20+05:30/user-guide/tools/transparent-endpoint-injection/2024-07-22T13:56:05-04:00/tutorials/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/2024-07-18T20:24:20+05:30/user-guide/tools/dns-server/2024-07-18T20:24:20+05:30/user-guide/security-testing/2024-07-18T20:24:20+05:30/references/changelog/2024-06-13T19:54:44+05:30/user-guide/cloud-sandbox/2024-07-23T18:12:24+05:30/references/iam-coverage/2024-07-18T20:24:20+05:30/tutorials/gitlab_ci_testcontainers/2024-07-18T20:24:20+05:30/tutorials/using-terraform-with-testcontainers-and-localstack/2024-07-23T04:59:24-07:00/tutorials/iam-policy-stream/2024-07-18T20:24:20+05:30/applications/2023-03-30T17:05:01+02:00/getting-started/auth-token/2024-07-18T20:24:20+05:30/user-guide/web-application/workspaces/2024-07-18T20:24:20+05:30/academy/2023-08-23T14:33:03+05:00/user-guide/web-application/users-licences/2024-07-18T20:24:20+05:30/getting-started/quickstart/2024-07-18T20:24:20+05:30/getting-started/faq/2024-07-18T20:24:20+05:30/user-guide/tools/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/2024-07-18T20:24:20+05:30/references/arm64-support/2024-07-18T20:24:20+05:30/references/credentials/2024-05-17T16:27:59+05:30/references/cross-account-access/2024-07-18T20:24:20+05:30/references/custom-tls-certificates/2024-07-18T20:24:20+05:30/references/docker-images/2024-07-18T20:24:20+05:30/references/external-ports/2024-07-18T20:24:20+05:30/references/filesystem/2024-07-18T20:24:20+05:30/references/init-hooks/2024-07-23T04:59:24-07:00/references/internal-endpoints/2024-07-18T20:24:20+05:30/user-guide/web-application/2023-11-16T14:25:42+01:00/references/logging/2024-07-18T20:24:20+05:30/references/multi-account-setups/2024-07-18T20:24:20+05:30/references/podman/2024-07-18T20:24:20+05:30/references/2023-02-03T15:18:39+05:30/references/usage-tracking/2024-07-18T20:24:20+05:30/getting-started/help-and-support/2024-07-18T20:24:20+05:30/user-guide/web-application/resource-browser/2024-07-18T20:24:20+05:30/user-guide/web-application/instance-management/2024-07-18T20:24:20+05:30/user-guide/web-application/stack-insights/2024-07-18T20:24:20+05:30/user-guide/web-application/ci-analytics/2024-07-18T20:24:20+05:30/user-guide/web-application/ci-keys/2024-07-18T20:24:20+05:30/references/api-key/2024-07-18T20:24:20+05:30/user-guide/web-application/single-sign-on/2024-07-18T20:24:20+05:30/applications/temp/2023-03-30T17:05:01+02:00/contributing/2024-05-08T14:32:30+05:30/references/network-troubleshooting/readme/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/dotnet/2024-07-18T20:24:20+05:30/references/coverage/coverage_account/2024-07-22T19:56:23+02:00/user-guide/aws/account/2024-07-18T20:24:20+05:30/references/coverage/coverage_acm/2024-07-22T19:56:23+02:00/references/coverage/coverage_acm-pca/2024-07-22T19:56:23+02:00/applications/amazon-rds-initialization-using-cdk-lambda-ecr-and-secrets-manager/2023-06-28T15:22:44+05:00/references/coverage/coverage_amplify/2024-07-22T19:56:23+02:00/user-guide/aws/amplify/2024-07-18T20:24:20+05:30/tags/api-gateway/2024-07-18T20:24:20+05:30/user-guide/aws/apigateway/2024-07-18T20:24:20+05:30/references/coverage/coverage_apigateway/2024-07-22T19:56:23+02:00/references/coverage/coverage_apigatewaymanagementapi/2024-07-22T19:56:23+02:00/references/coverage/coverage_apigatewayv2/2024-07-22T19:56:23+02:00/references/coverage/coverage_appconfig/2024-07-22T19:56:23+02:00/user-guide/aws/appconfig/2024-07-18T20:24:20+05:30/references/coverage/coverage_appconfigdata/2024-07-22T19:56:23+02:00/user-guide/aws/applicationautoscaling/2024-07-18T20:24:20+05:30/references/coverage/coverage_application-autoscaling/2024-07-22T19:56:23+02:00/references/coverage/coverage_appsync/2024-07-22T19:56:23+02:00/tags/appsync/2023-06-28T15:22:44+05:00/user-guide/aws/appsync/2024-07-18T20:24:20+05:30/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/2023-06-28T15:22:44+05:00/user-guide/integrations/architect/2024-07-18T20:24:20+05:30/references/coverage/coverage_athena/2024-07-22T19:56:23+02:00/user-guide/aws/athena/2024-07-18T20:24:20+05:30/user-guide/aws/autoscaling/2024-07-18T20:24:20+05:30/references/coverage/coverage_autoscaling/2024-07-22T19:56:23+02:00/user-guide/integrations/aws-cdk/2024-07-18T20:24:20+05:30/user-guide/integrations/chalice/2024-07-18T20:24:20+05:30/user-guide/integrations/aws-cli/2024-07-18T20:24:20+05:30/user-guide/integrations/copilot/2024-07-18T20:24:20+05:30/tags/aws-java-sdk/2024-07-18T20:24:20+05:30/user-guide/integrations/aws-sam/2024-07-18T20:24:20+05:30/references/coverage/coverage_backup/2024-07-22T19:56:23+02:00/user-guide/aws/backup/2024-07-18T20:24:20+05:30/tags/bash/2024-07-18T20:24:20+05:30/references/coverage/coverage_batch/2024-07-22T19:56:23+02:00/user-guide/aws/batch/2024-07-18T20:24:20+05:30/tags/big-data/2023-06-28T15:22:44+05:00/user-guide/integrations/sdks/cpp/2024-03-19T14:46:00+05:30/categories/2024-07-23T08:31:37+05:30/references/coverage/coverage_ce/2024-07-22T19:56:23+02:00/user-guide/aws/acm/2024-07-18T20:24:20+05:30/user-guide/integrations/cloud-custodian/2024-07-18T20:24:20+05:30/tags/cloud-pods/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudformation/2024-07-22T19:56:23+02:00/tags/cloudformation/2024-07-18T20:24:20+05:30/user-guide/aws/cloudformation/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudfront/2024-07-22T19:56:23+02:00/user-guide/aws/cloudfront/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudtrail/2024-07-22T19:56:23+02:00/user-guide/aws/cloudtrail/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudwatch/2024-07-22T19:56:23+02:00/tags/cloudwatch/2024-07-18T20:24:20+05:30/user-guide/aws/cloudwatch/2024-07-19T08:12:53+02:00/user-guide/aws/logs/2024-07-18T20:24:20+05:30/references/coverage/coverage_codecommit/2024-07-22T19:56:23+02:00/user-guide/aws/codecommit/2024-07-18T20:24:20+05:30/user-guide/aws/cognito/2024-07-18T20:24:20+05:30/references/coverage/coverage_cognito-identity/2024-07-22T19:56:23+02:00/references/coverage/coverage_cognito-idp/2024-07-22T19:56:23+02:00/tags/compliance/2023-06-28T15:22:44+05:00/references/coverage/coverage_config/2024-07-22T19:56:23+02:00/user-guide/aws/config/2024-05-29T13:37:58+05:30/tags/container/2024-07-18T20:24:20+05:30/tags/container-image/2024-07-18T20:24:20+05:30/user-guide/aws/ce/2024-07-18T20:24:20+05:30/user-guide/integrations/crossplane/2024-07-18T20:24:20+05:30/tags/data-analytics/2023-06-28T15:22:44+05:00/user-guide/aws/dms/2024-07-18T21:18:11+05:30/tags/databases/2023-06-28T15:22:44+05:00/references/coverage/coverage_dms/2024-07-22T19:56:23+02:00/references/coverage/coverage_docdb/2024-07-22T19:56:23+02:00/tags/docker/2024-07-18T20:24:20+05:30/tags/docker-in-docker/2024-07-18T20:24:20+05:30/2021-10-08T11:40:02+02:00/user-guide/aws/docdb/2024-07-18T20:24:20+05:30/references/coverage/coverage_dynamodb/2024-07-22T19:56:23+02:00/tags/dynamodb/2024-07-18T20:24:20+05:30/user-guide/aws/dynamodb/2024-07-23T15:17:50+09:00/user-guide/aws/dynamodbstreams/2024-07-18T20:24:20+05:30/references/coverage/coverage_dynamodbstreams/2024-07-22T19:56:23+02:00/references/coverage/coverage_ec2/2024-07-22T19:56:23+02:00/references/coverage/coverage_ecr/2024-07-22T19:56:23+02:00/tags/ecr/2024-07-18T20:24:20+05:30/references/coverage/coverage_ecs/2024-07-22T19:56:23+02:00/tags/ecs/2024-07-18T20:24:20+05:30/references/coverage/coverage_efs/2024-07-22T19:56:23+02:00/references/coverage/coverage_eks/2024-07-22T19:56:23+02:00/user-guide/integrations/eksctl/2024-07-18T20:24:20+05:30/user-guide/aws/elasticbeanstalk/2024-07-18T20:24:20+05:30/user-guide/aws/ec2/2024-07-18T20:24:20+05:30/user-guide/aws/ecr/2024-07-18T20:24:20+05:30/user-guide/aws/ecs/2024-07-23T08:31:37+05:30/user-guide/aws/efs/2024-07-18T20:24:20+05:30/user-guide/aws/eks/2024-07-18T20:24:20+05:30/tags/elastic-load-balancing/2024-07-18T20:24:20+05:30/user-guide/aws/elb/2024-07-18T20:24:20+05:30/user-guide/aws/emr/2024-07-18T20:24:20+05:30/user-guide/aws/elastictranscoder/2024-07-18T20:24:20+05:30/references/coverage/coverage_elasticache/2024-07-22T19:56:23+02:00/user-guide/aws/elasticache/2024-07-18T20:24:20+05:30/references/coverage/coverage_elasticbeanstalk/2024-07-22T19:56:23+02:00/user-guide/aws/es/2024-07-18T20:24:20+05:30/references/coverage/coverage_elastictranscoder/2024-07-22T19:56:23+02:00/references/coverage/coverage_elb/2024-07-22T19:56:23+02:00/references/coverage/coverage_elbv2/2024-07-22T19:56:23+02:00/user-guide/aws/mediastore/2024-07-18T20:24:20+05:30/references/coverage/coverage_emr/2024-07-22T19:56:23+02:00/references/coverage/coverage_emr-serverless/2024-07-22T19:56:23+02:00/tags/enterprise-plan/2024-07-18T21:18:11+05:30/references/coverage/coverage_es/2024-07-22T19:56:23+02:00/applications/event-driven-architecture-with-amazon-sns-fifo-dynamodb-lambda-and-s3/2023-06-28T15:22:44+05:00/tags/event-driven-architecture/2023-07-27T12:31:23+02:00/user-guide/aws/events/2024-07-18T20:24:20+05:30/user-guide/aws/pipes/2024-07-18T20:24:20+05:30/user-guide/aws/scheduler/2024-07-18T20:24:20+05:30/references/coverage/coverage_events/2024-07-22T19:56:23+02:00/tags/fargate/2024-07-18T20:24:20+05:30/user-guide/aws/fis/2024-07-18T20:24:20+05:30/references/coverage/coverage_firehose/2024-07-22T19:56:23+02:00/references/coverage/coverage_fis/2024-07-22T19:56:23+02:00/tags/fis/2024-07-18T20:24:20+05:30/user-guide/integrations/former2/2024-07-18T20:24:20+05:30/applications/full-stack-application-with-aws-lambda-dynamodb-s3-for-shipment-validation/2023-06-28T15:22:44+05:00/tags/gitlab/2024-07-18T20:24:20+05:30/tags/gitlab-runners/2024-07-18T20:24:20+05:30/user-guide/integrations/gitpod/2024-07-18T20:24:20+05:30/references/coverage/coverage_glacier/2024-07-22T19:56:23+02:00/user-guide/aws/glacier/2024-07-18T20:24:20+05:30/references/coverage/coverage_glue/2024-07-22T19:56:23+02:00/user-guide/aws/glue/2024-07-18T20:24:20+05:30/tags/glue-schema-registry/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/go/2024-07-18T20:24:20+05:30/tags/graphql/2023-06-28T15:22:44+05:00/references/coverage/coverage_iam/2024-07-22T19:56:23+02:00/tags/iam/2024-07-18T20:24:20+05:30/tags/identity/2023-06-28T15:22:44+05:00/user-guide/aws/iam/2024-07-18T20:24:20+05:30/user-guide/aws/identitystore/2024-07-18T20:24:20+05:30/references/coverage/coverage_identitystore/2024-07-22T19:56:23+02:00/tags/init-hooks/2024-07-23T04:59:24-07:00/tags/internal-endpoints/2024-07-18T20:24:20+05:30/references/coverage/coverage_iot/2024-07-22T19:56:23+02:00/user-guide/aws/iot/2024-07-18T20:24:20+05:30/user-guide/aws/iotanalytics/2024-07-18T20:24:20+05:30/user-guide/aws/iotwireless/2024-07-18T20:24:20+05:30/references/coverage/coverage_iot-data/2024-07-22T19:56:23+02:00/references/coverage/coverage_iotanalytics/2024-07-22T19:56:23+02:00/references/coverage/coverage_iotwireless/2024-07-22T19:56:23+02:00/tags/java/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/java/2024-07-18T20:24:20+05:30/tags/javascript/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/javascript/2024-07-18T20:24:20+05:30/references/coverage/coverage_kafka/2024-07-22T19:56:23+02:00/tags/kafka/2024-07-18T20:24:20+05:30/user-guide/aws/kms/2024-07-18T20:24:20+05:30/references/coverage/coverage_kinesis/2024-07-22T19:56:23+02:00/user-guide/aws/kinesis/2024-07-18T20:24:20+05:30/user-guide/aws/kinesisanalytics/2024-07-18T20:24:20+05:30/user-guide/aws/firehose/2024-07-18T20:24:20+05:30/references/coverage/coverage_kinesisanalytics/2024-07-22T19:56:23+02:00/references/coverage/coverage_kinesisanalyticsv2/2024-07-22T19:56:23+02:00/references/coverage/coverage_kms/2024-07-22T19:56:23+02:00/user-guide/integrations/kubernetes/2024-07-18T20:24:20+05:30/user-guide/aws/lakeformation/2024-07-18T20:24:20+05:30/references/coverage/coverage_lakeformation/2024-07-22T19:56:23+02:00/references/coverage/coverage_lambda/2024-07-22T19:56:23+02:00/tags/lambda/2024-07-18T20:24:20+05:30/user-guide/aws/lambda/2024-07-18T20:24:20+05:30/tags/lambda-layers/2024-07-18T20:24:20+05:30/tags/lambda-trigger/2023-06-28T15:22:44+05:00/user-guide/integrations/lambdatest-hyperexecute/2024-07-18T20:24:20+05:30/legal/2024-05-16T15:07:50+05:30/applications/loan-broker-application-with-aws-step-functions-dynamodb-lambda-sqs-and-sns/2023-06-28T15:22:44+05:00/categories/localstack-pro/2024-07-23T08:31:37+05:30/tags/localstack-endpoints/2024-07-18T20:24:20+05:30/tags/localsurf/2023-06-28T15:22:44+05:00/tags/logging/2024-07-18T20:24:20+05:30/references/coverage/coverage_logs/2024-07-22T19:56:23+02:00/tags/machine-learning/2024-07-18T20:24:20+05:30/user-guide/aws/managedblockchain/2024-07-18T20:24:20+05:30/user-guide/aws/msk/2024-07-18T20:24:20+05:30/user-guide/aws/mwaa/2024-07-18T20:24:20+05:30/references/coverage/coverage_managedblockchain/2024-07-22T19:56:23+02:00/references/coverage/coverage_mediastore/2024-07-22T19:56:23+02:00/references/coverage/coverage_mediastore-data/2024-07-22T19:56:23+02:00/references/coverage/coverage_memorydb/2024-07-22T19:56:23+02:00/user-guide/aws/memorydb/2024-07-18T20:24:20+05:30/applications/messaging-processing-application-with-sqs-dynamodb-and-fargate/2023-06-28T15:22:44+05:00/tags/microservices/2023-06-28T15:22:44+05:00/applications/mnist-handwritten-digit-recognition-model-running-on-a-local-sagemaker-endpoint/2023-06-28T15:22:44+05:00/references/coverage/coverage_mq/2024-07-22T19:56:23+02:00/user-guide/aws/mq/2024-07-18T20:24:20+05:30/tags/msk/2024-07-18T20:24:20+05:30/references/coverage/coverage_mwaa/2024-07-22T19:56:23+02:00/references/coverage/coverage_neptune/2024-07-22T19:56:23+02:00/user-guide/aws/neptune/2024-07-18T20:24:20+05:30/tags/networking/2024-07-18T20:24:20+05:30/tags/nginx/2024-07-18T20:24:20+05:30/tags/node.js/2024-07-18T20:24:20+05:30/applications/note-taking-application-using-aws-sdk-for-javascript/2023-06-28T15:22:44+05:00/references/coverage/coverage_opensearch/2024-07-22T19:56:23+02:00/user-guide/aws/opensearch/2024-07-18T20:24:20+05:30/user-guide/integrations/openshift/2024-07-18T20:24:20+05:30/references/coverage/coverage_organizations/2024-07-22T19:56:23+02:00/user-guide/aws/organizations/2024-07-18T20:24:20+05:30/persistence/2024-07-23T15:17:50+09:00/user-guide/state-management/support/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/php/2024-07-18T20:24:20+05:30/references/coverage/coverage_pinpoint/2024-07-22T19:56:23+02:00/user-guide/aws/pinpoint/2024-07-18T20:24:20+05:30/references/coverage/coverage_pipes/2024-07-22T19:56:23+02:00/user-guide/aws/pca/2024-07-18T20:24:20+05:30/tags/pro-image/2024-07-24T17:43:26+05:30/user-guide/integrations/pulumi/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/python/2024-07-18T20:24:20+05:30/references/coverage/coverage_qldb/2024-07-22T19:56:23+02:00/references/coverage/coverage_qldb-session/2024-07-22T19:56:23+02:00/user-guide/aws/qldb/2024-07-18T20:24:20+05:30/user-guide/integrations/quarkus/2024-07-18T20:24:20+05:30/applications/query-data-in-s3-bucket-with-amazon-athena-glue-catalog-cloudformation/2023-06-28T15:22:44+05:00/references/coverage/coverage_ram/2024-07-22T19:56:23+02:00/references/coverage/coverage_rds/2024-07-22T19:56:23+02:00/tags/rds/2023-06-28T15:22:44+05:00/references/coverage/coverage_rds-data/2024-07-22T19:56:23+02:00/tags/rds-proxy/2023-07-27T12:31:23+02:00/references/coverage/coverage_redshift/2024-07-22T19:56:23+02:00/user-guide/aws/redshift/2024-07-18T20:24:20+05:30/references/coverage/coverage_redshift-data/2024-07-22T19:56:23+02:00/user-guide/aws/rds/2024-07-18T20:24:20+05:30/tags/reproducible/2024-07-18T20:24:20+05:30/user-guide/aws/ram/2024-07-18T20:24:20+05:30/user-guide/aws/resource_groups/2024-07-18T20:24:20+05:30/references/coverage/coverage_resource-groups/2024-07-22T19:56:23+02:00/references/coverage/coverage_resourcegroupstaggingapi/2024-07-22T19:56:23+02:00/user-guide/aws/route53/2024-07-18T20:24:20+05:30/user-guide/aws/route53resolver/2024-07-18T20:24:20+05:30/references/coverage/coverage_route53/2024-07-22T19:56:23+02:00/tags/route53/2024-07-18T20:24:20+05:30/references/coverage/coverage_route53resolver/2024-07-22T19:56:23+02:00/user-guide/integrations/sdks/ruby/2024-07-18T20:24:20+05:30/tags/rule-based-authentication/2023-06-28T15:22:44+05:00/references/coverage/coverage_s3/2024-07-22T19:56:23+02:00/tags/s3/2024-07-18T20:24:20+05:30/tags/s3-website/2024-07-18T20:24:20+05:30/references/coverage/coverage_s3control/2024-07-22T19:56:23+02:00/references/coverage/coverage_sagemaker/2024-07-22T19:56:23+02:00/user-guide/aws/sagemaker/2024-07-18T20:24:20+05:30/references/coverage/coverage_sagemaker-runtime/2024-07-22T19:56:23+02:00/references/coverage/coverage_scheduler/2024-07-22T19:56:23+02:00/tags/schema-evolution/2024-07-18T20:24:20+05:30/applications/search-application-with-lambda-kinesis-firehose-elasticsearch-s3/2023-07-27T12:31:23+02:00/user-guide/aws/secretsmanager/2024-07-18T20:24:20+05:30/references/coverage/coverage_secretsmanager/2024-07-22T19:56:23+02:00/tags/security/2023-06-28T15:22:44+05:00/user-guide/aws/sts/2024-05-22T14:16:59-04:00/user-guide/integrations/kafka/2024-03-04T21:08:13+05:30/tags/serverless/2023-07-27T12:31:23+02:00/user-guide/aws/serverlessrepo/2024-07-18T20:24:20+05:30/applications/serverless-container-based-apis-with-amazon-ecs-api-gateway/2023-06-28T15:22:44+05:00/tags/serverless-framework/2024-07-18T20:24:20+05:30/user-guide/integrations/serverless-framework/2024-07-18T20:24:20+05:30/applications/serverless-image-resizer-with-aws-lambda-s3-sns-and-ses/2023-06-28T15:22:44+05:00/applications/serverless-microservices-with-amazon-api-gateway-dynamodb-sqs-and-lambda/2023-06-28T15:22:44+05:00/applications/serverless-rds-proxy-with-api-gateway-lambda-and-aurora-rds/2023-07-27T12:31:23+02:00/applications/serverless-transcription-application-using-transcribe-s3-lambda-sqs-and-ses/2023-06-28T15:22:44+05:00/tags/serverless-containers/2023-06-28T15:22:44+05:00/tags/serverless-localstack-plugin/2024-07-18T20:24:20+05:30/references/coverage/coverage_serverlessrepo/2024-07-22T19:56:23+02:00/user-guide/aws/servicediscovery/2024-07-18T20:24:20+05:30/references/coverage/coverage_servicediscovery/2024-07-22T19:56:23+02:00/references/coverage/coverage_ses/2024-07-22T19:56:23+02:00/references/coverage/coverage_sesv2/2024-07-22T19:56:23+02:00/tags/simple-email-service/2024-07-18T20:24:20+05:30/user-guide/aws/ses/2024-07-18T20:24:20+05:30/tags/simple-notification-service/2024-07-18T20:24:20+05:30/user-guide/aws/sns/2024-07-18T20:24:20+05:30/tags/simple-queue-service/2024-07-18T20:24:20+05:30/user-guide/aws/sqs/2024-07-18T20:24:20+05:30/user-guide/aws/s3/2024-07-18T20:24:20+05:30/user-guide/aws/swf/2024-07-18T20:24:20+05:30/references/coverage/coverage_sns/2024-07-22T19:56:23+02:00/tags/spring-boot/2024-07-18T20:24:20+05:30/user-guide/integrations/spring-cloud-function/2024-07-18T20:24:20+05:30/references/coverage/coverage_sqs/2024-07-22T19:56:23+02:00/tags/ssl/2024-07-18T20:24:20+05:30/references/coverage/coverage_ssm/2024-07-22T19:56:23+02:00/references/coverage/coverage_sso-admin/2024-07-22T19:56:23+02:00/tags/static-website/2024-07-18T20:24:20+05:30/user-guide/aws/stepfunctions/2024-07-18T20:24:20+05:30/applications/step-up-authentication-using-amazon-cognito/2023-06-28T15:22:44+05:00/tags/step-up-auth/2023-06-28T15:22:44+05:00/references/coverage/coverage_stepfunctions/2024-07-22T19:56:23+02:00/references/coverage/coverage_sts/2024-07-22T19:56:23+02:00/references/coverage/coverage_support/2024-07-22T19:56:23+02:00/user-guide/aws/support/2024-07-18T20:24:20+05:30/persistence/supported/2024-07-23T15:17:50+09:00/persistence/supported-with-limitations/2024-07-18T20:24:20+05:30/references/coverage/coverage_swf/2024-07-22T19:56:23+02:00/user-guide/aws/ssm/2024-07-18T20:24:20+05:30/tags/2024-07-24T20:46:26+05:30/tags/teams-plan/2024-07-24T20:46:26+05:30/tags/terraform/2024-07-23T04:59:24-07:00/user-guide/integrations/terraform/2024-07-18T20:24:20+05:30/tags/testcontainers/2024-07-23T04:59:24-07:00/user-guide/integrations/testcontainers/2024-07-18T20:24:20+05:30/references/coverage/coverage_textract/2024-07-22T19:56:23+02:00/user-guide/aws/textract/2024-07-18T20:24:20+05:30/tags/tflocal-cli/2024-07-18T20:24:20+05:30/user-guide/aws/timestream/2024-07-18T20:24:20+05:30/references/coverage/coverage_timestream-query/2024-07-22T19:56:23+02:00/references/coverage/coverage_timestream-write/2024-07-22T19:56:23+02:00/references/coverage/coverage_transcribe/2024-07-22T19:56:23+02:00/user-guide/aws/transcribe/2024-07-18T20:24:20+05:30/references/coverage/coverage_transfer/2024-07-22T19:56:23+02:00/user-guide/aws/transfer/2024-07-18T20:24:20+05:30/tags/troubleshooting/2024-07-18T20:24:20+05:30/references/coverage/coverage_wafv2/2024-07-22T19:56:23+02:00/user-guide/aws/waf/2024-07-18T20:24:20+05:30/user-guide/aws/xray/2024-07-18T20:24:20+05:30/references/coverage/coverage_xray/2024-07-22T19:56:23+02:00
\ No newline at end of file
+/user-guide/lambda-tools/hot-reloading/2024-07-18T20:24:20+05:30/user-guide/aws/feature-coverage/2024-07-18T20:24:20+05:30/references/network-troubleshooting/endpoint-url/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/2024-07-18T20:24:20+05:30/academy/localstack-101/course-overview/2024-04-10T21:36:53-07:00/academy/localstack-deployment/course-overview/2024-04-10T21:36:53-07:00/user-guide/cloud-sandbox/ephemeral-instance/2024-07-18T23:00:32+05:30/user-guide/extensions/getting-started/2024-07-18T20:24:20+05:30/user-guide/security-testing/iam-enforcement/2024-07-18T20:24:20+05:30/user-guide/aws/2022-12-01T14:30:06+05:30/references/network-troubleshooting/2024-07-18T20:24:20+05:30/developer-hub/2023-03-30T17:05:01+02:00/overview/2024-01-26T21:31:43+05:30/tutorials/schema-evolution-glue-msk/2024-07-18T20:24:20+05:30/legal/third-party-software-tools/2024-07-18T20:24:20+05:30/user-guide/cloud-sandbox/application-previews/2024-07-23T18:12:24+05:30/user-guide/state-management/cloud-pods/2024-07-24T20:46:26+05:30/academy/localstack-deployment/deploy-app-ls/2024-07-18T20:24:20+05:30/tutorials/lambda-ecr-container-images/2024-07-18T20:24:20+05:30/user-guide/security-testing/explainable-iam/2024-07-18T20:24:20+05:30/getting-started/2024-07-18T20:24:20+05:30/user-guide/integrations/2022-12-01T14:30:06+05:30/user-guide/extensions/managing-extensions/2024-07-24T17:43:26+05:30/user-guide/state-management/persistence/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/debugging/2024-07-18T20:24:20+05:30/references/network-troubleshooting/transparent-endpoint-injection/2024-07-18T20:24:20+05:30/academy/localstack-101/what-is-localstack/2024-07-18T20:24:20+05:30/references/network-troubleshooting/created-resources/2023-11-09T11:28:48+01:00/tutorials/java-notification-app/2024-07-18T20:24:20+05:30/user-guide/ci/2024-07-18T20:24:20+05:30/user-guide/extensions/developing-extensions/2024-07-18T20:24:20+05:30/user-guide/state-management/export-import-state/2024-07-18T20:24:20+05:30/user-guide/extensions/2024-07-18T20:24:20+05:30/user-guide/security-testing/iam-policy-stream/2024-07-18T20:24:20+05:30/academy/localstack-deployment/ls-integrations/2024-07-18T20:24:20+05:30/tutorials/elb-load-balancing/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/vscode-extension/2024-07-18T20:24:20+05:30/academy/localstack-101/why-localstack/2024-07-18T20:24:20+05:30/user-guide/ci/circle-ci/2024-07-18T20:24:20+05:30/academy/localstack-deployment/infra-terraform/2024-07-18T20:24:20+05:30/user-guide/extensions/extensions-library/2024-07-18T20:24:20+05:30/academy/localstack-101/getting-started/2024-07-18T20:24:20+05:30/tutorials/s3-static-website-terraform/2024-07-18T20:24:20+05:30/user-guide/state-management/launchpad/2024-07-18T20:24:20+05:30/user-guide/ci/bitbucket/2024-07-18T20:24:20+05:30/user-guide/state-management/pods-cli/2024-07-18T20:24:20+05:30/academy/localstack-deployment/infra-cloudformation/2024-07-18T20:24:20+05:30/tutorials/reproducible-machine-learning-cloud-pods/2024-07-18T20:24:20+05:30/user-guide/ci/github-actions/2024-07-18T20:24:20+05:30/references/lambda-provider-v2/2024-07-18T20:24:20+05:30/references/coverage/2024-07-18T20:24:20+05:30/user-guide/extensions/official-extensions/2024-05-15T17:29:55+05:30/user-guide/web-application/single-sign-on/azure-ad/2024-07-18T20:24:20+05:30/user-guide/tools/testing-utils/2024-07-18T20:24:20+05:30/academy/localstack-101/web-app-resource-browser/2024-07-18T20:24:20+05:30/tutorials/ecs-ecr-container-app/2024-07-18T20:24:20+05:30/academy/localstack-101/full-project-demo/2024-07-18T20:24:20+05:30/user-guide/ci/gitlab-ci/2024-07-23T09:21:53-07:00/academy/localstack-101/2023-08-23T14:33:03+05:00/academy/localstack-deployment/iam-policy-stream/2024-07-18T20:24:20+05:30/academy/localstack-101/cloud-pods/2024-07-18T20:24:20+05:30/user-guide/ci/codebuild/2024-07-18T20:24:20+05:30/tutorials/cloud-pods-collaborative-debugging/2024-07-18T20:24:20+05:30/user-guide/tools/localsurf/2024-07-18T20:24:20+05:30/tutorials/replicate-aws-resources-localstack-extension/2024-07-18T20:24:20+05:30/academy/localstack-deployment/github-action-ls/2024-07-18T20:24:20+05:30/user-guide/ci/travis-ci/2024-07-18T20:24:20+05:30/user-guide/2023-11-09T13:00:00+05:30/academy/localstack-deployment/cloud-pods/2024-07-18T20:24:20+05:30/tutorials/ephemeral-application-previews/2024-07-18T20:24:20+05:30/academy/localstack-development/2024-02-19T15:56:51+05:30/user-guide/tools/localstack-desktop/2024-07-18T20:24:20+05:30/user-guide/tools/localstack-docker-extension/2024-07-18T20:24:20+05:30/user-guide/web-application/accounts/2024-07-18T20:24:20+05:30/references/configuration/2024-07-18T20:24:20+05:30/getting-started/installation/2024-07-18T20:24:20+05:30/user-guide/state-management/2024-07-18T20:24:20+05:30/user-guide/tools/transparent-endpoint-injection/2024-07-22T13:56:05-04:00/tutorials/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/2024-07-25T12:57:46+05:30/user-guide/tools/dns-server/2024-07-18T20:24:20+05:30/user-guide/security-testing/2024-07-18T20:24:20+05:30/references/changelog/2024-06-13T19:54:44+05:30/user-guide/cloud-sandbox/2024-07-23T18:12:24+05:30/references/iam-coverage/2024-07-18T20:24:20+05:30/tutorials/gitlab_ci_testcontainers/2024-07-18T20:24:20+05:30/tutorials/using-terraform-with-testcontainers-and-localstack/2024-07-23T04:59:24-07:00/tutorials/iam-policy-stream/2024-07-18T20:24:20+05:30/applications/2023-03-30T17:05:01+02:00/getting-started/auth-token/2024-07-18T20:24:20+05:30/user-guide/web-application/workspaces/2024-07-18T20:24:20+05:30/academy/2023-08-23T14:33:03+05:00/user-guide/web-application/users-licences/2024-07-18T20:24:20+05:30/getting-started/quickstart/2024-07-18T20:24:20+05:30/getting-started/faq/2024-07-18T20:24:20+05:30/user-guide/tools/2024-07-18T20:24:20+05:30/user-guide/lambda-tools/2024-07-18T20:24:20+05:30/references/arm64-support/2024-07-18T20:24:20+05:30/references/credentials/2024-05-17T16:27:59+05:30/references/cross-account-access/2024-07-18T20:24:20+05:30/references/custom-tls-certificates/2024-07-18T20:24:20+05:30/references/docker-images/2024-07-18T20:24:20+05:30/references/external-ports/2024-07-18T20:24:20+05:30/references/filesystem/2024-07-18T20:24:20+05:30/references/init-hooks/2024-07-23T04:59:24-07:00/references/internal-endpoints/2024-07-25T12:57:46+05:30/user-guide/web-application/2023-11-16T14:25:42+01:00/references/logging/2024-07-18T20:24:20+05:30/references/multi-account-setups/2024-07-18T20:24:20+05:30/references/podman/2024-07-18T20:24:20+05:30/references/2023-02-03T15:18:39+05:30/references/usage-tracking/2024-07-18T20:24:20+05:30/getting-started/help-and-support/2024-07-18T20:24:20+05:30/user-guide/web-application/resource-browser/2024-07-18T20:24:20+05:30/user-guide/web-application/instance-management/2024-07-18T20:24:20+05:30/user-guide/web-application/stack-insights/2024-07-18T20:24:20+05:30/user-guide/web-application/ci-analytics/2024-07-18T20:24:20+05:30/user-guide/web-application/ci-keys/2024-07-18T20:24:20+05:30/references/api-key/2024-07-18T20:24:20+05:30/user-guide/web-application/single-sign-on/2024-07-18T20:24:20+05:30/applications/temp/2023-03-30T17:05:01+02:00/contributing/2024-05-08T14:32:30+05:30/references/network-troubleshooting/readme/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/dotnet/2024-07-18T20:24:20+05:30/references/coverage/coverage_account/2024-07-22T19:56:23+02:00/user-guide/aws/account/2024-07-18T20:24:20+05:30/references/coverage/coverage_acm/2024-07-22T19:56:23+02:00/references/coverage/coverage_acm-pca/2024-07-22T19:56:23+02:00/applications/amazon-rds-initialization-using-cdk-lambda-ecr-and-secrets-manager/2023-06-28T15:22:44+05:00/references/coverage/coverage_amplify/2024-07-22T19:56:23+02:00/user-guide/aws/amplify/2024-07-18T20:24:20+05:30/tags/api-gateway/2024-07-25T12:57:46+05:30/user-guide/aws/apigateway/2024-07-18T20:24:20+05:30/references/coverage/coverage_apigateway/2024-07-22T19:56:23+02:00/references/coverage/coverage_apigatewaymanagementapi/2024-07-22T19:56:23+02:00/references/coverage/coverage_apigatewayv2/2024-07-22T19:56:23+02:00/references/coverage/coverage_appconfig/2024-07-22T19:56:23+02:00/user-guide/aws/appconfig/2024-07-18T20:24:20+05:30/references/coverage/coverage_appconfigdata/2024-07-22T19:56:23+02:00/user-guide/aws/applicationautoscaling/2024-07-18T20:24:20+05:30/references/coverage/coverage_application-autoscaling/2024-07-22T19:56:23+02:00/references/coverage/coverage_appsync/2024-07-22T19:56:23+02:00/tags/appsync/2023-06-28T15:22:44+05:00/user-guide/aws/appsync/2024-07-18T20:24:20+05:30/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/2023-06-28T15:22:44+05:00/user-guide/integrations/architect/2024-07-18T20:24:20+05:30/references/coverage/coverage_athena/2024-07-22T19:56:23+02:00/user-guide/aws/athena/2024-07-18T20:24:20+05:30/user-guide/aws/autoscaling/2024-07-18T20:24:20+05:30/references/coverage/coverage_autoscaling/2024-07-22T19:56:23+02:00/user-guide/integrations/aws-cdk/2024-07-18T20:24:20+05:30/user-guide/integrations/chalice/2024-07-18T20:24:20+05:30/user-guide/integrations/aws-cli/2024-07-18T20:24:20+05:30/user-guide/integrations/copilot/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/fault-injection-service/2024-07-25T12:57:46+05:30/tags/aws-java-sdk/2024-07-18T20:24:20+05:30/user-guide/integrations/aws-sam/2024-07-18T20:24:20+05:30/references/coverage/coverage_backup/2024-07-22T19:56:23+02:00/user-guide/aws/backup/2024-07-18T20:24:20+05:30/tags/bash/2024-07-18T20:24:20+05:30/references/coverage/coverage_batch/2024-07-22T19:56:23+02:00/user-guide/aws/batch/2024-07-18T20:24:20+05:30/tags/big-data/2023-06-28T15:22:44+05:00/user-guide/integrations/sdks/cpp/2024-03-19T14:46:00+05:30/categories/2024-07-23T08:31:37+05:30/references/coverage/coverage_ce/2024-07-22T19:56:23+02:00/user-guide/aws/acm/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/chaos-api/2024-07-25T12:57:46+05:30/tags/chaos-engineering/2024-07-25T12:57:46+05:30/user-guide/chaos-engineering/web-application-dashboard/2024-07-25T12:57:46+05:30/tutorials/route-53-failover/2024-07-25T12:57:46+05:30/tutorials/simulating-outages/2024-07-25T12:57:46+05:30/user-guide/integrations/cloud-custodian/2024-07-18T20:24:20+05:30/tags/cloud-pods/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudformation/2024-07-22T19:56:23+02:00/tags/cloudformation/2024-07-18T20:24:20+05:30/user-guide/aws/cloudformation/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudfront/2024-07-22T19:56:23+02:00/user-guide/aws/cloudfront/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudtrail/2024-07-22T19:56:23+02:00/user-guide/aws/cloudtrail/2024-07-18T20:24:20+05:30/references/coverage/coverage_cloudwatch/2024-07-22T19:56:23+02:00/tags/cloudwatch/2024-07-18T20:24:20+05:30/user-guide/aws/cloudwatch/2024-07-19T08:12:53+02:00/user-guide/aws/logs/2024-07-18T20:24:20+05:30/references/coverage/coverage_codecommit/2024-07-22T19:56:23+02:00/user-guide/aws/codecommit/2024-07-18T20:24:20+05:30/user-guide/aws/cognito/2024-07-18T20:24:20+05:30/references/coverage/coverage_cognito-identity/2024-07-22T19:56:23+02:00/references/coverage/coverage_cognito-idp/2024-07-22T19:56:23+02:00/tags/compliance/2023-06-28T15:22:44+05:00/references/coverage/coverage_config/2024-07-22T19:56:23+02:00/user-guide/aws/config/2024-05-29T13:37:58+05:30/tags/container/2024-07-18T20:24:20+05:30/tags/container-image/2024-07-18T20:24:20+05:30/user-guide/aws/ce/2024-07-18T20:24:20+05:30/user-guide/integrations/crossplane/2024-07-18T20:24:20+05:30/tags/data-analytics/2023-06-28T15:22:44+05:00/user-guide/aws/dms/2024-07-18T21:18:11+05:30/tags/databases/2023-06-28T15:22:44+05:00/references/coverage/coverage_dms/2024-07-22T19:56:23+02:00/references/coverage/coverage_docdb/2024-07-22T19:56:23+02:00/tags/docker/2024-07-18T20:24:20+05:30/tags/docker-in-docker/2024-07-18T20:24:20+05:30/2021-10-08T11:40:02+02:00/user-guide/aws/docdb/2024-07-18T20:24:20+05:30/references/coverage/coverage_dynamodb/2024-07-22T19:56:23+02:00/tags/dynamodb/2024-07-25T12:57:46+05:30/user-guide/aws/dynamodb/2024-07-23T15:17:50+09:00/user-guide/aws/dynamodbstreams/2024-07-18T20:24:20+05:30/references/coverage/coverage_dynamodbstreams/2024-07-22T19:56:23+02:00/references/coverage/coverage_ec2/2024-07-22T19:56:23+02:00/references/coverage/coverage_ecr/2024-07-22T19:56:23+02:00/tags/ecr/2024-07-18T20:24:20+05:30/references/coverage/coverage_ecs/2024-07-22T19:56:23+02:00/tags/ecs/2024-07-25T12:57:46+05:30/references/coverage/coverage_efs/2024-07-22T19:56:23+02:00/references/coverage/coverage_eks/2024-07-22T19:56:23+02:00/user-guide/integrations/eksctl/2024-07-18T20:24:20+05:30/user-guide/aws/elasticbeanstalk/2024-07-18T20:24:20+05:30/user-guide/aws/ec2/2024-07-18T20:24:20+05:30/user-guide/aws/ecr/2024-07-18T20:24:20+05:30/user-guide/aws/ecs/2024-07-23T08:31:37+05:30/user-guide/aws/efs/2024-07-18T20:24:20+05:30/user-guide/aws/eks/2024-07-18T20:24:20+05:30/tags/elastic-load-balancing/2024-07-18T20:24:20+05:30/user-guide/aws/elb/2024-07-18T20:24:20+05:30/user-guide/aws/emr/2024-07-18T20:24:20+05:30/user-guide/aws/elastictranscoder/2024-07-18T20:24:20+05:30/references/coverage/coverage_elasticache/2024-07-22T19:56:23+02:00/user-guide/aws/elasticache/2024-07-18T20:24:20+05:30/references/coverage/coverage_elasticbeanstalk/2024-07-22T19:56:23+02:00/user-guide/aws/es/2024-07-18T20:24:20+05:30/references/coverage/coverage_elastictranscoder/2024-07-22T19:56:23+02:00/references/coverage/coverage_elb/2024-07-22T19:56:23+02:00/references/coverage/coverage_elbv2/2024-07-22T19:56:23+02:00/user-guide/aws/mediastore/2024-07-18T20:24:20+05:30/references/coverage/coverage_emr/2024-07-22T19:56:23+02:00/references/coverage/coverage_emr-serverless/2024-07-22T19:56:23+02:00/tags/enterprise-plan/2024-07-25T12:57:46+05:30/references/coverage/coverage_es/2024-07-22T19:56:23+02:00/applications/event-driven-architecture-with-amazon-sns-fifo-dynamodb-lambda-and-s3/2023-06-28T15:22:44+05:00/tags/event-driven-architecture/2023-07-27T12:31:23+02:00/user-guide/aws/events/2024-07-18T20:24:20+05:30/user-guide/aws/pipes/2024-07-18T20:24:20+05:30/user-guide/aws/scheduler/2024-07-18T20:24:20+05:30/references/coverage/coverage_events/2024-07-22T19:56:23+02:00/tags/fargate/2024-07-18T20:24:20+05:30/user-guide/aws/fis/2024-07-25T12:57:46+05:30/references/coverage/coverage_firehose/2024-07-22T19:56:23+02:00/references/coverage/coverage_fis/2024-07-22T19:56:23+02:00/user-guide/integrations/former2/2024-07-18T20:24:20+05:30/applications/full-stack-application-with-aws-lambda-dynamodb-s3-for-shipment-validation/2023-06-28T15:22:44+05:00/tags/gitlab/2024-07-18T20:24:20+05:30/tags/gitlab-runners/2024-07-18T20:24:20+05:30/user-guide/integrations/gitpod/2024-07-18T20:24:20+05:30/references/coverage/coverage_glacier/2024-07-22T19:56:23+02:00/user-guide/aws/glacier/2024-07-18T20:24:20+05:30/references/coverage/coverage_glue/2024-07-22T19:56:23+02:00/user-guide/aws/glue/2024-07-18T20:24:20+05:30/tags/glue-schema-registry/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/go/2024-07-18T20:24:20+05:30/tags/graphql/2023-06-28T15:22:44+05:00/references/coverage/coverage_iam/2024-07-22T19:56:23+02:00/tags/iam/2024-07-18T20:24:20+05:30/tags/identity/2023-06-28T15:22:44+05:00/user-guide/aws/iam/2024-07-18T20:24:20+05:30/user-guide/aws/identitystore/2024-07-18T20:24:20+05:30/references/coverage/coverage_identitystore/2024-07-22T19:56:23+02:00/tags/init-hooks/2024-07-23T04:59:24-07:00/tags/internal-endpoints/2024-07-25T12:57:46+05:30/references/coverage/coverage_iot/2024-07-22T19:56:23+02:00/user-guide/aws/iot/2024-07-18T20:24:20+05:30/user-guide/aws/iotanalytics/2024-07-18T20:24:20+05:30/user-guide/aws/iotwireless/2024-07-18T20:24:20+05:30/references/coverage/coverage_iot-data/2024-07-22T19:56:23+02:00/references/coverage/coverage_iotanalytics/2024-07-22T19:56:23+02:00/references/coverage/coverage_iotwireless/2024-07-22T19:56:23+02:00/tags/java/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/java/2024-07-18T20:24:20+05:30/tags/javascript/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/javascript/2024-07-18T20:24:20+05:30/references/coverage/coverage_kafka/2024-07-22T19:56:23+02:00/tags/kafka/2024-07-18T20:24:20+05:30/user-guide/aws/kms/2024-07-18T20:24:20+05:30/references/coverage/coverage_kinesis/2024-07-22T19:56:23+02:00/user-guide/aws/kinesis/2024-07-18T20:24:20+05:30/user-guide/aws/kinesisanalytics/2024-07-18T20:24:20+05:30/user-guide/aws/firehose/2024-07-18T20:24:20+05:30/references/coverage/coverage_kinesisanalytics/2024-07-22T19:56:23+02:00/references/coverage/coverage_kinesisanalyticsv2/2024-07-22T19:56:23+02:00/references/coverage/coverage_kms/2024-07-22T19:56:23+02:00/user-guide/integrations/kubernetes/2024-07-18T20:24:20+05:30/user-guide/aws/lakeformation/2024-07-18T20:24:20+05:30/references/coverage/coverage_lakeformation/2024-07-22T19:56:23+02:00/references/coverage/coverage_lambda/2024-07-22T19:56:23+02:00/tags/lambda/2024-07-25T12:57:46+05:30/user-guide/aws/lambda/2024-07-18T20:24:20+05:30/tags/lambda-layers/2024-07-18T20:24:20+05:30/tags/lambda-trigger/2023-06-28T15:22:44+05:00/user-guide/integrations/lambdatest-hyperexecute/2024-07-18T20:24:20+05:30/legal/2024-05-16T15:07:50+05:30/applications/loan-broker-application-with-aws-step-functions-dynamodb-lambda-sqs-and-sns/2023-06-28T15:22:44+05:00/categories/localstack-pro/2024-07-23T08:31:37+05:30/tags/localstack-endpoints/2024-07-25T12:57:46+05:30/tags/localsurf/2023-06-28T15:22:44+05:00/tags/logging/2024-07-18T20:24:20+05:30/references/coverage/coverage_logs/2024-07-22T19:56:23+02:00/tags/machine-learning/2024-07-18T20:24:20+05:30/user-guide/aws/managedblockchain/2024-07-18T20:24:20+05:30/user-guide/aws/msk/2024-07-18T20:24:20+05:30/user-guide/aws/mwaa/2024-07-18T20:24:20+05:30/references/coverage/coverage_managedblockchain/2024-07-22T19:56:23+02:00/references/coverage/coverage_mediastore/2024-07-22T19:56:23+02:00/references/coverage/coverage_mediastore-data/2024-07-22T19:56:23+02:00/references/coverage/coverage_memorydb/2024-07-22T19:56:23+02:00/user-guide/aws/memorydb/2024-07-18T20:24:20+05:30/applications/messaging-processing-application-with-sqs-dynamodb-and-fargate/2023-06-28T15:22:44+05:00/tags/microservices/2023-06-28T15:22:44+05:00/applications/mnist-handwritten-digit-recognition-model-running-on-a-local-sagemaker-endpoint/2023-06-28T15:22:44+05:00/references/coverage/coverage_mq/2024-07-22T19:56:23+02:00/user-guide/aws/mq/2024-07-18T20:24:20+05:30/tags/msk/2024-07-18T20:24:20+05:30/references/coverage/coverage_mwaa/2024-07-22T19:56:23+02:00/references/coverage/coverage_neptune/2024-07-22T19:56:23+02:00/user-guide/aws/neptune/2024-07-18T20:24:20+05:30/tags/networking/2024-07-18T20:24:20+05:30/tags/nginx/2024-07-18T20:24:20+05:30/tags/node.js/2024-07-18T20:24:20+05:30/applications/note-taking-application-using-aws-sdk-for-javascript/2023-06-28T15:22:44+05:00/references/coverage/coverage_opensearch/2024-07-22T19:56:23+02:00/user-guide/aws/opensearch/2024-07-18T20:24:20+05:30/user-guide/integrations/openshift/2024-07-18T20:24:20+05:30/references/coverage/coverage_organizations/2024-07-22T19:56:23+02:00/user-guide/aws/organizations/2024-07-18T20:24:20+05:30/user-guide/chaos-engineering/outages-extension/2024-07-25T12:57:46+05:30/persistence/2024-07-23T15:17:50+09:00/user-guide/state-management/support/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/php/2024-07-18T20:24:20+05:30/references/coverage/coverage_pinpoint/2024-07-22T19:56:23+02:00/user-guide/aws/pinpoint/2024-07-18T20:24:20+05:30/references/coverage/coverage_pipes/2024-07-22T19:56:23+02:00/user-guide/aws/pca/2024-07-18T20:24:20+05:30/tags/pro-image/2024-07-24T17:43:26+05:30/user-guide/integrations/pulumi/2024-07-18T20:24:20+05:30/user-guide/integrations/sdks/python/2024-07-18T20:24:20+05:30/references/coverage/coverage_qldb/2024-07-22T19:56:23+02:00/references/coverage/coverage_qldb-session/2024-07-22T19:56:23+02:00/user-guide/aws/qldb/2024-07-18T20:24:20+05:30/user-guide/integrations/quarkus/2024-07-18T20:24:20+05:30/applications/query-data-in-s3-bucket-with-amazon-athena-glue-catalog-cloudformation/2023-06-28T15:22:44+05:00/references/coverage/coverage_ram/2024-07-22T19:56:23+02:00/references/coverage/coverage_rds/2024-07-22T19:56:23+02:00/tags/rds/2023-06-28T15:22:44+05:00/references/coverage/coverage_rds-data/2024-07-22T19:56:23+02:00/tags/rds-proxy/2023-07-27T12:31:23+02:00/references/coverage/coverage_redshift/2024-07-22T19:56:23+02:00/user-guide/aws/redshift/2024-07-18T20:24:20+05:30/references/coverage/coverage_redshift-data/2024-07-22T19:56:23+02:00/user-guide/aws/rds/2024-07-18T20:24:20+05:30/tags/reproducible/2024-07-18T20:24:20+05:30/user-guide/aws/ram/2024-07-18T20:24:20+05:30/user-guide/aws/resource_groups/2024-07-18T20:24:20+05:30/references/coverage/coverage_resource-groups/2024-07-22T19:56:23+02:00/references/coverage/coverage_resourcegroupstaggingapi/2024-07-22T19:56:23+02:00/user-guide/aws/route53/2024-07-18T20:24:20+05:30/user-guide/aws/route53resolver/2024-07-18T20:24:20+05:30/references/coverage/coverage_route53/2024-07-22T19:56:23+02:00/tags/route53/2024-07-25T12:57:46+05:30/references/coverage/coverage_route53resolver/2024-07-22T19:56:23+02:00/user-guide/integrations/sdks/ruby/2024-07-18T20:24:20+05:30/tags/rule-based-authentication/2023-06-28T15:22:44+05:00/references/coverage/coverage_s3/2024-07-22T19:56:23+02:00/tags/s3/2024-07-18T20:24:20+05:30/tags/s3-website/2024-07-18T20:24:20+05:30/references/coverage/coverage_s3control/2024-07-22T19:56:23+02:00/references/coverage/coverage_sagemaker/2024-07-22T19:56:23+02:00/user-guide/aws/sagemaker/2024-07-18T20:24:20+05:30/references/coverage/coverage_sagemaker-runtime/2024-07-22T19:56:23+02:00/references/coverage/coverage_scheduler/2024-07-22T19:56:23+02:00/tags/schema-evolution/2024-07-18T20:24:20+05:30/applications/search-application-with-lambda-kinesis-firehose-elasticsearch-s3/2023-07-27T12:31:23+02:00/user-guide/aws/secretsmanager/2024-07-18T20:24:20+05:30/references/coverage/coverage_secretsmanager/2024-07-22T19:56:23+02:00/tags/security/2023-06-28T15:22:44+05:00/user-guide/aws/sts/2024-05-22T14:16:59-04:00/user-guide/integrations/kafka/2024-03-04T21:08:13+05:30/tags/serverless/2023-07-27T12:31:23+02:00/user-guide/aws/serverlessrepo/2024-07-18T20:24:20+05:30/applications/serverless-container-based-apis-with-amazon-ecs-api-gateway/2023-06-28T15:22:44+05:00/tags/serverless-framework/2024-07-18T20:24:20+05:30/user-guide/integrations/serverless-framework/2024-07-18T20:24:20+05:30/applications/serverless-image-resizer-with-aws-lambda-s3-sns-and-ses/2023-06-28T15:22:44+05:00/applications/serverless-microservices-with-amazon-api-gateway-dynamodb-sqs-and-lambda/2023-06-28T15:22:44+05:00/applications/serverless-rds-proxy-with-api-gateway-lambda-and-aurora-rds/2023-07-27T12:31:23+02:00/applications/serverless-transcription-application-using-transcribe-s3-lambda-sqs-and-ses/2023-06-28T15:22:44+05:00/tags/serverless-containers/2023-06-28T15:22:44+05:00/tags/serverless-localstack-plugin/2024-07-18T20:24:20+05:30/references/coverage/coverage_serverlessrepo/2024-07-22T19:56:23+02:00/user-guide/aws/servicediscovery/2024-07-18T20:24:20+05:30/references/coverage/coverage_servicediscovery/2024-07-22T19:56:23+02:00/references/coverage/coverage_ses/2024-07-22T19:56:23+02:00/references/coverage/coverage_sesv2/2024-07-22T19:56:23+02:00/tags/simple-email-service/2024-07-18T20:24:20+05:30/user-guide/aws/ses/2024-07-18T20:24:20+05:30/tags/simple-notification-service/2024-07-18T20:24:20+05:30/user-guide/aws/sns/2024-07-18T20:24:20+05:30/tags/simple-queue-service/2024-07-18T20:24:20+05:30/user-guide/aws/sqs/2024-07-18T20:24:20+05:30/user-guide/aws/s3/2024-07-18T20:24:20+05:30/user-guide/aws/swf/2024-07-18T20:24:20+05:30/references/coverage/coverage_sns/2024-07-22T19:56:23+02:00/tags/spring-boot/2024-07-18T20:24:20+05:30/user-guide/integrations/spring-cloud-function/2024-07-18T20:24:20+05:30/references/coverage/coverage_sqs/2024-07-22T19:56:23+02:00/tags/ssl/2024-07-18T20:24:20+05:30/references/coverage/coverage_ssm/2024-07-22T19:56:23+02:00/references/coverage/coverage_sso-admin/2024-07-22T19:56:23+02:00/tags/static-website/2024-07-18T20:24:20+05:30/user-guide/aws/stepfunctions/2024-07-18T20:24:20+05:30/applications/step-up-authentication-using-amazon-cognito/2023-06-28T15:22:44+05:00/tags/step-up-auth/2023-06-28T15:22:44+05:00/references/coverage/coverage_stepfunctions/2024-07-22T19:56:23+02:00/references/coverage/coverage_sts/2024-07-22T19:56:23+02:00/references/coverage/coverage_support/2024-07-22T19:56:23+02:00/user-guide/aws/support/2024-07-18T20:24:20+05:30/persistence/supported/2024-07-23T15:17:50+09:00/persistence/supported-with-limitations/2024-07-18T20:24:20+05:30/references/coverage/coverage_swf/2024-07-22T19:56:23+02:00/user-guide/aws/ssm/2024-07-18T20:24:20+05:30/tags/2024-07-25T12:57:46+05:30/tags/teams-plan/2024-07-24T20:46:26+05:30/tags/terraform/2024-07-23T04:59:24-07:00/user-guide/integrations/terraform/2024-07-18T20:24:20+05:30/tags/testcontainers/2024-07-23T04:59:24-07:00/user-guide/integrations/testcontainers/2024-07-18T20:24:20+05:30/references/coverage/coverage_textract/2024-07-22T19:56:23+02:00/user-guide/aws/textract/2024-07-18T20:24:20+05:30/tags/tflocal-cli/2024-07-18T20:24:20+05:30/user-guide/aws/timestream/2024-07-18T20:24:20+05:30/references/coverage/coverage_timestream-query/2024-07-22T19:56:23+02:00/references/coverage/coverage_timestream-write/2024-07-22T19:56:23+02:00/references/coverage/coverage_transcribe/2024-07-22T19:56:23+02:00/user-guide/aws/transcribe/2024-07-18T20:24:20+05:30/references/coverage/coverage_transfer/2024-07-22T19:56:23+02:00/user-guide/aws/transfer/2024-07-18T20:24:20+05:30/tags/troubleshooting/2024-07-18T20:24:20+05:30/references/coverage/coverage_wafv2/2024-07-22T19:56:23+02:00/user-guide/aws/waf/2024-07-18T20:24:20+05:30/user-guide/aws/xray/2024-07-18T20:24:20+05:30/references/coverage/coverage_xray/2024-07-22T19:56:23+02:00
\ No newline at end of file
diff --git a/tags/api-gateway/index.html b/tags/api-gateway/index.html
index 455fc3147f..0961bcac93 100644
--- a/tags/api-gateway/index.html
+++ b/tags/api-gateway/index.html
@@ -1,3 +1,3 @@
 API Gateway | Docs
-
    Tag: API Gateway
    How To: Collaborative AWS local development with LocalStack’s Cloud Pods
    Replicating development environments ensures that all developers, regardless of their local machine configurations or operating systems, work within an environment that closely mirrors production. This consistency helps identify and solve environment-specific issues early in the development cycle, reducing the “it works on my machine” problem where code behaves differently on different developers’ machines.
    Tags:
      9 minute read  
    Chaos Engineering: Simulating outages in your application stack
    Utilize the LocalStack Outages Extension to simulate service disruptions and assess how well your infrastructure can deploy and recover from unexpected situations. This tool helps you test the resilience of your system by creating controlled outage scenarios, allowing you to identify and improve upon weaknesses.
    Tags:
      5 minute read  
    All Tags
    
\ No newline at end of file
+
    Tag: API Gateway
    How To: Collaborative AWS local development with LocalStack’s Cloud Pods
    Replicating development environments ensures that all developers, regardless of their local machine configurations or operating systems, work within an environment that closely mirrors production. This consistency helps identify and solve environment-specific issues early in the development cycle, reducing the “it works on my machine” problem where code behaves differently on different developers’ machines.
    Tags:
      9 minute read  
    All Tags
    
\ No newline at end of file
diff --git a/tags/api-gateway/index.xml b/tags/api-gateway/index.xml
index b7ce4582ee..44b89f45c6 100644
--- a/tags/api-gateway/index.xml
+++ b/tags/api-gateway/index.xml
@@ -1,4 +1,4 @@
 API Gateway on Docs/tags/api-gateway/Recent content in API Gateway on DocsHugoenHow To: Collaborative AWS local development with LocalStack’s Cloud Pods/tutorials/cloud-pods-collaborative-debugging/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/cloud-pods-collaborative-debugging/Introduction By replicating environments, teams can share the exact conditions under which a bug occurs.
-For developing AWS applications locally, the tool of choice is LocalStack, which can sustain a full-blown comprehensive stack. However, when issues appear, and engineers need a second opinion from a colleague, recreating the environment from scratch can leave details slipping through the cracks. This is where Cloud Pods come in, to encapsulate the state of the LocalStack instance and allow for seamless collaboration.Chaos Engineering: Running Experiments with Fault Injection Service/tutorials/fault-injection-service-experiments/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/fault-injection-service-experiments/Introduction Fault Injection Simulator (FIS) is a service designed for conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. FIS offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. To read about the FIS service, refer to the dedicated FIS documentation.
-Getting started This tutorial is designed for users new to the Fault Injection Simulator and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.Chaos Engineering: Route53 Failover with FIS/tutorials/route53-failover-with-fis/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route53-failover-with-fis/Introduction LocalStack allows you to integrate &amp; test Fault Injection Simulator (FIS) with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences.
-Note Route53 Failover with FIS is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating outages in your application stack/tutorials/simulating-outages-in-your-application-stack/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages-in-your-application-stack/Introduction LocalStack Outages Extension can simulate outages for any AWS region or service. You can install and use the Outages Extension through LocalStack Extension mechanism to test infrastructure resilience by intentionally causing service outages and observing the system&rsquo;s recovery in scenarios with incomplete infrastructure is an effective approach. This method evaluates the system&rsquo;s deployment mechanisms and its ability to handle and recover from infrastructure anomalies, a critical aspect of chaos engineering.
\ No newline at end of file
+For developing AWS applications locally, the tool of choice is LocalStack, which can sustain a full-blown comprehensive stack. However, when issues appear, and engineers need a second opinion from a colleague, recreating the environment from scratch can leave details slipping through the cracks. This is where Cloud Pods come in, to encapsulate the state of the LocalStack instance and allow for seamless collaboration.Chaos Engineering: Route53 Failover/tutorials/route-53-failover/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route-53-failover/Introduction LocalStack allows you to integrate and test Chaos API with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences.
+Note Route53 Failover and Chaos API is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating Outages using Chaos API/tutorials/simulating-outages/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages/Introduction LocalStack Chaos API is capable of simulating infrastructure faults to allow conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. Chaos API offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages.
+Getting started In this tutorial we study the effects of outages on a sample AWS application. We use the Chaos API to simulate the outage and design a mitigation to make the application resilient against database outages.
\ No newline at end of file
diff --git a/tags/bash/index.html b/tags/bash/index.html
index 986dbb8dd6..1772de56af 100644
--- a/tags/bash/index.html
+++ b/tags/bash/index.html
@@ -1,3 +1,3 @@
 BASH | Docs
 
    Tag: BASH
    Deploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack
    Set up an NGINX web server via Elastic Container Service (ECS) and Elastic Container Registry (ECR) to serve a static website using LocalStack. Learn how you can use CloudFormation templates to declaratively define, create, and deploy your architecture locally with LocalStack’s awslocal CLI.
    Tags:
      11 minute read  
    Chaos Engineering: Simulating outages in your application stack
    Utilize the LocalStack Outages Extension to simulate service disruptions and assess how well your infrastructure can deploy and recover from unexpected situations. This tool helps you test the resilience of your system by creating controlled outage scenarios, allowing you to identify and improve upon weaknesses.
    Tags:
      5 minute read  
    All Tags
    
\ No newline at end of file
+    | docs

    Tag: BASH

    Deploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack

    Set up an NGINX web server via Elastic Container Service (ECS) and Elastic Container Registry (ECR) to serve a static website using LocalStack. Learn how you can use CloudFormation templates to declaratively define, create, and deploy your architecture locally with LocalStack’s awslocal CLI.

    Tags:

      11 minute read  

    All Tags
    \ No newline at end of file diff --git a/tags/bash/index.xml b/tags/bash/index.xml index 4156cd1d88..292b623aff 100644 --- a/tags/bash/index.xml +++ b/tags/bash/index.xml @@ -1,3 +1 @@ -BASH on Docs/tags/bash/Recent content in BASH on DocsHugoenDeploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack/tutorials/ecs-ecr-container-app/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/ecs-ecr-container-app/Amazon Elastic Container Service (ECS) is a fully-managed container orchestration service that simplifies the deployment, management, and scaling of Docker containers on AWS. With support for two launch types, EC2 and Fargate, ECS allows you to run containers on your cluster of EC2 instances or have AWS manage your underlying infrastructure with Fargate. The Fargate launch type provides a serverless-like experience for running containers, allowing you to focus on your applications instead of infrastructure.Chaos Engineering: Running Experiments with Fault Injection Service/tutorials/fault-injection-service-experiments/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/fault-injection-service-experiments/Introduction Fault Injection Simulator (FIS) is a service designed for conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. FIS offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. To read about the FIS service, refer to the dedicated FIS documentation. -Getting started This tutorial is designed for users new to the Fault Injection Simulator and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.Chaos Engineering: Route53 Failover with FIS/tutorials/route53-failover-with-fis/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route53-failover-with-fis/Introduction LocalStack allows you to integrate &amp; test Fault Injection Simulator (FIS) with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences. -Note Route53 Failover with FIS is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating outages in your application stack/tutorials/simulating-outages-in-your-application-stack/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages-in-your-application-stack/Introduction LocalStack Outages Extension can simulate outages for any AWS region or service. You can install and use the Outages Extension through LocalStack Extension mechanism to test infrastructure resilience by intentionally causing service outages and observing the system&rsquo;s recovery in scenarios with incomplete infrastructure is an effective approach. This method evaluates the system&rsquo;s deployment mechanisms and its ability to handle and recover from infrastructure anomalies, a critical aspect of chaos engineering. \ No newline at end of file +BASH on Docs/tags/bash/Recent content in BASH on DocsHugoenDeploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack/tutorials/ecs-ecr-container-app/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/ecs-ecr-container-app/Amazon Elastic Container Service (ECS) is a fully-managed container orchestration service that simplifies the deployment, management, and scaling of Docker containers on AWS. With support for two launch types, EC2 and Fargate, ECS allows you to run containers on your cluster of EC2 instances or have AWS manage your underlying infrastructure with Fargate. The Fargate launch type provides a serverless-like experience for running containers, allowing you to focus on your applications instead of infrastructure. \ No newline at end of file diff --git a/tags/chaos-engineering/index.html b/tags/chaos-engineering/index.html new file mode 100644 index 0000000000..9cc872c9f2 --- /dev/null +++ b/tags/chaos-engineering/index.html @@ -0,0 +1,3 @@ +Chaos Engineering | Docs +

    Tag: Chaos Engineering

    All Tags
    \ No newline at end of file diff --git a/tags/chaos-engineering/index.xml b/tags/chaos-engineering/index.xml new file mode 100644 index 0000000000..0ac6f8bbaf --- /dev/null +++ b/tags/chaos-engineering/index.xml @@ -0,0 +1,3 @@ +Chaos Engineering on Docs/tags/chaos-engineering/Recent content in Chaos Engineering on DocsHugoenChaos Engineering: Route53 Failover/tutorials/route-53-failover/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route-53-failover/Introduction LocalStack allows you to integrate and test Chaos API with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences. +Note Route53 Failover and Chaos API is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating Outages using Chaos API/tutorials/simulating-outages/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages/Introduction LocalStack Chaos API is capable of simulating infrastructure faults to allow conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. Chaos API offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. +Getting started In this tutorial we study the effects of outages on a sample AWS application. We use the Chaos API to simulate the outage and design a mitigation to make the application resilient against database outages. \ No newline at end of file diff --git a/tags/dynamodb/index.html b/tags/dynamodb/index.html index c51bad61e7..0cd95559e5 100644 --- a/tags/dynamodb/index.html +++ b/tags/dynamodb/index.html @@ -1,3 +1,3 @@ DynamoDB | Docs -

    Tag: DynamoDB

    How To: Collaborative AWS local development with LocalStack’s Cloud Pods

    Replicating development environments ensures that all developers, regardless of their local machine configurations or operating systems, work within an environment that closely mirrors production. This consistency helps identify and solve environment-specific issues early in the development cycle, reducing the “it works on my machine” problem where code behaves differently on different developers’ machines.

    Tags:

      9 minute read  

    Chaos Engineering: Simulating outages in your application stack

    Utilize the LocalStack Outages Extension to simulate service disruptions and assess how well your infrastructure can deploy and recover from unexpected situations. This tool helps you test the resilience of your system by creating controlled outage scenarios, allowing you to identify and improve upon weaknesses.

    Tags:

      5 minute read  

    All Tags
    \ No newline at end of file +

    Tag: DynamoDB

    How To: Collaborative AWS local development with LocalStack’s Cloud Pods

    Replicating development environments ensures that all developers, regardless of their local machine configurations or operating systems, work within an environment that closely mirrors production. This consistency helps identify and solve environment-specific issues early in the development cycle, reducing the “it works on my machine” problem where code behaves differently on different developers’ machines.

    Tags:

      9 minute read  

    All Tags
    \ No newline at end of file diff --git a/tags/dynamodb/index.xml b/tags/dynamodb/index.xml index e3cd712595..cb83ed6f6e 100644 --- a/tags/dynamodb/index.xml +++ b/tags/dynamodb/index.xml @@ -1,4 +1,4 @@ DynamoDB on Docs/tags/dynamodb/Recent content in DynamoDB on DocsHugoenHow To: Collaborative AWS local development with LocalStack’s Cloud Pods/tutorials/cloud-pods-collaborative-debugging/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/cloud-pods-collaborative-debugging/Introduction By replicating environments, teams can share the exact conditions under which a bug occurs. -For developing AWS applications locally, the tool of choice is LocalStack, which can sustain a full-blown comprehensive stack. However, when issues appear, and engineers need a second opinion from a colleague, recreating the environment from scratch can leave details slipping through the cracks. This is where Cloud Pods come in, to encapsulate the state of the LocalStack instance and allow for seamless collaboration.Chaos Engineering: Running Experiments with Fault Injection Service/tutorials/fault-injection-service-experiments/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/fault-injection-service-experiments/Introduction Fault Injection Simulator (FIS) is a service designed for conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. FIS offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. To read about the FIS service, refer to the dedicated FIS documentation. -Getting started This tutorial is designed for users new to the Fault Injection Simulator and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.Chaos Engineering: Route53 Failover with FIS/tutorials/route53-failover-with-fis/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route53-failover-with-fis/Introduction LocalStack allows you to integrate &amp; test Fault Injection Simulator (FIS) with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences. -Note Route53 Failover with FIS is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating outages in your application stack/tutorials/simulating-outages-in-your-application-stack/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages-in-your-application-stack/Introduction LocalStack Outages Extension can simulate outages for any AWS region or service. You can install and use the Outages Extension through LocalStack Extension mechanism to test infrastructure resilience by intentionally causing service outages and observing the system&rsquo;s recovery in scenarios with incomplete infrastructure is an effective approach. This method evaluates the system&rsquo;s deployment mechanisms and its ability to handle and recover from infrastructure anomalies, a critical aspect of chaos engineering.AppSync GraphQL APIs for DynamoDB and RDS Aurora PostgreSQL/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/Mon, 01 Jan 0001 00:00:00 +0000/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/ \ No newline at end of file +For developing AWS applications locally, the tool of choice is LocalStack, which can sustain a full-blown comprehensive stack. However, when issues appear, and engineers need a second opinion from a colleague, recreating the environment from scratch can leave details slipping through the cracks. This is where Cloud Pods come in, to encapsulate the state of the LocalStack instance and allow for seamless collaboration.AppSync GraphQL APIs for DynamoDB and RDS Aurora PostgreSQL/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/Mon, 01 Jan 0001 00:00:00 +0000/applications/appsync-graphql-apis-for-dynamodb-and-rds-aurora-postgresql/Chaos Engineering: Route53 Failover/tutorials/route-53-failover/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route-53-failover/Introduction LocalStack allows you to integrate and test Chaos API with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences. +Note Route53 Failover and Chaos API is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access.Chaos Engineering: Simulating Outages using Chaos API/tutorials/simulating-outages/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages/Introduction LocalStack Chaos API is capable of simulating infrastructure faults to allow conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. Chaos API offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. +Getting started In this tutorial we study the effects of outages on a sample AWS application. We use the Chaos API to simulate the outage and design a mitigation to make the application resilient against database outages. \ No newline at end of file diff --git a/tags/ecs/index.html b/tags/ecs/index.html index a4da9eb0d4..38c650b2cf 100644 --- a/tags/ecs/index.html +++ b/tags/ecs/index.html @@ -1,3 +1,3 @@ ECS | Docs -

    Tag: ECS

    Deploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack

    Set up an NGINX web server via Elastic Container Service (ECS) and Elastic Container Registry (ECR) to serve a static website using LocalStack. Learn how you can use CloudFormation templates to declaratively define, create, and deploy your architecture locally with LocalStack’s awslocal CLI.

    Tags:

      11 minute read  

    Chaos Engineering: Simulating outages in your application stack

    Utilize the LocalStack Outages Extension to simulate service disruptions and assess how well your infrastructure can deploy and recover from unexpected situations. This tool helps you test the resilience of your system by creating controlled outage scenarios, allowing you to identify and improve upon weaknesses.

    Tags:

      5 minute read  

    All Tags
    \ No newline at end of file +

    Tag: ECS

    Deploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack

    Set up an NGINX web server via Elastic Container Service (ECS) and Elastic Container Registry (ECR) to serve a static website using LocalStack. Learn how you can use CloudFormation templates to declaratively define, create, and deploy your architecture locally with LocalStack’s awslocal CLI.

    Tags:

      11 minute read  

    All Tags
    \ No newline at end of file diff --git a/tags/ecs/index.xml b/tags/ecs/index.xml index 84cbf3bdac..e33110226f 100644 --- a/tags/ecs/index.xml +++ b/tags/ecs/index.xml @@ -1 +1,2 @@ -ECS on Docs/tags/ecs/Recent content in ECS on DocsHugoenDeploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack/tutorials/ecs-ecr-container-app/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/ecs-ecr-container-app/Amazon Elastic Container Service (ECS) is a fully-managed container orchestration service that simplifies the deployment, management, and scaling of Docker containers on AWS. With support for two launch types, EC2 and Fargate, ECS allows you to run containers on your cluster of EC2 instances or have AWS manage your underlying infrastructure with Fargate. The Fargate launch type provides a serverless-like experience for running containers, allowing you to focus on your applications instead of infrastructure.Chaos Engineering: Simulating outages in your application stack/tutorials/simulating-outages-in-your-application-stack/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages-in-your-application-stack/Introduction LocalStack Outages Extension can simulate outages for any AWS region or service. You can install and use the Outages Extension through LocalStack Extension mechanism to test infrastructure resilience by intentionally causing service outages and observing the system&rsquo;s recovery in scenarios with incomplete infrastructure is an effective approach. This method evaluates the system&rsquo;s deployment mechanisms and its ability to handle and recover from infrastructure anomalies, a critical aspect of chaos engineering. \ No newline at end of file +ECS on Docs/tags/ecs/Recent content in ECS on DocsHugoenDeploying containers on Elastic Container Service (ECS) clusters using Elastic Container Registry (ECR) and AWS Fargate, with LocalStack/tutorials/ecs-ecr-container-app/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/ecs-ecr-container-app/Amazon Elastic Container Service (ECS) is a fully-managed container orchestration service that simplifies the deployment, management, and scaling of Docker containers on AWS. With support for two launch types, EC2 and Fargate, ECS allows you to run containers on your cluster of EC2 instances or have AWS manage your underlying infrastructure with Fargate. The Fargate launch type provides a serverless-like experience for running containers, allowing you to focus on your applications instead of infrastructure.Chaos Engineering: Simulating Outages using Chaos API/tutorials/simulating-outages/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/simulating-outages/Introduction LocalStack Chaos API is capable of simulating infrastructure faults to allow conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. Chaos API offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. +Getting started In this tutorial we study the effects of outages on a sample AWS application. We use the Chaos API to simulate the outage and design a mitigation to make the application resilient against database outages. \ No newline at end of file diff --git a/tags/enterprise-plan/index.html b/tags/enterprise-plan/index.html index 38da570a7e..ef7c0b7a63 100644 --- a/tags/enterprise-plan/index.html +++ b/tags/enterprise-plan/index.html @@ -1,3 +1,3 @@ Enterprise Plan | Docs -

    Tag: Enterprise Plan

    All Tags
    \ No newline at end of file +

    Tag: Enterprise Plan

    All Tags
    \ No newline at end of file diff --git a/tags/enterprise-plan/index.xml b/tags/enterprise-plan/index.xml index 91fb2df639..af49fecaa1 100644 --- a/tags/enterprise-plan/index.xml +++ b/tags/enterprise-plan/index.xml @@ -1,10 +1,14 @@ -Enterprise Plan on Docs/tags/enterprise-plan/Recent content in Enterprise Plan on DocsHugoenOutages Extension/user-guide/chaos-engineering/outages-extension/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/outages-extension/Introduction The LocalStack Outages Extension allows you to mimic outages across any AWS region or service. By integrating the Outages Extension using the LocalStack Extension mechanism, you can assess your infrastructure&rsquo;s robustness. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering.Special Configurations/user-guide/chaos-engineering/special-configs/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/special-configs/Introduction LocalStack allows users to inject intentional errors, particularly in Kinesis and DynamoDB. You can introduce controlled chaos into your development environment enhance to enhance service resilience. By configuring environment variables, you can simulate disruptions. This simple setup helps improve the response mechanisms of these key AWS services, ensuring robust architecture under challenging conditions with minimal initial configuration. -This guide demonstrates the DYNAMODB_ERROR_PROBABILITY and KINESIS_ERROR_PROBABILITY configuration flags. The guide assumes basic knowledge of the AWS CLI and our awslocal wrapper script.SSO for Azure AD/user-guide/web-application/single-sign-on/azure-ad/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/web-application/single-sign-on/azure-ad/To configure SSO with an Azure AD Enterprise application, we provide a simple step-by-step solution below: +Enterprise Plan on Docs/tags/enterprise-plan/Recent content in Enterprise Plan on DocsHugoenSSO for Azure AD/user-guide/web-application/single-sign-on/azure-ad/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/web-application/single-sign-on/azure-ad/To configure SSO with an Azure AD Enterprise application, we provide a simple step-by-step solution below: Navigate to &ldquo;Set up single sign on&rdquo; in your Azure AD Enterprise application. In the Basic SAML Configuration, ensure that the settings match the following details Take the correct values for Identifier (Entity ID) and Reply URL from the Identity Provider configuration page. In the Attributes &amp; Claims section, add a group claim with the following configuration and save it.CI Analytics/user-guide/web-application/ci-analytics/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/web-application/ci-analytics/Introduction CI Analytics is a feature of LocalStack Web Application that allows users to get insights into their CI builds. CI Analytics unifies additional features, such as Cloud Pods &amp; Stack Insights, and augments them with an integrated view of CI builds to provide users with insights and facilitate debugging. The features include: CI Project Runs: Offers a unified view of all CI builds for a particular project. Log Output: Enables viewing of detailed logs for individual CI builds.Single-Sign On/user-guide/web-application/single-sign-on/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/web-application/single-sign-on/Custom Single-Sign On (SSO) Identity providers, can be enabled to facilitate the process of quickly onboarding team members from your organization. In order to configure SSO access, first sign in to the LocalStack Web application under app.localstack.cloud. In your profile settings, navigate to the Single Sign-on tab which will list existing SSO Identity Providers (if any exist). -Next, click the button to create a new identity provider (IdP), where you can choose between the two leading industry standards:Database Migration Service (DMS)/user-guide/aws/dms/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/aws/dms/Introduction AWS Database Migration Service provides migration solution from databases, data warehouses, and other type of data stores (e.g. S3, SAP). The migration can be homogeneous (source and target have the same type), but often times is heterogeneous as it supports migration from various sources to various targets (self-hosted and AWS services). -LocalStack only supports selected use cases for DMS at the moment. The supported APIs are available on our API coverage page, which provides information on the extent of DMS integration with LocalStack. \ No newline at end of file +Next, click the button to create a new identity provider (IdP), where you can choose between the two leading industry standards:AWS Fault Injection Service/user-guide/chaos-engineering/fault-injection-service/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/fault-injection-service/Introduction The Fault Injection Service is a fully managed service by AWS designed to help you improve the resilience of your applications by simulating real-world outages and operational issues. This service allows you to conduct controlled experiments on your AWS infrastructure, injecting faults and observing how your system responds under various conditions. +By using the Fault Injection Service, you can identify weaknesses, test recovery procedures, and ensure that your applications can withstand unexpected disruptions.Chaos API/user-guide/chaos-engineering/chaos-api/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/chaos-api/Introduction LocalStack Chaos API allows you to mimic outages across any AWS region or service. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering. +You can use LocalStack Chaos API to cause API failures for any combination of the following:Chaos Engineering Dashboard/user-guide/chaos-engineering/web-application-dashboard/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/web-application-dashboard/Introduction The Chaos Engineering dashboard in LocalStack offers streamlined testing for cloud applications, enabling you to simulate server errors, service outages, regional disruptions, and network latency with ease, ensuring your app is ready for real-world challenges. +You can find this feature in the LocalStack Web Application by navigating to app.localstack.cloud/chaos-engineering. +FIS Dashboard The FIS Dashboard in LocalStack Web Application allows you to conduct Fault Injection Service experiments on infrastructure stacks. This control panel offers various FIS experiment options, which includes:Database Migration Service (DMS)/user-guide/aws/dms/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/aws/dms/Introduction AWS Database Migration Service provides migration solution from databases, data warehouses, and other type of data stores (e.g. S3, SAP). The migration can be homogeneous (source and target have the same type), but often times is heterogeneous as it supports migration from various sources to various targets (self-hosted and AWS services). +LocalStack only supports selected use cases for DMS at the moment. The supported APIs are available on our API coverage page, which provides information on the extent of DMS integration with LocalStack.Fault Injection Service (FIS)/user-guide/aws/fis/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/aws/fis/Introduction Fault Injection Service (FIS) is a service provided by Amazon Web Services that enables you to test the resilience of your applications and infrastructure by injecting faults and failures into your AWS resources. FIS simulates faults such as resource unavailability and service errors to assess the impact on your application&rsquo;s performance and availability. The full list of such possible fault injections is available in the AWS docs. +LocalStack allows you to use the FIS APIs in your local environment to introduce faults in other services, in order to check how your setup behaves when parts of it stop working locally.Outages Extension/user-guide/chaos-engineering/outages-extension/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/outages-extension/Introduction Warning Outages Extension has been deprecated. It is recommended to migrate to the Chaos API. The LocalStack Outages Extension allows you to mimic outages across any AWS region or service. By integrating the Outages Extension using the LocalStack Extension mechanism, you can assess your infrastructure&rsquo;s robustness. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering. \ No newline at end of file diff --git a/tags/fis/index.html b/tags/fis/index.html deleted file mode 100644 index 332e9a1240..0000000000 --- a/tags/fis/index.html +++ /dev/null @@ -1,3 +0,0 @@ -FIS | Docs -

    Tag: FIS

    All Tags
    \ No newline at end of file diff --git a/tags/fis/index.xml b/tags/fis/index.xml deleted file mode 100644 index da23bf8869..0000000000 --- a/tags/fis/index.xml +++ /dev/null @@ -1,3 +0,0 @@ -FIS on Docs/tags/fis/Recent content in FIS on DocsHugoenChaos Engineering: Running Experiments with Fault Injection Service/tutorials/fault-injection-service-experiments/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/fault-injection-service-experiments/Introduction Fault Injection Simulator (FIS) is a service designed for conducting controlled chaos engineering tests on AWS infrastructure. Its purpose is to uncover vulnerabilities and improve system robustness. FIS offers a means to deliberately introduce failures and observe their impacts, helping developers to better equip their systems against actual outages. To read about the FIS service, refer to the dedicated FIS documentation. -Getting started This tutorial is designed for users new to the Fault Injection Simulator and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.Chaos Engineering: Route53 Failover with FIS/tutorials/route53-failover-with-fis/Mon, 01 Jan 0001 00:00:00 +0000/tutorials/route53-failover-with-fis/Introduction LocalStack allows you to integrate &amp; test Fault Injection Simulator (FIS) with Route53 to automatically divert users to a healthy secondary zone if the primary region fails, ensuring system availability and responsiveness. Route53&rsquo;s health checks and traffic redirection enhance architecture resilience and ensure service continuity during regional outages, crucial for uninterrupted user experiences. -Note Route53 Failover with FIS is currently available as part of the LocalStack Enterprise plan. If you&rsquo;d like to try it out, please contact us to request access. \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 9ed4a96528..e0e233b9d9 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,3 +1,3 @@ Tags | Docs -

    Tags

    \ No newline at end of file +

    Tags

    \ No newline at end of file diff --git a/tags/index.xml b/tags/index.xml index 47dc2bd7b6..212528f674 100644 --- a/tags/index.xml +++ b/tags/index.xml @@ -1 +1 @@ -Tags on Docs/tags/Recent content in Tags on DocsHugoenAPI Gateway/tags/api-gateway/Mon, 01 Jan 0001 00:00:00 +0000/tags/api-gateway/Appsync/tags/appsync/Mon, 01 Jan 0001 00:00:00 +0000/tags/appsync/AWS Java SDK/tags/aws-java-sdk/Mon, 01 Jan 0001 00:00:00 +0000/tags/aws-java-sdk/BASH/tags/bash/Mon, 01 Jan 0001 00:00:00 +0000/tags/bash/Big-Data/tags/big-data/Mon, 01 Jan 0001 00:00:00 +0000/tags/big-data/Cloud Pods/tags/cloud-pods/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloud-pods/CloudFormation/tags/cloudformation/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloudformation/CloudWatch/tags/cloudwatch/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloudwatch/Compliance/tags/compliance/Mon, 01 Jan 0001 00:00:00 +0000/tags/compliance/Container/tags/container/Mon, 01 Jan 0001 00:00:00 +0000/tags/container/Container Image/tags/container-image/Mon, 01 Jan 0001 00:00:00 +0000/tags/container-image/Data-Analytics/tags/data-analytics/Mon, 01 Jan 0001 00:00:00 +0000/tags/data-analytics/Databases/tags/databases/Mon, 01 Jan 0001 00:00:00 +0000/tags/databases/Docker/tags/docker/Mon, 01 Jan 0001 00:00:00 +0000/tags/docker/Docker-in-Docker/tags/docker-in-docker/Mon, 01 Jan 0001 00:00:00 +0000/tags/docker-in-docker/DynamoDB/tags/dynamodb/Mon, 01 Jan 0001 00:00:00 +0000/tags/dynamodb/ECR/tags/ecr/Mon, 01 Jan 0001 00:00:00 +0000/tags/ecr/ECS/tags/ecs/Mon, 01 Jan 0001 00:00:00 +0000/tags/ecs/Elastic Load Balancing/tags/elastic-load-balancing/Mon, 01 Jan 0001 00:00:00 +0000/tags/elastic-load-balancing/Enterprise Plan/tags/enterprise-plan/Mon, 01 Jan 0001 00:00:00 +0000/tags/enterprise-plan/Event-Driven-Architecture/tags/event-driven-architecture/Mon, 01 Jan 0001 00:00:00 +0000/tags/event-driven-architecture/Fargate/tags/fargate/Mon, 01 Jan 0001 00:00:00 +0000/tags/fargate/FIS/tags/fis/Mon, 01 Jan 0001 00:00:00 +0000/tags/fis/GitLab/tags/gitlab/Mon, 01 Jan 0001 00:00:00 +0000/tags/gitlab/GitLab Runners/tags/gitlab-runners/Mon, 01 Jan 0001 00:00:00 +0000/tags/gitlab-runners/Glue Schema Registry/tags/glue-schema-registry/Mon, 01 Jan 0001 00:00:00 +0000/tags/glue-schema-registry/Graphql/tags/graphql/Mon, 01 Jan 0001 00:00:00 +0000/tags/graphql/IAM/tags/iam/Mon, 01 Jan 0001 00:00:00 +0000/tags/iam/Identity/tags/identity/Mon, 01 Jan 0001 00:00:00 +0000/tags/identity/Init Hooks/tags/init-hooks/Mon, 01 Jan 0001 00:00:00 +0000/tags/init-hooks/Internal-Endpoints/tags/internal-endpoints/Mon, 01 Jan 0001 00:00:00 +0000/tags/internal-endpoints/Java/tags/java/Mon, 01 Jan 0001 00:00:00 +0000/tags/java/JavaScript/tags/javascript/Mon, 01 Jan 0001 00:00:00 +0000/tags/javascript/Kafka/tags/kafka/Mon, 01 Jan 0001 00:00:00 +0000/tags/kafka/Lambda/tags/lambda/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda/Lambda Layers/tags/lambda-layers/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda-layers/Lambda-Trigger/tags/lambda-trigger/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda-trigger/Localstack-Endpoints/tags/localstack-endpoints/Mon, 01 Jan 0001 00:00:00 +0000/tags/localstack-endpoints/Localsurf/tags/localsurf/Mon, 01 Jan 0001 00:00:00 +0000/tags/localsurf/Logging/tags/logging/Mon, 01 Jan 0001 00:00:00 +0000/tags/logging/Machine Learning/tags/machine-learning/Mon, 01 Jan 0001 00:00:00 +0000/tags/machine-learning/Microservices/tags/microservices/Mon, 01 Jan 0001 00:00:00 +0000/tags/microservices/MSK/tags/msk/Mon, 01 Jan 0001 00:00:00 +0000/tags/msk/Networking/tags/networking/Mon, 01 Jan 0001 00:00:00 +0000/tags/networking/NGINX/tags/nginx/Mon, 01 Jan 0001 00:00:00 +0000/tags/nginx/Node.js/tags/node.js/Mon, 01 Jan 0001 00:00:00 +0000/tags/node.js/Pro Image/tags/pro-image/Mon, 01 Jan 0001 00:00:00 +0000/tags/pro-image/Rds/tags/rds/Mon, 01 Jan 0001 00:00:00 +0000/tags/rds/Rds-Proxy/tags/rds-proxy/Mon, 01 Jan 0001 00:00:00 +0000/tags/rds-proxy/Reproducible/tags/reproducible/Mon, 01 Jan 0001 00:00:00 +0000/tags/reproducible/Route53/tags/route53/Mon, 01 Jan 0001 00:00:00 +0000/tags/route53/Rule-Based-Authentication/tags/rule-based-authentication/Mon, 01 Jan 0001 00:00:00 +0000/tags/rule-based-authentication/S3/tags/s3/Mon, 01 Jan 0001 00:00:00 +0000/tags/s3/S3-Website/tags/s3-website/Mon, 01 Jan 0001 00:00:00 +0000/tags/s3-website/Schema Evolution/tags/schema-evolution/Mon, 01 Jan 0001 00:00:00 +0000/tags/schema-evolution/Security/tags/security/Mon, 01 Jan 0001 00:00:00 +0000/tags/security/Serverless/tags/serverless/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless/Serverless Framework/tags/serverless-framework/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-framework/Serverless-Containers/tags/serverless-containers/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-containers/Serverless-Localstack Plugin/tags/serverless-localstack-plugin/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-localstack-plugin/Simple Email Service/tags/simple-email-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-email-service/Simple Notification Service/tags/simple-notification-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-notification-service/Simple Queue Service/tags/simple-queue-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-queue-service/Spring Boot/tags/spring-boot/Mon, 01 Jan 0001 00:00:00 +0000/tags/spring-boot/Ssl/tags/ssl/Mon, 01 Jan 0001 00:00:00 +0000/tags/ssl/Static-Website/tags/static-website/Mon, 01 Jan 0001 00:00:00 +0000/tags/static-website/Step-Up-Auth/tags/step-up-auth/Mon, 01 Jan 0001 00:00:00 +0000/tags/step-up-auth/Teams Plan/tags/teams-plan/Mon, 01 Jan 0001 00:00:00 +0000/tags/teams-plan/Terraform/tags/terraform/Mon, 01 Jan 0001 00:00:00 +0000/tags/terraform/Testcontainers/tags/testcontainers/Mon, 01 Jan 0001 00:00:00 +0000/tags/testcontainers/Tflocal CLI/tags/tflocal-cli/Mon, 01 Jan 0001 00:00:00 +0000/tags/tflocal-cli/Troubleshooting/tags/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000/tags/troubleshooting/ \ No newline at end of file +Tags on Docs/tags/Recent content in Tags on DocsHugoenAPI Gateway/tags/api-gateway/Mon, 01 Jan 0001 00:00:00 +0000/tags/api-gateway/Appsync/tags/appsync/Mon, 01 Jan 0001 00:00:00 +0000/tags/appsync/AWS Java SDK/tags/aws-java-sdk/Mon, 01 Jan 0001 00:00:00 +0000/tags/aws-java-sdk/BASH/tags/bash/Mon, 01 Jan 0001 00:00:00 +0000/tags/bash/Big-Data/tags/big-data/Mon, 01 Jan 0001 00:00:00 +0000/tags/big-data/Chaos Engineering/tags/chaos-engineering/Mon, 01 Jan 0001 00:00:00 +0000/tags/chaos-engineering/Cloud Pods/tags/cloud-pods/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloud-pods/CloudFormation/tags/cloudformation/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloudformation/CloudWatch/tags/cloudwatch/Mon, 01 Jan 0001 00:00:00 +0000/tags/cloudwatch/Compliance/tags/compliance/Mon, 01 Jan 0001 00:00:00 +0000/tags/compliance/Container/tags/container/Mon, 01 Jan 0001 00:00:00 +0000/tags/container/Container Image/tags/container-image/Mon, 01 Jan 0001 00:00:00 +0000/tags/container-image/Data-Analytics/tags/data-analytics/Mon, 01 Jan 0001 00:00:00 +0000/tags/data-analytics/Databases/tags/databases/Mon, 01 Jan 0001 00:00:00 +0000/tags/databases/Docker/tags/docker/Mon, 01 Jan 0001 00:00:00 +0000/tags/docker/Docker-in-Docker/tags/docker-in-docker/Mon, 01 Jan 0001 00:00:00 +0000/tags/docker-in-docker/DynamoDB/tags/dynamodb/Mon, 01 Jan 0001 00:00:00 +0000/tags/dynamodb/ECR/tags/ecr/Mon, 01 Jan 0001 00:00:00 +0000/tags/ecr/ECS/tags/ecs/Mon, 01 Jan 0001 00:00:00 +0000/tags/ecs/Elastic Load Balancing/tags/elastic-load-balancing/Mon, 01 Jan 0001 00:00:00 +0000/tags/elastic-load-balancing/Enterprise Plan/tags/enterprise-plan/Mon, 01 Jan 0001 00:00:00 +0000/tags/enterprise-plan/Event-Driven-Architecture/tags/event-driven-architecture/Mon, 01 Jan 0001 00:00:00 +0000/tags/event-driven-architecture/Fargate/tags/fargate/Mon, 01 Jan 0001 00:00:00 +0000/tags/fargate/GitLab/tags/gitlab/Mon, 01 Jan 0001 00:00:00 +0000/tags/gitlab/GitLab Runners/tags/gitlab-runners/Mon, 01 Jan 0001 00:00:00 +0000/tags/gitlab-runners/Glue Schema Registry/tags/glue-schema-registry/Mon, 01 Jan 0001 00:00:00 +0000/tags/glue-schema-registry/Graphql/tags/graphql/Mon, 01 Jan 0001 00:00:00 +0000/tags/graphql/IAM/tags/iam/Mon, 01 Jan 0001 00:00:00 +0000/tags/iam/Identity/tags/identity/Mon, 01 Jan 0001 00:00:00 +0000/tags/identity/Init Hooks/tags/init-hooks/Mon, 01 Jan 0001 00:00:00 +0000/tags/init-hooks/Internal-Endpoints/tags/internal-endpoints/Mon, 01 Jan 0001 00:00:00 +0000/tags/internal-endpoints/Java/tags/java/Mon, 01 Jan 0001 00:00:00 +0000/tags/java/JavaScript/tags/javascript/Mon, 01 Jan 0001 00:00:00 +0000/tags/javascript/Kafka/tags/kafka/Mon, 01 Jan 0001 00:00:00 +0000/tags/kafka/Lambda/tags/lambda/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda/Lambda Layers/tags/lambda-layers/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda-layers/Lambda-Trigger/tags/lambda-trigger/Mon, 01 Jan 0001 00:00:00 +0000/tags/lambda-trigger/Localstack-Endpoints/tags/localstack-endpoints/Mon, 01 Jan 0001 00:00:00 +0000/tags/localstack-endpoints/Localsurf/tags/localsurf/Mon, 01 Jan 0001 00:00:00 +0000/tags/localsurf/Logging/tags/logging/Mon, 01 Jan 0001 00:00:00 +0000/tags/logging/Machine Learning/tags/machine-learning/Mon, 01 Jan 0001 00:00:00 +0000/tags/machine-learning/Microservices/tags/microservices/Mon, 01 Jan 0001 00:00:00 +0000/tags/microservices/MSK/tags/msk/Mon, 01 Jan 0001 00:00:00 +0000/tags/msk/Networking/tags/networking/Mon, 01 Jan 0001 00:00:00 +0000/tags/networking/NGINX/tags/nginx/Mon, 01 Jan 0001 00:00:00 +0000/tags/nginx/Node.js/tags/node.js/Mon, 01 Jan 0001 00:00:00 +0000/tags/node.js/Pro Image/tags/pro-image/Mon, 01 Jan 0001 00:00:00 +0000/tags/pro-image/Rds/tags/rds/Mon, 01 Jan 0001 00:00:00 +0000/tags/rds/Rds-Proxy/tags/rds-proxy/Mon, 01 Jan 0001 00:00:00 +0000/tags/rds-proxy/Reproducible/tags/reproducible/Mon, 01 Jan 0001 00:00:00 +0000/tags/reproducible/Route53/tags/route53/Mon, 01 Jan 0001 00:00:00 +0000/tags/route53/Rule-Based-Authentication/tags/rule-based-authentication/Mon, 01 Jan 0001 00:00:00 +0000/tags/rule-based-authentication/S3/tags/s3/Mon, 01 Jan 0001 00:00:00 +0000/tags/s3/S3-Website/tags/s3-website/Mon, 01 Jan 0001 00:00:00 +0000/tags/s3-website/Schema Evolution/tags/schema-evolution/Mon, 01 Jan 0001 00:00:00 +0000/tags/schema-evolution/Security/tags/security/Mon, 01 Jan 0001 00:00:00 +0000/tags/security/Serverless/tags/serverless/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless/Serverless Framework/tags/serverless-framework/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-framework/Serverless-Containers/tags/serverless-containers/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-containers/Serverless-Localstack Plugin/tags/serverless-localstack-plugin/Mon, 01 Jan 0001 00:00:00 +0000/tags/serverless-localstack-plugin/Simple Email Service/tags/simple-email-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-email-service/Simple Notification Service/tags/simple-notification-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-notification-service/Simple Queue Service/tags/simple-queue-service/Mon, 01 Jan 0001 00:00:00 +0000/tags/simple-queue-service/Spring Boot/tags/spring-boot/Mon, 01 Jan 0001 00:00:00 +0000/tags/spring-boot/Ssl/tags/ssl/Mon, 01 Jan 0001 00:00:00 +0000/tags/ssl/Static-Website/tags/static-website/Mon, 01 Jan 0001 00:00:00 +0000/tags/static-website/Step-Up-Auth/tags/step-up-auth/Mon, 01 Jan 0001 00:00:00 +0000/tags/step-up-auth/Teams Plan/tags/teams-plan/Mon, 01 Jan 0001 00:00:00 +0000/tags/teams-plan/Terraform/tags/terraform/Mon, 01 Jan 0001 00:00:00 +0000/tags/terraform/Testcontainers/tags/testcontainers/Mon, 01 Jan 0001 00:00:00 +0000/tags/testcontainers/Tflocal CLI/tags/tflocal-cli/Mon, 01 Jan 0001 00:00:00 +0000/tags/tflocal-cli/Troubleshooting/tags/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000/tags/troubleshooting/ \ No newline at end of file diff --git a/tags/internal-endpoints/index.html b/tags/internal-endpoints/index.html index 83f8b33e9d..8cf840ab0a 100644 --- a/tags/internal-endpoints/index.html +++ b/tags/internal-endpoints/index.html @@ -1,3 +1,3 @@ Internal-Endpoints | Docs -

    How To: Collaborative AWS local development with LocalStack’s Cloud Pods

    Replicating development environments ensures that all developers, regardless of their local machine configurations or operating systems, work within an environment that closely mirrors production. This consistency helps identify and solve environment-specific issues early in the development cycle, reducing the “it works on my machine” problem where code behaves differently on different developers’ machines.
    \ No newline at end of file diff --git a/user-guide/aws/glacier/index.html b/user-guide/aws/glacier/index.html index 1077674fc8..8ce48053f4 100644 --- a/user-guide/aws/glacier/index.html +++ b/user-guide/aws/glacier/index.html @@ -152,10 +152,10 @@
  • +

    • Glacier

    Get started with S3 Glacier on LocalStack
    Tags:
    Persistence:

      4 minute read  

    Introduction

    Glacier is a data storage service provided by Amazon Web Services to suit the long-term storage of archives and backup of infrequently accessed data. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Glacier

    Get started with S3 Glacier on LocalStack
    Tags:
    Persistence:

      4 minute read  

    Introduction

    Glacier is a data storage service provided by Amazon Web Services to suit the long-term storage of archives and backup of infrequently accessed data. It offers various retrieval options, different levels of retrieval speed, and more. Glacier uses a Vault container to store your data, similar to how S3 stores data in Buckets. A Vault further holds the data in an Archive, which can contain text, images, video, and audio files. diff --git a/user-guide/aws/glue/index.html b/user-guide/aws/glue/index.html index 19c87773fb..5fb34ac86c 100644 --- a/user-guide/aws/glue/index.html +++ b/user-guide/aws/glue/index.html @@ -152,10 +152,10 @@

  • +

    • Glue

    Get started with Glue on LocalStack
    Tags:

      10 minute read  

    Introduction

    The Glue API in LocalStack Pro allows you to run ETL (Extract-Transform-Load) jobs locally, maintaining table metadata in the local Glue data catalog, and using the Spark ecosystem (PySpark/Scala) to run data processing workflows.

    LocalStack allows you to use the Glue APIs in your local environment. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Glue

    Get started with Glue on LocalStack
    Tags:

      10 minute read  

    Introduction

    The Glue API in LocalStack Pro allows you to run ETL (Extract-Transform-Load) jobs locally, maintaining table metadata in the local Glue data catalog, and using the Spark ecosystem (PySpark/Scala) to run data processing workflows.

    LocalStack allows you to use the Glue APIs in your local environment. The supported APIs are available on our API coverage page, which provides information on the extent of Glue’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Glue and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to create databases and table metadata in Glue, run Glue ETL jobs, import databases from Athena, and run Glue Crawlers with the AWS CLI.

    Identity and Access Management (IAM)

    Get started with AWS Identity and Access Management (IAM) on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Identity and Access Management (IAM) is a web service provided by Amazon Web Services (AWS) that enables users to control access to AWS resources securely. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Identity and Access Management (IAM)

    Get started with AWS Identity and Access Management (IAM) on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Identity and Access Management (IAM) is a web service provided by Amazon Web Services (AWS) that enables users to control access to AWS resources securely. IAM allows organizations to create and manage AWS users, groups, and roles, defining granular permissions to access specific AWS services and resources. By centralizing access control, administrators can enforce the principle of least privilege, ensuring users have only the necessary permissions for their tasks.

    LocalStack allows you to use the IAM APIs in your local environment to create and manage users, groups, and roles, granting permissions that adhere to the principle of least privilege. The supported APIs are available on our API coverage page, which provides information on the extent of IAM’s integration with LocalStack.

    Getting started

    This guide is designed for users new to IAM and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/identitystore/index.html b/user-guide/aws/identitystore/index.html index 283fb46c6f..3356d726bd 100644 --- a/user-guide/aws/identitystore/index.html +++ b/user-guide/aws/identitystore/index.html @@ -152,10 +152,10 @@

  • +

    • Identity Store

    Get started with Identity Store on LocalStack
    Tags:

      2 minute read  

    Introduction

    Identity Store is a managed service that enables the creation and management of groups within your AWS environment. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Identity Store

    Get started with Identity Store on LocalStack
    Tags:

      2 minute read  

    Introduction

    Identity Store is a managed service that enables the creation and management of groups within your AWS environment. Groups are used to manage access to AWS resources, and Identity Store provides a central location to create and manage groups across your AWS accounts.

    LocalStack allows you to use the Identity Store APIs to create and manage groups in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of Identity Store integration with LocalStack.

    Getting started

    This guide is aimed at users who are familiar with the AWS CLI and awslocal wrapper script. It will walk you through the basics of setting up and managing groups within the AWS Identity Store using LocalStack.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/iot/index.html b/user-guide/aws/iot/index.html index dbdacd8243..e9f431ce69 100644 --- a/user-guide/aws/iot/index.html +++ b/user-guide/aws/iot/index.html @@ -155,10 +155,10 @@

  • +

    • IoT

    Get started with AWS IoT on LocalStack
    Categories:

      4 minute read  

    Introduction

    AWS IoT provides cloud services to manage IoT fleet and integrate them with other AWS services

    LocalStack Pro supports IoT Core, IoT Data, IoT Analytics and related APIs as well as an in-built MQTT broker. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IoT

    Get started with AWS IoT on LocalStack
    Categories:

      4 minute read  

    Introduction

    AWS IoT provides cloud services to manage IoT fleet and integrate them with other AWS services

    LocalStack Pro supports IoT Core, IoT Data, IoT Analytics and related APIs as well as an in-built MQTT broker. Common operations for creating and updating things, groups, policies, certificates and other entities are implemented with full CloudFormation support. The supported APIs are available on our API coverage page.

    Getting Started

    This guide is for users that are new to IoT and assumes a basic knowledge of the AWS CLI and LocalStack awslocal wrapper.

    Start LocalStack using your preferred method.

    LocalStack ships an Message Queuing Telemetry Transport (MQTT) broker powered by Mosquitto which supports both pure MQTT and MQTT-over-WSS (WebSockets Secure) protocols. To retrieve the MQTT endpoint, use the DescribeEndpoint operation.

    $ awslocal iot describe-endpoint
diff --git a/user-guide/aws/iotanalytics/index.html b/user-guide/aws/iotanalytics/index.html
index c8d8bc578e..71933abd70 100644
--- a/user-guide/aws/iotanalytics/index.html
+++ b/user-guide/aws/iotanalytics/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • IoT Analytics

    Get started with IoT Analytics on LocalStack
    Categories:

      2 minute read  

    Introduction

    IoT Analytics is a managed service that enables you to collect, store, process, and analyze data generated by your IoT devices. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IoT Analytics

    Get started with IoT Analytics on LocalStack
    Categories:

      2 minute read  

    Introduction

    IoT Analytics is a managed service that enables you to collect, store, process, and analyze data generated by your IoT devices. It provides a set of tools to build IoT applications without having to manage the underlying infrastructure.

    LocalStack allows you to use the IoT Analytics APIs to create and manage channels, data stores, and pipelines in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of IoT Analytics integration with LocalStack.

    Getting started

    This guide is designed for users new to Iot Analytics and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to create a channel, data store, and pipeline within IoT Analytics using LocalStack.

    Create a channel

    You can create a channel using the CreateChannel API. diff --git a/user-guide/aws/iotwireless/index.html b/user-guide/aws/iotwireless/index.html index 7e337c0790..4d804179cf 100644 --- a/user-guide/aws/iotwireless/index.html +++ b/user-guide/aws/iotwireless/index.html @@ -152,10 +152,10 @@

  • +

    • IoT Wireless

    Get started with IoT Wireless on LocalStack
    Tags:

      2 minute read  

    Introduction

    AWS IoT Wireless is a managed service that enables customers to connect and manage wireless devices. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IoT Wireless

    Get started with IoT Wireless on LocalStack
    Tags:

      2 minute read  

    Introduction

    AWS IoT Wireless is a managed service that enables customers to connect and manage wireless devices. The service provides a set of APIs to manage wireless devices, gateways, and destinations.

    LocalStack allows you to use the IoT Wireless APIs in your local environment from creating wireless devices and gateways. The supported APIs are available on our API coverage page, which provides information on the extent of IoT Wireless’s integration with LocalStack.

    Getting started

    This guide is designed for users new to IoT Wireless and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to use IoT Wireless to create wireless devices and gateways with the AWS CLI.

    Create a Wireless Device

    You can create a wireless device using the CreateWirelessDevice API. diff --git a/user-guide/aws/kinesis/index.html b/user-guide/aws/kinesis/index.html index 57e2604555..353741c712 100644 --- a/user-guide/aws/kinesis/index.html +++ b/user-guide/aws/kinesis/index.html @@ -152,10 +152,10 @@

  • +

    • Kinesis

    Get started with Kinesis on LocalStack
    Persistence:

      5 minute read  

    Introduction

    Kinesis is a platform provided by Amazon Web Services (AWS) that enables your application to ingest, buffer, and process data in real-time. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis

    Get started with Kinesis on LocalStack
    Persistence:

      5 minute read  

    Introduction

    Kinesis is a platform provided by Amazon Web Services (AWS) that enables your application to ingest, buffer, and process data in real-time. Kinesis is suitable for applications that require processing and deriving insights from data streams such as logs, metrics, user interactions, and IoT sensor readings. Kinesis offers three main services: Kinesis Data Streams, Kinesis Data Firehose, and Kinesis Data Analytics. In this page, we take a look at Kinesis Data Streams which allows you to capture and store real-time data streams.

    LocalStack allows you to use the Kinesis APIs in your local environment from setting up data streams and configuring data processing to building real-time analytics applications. diff --git a/user-guide/aws/kinesisanalytics/index.html b/user-guide/aws/kinesisanalytics/index.html index 4b5d4b3a30..db9d743afc 100644 --- a/user-guide/aws/kinesisanalytics/index.html +++ b/user-guide/aws/kinesisanalytics/index.html @@ -155,10 +155,10 @@

  • +

    • Kinesis Data Analytics

    Get started with Kinesis Data Analytics on LocalStack
    Tags:

      2 minute read  

    Introduction

    Kinesis Data Analytics is a service offered by Amazon Web Services (AWS) that enables you to process and analyze streaming data in real-time. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Kinesis Data Analytics

    Get started with Kinesis Data Analytics on LocalStack
    Tags:

      2 minute read  

    Introduction

    Kinesis Data Analytics is a service offered by Amazon Web Services (AWS) that enables you to process and analyze streaming data in real-time. Kinesis Data Analytics allows you to apply transformations, filtering, and enrichment to streaming data using standard SQL syntax. You can also run Java or Scala programs against streaming sources to perform various operations on the data using Apache Flink.

    LocalStack allows you to use the Kinesis Data Analytics APIs in your local environment. The API coverage is available on:

    This provides information on the extent of Kinesis Data Analytics integration with LocalStack.

    Getting started

    This guide is designed for users new to Kinesis Data Analytics and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/kms/index.html b/user-guide/aws/kms/index.html index 0ba6b26b2a..23724dcb45 100644 --- a/user-guide/aws/kms/index.html +++ b/user-guide/aws/kms/index.html @@ -152,10 +152,10 @@

  • +

    • Key Management Service (KMS)

    Get started with Key Management Service (KMS) on LocalStack
    Persistence:

      6 minute read  

    Introduction

    Key Management Service (KMS) is a managed service that allows users to handle encryption keys within the Amazon Web Services ecosystem. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Key Management Service (KMS)

    Get started with Key Management Service (KMS) on LocalStack
    Persistence:

      6 minute read  

    Introduction

    Key Management Service (KMS) is a managed service that allows users to handle encryption keys within the Amazon Web Services ecosystem. KMS allows users to create, control, and utilize keys to encrypt and decrypt data, as well as to sign and verify messages. KMS allows you to create, delete, list, and update aliases, friendly names for your KMS keys, and tag them for identification and automation. You can check the official AWS documentation to understand the basic terms and concepts used in the KMS.

    LocalStack allows you to use the KMS APIs in your local environment to create, edit, and view symmetric and asymmetric KMS keys, including HMAC keys. diff --git a/user-guide/aws/lakeformation/index.html b/user-guide/aws/lakeformation/index.html index d4db633004..a5d5de5449 100644 --- a/user-guide/aws/lakeformation/index.html +++ b/user-guide/aws/lakeformation/index.html @@ -152,10 +152,10 @@

  • +

    • Lake Formation

    Get started with Lake Formation on LocalStack

      2 minute read  

    Introduction

    Lake Formation is a managed service that allows users to build, secure, and manage data lakes. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Lake Formation

    Get started with Lake Formation on LocalStack

      2 minute read  

    Introduction

    Lake Formation is a managed service that allows users to build, secure, and manage data lakes. Lake Formation allows users to define and enforce fine-grained access controls, manage metadata, and discover and share data across multiple data sources.

    LocalStack allows you to use the Lake Formation APIs in your local environment to register resources, grant permissions, and list resources and permissions. The supported APIs are available on our API coverage page, which provides information on the extent of Lake Formation’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Lake Formation and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to register an S3 bucket as a resource in Lake Formation, grant permissions to a user, and list the resources and permissions.

    Register the resource

    Create a new S3 bucket named test-bucket using the mb command:

    $ awslocal s3 mb s3://test-bucket

    You can now register the S3 bucket as a resource in Lake Formation using the RegisterResource API. diff --git a/user-guide/aws/lambda/index.html b/user-guide/aws/lambda/index.html index ada00df044..7349e07f6f 100644 --- a/user-guide/aws/lambda/index.html +++ b/user-guide/aws/lambda/index.html @@ -152,10 +152,10 @@

  • +

    • Lambda

    Get started with Lambda on LocalStack
    Persistence:

      14 minute read  

    Introduction

    AWS Lambda is a Serverless Function as a Service (FaaS) platform that lets you run code in your preferred programming language on the AWS ecosystem. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Lambda

    Get started with Lambda on LocalStack
    Persistence:

      14 minute read  

    Introduction

    AWS Lambda is a Serverless Function as a Service (FaaS) platform that lets you run code in your preferred programming language on the AWS ecosystem. AWS Lambda automatically scales your code to meet demand and handles server provisioning, management, and maintenance. AWS Lambda allows you to break down your application into smaller, independent functions that integrate seamlessly with AWS services.

    LocalStack allows you to use the Lambda APIs to create, deploy, and test your Lambda functions. The supported APIs are available on our Lambda coverage page, which provides information on the extent of Lambda’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Lambda and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/logs/index.html b/user-guide/aws/logs/index.html index 4d95a6a66d..47ba3f74d1 100644 --- a/user-guide/aws/logs/index.html +++ b/user-guide/aws/logs/index.html @@ -152,10 +152,10 @@

  • +

    • CloudWatch Logs

    Get started with AWS CloudWatch Logs on LocalStack
    Persistence:

      4 minute read  

    CloudWatch Logs allows to store and retrieve logs. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    CloudWatch Logs

    Get started with AWS CloudWatch Logs on LocalStack
    Persistence:

      4 minute read  

    CloudWatch Logs allows to store and retrieve logs. While some services automatically create and write logs (e.g. Lambda), logs can also be added manually. CloudWatch Logs is available in the Community version. However, some specific features are only available in Pro.

    Subscription Filters

    Subscription filters can be used to forward logs to certain services, e.g. Kinesis, Lambda, and Kinesis Data Firehose. diff --git a/user-guide/aws/managedblockchain/index.html b/user-guide/aws/managedblockchain/index.html index b3f7a5b564..1c7616cfd0 100644 --- a/user-guide/aws/managedblockchain/index.html +++ b/user-guide/aws/managedblockchain/index.html @@ -155,10 +155,10 @@

  • +

    • Managed Blockchain (AMB)

    Get started with Managed Blockchain (AMB) on LocalStack
    Tags:

      2 minute read  

    Managed Blockchain (AMB) is a managed service that enables the creation and management of blockchain networks, such as Hyperledger Fabric, Bitcoin, Polygon and Ethereum. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Managed Blockchain (AMB)

    Get started with Managed Blockchain (AMB) on LocalStack
    Tags:

      2 minute read  

    Managed Blockchain (AMB) is a managed service that enables the creation and management of blockchain networks, such as Hyperledger Fabric, Bitcoin, Polygon and Ethereum. Blockchain enables the development of applications in which multiple entities can conduct transactions and exchange data securely and transparently, eliminating the requirement for a central, trusted authority.

    LocalStack allows you to use the AMB APIs to develop and deploy decentralized applications in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of AMB integration with LocalStack.

    Getting started

    This guide is designed for users new to AMB and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to create a blockchain network, a node, and a proposal.

    Create a blockchain network

    You can create a blockchain network using the CreateNetwork API. diff --git a/user-guide/aws/mediastore/index.html b/user-guide/aws/mediastore/index.html index 9defb6d9b0..316d54e01b 100644 --- a/user-guide/aws/mediastore/index.html +++ b/user-guide/aws/mediastore/index.html @@ -152,10 +152,10 @@

  • +

    • Elemental MediaStore

    Get started with Elemental MediaStore on LocalStack
    Tags:

      2 minute read  

    Introduction

    MediaStore is a scalable and highly available object storage service designed specifically for media content. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Elemental MediaStore

    Get started with Elemental MediaStore on LocalStack
    Tags:

      2 minute read  

    Introduction

    MediaStore is a scalable and highly available object storage service designed specifically for media content. It provides a reliable way to store, manage, and serve media assets, such as audio, video, and images, with low latency and high performance. MediaStore seamlessly integrates with other AWS services like Elemental MediaConvert, Elemental MediaLive, Elemental MediaPackage, and CloudFront.

    LocalStack allows you to use the Elemental MediaStore APIs as a high-performance storage solution for media content in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of Elemental MediaStore integration with LocalStack.

    Getting started

    This guide is designed for users new to Elemental MediaStore and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/memorydb/index.html b/user-guide/aws/memorydb/index.html index a09c12ea83..28d98f3d2d 100644 --- a/user-guide/aws/memorydb/index.html +++ b/user-guide/aws/memorydb/index.html @@ -155,10 +155,10 @@

  • +

    • MemoryDB for Redis

    Get started with AWS MemoryDB on LocalStack
    Categories:

      3 minute read  

    Introduction

    MemoryDB is a fully managed, Redis-compatible, in-memory database tailored for workloads demanding ultra-fast, primary database functionality. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    MemoryDB for Redis

    Get started with AWS MemoryDB on LocalStack
    Categories:

      3 minute read  

    Introduction

    MemoryDB is a fully managed, Redis-compatible, in-memory database tailored for workloads demanding ultra-fast, primary database functionality. It streamlines the deployment and management of in-memory databases within the AWS cloud environment, acting as a replacement for using a cache in front of a database for improved durability and performance.

    LocalStack’s Pro offering contains support for the main MemoryDB APIs surrounding cluster creation, allowing developers to utilize the MemoryDB functionalities in their local development environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of MemoryDB’s integration with LocalStack.

    Getting started

    This guide is designed for users new to MemoryDB and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how you can create a MemoryDB cluster and connect to it.

    Basic cluster creation

    You can create a MemoryDB cluster using the CreateCluster API. diff --git a/user-guide/aws/mq/index.html b/user-guide/aws/mq/index.html index cf0890d35e..f701515e5b 100644 --- a/user-guide/aws/mq/index.html +++ b/user-guide/aws/mq/index.html @@ -152,10 +152,10 @@

  • +

    • MQ

    Get started with MQ on LocalStack
    Tags:

      3 minute read  

    Introduction

    MQ is a managed message broker service offered by Amazon Web Services (AWS). + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    MQ

    Get started with MQ on LocalStack
    Tags:

      3 minute read  

    Introduction

    MQ is a managed message broker service offered by Amazon Web Services (AWS). It facilitates the exchange of messages between various components of distributed applications, enabling reliable and scalable communication. AWS MQ supports popular messaging protocols like MQTT, AMQP, and STOMP, making it suitable for a wide range of messaging use cases.

    LocalStack allows you to use the MQ APIs to implement pub/sub messaging, request/response patterns, or distributed event-driven architectures in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of MQ integration with LocalStack.

    Getting started

    This guide is designed for users new to MQ and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/msk/index.html b/user-guide/aws/msk/index.html index ef9c5b84cb..22488e3f09 100644 --- a/user-guide/aws/msk/index.html +++ b/user-guide/aws/msk/index.html @@ -152,10 +152,10 @@

  • +

    • Managed Streaming for Kafka (MSK)

    Get started with Managed Streaming for Kafka (MSK) on LocalStack
    Tags:
    Persistence:

      6 minute read  

    Introduction

    Managed Streaming for Apache Kafka (MSK) is a fully managed Apache Kafka service that allows you to build and run applications that process streaming data. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Managed Streaming for Kafka (MSK)

    Get started with Managed Streaming for Kafka (MSK) on LocalStack
    Tags:
    Persistence:

      6 minute read  

    Introduction

    Managed Streaming for Apache Kafka (MSK) is a fully managed Apache Kafka service that allows you to build and run applications that process streaming data. MSK offers a centralized platform to facilitate seamless communication between various AWS services and applications through event-driven architectures, facilitating data ingestion, processing, and analytics for various applications. MSK also features automatic scaling and built-in monitoring, allowing users to build robust, high-throughput data pipelines.

    LocalStack allows you to use the MSK APIs in your local environment to spin up Kafka clusters on the local machine, create topics for exchanging messages, and define event source mappings that trigger Lambda functions when messages are received on a certain topic. The supported APIs are available on our API coverage page, which provides information on the extent of MSK’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Managed Streaming for Kafka and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/mwaa/index.html b/user-guide/aws/mwaa/index.html index 717d0b6198..ed574225b9 100644 --- a/user-guide/aws/mwaa/index.html +++ b/user-guide/aws/mwaa/index.html @@ -155,10 +155,10 @@

  • +

    • Managed Workflows for Apache Airflow (MWAA)

    Get started with Managed Workflows for Apache Airflow (MWAA) on LocalStack
    Tags:

      4 minute read  

    Introduction

    Managed Workflows for Apache Airflow (MWAA) is a fully managed service by AWS that simplifies the deployment, management, and scaling of Apache Airflow workflows in the cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Managed Workflows for Apache Airflow (MWAA)

    Get started with Managed Workflows for Apache Airflow (MWAA) on LocalStack
    Tags:

      4 minute read  

    Introduction

    Managed Workflows for Apache Airflow (MWAA) is a fully managed service by AWS that simplifies the deployment, management, and scaling of Apache Airflow workflows in the cloud. MWAA leverages the familiar Airflow features and integrations while integrating with S3, Glue, Redshift, Lambda, and other AWS services to build data pipelines and orchestrate data processing workflows in the cloud.

    LocalStack allows you to use the MWAA APIs in your local environment to allow the setup and operation of data pipelines. The supported APIs are available on our API coverage page, which provides information on the extent of MWAA’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Managed Workflows for Apache Airflow and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to create an Airflow environment and access the Airflow UI.

    Create a S3 bucket

    Create a S3 bucket that will be used for Airflow resources. diff --git a/user-guide/aws/neptune/index.html b/user-guide/aws/neptune/index.html index 4b3b037391..63b9307388 100644 --- a/user-guide/aws/neptune/index.html +++ b/user-guide/aws/neptune/index.html @@ -155,10 +155,10 @@

  • +

    • Neptune

    Get started with Neptune on LocalStack
    Tags:

      5 minute read  

    Introduction

    Neptune is a fully managed, highly available, and scalable graph database service offered by AWS. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Neptune

    Get started with Neptune on LocalStack
    Tags:

      5 minute read  

    Introduction

    Neptune is a fully managed, highly available, and scalable graph database service offered by AWS. It is designed for storing and querying highly connected data for applications that require complex relationship modeling, such as social networks, recommendation engines, and fraud detection. Neptune supports popular graph query languages like Gremlin and SPARQL, making it compatible with a wide range of graph applications and tools.

    LocalStack allows you to use the Neptune APIs in your local environment to support both property graph and RDF graph models. The supported APIs are available on our API coverage page, which provides information on the extent of Neptune’s integration with LocalStack.

    The following versions of Neptune engine are supported by LocalStack:

    Engine VersionTinkerpop Version
    1.1.0.03.4.11
    1.1.1.03.5.2
    1.2.0.03.5.2
    1.2.0.13.5.2
    1.2.0.23.5.2
    1.2.1.03.6.2
    1.2.1.13.6.2
    1.3.0.03.6.2
    1.3.1.03.6.2

    Getting started

    This guide is designed for users new to Neptune and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/opensearch/index.html b/user-guide/aws/opensearch/index.html index 673a019a78..3061e78800 100644 --- a/user-guide/aws/opensearch/index.html +++ b/user-guide/aws/opensearch/index.html @@ -155,10 +155,10 @@

  • +

    • OpenSearch Service

    Get started with OpenSearch Service on LocalStack

      9 minute read  

    Introduction

    OpenSearch Service is an open-source search and analytics engine, offering developers and organizations advanced search capabilities, robust data analysis, and insightful visualizations. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    OpenSearch Service

    Get started with OpenSearch Service on LocalStack

      9 minute read  

    Introduction

    OpenSearch Service is an open-source search and analytics engine, offering developers and organizations advanced search capabilities, robust data analysis, and insightful visualizations. OpenSearch Service also offers log analytics, real-time application monitoring, and clickstream analysis.

    LocalStack allows you to use the OpenSearch Service APIs in your local environment to create, manage, and operate the OpenSearch clusters. The supported APIs are available on our API coverage page, which provides information on the extent of OpenSearch’s integration with LocalStack.

    The following versions of OpenSearch Service are supported by LocalStack:

    • 1.0
    • 1.1
    • 1.2
    • 1.3
    • 2.3
    • 2.7
    • 2.9
    • 2.11 (default)

    OpenSearch is closely coupled with the Elasticsearch Service. Clusters generated through the OpenSearch Service will be visible within the Elasticsearch Service interface, and vice versa. diff --git a/user-guide/aws/organizations/index.html b/user-guide/aws/organizations/index.html index 6ff07bc2b7..7ce8caf016 100644 --- a/user-guide/aws/organizations/index.html +++ b/user-guide/aws/organizations/index.html @@ -152,10 +152,10 @@

  • +

    • Organizations

    Get started with AWS Organizations on LocalStack
    Categories:

      2 minute read  

    Amazon Web Services Organizations is an account management service that allows you to consolidate multiple different AWS accounts into an organization. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Organizations

    Get started with AWS Organizations on LocalStack
    Categories:

      2 minute read  

    Amazon Web Services Organizations is an account management service that allows you to consolidate multiple different AWS accounts into an organization. It allows you to manage different accounts in a single organization and consolidate billing. With Organizations, you can also attach different policies to your organizational units (OUs) or individual accounts in your organization.

    Organizations is available over LocalStack Pro and the supported APIs are available over our configuration page.

    Getting started

    In this getting started guide, you’ll learn how to create your local AWS Organization and configure it with member accounts. This guide is intended for users who wish to get more acquainted with Organizations, and assumes you have basic knowledge of the AWS CLI (and our awslocal wrapper script). diff --git a/user-guide/aws/pca/index.html b/user-guide/aws/pca/index.html index 666734ba53..cefa6dbe5a 100644 --- a/user-guide/aws/pca/index.html +++ b/user-guide/aws/pca/index.html @@ -152,10 +152,10 @@

  • +

    • Private Certificate Authority (ACM PCA)

    Get started with Private Certificate Authority (ACM PCA) on LocalStack
    Tags:

      2 minute read  

    Introduction

    AWS Private Certificate Authority (ACM PCA) is a managed private Certificate Authority (CA) service that manages the lifecycle of your private certificates. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Private Certificate Authority (ACM PCA)

    Get started with Private Certificate Authority (ACM PCA) on LocalStack
    Tags:

      2 minute read  

    Introduction

    AWS Private Certificate Authority (ACM PCA) is a managed private Certificate Authority (CA) service that manages the lifecycle of your private certificates. ACM PCA extends ACM’s certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.

    LocalStack allows you to use the ACM PCA APIs to create, list, and delete private certificates. You can creating, describing, tagging, and listing tags for a CA using ACM PCA. The supported APIs are available on our API coverage page, which provides information on the extent of ACM PCA’s integration with LocalStack.

    Getting started

    This guide is designed for users who are new to ACM PCA and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Create a Certificate Authority (CA)

    Start by creating a new Certificate Authority with ACM PCA using the CreateCertificateAuthority API. diff --git a/user-guide/aws/pinpoint/index.html b/user-guide/aws/pinpoint/index.html index e3e156bae6..b93ded8783 100644 --- a/user-guide/aws/pinpoint/index.html +++ b/user-guide/aws/pinpoint/index.html @@ -152,10 +152,10 @@

  • +

    • Pinpoint

    Get started with Pinpoint on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Introduction

    Pinpoint is a customer engagement service to facilitate communication across multiple channels, including email, SMS, and push notifications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Pinpoint

    Get started with Pinpoint on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Introduction

    Pinpoint is a customer engagement service to facilitate communication across multiple channels, including email, SMS, and push notifications. Pinpoint allows developers to create and manage customer segments based on various attributes, such as user behavior and demographics, while integrating with other AWS services to send targeted messages to customers.

    LocalStack allows you to mock the Pinpoint APIs in your local environment. The supported APIs are available on our API coverage page, which provides information on the extent of Pinpoint’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Pinpoint and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to create a Pinpoint application, retrieve all applications, and list tags for the resource.

    Create an application

    Create a Pinpoint application using the CreateApp API. diff --git a/user-guide/aws/pipes/index.html b/user-guide/aws/pipes/index.html index b1ef63ce61..0d628cdf6d 100644 --- a/user-guide/aws/pipes/index.html +++ b/user-guide/aws/pipes/index.html @@ -152,10 +152,10 @@

  • +

    • EventBridge Pipes

    Get started with EventBridge Pipes on LocalStack
    Tags:

      4 minute read  

    Introduction

    EventBridge Pipes allows users to create point-to-point integrations between event producers and consumers with transform, filter and enrichment steps. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    EventBridge Pipes

    Get started with EventBridge Pipes on LocalStack
    Tags:

      4 minute read  

    Introduction

    EventBridge Pipes allows users to create point-to-point integrations between event producers and consumers with transform, filter and enrichment steps. Pipes are particularly useful for scenarios involving real-time data processing, application integration, and automated workflows, while simplifying the process of routing events between AWS services. Pipes offer a point-to-point connection from one source to one target (one-to-one). In contrast, EventBridge Event Bus offers a one-to-many integration where an event router delivers one event to zero or more destinations.

    LocalStack allows you to use the Pipes APIs in your local environment to create Pipes with SQS queues and Kinesis streams as source and target. diff --git a/user-guide/aws/qldb/index.html b/user-guide/aws/qldb/index.html index ed01fe5972..32c2ce4681 100644 --- a/user-guide/aws/qldb/index.html +++ b/user-guide/aws/qldb/index.html @@ -152,10 +152,10 @@

  • +

    • Quantum Ledger Database (QLDB)

    Get started with Quantum Ledger Database (QLDB) on LocalStack
    Tags:

      7 minute read  

    Introduction

    Amazon Quantum Ledger Database is a fully managed ledger database service offered by Amazon Web + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Quantum Ledger Database (QLDB)

    Get started with Quantum Ledger Database (QLDB) on LocalStack
    Tags:

      7 minute read  

    Introduction

    Amazon Quantum Ledger Database is a fully managed ledger database service offered by Amazon Web Services. It is designed to provide transparent, immutable, and cryptographically verifiable transaction diff --git a/user-guide/aws/ram/index.html b/user-guide/aws/ram/index.html index b655efca78..4863f2c5ca 100644 --- a/user-guide/aws/ram/index.html +++ b/user-guide/aws/ram/index.html @@ -152,10 +152,10 @@

  • +

    • Resource Access Manager (RAM)

    Get started with RAM on LocalStack

      less than a minute  

    Resource Access Manager (RAM) helps resources to be shared across AWS accounts, within or across organizations.

    On AWS, RAM is an abstraction on top of AWS Identity and Access Management (IAM) which can manage resource-based policies to supported resource types.

    LocalStack supports RAM in the Pro edition. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Resource Access Manager (RAM)

    Get started with RAM on LocalStack

      less than a minute  

    Resource Access Manager (RAM) helps resources to be shared across AWS accounts, within or across organizations.

    On AWS, RAM is an abstraction on top of AWS Identity and Access Management (IAM) which can manage resource-based policies to supported resource types.

    LocalStack supports RAM in the Pro edition. The supported API operations can be found on the API coverage page.

    Getting started

    Start the LocalStack container using your preferred method. This section will illustrate how to create permissions and resource shares using the AWS CLI.

    Create a permission

    $ awslocal ram create-permission \
     --name example \
diff --git a/user-guide/aws/rds/index.html b/user-guide/aws/rds/index.html
index 7a166dfd30..874b7dc0d1 100644
--- a/user-guide/aws/rds/index.html
+++ b/user-guide/aws/rds/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Relational Database Service (RDS)

    Get started with Relational Database Service (RDS) on LocalStack
    Tags:
    Persistence:

      10 minute read  

    Introduction

    Relational Database Service (RDS) is a managed database service provided by Amazon Web Services (AWS) that allows users to setup, operate, and scale relational databases in the cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Relational Database Service (RDS)

    Get started with Relational Database Service (RDS) on LocalStack
    Tags:
    Persistence:

      10 minute read  

    Introduction

    Relational Database Service (RDS) is a managed database service provided by Amazon Web Services (AWS) that allows users to setup, operate, and scale relational databases in the cloud. RDS allows you to deploy and manage various relational database engines like MySQL, PostgreSQL, MariaDB, and Microsoft SQL Server. RDS handles routine database tasks such as provisioning, patching, backup, recovery, and scaling.

    LocalStack allows you to use the RDS APIs in your local environment to create and manage RDS clusters and instances for testing & integration purposes. The supported APIs are available on our API coverage page, which provides information on the extent of RDS’s integration with LocalStack.

    Getting started

    This guide is designed for users new to RDS and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/redshift/index.html b/user-guide/aws/redshift/index.html index d2de1fc4ad..0ff0873eec 100644 --- a/user-guide/aws/redshift/index.html +++ b/user-guide/aws/redshift/index.html @@ -152,10 +152,10 @@

  • +

    • Redshift

    Get started with Redshift on LocalStack
    Tags:

      4 minute read  

    Introduction

    RedShift is a cloud-based data warehouse solution which allows end users to aggregate huge volumes of data and parallel processing of data. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Redshift

    Get started with Redshift on LocalStack
    Tags:

      4 minute read  

    Introduction

    RedShift is a cloud-based data warehouse solution which allows end users to aggregate huge volumes of data and parallel processing of data. RedShift is fully managed by AWS and serves as a petabyte-scale service which allows users to create visualization reports and critically analyze collected data. The query results can be saved to an S3 Data Lake while additional analytics can be provided by Athena or SageMaker.

    LocalStack allows you to use the RedShift APIs in your local environment to analyze structured and semi-structured data across local data warehouses and data lakes. The supported APIs are available on our API coverage page, which provides information on the extent of RedShift’s integration with LocalStack.

    Getting started

    This guide is designed for users new to RedShift and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/resource_groups/index.html b/user-guide/aws/resource_groups/index.html index d7745c1173..951de3b82b 100644 --- a/user-guide/aws/resource_groups/index.html +++ b/user-guide/aws/resource_groups/index.html @@ -155,10 +155,10 @@

  • +

    • Resource Groups

    Get started with Resource Groups on LocalStack

      3 minute read  

    Introduction

    Resource Groups allow developers to organize and manage their AWS resources more efficiently. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Resource Groups

    Get started with Resource Groups on LocalStack

      3 minute read  

    Introduction

    Resource Groups allow developers to organize and manage their AWS resources more efficiently. Resource Groups allow for a unified view of their resources allowing developers to perform specific actions, such as resource tagging, access control, and policy enforcement across multiple resources simultaneously. Resource Groups in AWS provide two types of queries that developers can use to build groups: Tag-based queries and CloudFormation stack-based queries. With Tag-based queries, developers can organize resources based on common attributes or characteristics, while CloudFormation stack-based queries allow developers to group resources that are deployed together as part of a CloudFormation stack.

    LocalStack allows you to use the Resource Groups APIs in your local environment to group and categorize resources based on criteria such as tags, resource types, regions, or custom attributes. diff --git a/user-guide/aws/route53/index.html b/user-guide/aws/route53/index.html index 1a7e9a5104..db46f6af43 100644 --- a/user-guide/aws/route53/index.html +++ b/user-guide/aws/route53/index.html @@ -152,10 +152,10 @@

  • +

    • Route 53

    Get started with Route 53 on LocalStack
    Persistence:

      6 minute read  

    Introduction

    Route 53 is a highly scalable and reliable domain name system (DNS) web service provided by Amazon Web Services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Route 53

    Get started with Route 53 on LocalStack
    Persistence:

      6 minute read  

    Introduction

    Route 53 is a highly scalable and reliable domain name system (DNS) web service provided by Amazon Web Services. Route 53 allows you to register domain names, and associate them with IP addresses or other resources. In addition to basic DNS functionality, Route 53 offers advanced features like health checks and DNS failover. Route 53 integrates seamlessly with other AWS services, such as route traffic to CloudFront distributions, S3 buckets configured for static website hosting, EC2 instances, and more.

    LocalStack allows you to use the Route53 APIs in your local environment to create hosted zones and to manage DNS entries. diff --git a/user-guide/aws/route53resolver/index.html b/user-guide/aws/route53resolver/index.html index 076f88d986..187472e4c2 100644 --- a/user-guide/aws/route53resolver/index.html +++ b/user-guide/aws/route53resolver/index.html @@ -152,10 +152,10 @@

  • +

    • Route 53 Resolver

    Get started with Route 53 Resolver on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Route 53 Resolver allows you to route DNS queries between your virtual private cloud (VPC) and your network. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Route 53 Resolver

    Get started with Route 53 Resolver on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Route 53 Resolver allows you to route DNS queries between your virtual private cloud (VPC) and your network. Route 53 Resolver forwards DNS queries for domain names to the appropriate DNS service based on the configuration you set up. Route 53 Resolver can be used to resolve domain names between your VPC and your network, and to resolve domain names between your VPCs.

    LocalStack allows you to use the Route 53 Resolver endpoints in your local environment. The supported APIs are available on our API coverage page, which provides information on the extent of Route 53 Resolver’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Route53 Resolver and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/s3/index.html b/user-guide/aws/s3/index.html index abc41959f3..f63564da37 100644 --- a/user-guide/aws/s3/index.html +++ b/user-guide/aws/s3/index.html @@ -152,10 +152,10 @@

  • +

    • Simple Storage Service (S3)

    Get started with Amazon S3 on LocalStack
    Persistence:

      8 minute read  

    Introduction

    Simple Storage Service (S3) is an object storage service that provides a highly scalable and durable solution for storing and retrieving data. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Simple Storage Service (S3)

    Get started with Amazon S3 on LocalStack
    Persistence:

      8 minute read  

    Introduction

    Simple Storage Service (S3) is an object storage service that provides a highly scalable and durable solution for storing and retrieving data. In S3, a bucket represents a directory, while an object corresponds to a file. Each object or file within S3 encompasses essential attributes such as a unique key denoting its name, the actual content it holds, a version ID for versioning support, and accompanying metadata. S3 can store unlimited objects, allowing you to store, retrieve, and manage your data in a highly adaptable and reliable manner.

    LocalStack allows you to use the S3 APIs in your local environment to create new buckets, manage your S3 objects, and test your S3 configurations locally. diff --git a/user-guide/aws/sagemaker/index.html b/user-guide/aws/sagemaker/index.html index 8928aefae1..62ce667778 100644 --- a/user-guide/aws/sagemaker/index.html +++ b/user-guide/aws/sagemaker/index.html @@ -152,10 +152,10 @@

  • +

    • SageMaker

    Get started with SageMaker on LocalStack
    Tags:

      3 minute read  

    Introduction

    Amazon SageMaker is a fully managed service provided by Amazon Web Services (AWS) that provides the tools to build, train, and deploy machine-learning models in the cloud for predictive analytics applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    SageMaker

    Get started with SageMaker on LocalStack
    Tags:

      3 minute read  

    Introduction

    Amazon SageMaker is a fully managed service provided by Amazon Web Services (AWS) that provides the tools to build, train, and deploy machine-learning models in the cloud for predictive analytics applications. It streamlines the machine learning development process, reduces the time and effort required to build and deploy models, and offers the scalability and flexibility needed for large-scale machine learning projects in the AWS cloud.

    LocalStack Pro provides a local version of the SageMaker API, which allows running jobs to create machine learning models (e.g., using PyTorch) and to deploy them. The supported APIs are available on our API coverage page, which provides information on the extent of Sagemaker’s integration with LocalStack.

    EventBridge Scheduler

    Get started with EventBridge Scheduler on LocalStack

      2 minute read  

    Introduction

    EventBridge Scheduler is a service that enables you to schedule the execution of your AWS Lambda functions, Amazon ECS tasks, and Amazon Batch jobs. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    EventBridge Scheduler

    Get started with EventBridge Scheduler on LocalStack

      2 minute read  

    Introduction

    EventBridge Scheduler is a service that enables you to schedule the execution of your AWS Lambda functions, Amazon ECS tasks, and Amazon Batch jobs. You can use EventBridge Scheduler to create schedules that run at a specific time or at regular intervals. You can also use EventBridge Scheduler to create schedules that run within a flexible time window.

    LocalStack allows you to use the Scheduler APIs in your local environment to create and run schedules. The supported APIs are available on our API coverage page, which provides information on the extent of EventBridge Scheduler’s integration with LocalStack.

    Getting started

    This guide is designed for users new to EventBridge Scheduler and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/secretsmanager/index.html b/user-guide/aws/secretsmanager/index.html index c9d37f2e7b..a633033c82 100644 --- a/user-guide/aws/secretsmanager/index.html +++ b/user-guide/aws/secretsmanager/index.html @@ -152,10 +152,10 @@

  • +

    • Secrets Manager

    Get started with Secrets Manager on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Secrets Manager is a service provided by Amazon Web Services (AWS) that enables you to securely store, manage, and retrieve sensitive information such as passwords, API keys, and other credentials. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Secrets Manager

    Get started with Secrets Manager on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Secrets Manager is a service provided by Amazon Web Services (AWS) that enables you to securely store, manage, and retrieve sensitive information such as passwords, API keys, and other credentials. Secrets Manager integrates seamlessly with AWS services, making it easier to manage secrets used by various applications and services. Secrets Manager supports automatic secret rotation, replacing long-term secrets with short-term ones to mitigate the risk of compromise without requiring application updates.

    LocalStack allows you to use the Secrets Manager APIs in your local environment to manage, retrieve, and rotate secrets. The supported APIs are available on our API coverage page, which provides information on the extent of Secrets Manager’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Secrets Manager and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/serverlessrepo/index.html b/user-guide/aws/serverlessrepo/index.html index 2d00c9df0b..7b1231cadc 100644 --- a/user-guide/aws/serverlessrepo/index.html +++ b/user-guide/aws/serverlessrepo/index.html @@ -155,10 +155,10 @@

  • +

    • Serverless Application Repository

    Get started with Serverless Application Repository on LocalStack
    Tags:

      3 minute read  

    Introduction

    Serverless Application Repository allows developers to discover, deploy, and share serverless applications and components. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Serverless Application Repository

    Get started with Serverless Application Repository on LocalStack
    Tags:

      3 minute read  

    Introduction

    Serverless Application Repository allows developers to discover, deploy, and share serverless applications and components. Using Serverless Application Repository, developers can build & publish applications and components once and share them across the community and organizations, making them accessible to others. Serverless Application Repository provides a user-friendly interface to search, filter, and browse through a diverse catalog of serverless applications.

    LocalStack allows you to use the Serverless Application Repository APIs in your local environment to create, update, delete, and list serverless applications and components. The supported APIs are available on our API coverage page, which provides information on the extent of Serverless Application Repository’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Serverless Application Repository and assumes basic knowledge of the SAM CLI and our samlocal wrapper script.

    Start your LocalStack container using your preferred method, such as via docker-compose. diff --git a/user-guide/aws/servicediscovery/index.html b/user-guide/aws/servicediscovery/index.html index fca7b80165..991964723f 100644 --- a/user-guide/aws/servicediscovery/index.html +++ b/user-guide/aws/servicediscovery/index.html @@ -155,10 +155,10 @@

  • +

    • Service Discovery

    Get started with Service Discovery on LocalStack
    Tags:

      6 minute read  

    Introduction

    Service Discovery simplifies the management and discovery of services by locating and connecting to the components and resources that make up their applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Service Discovery

    Get started with Service Discovery on LocalStack
    Tags:

      6 minute read  

    Introduction

    Service Discovery simplifies the management and discovery of services by locating and connecting to the components and resources that make up their applications. Service Discovery allows for a centralized mechanism for dynamically registering, tracking, and resolving service instances, allowing seamless communication between services. Service discovery uses Cloud Map API actions to manage HTTP and DNS namespaces for services, enabling automatic registration and discovery of services running in the cluster.

    LocalStack allows you to use the Service Discovery APIs in your local environment to monitor and manage your services across various environments and network topologies. The supported APIs are available on our API coverage page, which provides information on the extent of Service Discovery’s integration with LocalStack.

    Getting Started

    This guide is designed for users new to Service Discovery and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/ses/index.html b/user-guide/aws/ses/index.html index 6e395992c5..280731727e 100644 --- a/user-guide/aws/ses/index.html +++ b/user-guide/aws/ses/index.html @@ -152,10 +152,10 @@

  • +

    • Simple Email Service (SES)

    Get started with Amazon Simple Email Service (SES) on LocalStack
    Tags:
    Persistence:

      3 minute read  

    Introduction

    Simple Email Service (SES) is an emailing service that can be integrated with other cloud-based services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Simple Email Service (SES)

    Get started with Amazon Simple Email Service (SES) on LocalStack
    Tags:
    Persistence:

      3 minute read  

    Introduction

    Simple Email Service (SES) is an emailing service that can be integrated with other cloud-based services. It provides API to facilitate email templating, sending bulk emails and more.

    LocalStack supports SES v1 in the Community image, while SES v2 and SMTP integration is supported in the Pro image. The supported APIs are available on the API coverage page for SES v1 and SES v2.

    Getting Started

    This is an introductory guide to get started with SES. Basic knowledge of the AWS CLI and LocalStack awslocal command is assumed.

    Start LocalStack using your preferred method.

    To be able to send emails, we need to create a verified identity. diff --git a/user-guide/aws/sns/index.html b/user-guide/aws/sns/index.html index e0d326886d..da52b7dc9a 100644 --- a/user-guide/aws/sns/index.html +++ b/user-guide/aws/sns/index.html @@ -152,10 +152,10 @@

  • +

    • Simple Notification Service (SNS)

    Get started with Simple Notification Service (SNS) on LocalStack
    Persistence:

      10 minute read  

    Introduction

    Simple Notification Service (SNS) is a serverless messaging service that can distribute a massive number of messages to multiple subscribers and can be used to send messages to mobile devices, email addresses, and HTTP(s) endpoints. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Simple Notification Service (SNS)

    Get started with Simple Notification Service (SNS) on LocalStack
    Persistence:

      10 minute read  

    Introduction

    Simple Notification Service (SNS) is a serverless messaging service that can distribute a massive number of messages to multiple subscribers and can be used to send messages to mobile devices, email addresses, and HTTP(s) endpoints. SNS employs the Publish/Subscribe, an asynchronous messaging pattern that decouples services that produce events from services that process events.

    LocalStack allows you to use the SNS APIs in your local environment to coordinate the delivery of messages to subscribing endpoints or clients. The supported APIs are available on our API coverage page, which provides information on the extent of SNS’s integration with LocalStack.

    Getting started

    This guide is intended for users who wish to get more acquainted with SNS over LocalStack. It assumes you have basic knowledge of the AWS CLI (and our awslocal wrapper script).

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/sqs/index.html b/user-guide/aws/sqs/index.html index 95e4ac6b18..429044eeb0 100644 --- a/user-guide/aws/sqs/index.html +++ b/user-guide/aws/sqs/index.html @@ -152,10 +152,10 @@

  • +

    • Simple Queue Service (SQS)

    Get started with Simple Queue Service (SQS) on LocalStack
    Persistence:

      13 minute read  

    Introduction

    Simple Queue Service (SQS) is a managed messaging service offered by AWS. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Simple Queue Service (SQS)

    Get started with Simple Queue Service (SQS) on LocalStack
    Persistence:

      13 minute read  

    Introduction

    Simple Queue Service (SQS) is a managed messaging service offered by AWS. It allows you to decouple different components of your applications by enabling asynchronous communication through message queues. SQS allows you to reliably send, store, and receive messages with support for standard and FIFO queues.

    LocalStack allows you to use the SQS APIs in your local environment to integrate and decouple distributed systems via hosted queues. The supported APIs are available on our API coverage page, which provides information on the extent of SQS’s integration with LocalStack.

    Getting started

    This guide is designed for users new to SQS and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/ssm/index.html b/user-guide/aws/ssm/index.html index 7dec8ff03d..b8288ad0be 100644 --- a/user-guide/aws/ssm/index.html +++ b/user-guide/aws/ssm/index.html @@ -152,10 +152,10 @@

  • +

    • Systems Manager (SSM)

    Get started with Systems Manager (SSM) on LocalStack
    Tags:
    Persistence:

      4 minute read  

    Introduction

    Systems Manager (SSM) is a management service provided by Amazon Web Services that helps you effectively manage and control your infrastructure resources. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Systems Manager (SSM)

    Get started with Systems Manager (SSM) on LocalStack
    Tags:
    Persistence:

      4 minute read  

    Introduction

    Systems Manager (SSM) is a management service provided by Amazon Web Services that helps you effectively manage and control your infrastructure resources. SSM simplifies tasks related to system and application management, patching, configuration, and automation, allowing you to maintain the health and compliance of your environment.

    LocalStack allows you to use the SSM APIs in your local environment to run operational tasks on the Dockerized instances. The supported APIs are available on our API coverage page, which provides information on the extent of SSM’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Systems Manager (SSM) and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method with an additional EC2_VM_MANAGER=docker configuration variable. We will demonstrate how to use EC2 and SSM functionalities when using the Docker backend with LocalStack with the AWS CLI.

    Create an EC2 instance

    To get started, pull the ubuntu:focal image from Docker Hub and tag it as localstack-ec2/ubuntu-focal-docker-ami:ami-00a001. diff --git a/user-guide/aws/stepfunctions/index.html b/user-guide/aws/stepfunctions/index.html index 4eb68a37e5..11a8ce8b3a 100644 --- a/user-guide/aws/stepfunctions/index.html +++ b/user-guide/aws/stepfunctions/index.html @@ -155,10 +155,10 @@

  • +

    • Step Functions

    Get started with Step Functions on LocalStack

      4 minute read  

    Introduction

    Step Functions is a serverless workflow engine that enables the orchestrating of multiple AWS services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Step Functions

    Get started with Step Functions on LocalStack

      4 minute read  

    Introduction

    Step Functions is a serverless workflow engine that enables the orchestrating of multiple AWS services. It provides a JSON-based structured language called Amazon States Language (ASL) which allows to specify how to manage a sequence of tasks and actions that compose the application’s workflow. Thus making it easier to build and maintain complex and distributed applications.

    LocalStack allows you to use the Step Functions APIs in your local environment to create, execute, update, and delete state machines locally. The supported APIs are available on our API coverage page, which provides information on the extent of Step Function’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Step Functions and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/sts/index.html b/user-guide/aws/sts/index.html index f0d371ac62..52b7210c5d 100644 --- a/user-guide/aws/sts/index.html +++ b/user-guide/aws/sts/index.html @@ -152,10 +152,10 @@

  • +

    • Security Token Service (STS)

    Get started with Security Token Service on LocalStack
    Persistence:

      3 minute read  

    Introduction

    Security Token Service (STS) is a service provided by Amazon Web Services (AWS) that enables you to grant temporary, limited-privilege credentials to users and applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Security Token Service (STS)

    Get started with Security Token Service on LocalStack
    Persistence:

      3 minute read  

    Introduction

    Security Token Service (STS) is a service provided by Amazon Web Services (AWS) that enables you to grant temporary, limited-privilege credentials to users and applications. STS implements fine-grained access control and reduce the exposure of your long-term credentials. The temporary credentials, known as security tokens, can be used to access AWS services and resources based on the permissions specified in the associated policies.

    LocalStack allows you to use the STS APIs in your local environment to request security tokens, manage permissions, integrate with identity providers, and more. The supported APIs are available on our API coverage page, which provides information on the extent of STS’s integration with LocalStack.

    Getting started

    This guide is designed for users new to STS and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/support/index.html b/user-guide/aws/support/index.html index 7b338dc1ef..4df6a355af 100644 --- a/user-guide/aws/support/index.html +++ b/user-guide/aws/support/index.html @@ -152,10 +152,10 @@

  • +

    • Support

    Get started with Support on LocalStack
    Persistence:

      3 minute read  

    Introduction

    AWS Support is a service provided by Amazon Web Services (AWS) that offers technical assistance and resources to help you optimize your AWS environment, troubleshoot issues, and maintain operational efficiency. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Support

    Get started with Support on LocalStack
    Persistence:

      3 minute read  

    Introduction

    AWS Support is a service provided by Amazon Web Services (AWS) that offers technical assistance and resources to help you optimize your AWS environment, troubleshoot issues, and maintain operational efficiency. Support APIs provide programmatic access to AWS Support services, including the ability to create and manage support cases programmatically. You can further automate your support workflow using various AWS services, such as Lambda, CloudWatch, and EventBridge.

    LocalStack allows you to use the Support APIs in your local environment to create and manage new cases, while testing your configurations locally. LocalStack provides a mock implementation via a mock Support Center provided by Moto, and does not create real cases in the AWS. diff --git a/user-guide/aws/swf/index.html b/user-guide/aws/swf/index.html index 06cbf999b5..eb22e48d5e 100644 --- a/user-guide/aws/swf/index.html +++ b/user-guide/aws/swf/index.html @@ -155,10 +155,10 @@

  • +

    • Simple Workflow Service (SWF)

    Get started with Simple Workflow Service (SWF) on LocalStack

      3 minute read  

    Introduction

    Simple Workflow Service (SWF) is a fully managed service offered by Amazon Web Services (AWS) that enables you to build and manage applications with distributed components and complex workflows. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Simple Workflow Service (SWF)

    Get started with Simple Workflow Service (SWF) on LocalStack

      3 minute read  

    Introduction

    Simple Workflow Service (SWF) is a fully managed service offered by Amazon Web Services (AWS) that enables you to build and manage applications with distributed components and complex workflows. SWF allows you to define workflows in a way that’s separate from the actual application code, making it easier to modify and adapt workflows without changing the application logic. SWF also provides a programming framework to design, coordinate, and execute workflows that involve multiple tasks, steps, and decision points.

    LocalStack allows you to use the SWF APIs in your local environment to monitor and manage workflow design, task coordination, activity implementation, and error handling. The supported APIs are available on our API coverage page, which provides information on the extent of SWF’s integration with LocalStack.

    Getting started

    This guide is designed for users new to Simple Workflow Service and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. diff --git a/user-guide/aws/textract/index.html b/user-guide/aws/textract/index.html index f2341c9f0d..eb7fb99a05 100644 --- a/user-guide/aws/textract/index.html +++ b/user-guide/aws/textract/index.html @@ -152,10 +152,10 @@

  • +

    • Textract

    Get started with Textract on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Textract is a machine learning service that automatically extracts text, forms, and tables from scanned documents. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Textract

    Get started with Textract on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Textract is a machine learning service that automatically extracts text, forms, and tables from scanned documents. It simplifies the process of extracting valuable information from a variety of document types, enabling applications to quickly analyze and understand document content.

    LocalStack allows you to mock Textract APIs in your local environment. The supported APIs are available on our API coverage page, providing details on the extent of Textract’s integration with LocalStack.

    Getting started

    This guide is tailored for users new to Textract and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how to perform basic Textract operations, such as mocking text detection in a document.

    Detect document text

    You can use the DetectDocumentText API to identify and extract text from a document. diff --git a/user-guide/aws/timestream/index.html b/user-guide/aws/timestream/index.html index 2802e72cf3..d721cabe92 100644 --- a/user-guide/aws/timestream/index.html +++ b/user-guide/aws/timestream/index.html @@ -152,10 +152,10 @@

  • +

    • Timestream

    Get started with Timestream on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Introduction

    LocalStack contains basic support for Timestream time series databases, including these operations:

    • Creating databases
    • Creating tables
    • Writing records to tables
    • Querying timeseries data from tables

    The supported APIs are available on our API Coverage Page (Timestream-Query/Timestream-Write), which provides information on the extent of Timestream integration with LocalStack.

    Getting Started

    The following example illustrates the basic operations, using the awslocal command line.

    First, we create a test database and table:

    $ awslocal timestream-write create-database --database-name testDB
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Timestream

    Get started with Timestream on LocalStack
    Tags:
    Persistence:

      2 minute read  

    Introduction

    LocalStack contains basic support for Timestream time series databases, including these operations:

    • Creating databases
    • Creating tables
    • Writing records to tables
    • Querying timeseries data from tables

    The supported APIs are available on our API Coverage Page (Timestream-Query/Timestream-Write), which provides information on the extent of Timestream integration with LocalStack.

    Getting Started

    The following example illustrates the basic operations, using the awslocal command line.

    First, we create a test database and table:

    $ awslocal timestream-write create-database --database-name testDB
 $ awslocal timestream-write create-table --database-name testDB --table-name testTable

    We can then add a few records with a timestamp, measure name, and value to the table:

    $ awslocal timestream-write write-records --database-name testDB --table-name testTable --records '[{"MeasureName":"cpu","MeasureValue":"60","TimeUnit":"SECONDS","Time":"1636986409"}]'
 $ awslocal timestream-write write-records --database-name testDB --table-name testTable --records '[{"MeasureName":"cpu","MeasureValue":"80","TimeUnit":"SECONDS","Time":"1636986412"}]'
 $ awslocal timestream-write write-records --database-name testDB --table-name testTable --records '[{"MeasureName":"cpu","MeasureValue":"70","TimeUnit":"SECONDS","Time":"1636986414"}]'

    Finally, we can run a query to retrieve the timeseries data (or aggregate values) from the table:

    $ awslocal timestream-query query --query-string "SELECT CREATE_TIME_SERIES(time, measure_value::double) as cpu FROM testDB.timeStreamTable WHERE measure_name='cpu'"
diff --git a/user-guide/aws/transcribe/index.html b/user-guide/aws/transcribe/index.html
index 2b661dd6b1..18c7fbecf8 100644
--- a/user-guide/aws/transcribe/index.html
+++ b/user-guide/aws/transcribe/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Transcribe

    Get started with Amazon Transcribe on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Transcribe is a service provided by Amazon Web Services (AWS) that offers automatic speech recognition (ASR) capabilities. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Transcribe

    Get started with Amazon Transcribe on LocalStack
    Persistence:

      4 minute read  

    Introduction

    Transcribe is a service provided by Amazon Web Services (AWS) that offers automatic speech recognition (ASR) capabilities. It enables developers to convert spoken language into written text, making it valuable for a wide range of applications, from transcription services to voice analytics.

    LocalStack allows you to use the Transcribe APIs for offline speech-to-text jobs in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of Transcribe integration with LocalStack.

    Transfer

    Get started with Amazon Transfer on LocalStack
    Categories:

      2 minute read  

    Introduction

    The AWS Transfer API is a powerful tool that empowers users to establish FTP(S) servers with ease. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Transfer

    Get started with Amazon Transfer on LocalStack
    Categories:

      2 minute read  

    Introduction

    The AWS Transfer API is a powerful tool that empowers users to establish FTP(S) servers with ease. These servers serve as gateways, allowing direct access to files residing in Amazon S3 buckets. This functionality streamlines file management processes, making it simpler and more efficient to handle data stored in S3 by providing a familiar FTP interface for users to interact with their files securely. Whether you’re looking to facilitate file transfers or enhance your data access capabilities, the AWS Transfer API simplifies the process and extends the versatility of your cloud storage infrastructure.

    Getting started

    This Python code demonstrates a basic workflow for transferring a file between a local machine and AWS S3 using the AWS Transfer Family service and FTP (File Transfer Protocol).

    import io
diff --git a/user-guide/aws/waf/index.html b/user-guide/aws/waf/index.html
index 1eac15a843..433a2a356a 100644
--- a/user-guide/aws/waf/index.html
+++ b/user-guide/aws/waf/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Web Application Firewall (WAF)

    Get started with Web Application Firewall (WAF) on LocalStack
    Tags:

      2 minute read  

    Introduction

    Web Application Firewall (WAF) is a service provided by Amazon Web Services (AWS) that helps protect your web applications from common web exploits that could affect application availability, compromise security, or consume excessive resources. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Web Application Firewall (WAF)

    Get started with Web Application Firewall (WAF) on LocalStack
    Tags:

      2 minute read  

    Introduction

    Web Application Firewall (WAF) is a service provided by Amazon Web Services (AWS) that helps protect your web applications from common web exploits that could affect application availability, compromise security, or consume excessive resources. WAFv2 is the latest version of WAF, and it allows you to specify a single set of rules to protect your web applications, APIs, and mobile applications from common attack patterns, such as SQL injection and cross-site scripting.

    LocalStack allows you to use the WAFv2 APIs for offline web application firewall jobs in your local environment. The supported APIs are available on our API Coverage Page, which provides information on the extent of WAFv2 integration with LocalStack.

    Getting started

    This guide is for users who are familiar with the AWS CLI and awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will walk you through creating, listing, tagging, and viewing tags for Web Access Control Lists (WebACLs) using the Web Application Firewall (WAF) service in a LocalStack environment using the AWS CLI.

    Create a WebACL

    Start by creating a Web Access Control List (WebACL) using the CreateWebACL API. diff --git a/user-guide/aws/xray/index.html b/user-guide/aws/xray/index.html index aed006c9cd..145af97e39 100644 --- a/user-guide/aws/xray/index.html +++ b/user-guide/aws/xray/index.html @@ -152,10 +152,10 @@

  • +

    • X-Ray

    Get started with X-Ray on LocalStack
    Tags:

      3 minute read  

    Introduction

    X-Ray is a distributed tracing service that + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    X-Ray

    Get started with X-Ray on LocalStack
    Tags:

      3 minute read  

    Introduction

    X-Ray is a distributed tracing service that helps to understand cross-service interactions and facilitates debugging of performance bottlenecks. Instrumented applications generate trace data by recording trace segments with information about the work tasks of an application, such as timestamps, tasks names, or metadata. diff --git a/user-guide/chaos-engineering/special-configs/index.html b/user-guide/chaos-engineering/chaos-api/index.html similarity index 78% rename from user-guide/chaos-engineering/special-configs/index.html rename to user-guide/chaos-engineering/chaos-api/index.html index aa152a6d2a..a4d3abc0df 100644 --- a/user-guide/chaos-engineering/special-configs/index.html +++ b/user-guide/chaos-engineering/chaos-api/index.html @@ -1,5 +1,5 @@ -Special Configurations | Docs -

    Table of Contents
    Categories
    Persistence
    Tags

    Chaos API

    Simulate outages and network failures to test the resiliency of your infrastructure
    Tags:

      4 minute read  

    Introduction

    LocalStack Chaos API allows you to mimic outages across any AWS region or service. +Intentionally triggering service outages and monitoring the system’s response in situations where the infrastructure is compromised offers a powerful way to test. +This strategy helps gauge the effectiveness of the system’s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering.

    You can use LocalStack Chaos API to cause API failures for any combination of the following:

    • Service
    • Region
    • Operation

    You can customise the HTTP error code and message that LocalStack responds with. +If required, you can make the failures occur probabilistically.

    Furthermore, the Chaos API can also be configured to add a network latency for all calls.

    Prerequisites

    The prerequisites for this guide are:

    Configuration

    The disruption types supported by Chaos API are broadly categorised into two groups. +Service Faults lead to an application-level HTTP error in an AWS service, and Network Effects introduce network-level effects to all connections.

    Service Faults

    Service faults can be configured using the endpoint at /_localstack/chaos/faults. +The configuration schema consists of an array of one or more rules, where each rule specifies the conditions for the fault to occur. +When active, rules are evaluated sequentially on every request to LocalStack until the first match.

    The schema for the configuration is as follows.

    [
+    {
+        "region": "(str) Region name, e.g. 'ap-south-1'. If omitted, all regions are affected.",
+        "service": "(str) Name of the service, e.g. 'kinesis'. If omitted, all services are affected.",
+        "operation": "(str) Name of the operation, e.g. 'PutRecord'. If omitted, all operations are affected.",
+        "probability": "(num) Probability of invoking this rule, e.g. 0.5. If omitted, 1 is used.",
+        "error": {
+            "statusCode": "(int) HTTP status code to use in response, e.g. 503. If omitted, 503 is used.",
+            "code": "(str) Descriptive error code used in response. If omitted, 'ServiceUnavailable' is used."
+        }
+    },
+    ...
+]
+

    The endpoint allows the following operations:

    • GET: Get current configuration
    • POST: Add new configuration
    • PATCH: Add a rule
    • DELETE: Delete a rule

    An empty array [] disables the faults entirely, while an empty rule in the array [{}] causes all AWS operations to lead to faults.

    Network Effects

    Network effects are configured using the endpoint /_localstack/chaos/effects. +Currently the Chaos API only supports a latency factor.

    {
+    "latency": "(int) Network latency in milliseconds. By default, 0 is used."
+}
+

    This endpoint allows the following operations:

    • GET: Get current configuration
    • POST: Add new configuration

    Examples

    To cause faults, make a POST request as follows:

    $ curl --location --request POST 'http://localhost.localstack.cloud:4566/_localstack/chaos/faults' \
+--header 'Content-Type: application/json' \
+--data '
+[
+    {
+        "service": "s3",
+        "region": "us-east-1"
+    },
+    {
+        "service": "s3",
+        "region": "ap-south-1"
+    },
+    {
+        "service": "lambda",
+    }
+]'

    In this example, S3 is affected in us-east-1 and ap-south-1, and Lambda is affected in all regions. +All calls to these services in these regions will return a 503 Service Unavailable error.

    To see this in action, try to create an S3 bucket in us-east-1:

    $ awslocal s3 mb s3://test-bucket --region us-east-1
+
    
+make_bucket failed: s3://test-bucket An error occurred (ServiceUnavailableException) when calling the CreateBucket operation (reached max retries: 4): Service 's3' not accessible due to an outage
+

    However, the same operation, when run in eu-central-1 will work as expected.

    $ awslocal s3 mb s3://test-bucket --region eu-central-1
+
    
+make_bucket: test-bucket
+

    Faults can be disabled by setting an empty rule list in the configuration. +The following request will clear the current configuration:

    $ curl --location --request POST 'http://localhost.localstack.cloud:4566/_localstack/chaos/faults' \
+--header 'Content-Type: application/json' \
+--data '[]'

    To retrieve the current configuration, make the following GET call:

    $ curl --location --request GET 'http://localhost.localstack.cloud:4566/_localstack/chaos/faults'

    To add a new rule to the current configuration, make a PATCH call as follows:

    $ curl --location --request PATCH 'http://localhost.localstack.cloud:4566/_localstack/chaos/faults' \
+--header 'Content-Type: application/json' \
+--data '
+[
+    {
+        "service": "kinesis",
+        "operation": "PutRecord",
+        "probability": 0.3,
+        "error": {
+            "statusCode": 400,
+            "code": "ProvisionedThroughputExceededException"
+        }
+    }
+]'

    This new rule will cause probabilistic failures for Kinesis PutRecord operation. +Here, the returned error is also customised to be HTTP 400 ProvisionedThroughputExceededException.

    To remove a rule from the configuration, make a DELETE call as follows:

    $ curl --location --request DELETE 'http://localhost.localstack.cloud:4566/_localstack/chaos/faults' \
+--header 'Content-Type: application/json' \
+--data '[{"service": "lambda"}]'

    The rule to be removed must be exactly the same as in the existing configuration.

    Comparison with Fault Injection Service

    AWS Fault Injection Service (FIS) also allows controlled chaos engineering experiments on infrastructure.

    When it comes to fault injection, Chaos API has some overlaps with FIS, but it is designed to have a broader application. +For example, the FIS action aws:fis:inject-api-internal-error injects Internal Errors into requests, but only for EC2. +The Chaos API has not such limitation.

    Another difference is that FIS is capable of running procedural experiments where it can invoke API actions that affect AWS resources. +For example, the action aws:ec2:stop-instances can stop EC2 instances. +The Chaos API focuses on declarative effects that impact the AWS API.

    Last modified July 25, 2024: Update chaos engg docs with recent product changes (#1256) (0e4708aff)
    \ No newline at end of file diff --git a/user-guide/chaos-engineering/fault-injection-service/index.html b/user-guide/chaos-engineering/fault-injection-service/index.html index 581986dc4d..f4a3f14a03 100644 --- a/user-guide/chaos-engineering/fault-injection-service/index.html +++ b/user-guide/chaos-engineering/fault-injection-service/index.html @@ -1,5 +1,5 @@ -Using the Fault Injection Service | Docs -
    Last modified July 25, 2024: Update chaos engg docs with recent product changes (#1256) (0e4708aff)
    \ No newline at end of file diff --git a/user-guide/chaos-engineering/index.html b/user-guide/chaos-engineering/index.html index 8ea9ebafba..8d856e3f9c 100644 --- a/user-guide/chaos-engineering/index.html +++ b/user-guide/chaos-engineering/index.html @@ -1,7 +1,7 @@ Chaos Engineering | Docs

    Chaos Engineering

    Chaos Engineering with LocalStack enables you to build resilient systems early on in the development phase.

      less than a minute  

    The best way to understand concepts is through practice, so dive into our chaos engineering tutorials. -Learn how to build resilient software -by detecting potential outages with the Fault Injection Service, create a -strong architecture through Route53 failover experiments, and -simulate outages in your application stack .

    Introduction

    Chaos engineering via LocalStack is a method to enhance system resilience by deliberately introducing controlled disruptions. -This technique takes different forms depending on the team:

    • Software developers focus on application behavior and error response
    • Architects concentrate on the strength of system design
    • Operations teams investigate the dependability of infrastructure setup.

    Integrating chaos tests early in the development process helps identify and mitigate potential flaws, leading to systems that are more robust under stress and can withstand -turbulent conditions. -Chaos engineering in LocalStack encompasses the following features:

    • Application behavior and error management through Fault Injection Service (FIS) experiments.
    • Robust architecture tested via failover scenarios using FIS.
    • Consistent infrastructure setup under challenging conditions like outages, examined through automated provisioning processes.
    Using the Fault Injection Service

    Use LocalStack Outages Extension to mimic service outages by testing your infrastructure’s ability to deploy robustly and recover from unexpected events.

    Chaos Engineering Dashboard

    Effortlessly design, activate, and manage fault injection experiments with the LocalStack user-friendly dashboard.

    Outages Extension

    Use LocalStack Outages Extension to mimic service outages by testing your infrastructure’s ability to deploy robustly and recover from unexpected events.

    Special Configurations

    Set up LocalStack for chaos engineering using environment variables.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Chaos Engineering

    Chaos Engineering with LocalStack enables you to build resilient systems early on in the development phase.

      less than a minute  

    Introduction

    Chaos engineering via LocalStack is a method to enhance system resilience by deliberately introducing controlled disruptions. +This technique takes different forms depending on the team:

    • Software developers focus on application behavior and error response
    • Architects concentrate on the strength of system design
    • Operations teams investigate the dependability of infrastructure setup.

    Integrating chaos tests early in the development process helps identify and mitigate potential flaws, leading to systems that are more robust under stress and can withstand turbulent conditions. +Chaos engineering in LocalStack encompasses the following features:

    • Application behavior and error management through Fault Injection Service (FIS) experiments.
    • Robust architecture tested via failover scenarios using the Chaos API.
    • Consistent infrastructure setup under challenging conditions like outages, examined through automated provisioning processes.

    The best way to understand concepts is through practice, so dive into our chaos engineering tutorials.

    AWS Fault Injection Service

    Use Fault Injection Service to simulate faults in your infrastructure and test its fault tolerance

    Chaos API

    Simulate outages and network failures to test the resiliency of your infrastructure

    Chaos Engineering Dashboard

    Effortlessly design, activate, and manage Fault Injection Service experiments

    Outages Extension

    Use LocalStack Outages Extension to mimic service outages by testing your infrastructure’s ability to deploy robustly and recover from unexpected events.

    Last modified July 25, 2024: Update chaos engg docs with recent product changes (#1256) (0e4708aff)
    \ No newline at end of file diff --git a/user-guide/chaos-engineering/index.xml b/user-guide/chaos-engineering/index.xml index b3589a5a8e..2940712237 100644 --- a/user-guide/chaos-engineering/index.xml +++ b/user-guide/chaos-engineering/index.xml @@ -1,3 +1,5 @@ -Chaos Engineering on Docs/user-guide/chaos-engineering/Recent content in Chaos Engineering on DocsHugoenUsing the Fault Injection Service/user-guide/chaos-engineering/fault-injection-service/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/fault-injection-service/Introduction The AWS Fault Injection Service is a fully managed service designed to help you improve the resilience of your applications by simulating real-world outages and operational issues. This service allows you to conduct controlled experiments on your AWS infrastructure, injecting faults and observing how your system responds under various conditions. By using the Fault Injection Service, you can identify weaknesses, test recovery procedures, and ensure that your applications can withstand unexpected disruptions.Chaos Engineering Dashboard/user-guide/chaos-engineering/web-application-dashboard/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/web-application-dashboard/Introduction LocalStack&rsquo;s Chaos Engineering dashboard offers streamlined testing for cloud applications, enabling you to simulate server errors, service outages, regional disruptions, and network latency with ease, ensuring your app is ready for real-world challenges. You can find this Pro feature in the web app by navigating to app.localstack.cloud/chaos-engineering. -Web Application FIS Dashboard LocalStack Web Application provides a dashboard for conducting FIS experiments in user stacks. This control panel offers various FIS experiment options, which includes:Outages Extension/user-guide/chaos-engineering/outages-extension/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/outages-extension/Introduction The LocalStack Outages Extension allows you to mimic outages across any AWS region or service. By integrating the Outages Extension using the LocalStack Extension mechanism, you can assess your infrastructure&rsquo;s robustness. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering.Special Configurations/user-guide/chaos-engineering/special-configs/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/special-configs/Introduction LocalStack allows users to inject intentional errors, particularly in Kinesis and DynamoDB. You can introduce controlled chaos into your development environment enhance to enhance service resilience. By configuring environment variables, you can simulate disruptions. This simple setup helps improve the response mechanisms of these key AWS services, ensuring robust architecture under challenging conditions with minimal initial configuration. -This guide demonstrates the DYNAMODB_ERROR_PROBABILITY and KINESIS_ERROR_PROBABILITY configuration flags. The guide assumes basic knowledge of the AWS CLI and our awslocal wrapper script. \ No newline at end of file +Chaos Engineering on Docs/user-guide/chaos-engineering/Recent content in Chaos Engineering on DocsHugoenAWS Fault Injection Service/user-guide/chaos-engineering/fault-injection-service/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/fault-injection-service/Introduction The Fault Injection Service is a fully managed service by AWS designed to help you improve the resilience of your applications by simulating real-world outages and operational issues. This service allows you to conduct controlled experiments on your AWS infrastructure, injecting faults and observing how your system responds under various conditions. +By using the Fault Injection Service, you can identify weaknesses, test recovery procedures, and ensure that your applications can withstand unexpected disruptions.Chaos API/user-guide/chaos-engineering/chaos-api/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/chaos-api/Introduction LocalStack Chaos API allows you to mimic outages across any AWS region or service. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering. +You can use LocalStack Chaos API to cause API failures for any combination of the following:Chaos Engineering Dashboard/user-guide/chaos-engineering/web-application-dashboard/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/web-application-dashboard/Introduction The Chaos Engineering dashboard in LocalStack offers streamlined testing for cloud applications, enabling you to simulate server errors, service outages, regional disruptions, and network latency with ease, ensuring your app is ready for real-world challenges. +You can find this feature in the LocalStack Web Application by navigating to app.localstack.cloud/chaos-engineering. +FIS Dashboard The FIS Dashboard in LocalStack Web Application allows you to conduct Fault Injection Service experiments on infrastructure stacks. This control panel offers various FIS experiment options, which includes:Outages Extension/user-guide/chaos-engineering/outages-extension/Mon, 01 Jan 0001 00:00:00 +0000/user-guide/chaos-engineering/outages-extension/Introduction Warning Outages Extension has been deprecated. It is recommended to migrate to the Chaos API. The LocalStack Outages Extension allows you to mimic outages across any AWS region or service. By integrating the Outages Extension using the LocalStack Extension mechanism, you can assess your infrastructure&rsquo;s robustness. Intentionally triggering service outages and monitoring the system&rsquo;s response in situations where the infrastructure is compromised offers a powerful way to test. This strategy helps gauge the effectiveness of the system&rsquo;s deployment procedures and its resilience against infrastructure disruptions, which is a key element of chaos engineering. \ No newline at end of file diff --git a/user-guide/chaos-engineering/outages-extension/index.html b/user-guide/chaos-engineering/outages-extension/index.html index 38c417b576..02069d95cc 100644 --- a/user-guide/chaos-engineering/outages-extension/index.html +++ b/user-guide/chaos-engineering/outages-extension/index.html @@ -1,5 +1,5 @@ Outages Extension | Docs -
    \ No newline at end of file +--data '[{"service": "transcribe", "region": "us-west-1"}]'
    Last modified July 25, 2024: Update chaos engg docs with recent product changes (#1256) (0e4708aff)
    \ No newline at end of file diff --git a/user-guide/chaos-engineering/web-application-dashboard/index.html b/user-guide/chaos-engineering/web-application-dashboard/index.html index 85f7752820..690a75e7a9 100644 --- a/user-guide/chaos-engineering/web-application-dashboard/index.html +++ b/user-guide/chaos-engineering/web-application-dashboard/index.html @@ -1,5 +1,5 @@ Chaos Engineering Dashboard | Docs -
    \ No newline at end of file diff --git a/user-guide/ci/bitbucket/index.html b/user-guide/ci/bitbucket/index.html index 352c592a55..0e29e158c0 100644 --- a/user-guide/ci/bitbucket/index.html +++ b/user-guide/ci/bitbucket/index.html @@ -155,10 +155,10 @@
  • +

    • BitBucket

    Use LocalStack in BitBucket Pipelines

      2 minute read  

    Introduction

    BitBucket Pipeline is a CI/CD tool that allows you to build, test, and deploy your code directly from BitBucket. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    BitBucket

    Use LocalStack in BitBucket Pipelines

      2 minute read  

    Introduction

    BitBucket Pipeline is a CI/CD tool that allows you to build, test, and deploy your code directly from BitBucket. This guide will show you how to use LocalStack in BitBucket Pipelines.

    Setting up the BitBucket Pipeline

    When you want to integrate LocalStack into your job configuration, you just have to execute the following steps:

    • Specify the Docker Socket to allow the LocalStack container to access the Docker daemon.
    • Export the AWS_ENDPOINT_URL environment variable to point to the LocalStack endpoint.
    • Install the localstack CLI and awscli-local to interact with LocalStack’s emulated services.
    • Start the LocalStack container in detached mode by specifying the Docker Socket and Docker Host.

    The following example BitBucket Pipeline configuration (bitbucket-pipelines.yaml) executes these steps, creates a new S3 bucket, and queries the list of S3 buckets:

    image: python:3.9
 
 definitions:
diff --git a/user-guide/ci/circle-ci/index.html b/user-guide/ci/circle-ci/index.html
index 39fc7743cf..509eb0f93f 100644
--- a/user-guide/ci/circle-ci/index.html
+++ b/user-guide/ci/circle-ci/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • CircleCI

    Use LocalStack in CircleCI

      6 minute read  

    Introduction

    CircleCI is a continuous integration and continuous delivery (CI/CD) platform which uses a configuration file (usually named .circleci/config.yml) to define the build, test, and deployment workflows. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    CircleCI

    Use LocalStack in CircleCI

      6 minute read  

    Introduction

    CircleCI is a continuous integration and continuous delivery (CI/CD) platform which uses a configuration file (usually named .circleci/config.yml) to define the build, test, and deployment workflows. LocalStack supports CircleCI out of the box and can be easily integrated into your pipeline to run your tests against a local cloud emulator.

    Snippets

    Start up LocalStack

    Default

    version: '2.1'
 orbs:
   localstack: localstack/platform@2.2
diff --git a/user-guide/ci/codebuild/index.html b/user-guide/ci/codebuild/index.html
index 25ae450b3e..c194c99816 100644
--- a/user-guide/ci/codebuild/index.html
+++ b/user-guide/ci/codebuild/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • CodeBuild

    Use LocalStack in CodeBuild

      5 minute read  

    Introduction

    AWS CodeBuild is a managed AWS service for the build and testing phases of software development. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    CodeBuild

    Use LocalStack in CodeBuild

      5 minute read  

    Introduction

    AWS CodeBuild is a managed AWS service for the build and testing phases of software development. CodeBuild allows you to define your build project, set the source code location, and handles the building and testing, while supporting various programming languages, build tools, and runtime environments. LocalStack supports CodeBuild out of the box and can be easily integrated into your pipeline to run your tests against a cloud emulator.

    Snippets

    CodeBuild has the capability to use LocalStack’s GitHub Action.

    Start up LocalStack

    Native Runner

    version: 0.2
 ...
diff --git a/user-guide/ci/github-actions/index.html b/user-guide/ci/github-actions/index.html
index abdf847512..4b6282cba8 100644
--- a/user-guide/ci/github-actions/index.html
+++ b/user-guide/ci/github-actions/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • GitHub Actions

    Use LocalStack in GitHub Actions

      3 minute read  

    This page contains easily customisable snippets to show you how to manage LocalStack in a GitHub Actions pipeline.

    Snippets

    Start up Localstack

    - name: Start LocalStack
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    GitHub Actions

    Use LocalStack in GitHub Actions

      3 minute read  

    This page contains easily customisable snippets to show you how to manage LocalStack in a GitHub Actions pipeline.

    Snippets

    Start up Localstack

    - name: Start LocalStack
   uses: LocalStack/setup-localstack@v0.2.2
   with:
     image-tag: 'latest'
diff --git a/user-guide/ci/gitlab-ci/index.html b/user-guide/ci/gitlab-ci/index.html
index 1dd7b13c1b..0a5f542394 100644
--- a/user-guide/ci/gitlab-ci/index.html
+++ b/user-guide/ci/gitlab-ci/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • GitLab CI

    Use LocalStack in GitLab CI

      4 minute read  

    This page contains easily customisable snippets to show you how to manage LocalStack in a GitLab CI pipeline.

    Snippets

    Start up Localstack

    Table of Contents
    Categories
    Persistence
    Tags

    GitLab CI

    Use LocalStack in GitLab CI

      4 minute read  

    This page contains easily customisable snippets to show you how to manage LocalStack in a GitLab CI pipeline.

    Snippets

    Start up Localstack

    For LocalStack versions before 3.0.0Under test>variables, add:
    LOCALSTACK_HOSTNAME: localhost.localstack.cloud
    HOSTNAME_EXTERNAL: localhost.localstack.cloud.

    Service

    ...
 variables:
diff --git a/user-guide/ci/index.html b/user-guide/ci/index.html
index 5638e0a836..ffc1d4a3ab 100644
--- a/user-guide/ci/index.html
+++ b/user-guide/ci/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Continuous Integration

    Run LocalStack in your CI environment to test your application against a high-fidelity cloud emulator

      2 minute read  

    LocalStack enables organizations to automate their application testing and integration process through DevOps practices, such as continuous integration (CI). + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Continuous Integration

    Run LocalStack in your CI environment to test your application against a high-fidelity cloud emulator

      2 minute read  

    LocalStack enables organizations to automate their application testing and integration process through DevOps practices, such as continuous integration (CI). To meet your organizational needs, LocalStack lets you move away from complicated AWS testing and staging environments by enabling a key component of testing and delivering cloud-native applications.

    You can easily integrate LocalStack with your existing CI platform. We provide native plugins for CircleCI and a generic driver for any other CI platform you might use. This enables you to incorporate LocalStack’s local AWS cloud emulation in your CI pipelines, use advanced features like Cloud Pods and CI analytics, and run your test & integration suite before pushing to production.

    Hypothetical CI workflow

    Let’s assume that your team has an automated CI workflow into which you want to integrate end-to-end cloud testing with LocalStack. diff --git a/user-guide/ci/travis-ci/index.html b/user-guide/ci/travis-ci/index.html index a503d71a9b..20a55a939c 100644 --- a/user-guide/ci/travis-ci/index.html +++ b/user-guide/ci/travis-ci/index.html @@ -155,10 +155,10 @@

  • +

    • Travis CI

    Use LocalStack in Travis CI

      2 minute read  

    This guide shows how to start and use LocalStack in your Travis CI jobs.

    Setting up the Travis CI job

    When you want to integrate LocalStack into your job configuration, you just have to execute the following steps:

    • Install the LocalStack CLI (and maybe also awslocal).
    • Make sure your LocalStack docker image is up-to-date by pulling the latest version.
    • Use the LocalStack CLI to start LocalStack. + Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Travis CI

    Use LocalStack in Travis CI

      2 minute read  

    This guide shows how to start and use LocalStack in your Travis CI jobs.

    Setting up the Travis CI job

    When you want to integrate LocalStack into your job configuration, you just have to execute the following steps:

    • Install the LocalStack CLI (and maybe also awslocal).
    • Make sure your LocalStack docker image is up-to-date by pulling the latest version.
    • Use the LocalStack CLI to start LocalStack. Make sure to use the -d flag to start the LocalStack docker container in detached mode.
    • Wait for the container to report that it is up and running.

    The following example Travis CI job config (.travis.yaml) executes these steps, creates a new S3 bucket, and prints a nice message in the end:

    language: python
 
 services:
diff --git a/user-guide/cloud-sandbox/application-previews/index.html b/user-guide/cloud-sandbox/application-previews/index.html
index a1b6e5afec..4f8e75e743 100644
--- a/user-guide/cloud-sandbox/application-previews/index.html
+++ b/user-guide/cloud-sandbox/application-previews/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Application Preview

    Create an Application Preview to deploy your application changes in an Ephemeral Instance

      3 minute read  

    Introduction

    Application Preview generates a preview environment from GitHub Pull Requests (PRs). + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Application Preview

    Create an Application Preview to deploy your application changes in an Ephemeral Instance

      3 minute read  

    Introduction

    Application Preview generates a preview environment from GitHub Pull Requests (PRs). It allows temporary deployment of AWS powered applications on a LocalStack Ephemeral Instance to preview changes. This feature is currently only available for GitHub repositories that use GitHub Actions.

    Getting started

    This guide is designed for users new to Application Preview and assumes basic knowledge of GitHub Actions. We will configure a CI pipeline that runs on pull requests using GitHub Actions.

    Prerequisites

    Create the Application Preview

    To create an Application Preview, use the LocalStack/setup-localstack action.

    Create a file named preview-pipeline.yml in the .github/workflows directory of your custom repository. diff --git a/user-guide/cloud-sandbox/ephemeral-instance/index.html b/user-guide/cloud-sandbox/ephemeral-instance/index.html index 4a41e218a7..5bf1ebef20 100644 --- a/user-guide/cloud-sandbox/ephemeral-instance/index.html +++ b/user-guide/cloud-sandbox/ephemeral-instance/index.html @@ -152,10 +152,10 @@

  • +

    • Ephemeral Instances

    Create an Ephemeral Instance in the cloud using the LocalStack Web Application

      3 minute read  

    Introduction

    Ephemeral Instances allows you to run a LocalStack instance in the cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Ephemeral Instances

    Create an Ephemeral Instance in the cloud using the LocalStack Web Application

      3 minute read  

    Introduction

    Ephemeral Instances allows you to run a LocalStack instance in the cloud. You can interact with these instances via the LocalStack Web Application, or by configuring your integrations and developer tools with the endpoint URL of the ephemeral instance.

    Getting started

    This guide is designed for users new to Ephemeral Instance and assumes basic knowledge of the LocalStack Web Application. In this guide, we will create an Ephemeral Instance and interact with it via the LocalStack Web Application and the AWS CLI.

    Create a new Ephemeral Instance

    Navigate to the LocalStack Ephemeral Instance Management page. In the form, enter the name of the new Ephemeral Instance, select the lifetime of the instance by dragging the slider, and click on Launch.

    Creating an Ephemeral Instance

    Optionally, you can specify a LocalStack Extension to be installed or loaded in the Ephemeral Instance. diff --git a/user-guide/cloud-sandbox/index.html b/user-guide/cloud-sandbox/index.html index 90168034e2..d1515938eb 100644 --- a/user-guide/cloud-sandbox/index.html +++ b/user-guide/cloud-sandbox/index.html @@ -155,10 +155,10 @@

  • +

    • Cloud Sandbox

    You can run a LocalStack instance as a Cloud Sandbox and access it from your local machine.

      less than a minute  

    Introduction

    LocalStack Cloud Sandbox allow you to run an LocalStack instance in the cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Cloud Sandbox

    You can run a LocalStack instance as a Cloud Sandbox and access it from your local machine.

      less than a minute  

    Introduction

    LocalStack Cloud Sandbox allow you to run an LocalStack instance in the cloud. LocalStack Cloud Sandbox encompasses the following features:

    • Deploy LocalStack as an ephemeral instance for dev&test loops without running it locally.
    • Create easy previews by enabling preview-per-PR type workflows for application change.
    • Facilitate collaboration by allowing developers to test features on the same environment.
    Ephemeral Instances

    Create an Ephemeral Instance in the cloud using the LocalStack Web Application

    Application Preview

    Create an Application Preview to deploy your application changes in an Ephemeral Instance

    Last modified July 23, 2024: revamp app preview docs (#1397) (9f8c0f58c)
    \ No newline at end of file diff --git a/user-guide/extensions/developing-extensions/index.html b/user-guide/extensions/developing-extensions/index.html index 60fef6e3b2..48e86b879c 100644 --- a/user-guide/extensions/developing-extensions/index.html +++ b/user-guide/extensions/developing-extensions/index.html @@ -155,10 +155,10 @@
  • +

    • Developing extensions

    How to develop your own extensions
    Tags:

      5 minute read  

    Introduction

    This section provides a brief overview of how to develop your own extensions.

    Extensions API

    LocalStack exposes a Python API for building extensions that can be found in the core codebase in localstack.extensions.api.

    The basic interface to implement is as follows:

    class Extension(BaseExtension):
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Developing extensions

    How to develop your own extensions
    Tags:

      5 minute read  

    Introduction

    This section provides a brief overview of how to develop your own extensions.

    Extensions API

    LocalStack exposes a Python API for building extensions that can be found in the core codebase in localstack.extensions.api.

    The basic interface to implement is as follows:

    class Extension(BaseExtension):
     """
     An extension that is loaded into LocalStack dynamically. The method
     execution order of an extension is as follows:
diff --git a/user-guide/extensions/extensions-library/index.html b/user-guide/extensions/extensions-library/index.html
index 0fe5058a6b..ed0961a035 100644
--- a/user-guide/extensions/extensions-library/index.html
+++ b/user-guide/extensions/extensions-library/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Extensions Library

    Extend LocalStack by adding new services and features as extensions
    Tags:

      less than a minute  

    Introduction

    LocalStack extensions allows you to extend and customize LocalStack. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Extensions Library

    Extend LocalStack by adding new services and features as extensions
    Tags:

      less than a minute  

    Introduction

    LocalStack extensions allows you to extend and customize LocalStack. A LocalStack extension is a Python application that runs together with LocalStack within the LocalStack container.

    LocalStack extensions are available to licensed users, and the list of available extensions can be found in the Extensions Library.

    LocalStack Extensions Library

    Installing an Extension

    To install an extension using the LocalStack Extensions Library, you can navigate to the app.localstack.cloud/extensions/library and click on the Go to Instance button to open the list of available instances. If you are running your LocalStack instance locally, you can click on the Default option.

    You will be redirected to the LocalStack instance page, where you can directly click the Install button to install the Extension. The installation process will take a few seconds, and will restart your LocalStack instance. diff --git a/user-guide/extensions/getting-started/index.html b/user-guide/extensions/getting-started/index.html index 7fbe55f7a2..00930b4dc2 100644 --- a/user-guide/extensions/getting-started/index.html +++ b/user-guide/extensions/getting-started/index.html @@ -155,10 +155,10 @@

  • +

    • Getting started

    Get started with LocalStack extensions by installing and using the official MailHog extension.
    Tags:

      2 minute read  

    Introduction

    MailHog is an open source email testing tool for developers. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Getting started

    Get started with LocalStack extensions by installing and using the official MailHog extension.
    Tags:

      2 minute read  

    Introduction

    MailHog is an open source email testing tool for developers. It provides a simple SMTP server and web interface that allows developers to easily catch and inspect emails sent from their application during development. In this guide, you will install and use the official MailHog extension for LocalStack and send an email through SES, while inspecting it in MailHog.

    Prerequisites

    Installation

    To get started, start your LocalStack instance with your LOCALSTACK_API_KEY. Access our Extension Manager, and click the Install button for the MailHog extension.

    Extensions Manager

    You’ll receive a confirmation prompt indicating that LocalStack container will restart, after which the extension will become accessible. diff --git a/user-guide/extensions/index.html b/user-guide/extensions/index.html index 414361736e..a10f994aee 100644 --- a/user-guide/extensions/index.html +++ b/user-guide/extensions/index.html @@ -155,10 +155,10 @@

  • +

    • LocalStack Extensions

    Use LocalStack Extensions to customize and extend your local development experience.

      less than a minute  

    LocalStack Extensions allow developers to extend and customize LocalStack. + Create project issue

    Categories
    Persistence
    Tags

    LocalStack Extensions

    Use LocalStack Extensions to customize and extend your local development experience.

      less than a minute  

    LocalStack Extensions allow developers to extend and customize LocalStack. Extensions are a feature of our paid offering. LocalStack Extensions enable you to start custom services with LocalStack in the same container, while leveraging the existing features in the ecosystem.

    Developers can add new services, extend existing services, and even add custom functionality. The Extensions API allows developers to easily plug in their own custom logic and services into the LocalStack container.

    You can use LocalStack Extensions to:

    • Starting custom services together with LocalStack in the same container (see our Cloudflare Workers Extension).
    • Instrumenting AWS requests with additional information before they reach your Lambdas.
    • Logging AWS API calls to custom data backends.

    The officially supported LocalStack Extensions can be discovered on our Extension Library. diff --git a/user-guide/extensions/managing-extensions/index.html b/user-guide/extensions/managing-extensions/index.html index 4a053805a4..7366bebe57 100644 --- a/user-guide/extensions/managing-extensions/index.html +++ b/user-guide/extensions/managing-extensions/index.html @@ -155,10 +155,10 @@

  • +

    • Managing extensions

    How to manage LocalStack extensions in your LocalStack environment
    Tags:

      5 minute read  

    You have different options to install and manage your LocalStack extensions depending on your environment and work style.

    Extensions are managed through the LocalStack container, but stored in the LocalStack volume on your host. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Managing extensions

    How to manage LocalStack extensions in your LocalStack environment
    Tags:

      5 minute read  

    You have different options to install and manage your LocalStack extensions depending on your environment and work style.

    Extensions are managed through the LocalStack container, but stored in the LocalStack volume on your host. The next time you start up LocalStack, your extensions will still be there!

    Using the extensions manager in our App

    The easiest way to manage official extensions is through our webapp and our Extension Manager App. Simply install and remove extensions from your specific LocalStack instance directly from the App.

    If you have multiple instances of LocalStack, each instance has its own set of extensions, and our App allows you to manage extensions for each instance individually.

    User Guides

    Develop your understanding of various LocalStack features, integrations, and use cases.
    Local AWS Services

    Integrations

    How to use your favorite cloud development tools with LocalStack.

    Continuous Integration

    Run LocalStack in your CI environment to test your application against a high-fidelity cloud emulator

    LocalStack Extensions

    Use LocalStack Extensions to customize and extend your local development experience.

    State Management

    Cloud Pods provides a new way of collaborating in cloud application development workflows.

    Chaos Engineering

    Chaos Engineering with LocalStack enables you to build resilient systems early on in the development phase.

    Security Testing

    Security Testing in LocalStack allows you to test your IAM policies and permissions locally resembling the AWS environment.

    Cloud Sandbox

    You can run a LocalStack instance as a Cloud Sandbox and access it from your local machine.

    LocalStack Tools

    Increase your development efficiency with LocalStack Cloud Developer Tools.

    Lambda Tools

    Develop your Lambdas more efficiently.

    LocalStack Web Application

    The LocalStack web app allows you to access additional features of LocalStack as well as to manage subscription and licenses, workspace members and permissions.

    Last modified November 9, 2023: Add v3 pre-release banner (#903) (1fd4f9b6f)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    User Guides

    Develop your understanding of various LocalStack features, integrations, and use cases.
    Local AWS Services

    Integrations

    How to use your favorite cloud development tools with LocalStack.

    Continuous Integration

    Run LocalStack in your CI environment to test your application against a high-fidelity cloud emulator

    LocalStack Extensions

    Use LocalStack Extensions to customize and extend your local development experience.

    State Management

    Cloud Pods provides a new way of collaborating in cloud application development workflows.

    Chaos Engineering

    Chaos Engineering with LocalStack enables you to build resilient systems early on in the development phase.

    Security Testing

    Security Testing in LocalStack allows you to test your IAM policies and permissions locally resembling the AWS environment.

    Cloud Sandbox

    You can run a LocalStack instance as a Cloud Sandbox and access it from your local machine.

    LocalStack Tools

    Increase your development efficiency with LocalStack Cloud Developer Tools.

    Lambda Tools

    Develop your Lambdas more efficiently.

    LocalStack Web Application

    The LocalStack web app allows you to access additional features of LocalStack as well as to manage subscription and licenses, workspace members and permissions.

    Last modified November 9, 2023: Add v3 pre-release banner (#903) (1fd4f9b6f)
    \ No newline at end of file diff --git a/user-guide/integrations/architect/index.html b/user-guide/integrations/architect/index.html index 0f9d57a644..b2afe7894f 100644 --- a/user-guide/integrations/architect/index.html +++ b/user-guide/integrations/architect/index.html @@ -155,10 +155,10 @@
  • +

    • Architect

    Use the Architect Infrastructure as Code framework with LocalStack

      less than a minute  

    architect logo

    Overview

    Architect enables you to quickly build large serverless apps without worrying about the underlying infrastructure. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Architect

    Use the Architect Infrastructure as Code framework with LocalStack

      less than a minute  

    architect logo

    Overview

    Architect enables you to quickly build large serverless apps without worrying about the underlying infrastructure. On this page we discuss how Architect and LocalStack can be used together. If you are adapting an existing configuration, you might be able to skip certain steps at your own discretion.

    Example

    Setup

    To use Architect in conjunction with LocalStack, simply install the arclocal command (sources can be found here).

    $ npm install -g architect-local @architect/architect aws-sdk

    The arclocal command has the same usage as the arc command, so you can start right away.

    Create a test directory

    $ mkdir architect_quickstart && cd architect_quickstart

    then create an architect project

    $ arclocal init

    Deployment

    Now you need to start LocalStack. After LocalStack has started you can deploy your Architect setup via:

    $ arclocal deploy

    Further reading

    For more architect examples, you can take a look at the official architect docs.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/integrations/aws-cdk/index.html b/user-guide/integrations/aws-cdk/index.html index c577490f18..8670ed169b 100644 --- a/user-guide/integrations/aws-cdk/index.html +++ b/user-guide/integrations/aws-cdk/index.html @@ -155,10 +155,10 @@
  • +

    • AWS CDK

    Use the AWS CDK (Cloud Development Kit) with LocalStack

      3 minute read  

    AWS CDK

    Overview

    The AWS Cloud Development Kit (CDK) is an Infrastructure-as-Code (IaC) tool using general-purpose programming languages such as TypeScript/JavaScript, Python, Java, and .NET to programmatically define your cloud architecture on AWS.

    AWS CDK CLI for LocalStack

    cdklocal is a thin wrapper script for using the AWS CDK library against local APIs provided by LocalStack.

    Installation

    The cdklocal command line is published as an npm library:

    # Install globally
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    AWS CDK

    Use the AWS CDK (Cloud Development Kit) with LocalStack

      3 minute read  

    AWS CDK

    Overview

    The AWS Cloud Development Kit (CDK) is an Infrastructure-as-Code (IaC) tool using general-purpose programming languages such as TypeScript/JavaScript, Python, Java, and .NET to programmatically define your cloud architecture on AWS.

    AWS CDK CLI for LocalStack

    cdklocal is a thin wrapper script for using the AWS CDK library against local APIs provided by LocalStack.

    Installation

    The cdklocal command line is published as an npm library:

    # Install globally
 npm install -g aws-cdk-local aws-cdk
 
 # Verify it installed correctly
diff --git a/user-guide/integrations/aws-cli/index.html b/user-guide/integrations/aws-cli/index.html
index 5ef1161d12..dcd8121710 100644
--- a/user-guide/integrations/aws-cli/index.html
+++ b/user-guide/integrations/aws-cli/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • AWS Command Line Interface (CLI)

    Use AWS Command Line Interface (CLI) to create local AWS resources with LocalStack

      4 minute read  

    Introduction

    The AWS Command Line Interface (CLI) is a unified tool for creating and managing AWS services via a command line interface. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Command Line Interface (CLI)

    Use AWS Command Line Interface (CLI) to create local AWS resources with LocalStack

      4 minute read  

    Introduction

    The AWS Command Line Interface (CLI) is a unified tool for creating and managing AWS services via a command line interface. All CLI commands applicable to services implemented within LocalStack can be executed when operating against LocalStack.

    You can use the AWS CLI with LocalStack using either of the following approaches:

    AWS CLI

    You can install aws by using the following command if it’s not already installed.

    $ pip install awscli

    You can configure the AWS CLI to redirect AWS API requests to LocalStack using two approaches:

    Configuring an endpoint URL

    You can use AWS CLI with an endpoint URL by configuring test environment variables and include the --endpoint-url=<localstack-url> flag in your aws CLI commands. For example:

    $ export AWS_ACCESS_KEY_ID="test"
 $ export AWS_SECRET_ACCESS_KEY="test"
diff --git a/user-guide/integrations/aws-sam/index.html b/user-guide/integrations/aws-sam/index.html
index 1cb007c087..87301bc3a9 100644
--- a/user-guide/integrations/aws-sam/index.html
+++ b/user-guide/integrations/aws-sam/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • AWS Serverless Application Model (SAM)

    Use the AWS SAM (Serverless Application Model) with LocalStack

      3 minute read  

    Introduction

    The AWS Serverless Application Model (SAM) is an open-source framework for developing serverless applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Serverless Application Model (SAM)

    Use the AWS SAM (Serverless Application Model) with LocalStack

      3 minute read  

    Introduction

    The AWS Serverless Application Model (SAM) is an open-source framework for developing serverless applications. It uses a simplified syntax to define functions, APIs, databases, and event source mappings. When you deploy, SAM converts its syntax into AWS CloudFormation syntax, helping you create serverless applications more quickly.

    LocalStack can work with SAM using the AWS SAM CLI for LocalStack. This CLI comes in the form of a samlocal wrapper script, which lets you deploy SAM applications on LocalStack. diff --git a/user-guide/integrations/chalice/index.html b/user-guide/integrations/chalice/index.html index 8f0544ed51..72f782a35c 100644 --- a/user-guide/integrations/chalice/index.html +++ b/user-guide/integrations/chalice/index.html @@ -155,10 +155,10 @@

  • +

    • AWS Chalice

    Use AWS Chalice with LocalStack

      3 minute read  

    AWS Chalice is a serverless micro framework used to develop and deploy your serverless applications on AWS resources. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Chalice

    Use AWS Chalice with LocalStack

      3 minute read  

    AWS Chalice is a serverless micro framework used to develop and deploy your serverless applications on AWS resources. Chalice provides integrated functionality with most of the AWS Toolings like S3 Storage, Simple Queue Service, API Gateway and more. It offers a handy CLI interface that allows you to easily create, develop & deploy your serverless applications.

    LocalStack offers an AWS Chalice client that allows you to interact with your Chalice applications locally. Using LocalStack, you can kick-start your development process, create a new Chalice application, and test it application locally.

    Creating a new Chalice project

    Start LocalStack inside a Docker container by running:

    $ localstack start -d

    Install the chalice-local package by running:

    $ pip install chalice-local

    You can now create a new Chalice project by running:

    $ chalice-local new-project

    You will be prompted with an interactive menu where you can choose the name of your project and the project type. diff --git a/user-guide/integrations/cloud-custodian/index.html b/user-guide/integrations/cloud-custodian/index.html index 3f80c7a82f..07a0696ad9 100644 --- a/user-guide/integrations/cloud-custodian/index.html +++ b/user-guide/integrations/cloud-custodian/index.html @@ -155,10 +155,10 @@

  • +

    • Cloud Custodian

    Use Cloud Custodian with LocalStack

      4 minute read  

    Introduction

    Cloud Custodian is an open-source rules engine and cloud management tool designed to help organizations maintain security and compliance across their cloud environments. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Cloud Custodian

    Use Cloud Custodian with LocalStack

      4 minute read  

    Introduction

    Cloud Custodian is an open-source rules engine and cloud management tool designed to help organizations maintain security and compliance across their cloud environments. Cloud Custodian’s YAML DSL allows definition of rules to filter and tag resources, and then apply actions to those resources.

    Cloud Custodian can be used to manage local AWS resources in LocalStack, resembling the live AWS environment, allowing you to test and validate your security policies locally. You can use Cloud Custodian with LocalStack by just specifying the Cloud Custodian package to use the LocalStack profile configured with your AWS CLI.

    Getting started

    This guide is designed for users who are new to Cloud Custodian and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container using your preferred method. We will demonstrate how you can spin up an EC2 instance and tag it with the key Custodian, and then use Cloud Custodian to stop the instance.

    Install Cloud Custodian

    To install Cloud Custodian, run the following command:

    $ pip install c7n

    After installing Cloud Custodian, you can configure a custom LocalStack profile in your AWS CLI configuration file.

    Create an EC2 instance

    You can create an EC2 instance using the awslocal wrapper script. diff --git a/user-guide/integrations/copilot/index.html b/user-guide/integrations/copilot/index.html index 16fcfc8934..6d88c2adec 100644 --- a/user-guide/integrations/copilot/index.html +++ b/user-guide/integrations/copilot/index.html @@ -155,10 +155,10 @@

  • +

    • AWS Copilot CLI

    Build, Release and Operate Containerized Applications on AWS with AWS Copilot CLI

      2 minute read  

    Overview

    The AWS Copilot CLI is a command line tool for developer, to release and operate containerized applications using the AWS services ECS, Fargate and App runner. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    AWS Copilot CLI

    Build, Release and Operate Containerized Applications on AWS with AWS Copilot CLI

      2 minute read  

    Overview

    The AWS Copilot CLI is a command line tool for developer, to release and operate containerized applications using the AWS services ECS, Fargate and App runner. Copilot CLI makes it very simple to deploy your application, without the need for manual configuration of the mentioned services.

    Copilot Local

    copilotlocal is a fork of AWS Copilot CLI, where the endpoints for all services are redirected to http://localhost:4566. Using copilotlocal instead of copilot in your command line therefore ensures the deployment of your service on LocalStack instead of AWS.

    Download / Installation

  • +

    • Crossplane

    Use the Crossplane cloud-native control plane framework with LocalStack

      5 minute read  

    Crossplane logo

    Overview

    Crossplane is a cloud-native control plane framework, which offers an extensible backend that enables orchestrating applications and infrastructure via declarative APIs and resource definitions.

    Crossplane offers a native AWS provider which can be used to create and manage AWS cloud resources via the Crossplane platform. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Crossplane

    Use the Crossplane cloud-native control plane framework with LocalStack

      5 minute read  

    Crossplane logo

    Overview

    Crossplane is a cloud-native control plane framework, which offers an extensible backend that enables orchestrating applications and infrastructure via declarative APIs and resource definitions.

    Crossplane offers a native AWS provider which can be used to create and manage AWS cloud resources via the Crossplane platform. For example, it can be used to create S3 buckets, SQS queues, Lambda functions, among many other resources. Crossplane AWS provider supports a comprehensive set of some 900+ resource types.

    Getting started

    In the following, we provide a step-by-step guide for installing Crossplane in a local test environment, and creating AWS resources (S3 bucket, SQS queue) in LocalStack via Crossplane.

    Prerequisites

    • LocalStack running in local Docker
    • A local Kubernetes cluster:
      • We can use the embedded Kubernetes cluster that ships with modern versions of Docker Desktop (can be easily enabled in the Docker settings)
      • Alternatively, you can create a local EKS cluster in LocalStack directly, which will spin up a light-weight embedded k3d Kubernetes cluster in your Docker environment
    • The helm and kubectl command-line clients installed

    Installing Crossplane in local Kubernetes

    Once your kubectl is configured to point to the local Kubernetes cluster, we first install Crossplane via helm:

    $ helm repo add crossplane-stable https://charts.crossplane.io/stable
 $ helm repo update
diff --git a/user-guide/integrations/eksctl/index.html b/user-guide/integrations/eksctl/index.html
index 8e7a8a9d08..c4c05c5597 100644
--- a/user-guide/integrations/eksctl/index.html
+++ b/user-guide/integrations/eksctl/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • eksctl

    Running eksctl on LocalStack to create EKS clusters

      less than a minute  

    Introduction

    eksctl is a CLI tool for creating and managing EKS clusters, Amazon’s managed Kubernetes service. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    eksctl

    Running eksctl on LocalStack to create EKS clusters

      less than a minute  

    Introduction

    eksctl is a CLI tool for creating and managing EKS clusters, Amazon’s managed Kubernetes service. LocalStack supports running eksctl on LocalStack to create EKS clusters locally. LocalStack’s EKS spin up embedded Kubernetes clusters using K3s to allow you to use the EKS APIs in your local environment.

    Getting started

    This guide is designed for users new to eksctl and running EKS clusters with LocalStack. diff --git a/user-guide/integrations/former2/index.html b/user-guide/integrations/former2/index.html index 0eabcc4723..b2e26960fe 100644 --- a/user-guide/integrations/former2/index.html +++ b/user-guide/integrations/former2/index.html @@ -155,10 +155,10 @@

  • +

    • Former2

    Use Former2 to generate Infrastructure-as-Code outputs from existing resources with LocalStack

      3 minute read  

    Introduction

    Former2 allows you to generate Infrastructure-as-Code (IaC) outputs using your pre-existing AWS resources. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Former2

    Use Former2 to generate Infrastructure-as-Code outputs from existing resources with LocalStack

      3 minute read  

    Introduction

    Former2 allows you to generate Infrastructure-as-Code (IaC) outputs using your pre-existing AWS resources. It uses the AWS JavaScript SDK to make relevant API calls, scans your infrastructure, and provides you with a resource list. You can then select the resources for which you want to generate IaC outputs. Former2 currently supports the following outputs:

    With Former2, you can scan the resources within your LocalStack instance and produce Infrastructure-as-Code (IaC) outputs. diff --git a/user-guide/integrations/gitpod/index.html b/user-guide/integrations/gitpod/index.html index cb8a5adf8c..59dd76b02c 100644 --- a/user-guide/integrations/gitpod/index.html +++ b/user-guide/integrations/gitpod/index.html @@ -155,10 +155,10 @@

  • +

    • GitPod

    Use GitPod’s fully automated, ephemeral workspaces to develop & test your cloud applications with LocalStack

      3 minute read  

    GitPod logo

    Overview

    Gitpod is an open-source platform that enables remote software development via ephemeral workspaces. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    GitPod

    Use GitPod’s fully automated, ephemeral workspaces to develop & test your cloud applications with LocalStack

      3 minute read  

    GitPod logo

    Overview

    Gitpod is an open-source platform that enables remote software development via ephemeral workspaces. It provides an automated setup with cloud-based, remote developer environments connected with a developer’s editing experience of choice. Gitpod allow users to codify their developer environment as code. With projects codified, you can spin up a new workspace, start coding and throw away the workspace when they are done!

    LocalStack on GitPod

    LocalStack allows you to set up a development environment with a cloud sandbox that can be used to test and develop cloud applications. diff --git a/user-guide/integrations/index.html b/user-guide/integrations/index.html index cb41b71662..d0ac1c484f 100644 --- a/user-guide/integrations/index.html +++ b/user-guide/integrations/index.html @@ -155,10 +155,10 @@

  • +

    • Integrations

    How to use your favorite cloud development tools with LocalStack.

      less than a minute  

    LocalStack supports a wide range of tools from the cloud development ecosystem. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Integrations

    How to use your favorite cloud development tools with LocalStack.

      less than a minute  

    LocalStack supports a wide range of tools from the cloud development ecosystem. This section of the documentation covers tools that are officially supported by LocalStack.

    The Cloud Development Ecosystem

    Cloud development has many facets and a rich ecosystem of tools to cover them. Whether you are using Infrastructure-as-Code (IaC) to manage your AWS infrastructure, or are developing applications using AWS SDKs like boto, LocalStack allows you to run your workflow completely on your local machine.

    Sample of supported tools

    Integrations

    We strive to make the integration of LocalStack into your workflow as seamless as possible. diff --git a/user-guide/integrations/kafka/index.html b/user-guide/integrations/kafka/index.html index 8c4c5c8e35..7d79898b75 100644 --- a/user-guide/integrations/kafka/index.html +++ b/user-guide/integrations/kafka/index.html @@ -155,10 +155,10 @@

  • +

    • Self-managed Kafka cluster

    Using LocalStack Lambda with a self-managed Kafka cluster

      2 minute read  

    LocalStack Pro supports AWS Managed Streaming for Kafka (MSK) and you can create Kafka clusters directly through the MSK API that will run in LocalStack. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Self-managed Kafka cluster

    Using LocalStack Lambda with a self-managed Kafka cluster

      2 minute read  

    LocalStack Pro supports AWS Managed Streaming for Kafka (MSK) and you can create Kafka clusters directly through the MSK API that will run in LocalStack. In some cases, you may want to run your own self-managed Kafka cluster and integrate it with your applications, like triggering Lambdas from a Kafka stream running in your own cluster. The Lambda integration with self-managed Kafka clusters is also a LocalStack Pro feature.

    Running self-managed Kafka

    You can find the example Docker Compose file which contains a single-noded ZooKeeper and a Kafka cluster and a simple LocalStack setup as well as Kowl, an Apache Kafka Web UI.

    1. Run Docker Compose:
    $ docker-compose up -d
    1. Create the Lambda function:
    $ awslocal lambda create-function \
     --function-name fun1 \
diff --git a/user-guide/integrations/kubernetes/index.html b/user-guide/integrations/kubernetes/index.html
index faef421a2f..aebec18737 100644
--- a/user-guide/integrations/kubernetes/index.html
+++ b/user-guide/integrations/kubernetes/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Kubernetes

    Running LocalStack on Kubernetes

      5 minute read  

    Introduction

    Kubernetes is an open-source container orchestration platform that simplifies the deployment, scaling, and management of containerized applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Kubernetes

    Running LocalStack on Kubernetes

      5 minute read  

    Introduction

    Kubernetes is an open-source container orchestration platform that simplifies the deployment, scaling, and management of containerized applications. LocalStack can be deployed on Kubernetes using the LocalStack Helm chart.

    Getting started

    To deploy LocalStack in your Kubernetes cluster, you can use Helm.

    Prerequisites

    • Kubernetes 1.19+
    • Helm 3.2.0+

    Setup a Kubernetes cluster

    For setting up Kubernetes refer to the Kubernetes getting started guide.

    Install Helm

    Helm is a tool for managing Kubernetes charts. diff --git a/user-guide/integrations/lambdatest-hyperexecute/index.html b/user-guide/integrations/lambdatest-hyperexecute/index.html index c1b47acf65..b4798d6a8c 100644 --- a/user-guide/integrations/lambdatest-hyperexecute/index.html +++ b/user-guide/integrations/lambdatest-hyperexecute/index.html @@ -152,10 +152,10 @@

  • +

    • LambdaTest HyperExecute

    Executing LocalStack tests on LambdaTest’s HyperExecute

      3 minute read  

    HyperExecute is a test orchestration platform designed to optimize the execution of automated tests in the cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    LambdaTest HyperExecute

    Executing LocalStack tests on LambdaTest’s HyperExecute

      3 minute read  

    HyperExecute is a test orchestration platform designed to optimize the execution of automated tests in the cloud. It supports a wide range of testing frameworks and integrates seamlessly with CI/CD pipelines, such as GitHub Actions. You can use HyperExecute to run your LocalStack tests on your local machine or in the CI pipeline using a single configuration file.

    OpenShift

    Use the OpenShift managed Kubernetes cluster to deploy LocalStack

      4 minute read  

    Introduction

    OpenShift is a container orchestration platform as a service designed to simplify the deployment, scaling, and management of containerized applications. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    OpenShift

    Use the OpenShift managed Kubernetes cluster to deploy LocalStack

      4 minute read  

    Introduction

    OpenShift is a container orchestration platform as a service designed to simplify the deployment, scaling, and management of containerized applications. Built on Kubernetes, OpenShift provides a comprehensive set of tools and features that facilitate the orchestration, automation, and monitoring of containerized workloads.

    With OpenShift, you can deploy LocalStack on a managed Kubernetes cluster, as a cloud sandbox that emulates various AWS services & APIs. This guide demonstrates how you can deploy LocalStack on OpenShift using Devfile. You can use the deployed LocalStack container to create AWS resources that you can use for local development and testing purposes.

    Pulumi

    Use the Pulumi Infrastructure as Code framework with LocalStack

      7 minute read  

    Introduction

    Pulumi’s SDK for infrastructure-as-code allows you to create, deploy, and manage AWS containers, serverless functions, and other infrastructure using popular programming languages. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Pulumi

    Use the Pulumi Infrastructure as Code framework with LocalStack

      7 minute read  

    Introduction

    Pulumi’s SDK for infrastructure-as-code allows you to create, deploy, and manage AWS containers, serverless functions, and other infrastructure using popular programming languages. It supports a range of cloud providers, including AWS, Azure, Google Cloud, and Kubernetes.

    LocalStack can integrate with Pulumi through the Pulumi configuration environment. There are two main methods to configure Pulumi for use with LocalStack:

    • Using the pulumilocal wrapper script which automatically configures service endpoints.
    • Manually setting up the service endpoints in your Pulumi configuration, which requires ongoing maintenance.

    This guide will show you how to set up local AWS resources using both the pulumilocal wrapper and manual configuration.

    pulumilocal wrapper script

    pulumilocal is a wrapper for the pulumi command line interface, facilitating the use of Pulumi with LocalStack. When executing deployment commands like pulumilocal ["up", "destroy", "preview", "cancel"], the script configures the Pulumi settings for LocalStack and runs the specified Pulumi command.

    The endpoints are set to point to the LocalStack API (http://localhost:4566). diff --git a/user-guide/integrations/quarkus/index.html b/user-guide/integrations/quarkus/index.html index 1105ab7150..8cbc026693 100644 --- a/user-guide/integrations/quarkus/index.html +++ b/user-guide/integrations/quarkus/index.html @@ -155,10 +155,10 @@

  • +

    • Quarkus

    Use the Quarkus framework with LocalStack

      4 minute read  

    Introduction

    Quarkus is a Java framework optimized for cloud, serverless, and containerized environments. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Quarkus

    Use the Quarkus framework with LocalStack

      4 minute read  

    Introduction

    Quarkus is a Java framework optimized for cloud, serverless, and containerized environments. Quarkus leverages a Kubernetes Native Java stack tailored for GraalVM & OpenJDK HotSpot, which further builds on various Java libraries and standards.

    Localstack is supported by Quarkus as a Dev service for Amazon Services. Quarkus Amazon Services automatically starts a LocalStack container in development mode and when running tests, and the extension client is configured automatically.

    Getting started

    In this guide, we will demonstrate how you can create a service client for creating and managing Lambdas on LocalStack. The Lambda extension is based on AWS Java SDK 2.x.

    Prerequisites

    Create a Maven project

    Create a new project with the following command:

    $ mvn io.quarkus.platform:quarkus-maven-plugin:3.6.3:create \
diff --git a/user-guide/integrations/sdks/cpp/index.html b/user-guide/integrations/sdks/cpp/index.html
index 977ed506e7..a3fc105b5f 100644
--- a/user-guide/integrations/sdks/cpp/index.html
+++ b/user-guide/integrations/sdks/cpp/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • C++

    How to use the C++ AWS SDK with LocalStack.

      2 minute read  

    Overview

    The AWS SDK for C++, like other AWS SDKs, lets you set the endpoint when creating resource clients, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    C++

    How to use the C++ AWS SDK with LocalStack.

      2 minute read  

    Overview

    The AWS SDK for C++, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the C++ SDK with LocalStack.

    Example

    Consider the following example, which creates an SQS queue, sends a message to it, then receives the same message via the SDK:

    #include <iostream>
 #include <aws/core/Aws.h>
 #include <aws/core/utils/logging/LogLevel.h>
diff --git a/user-guide/integrations/sdks/dotnet/index.html b/user-guide/integrations/sdks/dotnet/index.html
index 8084f45b83..516352ca65 100644
--- a/user-guide/integrations/sdks/dotnet/index.html
+++ b/user-guide/integrations/sdks/dotnet/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • .NET

    How to use the .NET AWS SDK with LocalStack.

      3 minute read  

    Overview

    The AWS SDK for .NET, like other AWS SDKs, lets you set the endpoint when creating resource clients, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    .NET

    How to use the .NET AWS SDK with LocalStack.

      3 minute read  

    Overview

    The AWS SDK for .NET, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the .NET SDK with LocalStack.

    Example

    Here is an example of how to create an LambdaClient with the endpoint set to LocalStack.

    var lambdaClient = new AmazonLambdaClient(new AmazonLambdaConfig(
     {
         ServiceURL = "http://localhost:4566"
diff --git a/user-guide/integrations/sdks/go/index.html b/user-guide/integrations/sdks/go/index.html
index 994c092869..0474c7dad0 100644
--- a/user-guide/integrations/sdks/go/index.html
+++ b/user-guide/integrations/sdks/go/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Go

    How to use the Go AWS SDK with LocalStack.

      less than a minute  

    Overview

    The AWS SDK for Go, like other AWS SDKs, lets you set the endpoint when creating resource clients, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Go

    How to use the Go AWS SDK with LocalStack.

      less than a minute  

    Overview

    The AWS SDK for Go, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the Go SDK with LocalStack.

    The Go SDK has two major versions, each with their own way of specifying the LocalStack endpoint:

    Examples

    Here is an example of how to create an S3 Client from a Session with the endpoint set to LocalStack. Full examples for both SDK versions can be found in our samples repository.

  • +

    • AWS SDKs

    How to use your favorite cloud development SDK with LocalStack.

      less than a minute  

    Introduction

    LocalStack integrates with official AWS Software Development Kits (SDKs) so you can connect to LocalStack services using the same SDKs you use for AWS services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    AWS SDKs

    How to use your favorite cloud development SDK with LocalStack.

      less than a minute  

    Introduction

    LocalStack integrates with official AWS Software Development Kits (SDKs) so you can connect to LocalStack services using the same SDKs you use for AWS services. This lets you develop and test your applications locally without connecting to the cloud.

    How to connect with AWS SDKs?

    To connect to LocalStack services using AWS SDKs, you can use one of the following methods:

    • Manual configuration: Manually configure the SDK to connect to LocalStack services by setting the endpoint URL to http://localhost:4566 or localhost.localstack.cloud:4566. This can also be specified using a profile or an environment variable.
    • Transparent endpoint injection (recommended): Connect to LocalStack services without modifying your application code. Transparent endpoint injection uses the integrated DNS server to resolve AWS API calls to target LocalStack. diff --git a/user-guide/integrations/sdks/java/index.html b/user-guide/integrations/sdks/java/index.html index a065688df6..34a7e3f1ef 100644 --- a/user-guide/integrations/sdks/java/index.html +++ b/user-guide/integrations/sdks/java/index.html @@ -155,10 +155,10 @@
  • +

    • Java

    How to use the AWS Java SDK with LocalStack.

      6 minute read  

    Overview

    The AWS SDK for Java provides a Java API for AWS services. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Java

    How to use the AWS Java SDK with LocalStack.

      6 minute read  

    Overview

    The AWS SDK for Java provides a Java API for AWS services. Using the SDK, your Java application can interact with LocalStack services the same way it does with Amazon services. Support for new services is regularly added to diff --git a/user-guide/integrations/sdks/javascript/index.html b/user-guide/integrations/sdks/javascript/index.html index 072549653f..9343a0ca59 100644 --- a/user-guide/integrations/sdks/javascript/index.html +++ b/user-guide/integrations/sdks/javascript/index.html @@ -155,10 +155,10 @@

  • +

    • JavaScript

    How to use the JavaScript AWS SDK with LocalStack.

      3 minute read  

    Overview

    The AWS SDK for JavaScript, like other AWS SDKs, lets you set the endpoint when creating resource clients, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    JavaScript

    How to use the JavaScript AWS SDK with LocalStack.

      3 minute read  

    Overview

    The AWS SDK for JavaScript, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the JavaScript SDK with LocalStack.

    The JavaScript SDK has two major versions, each with their own way of specifying the LocalStack endpoint:

    Examples

    Here is an example of how to create a Lambda client and an S3 client with the endpoint set to LocalStack.

    const AWS = require('aws-sdk');
diff --git a/user-guide/integrations/sdks/php/index.html b/user-guide/integrations/sdks/php/index.html
index 8bc7d9839d..9af8c9382c 100644
--- a/user-guide/integrations/sdks/php/index.html
+++ b/user-guide/integrations/sdks/php/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • PHP

    How to use the PHP AWS SDK with LocalStack.

      less than a minute  

    Overview

    The AWS SDK for PHP, like other AWS SDKs, lets you set the endpoint when creating resource clients, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    PHP

    How to use the PHP AWS SDK with LocalStack.

      less than a minute  

    Overview

    The AWS SDK for PHP, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the PHP SDK with LocalStack.

    Example

    Here is an example of how to create an S3Client with the endpoint set to LocalStack.

    use Aws\S3\S3Client;
 use Aws\Exception\AwsException;
 
diff --git a/user-guide/integrations/sdks/python/index.html b/user-guide/integrations/sdks/python/index.html
index 8aae3456a3..c8be058150 100644
--- a/user-guide/integrations/sdks/python/index.html
+++ b/user-guide/integrations/sdks/python/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Python Boto3

    How to use the Boto3 Python AWS SDK with LocalStack.

      less than a minute  

    Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for Python, which allows Python developers to write software that makes use of AWS services.

    You can easily create a boto3 client that interacts with your LocalStack instance. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Python Boto3

    How to use the Boto3 Python AWS SDK with LocalStack.

      less than a minute  

    Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for Python, which allows Python developers to write software that makes use of AWS services.

    You can easily create a boto3 client that interacts with your LocalStack instance. The example below creates a boto3 client that lists all available Lambda functions:

    import boto3
 
 endpoint_url = "http://localhost.localstack.cloud:4566"
diff --git a/user-guide/integrations/sdks/ruby/index.html b/user-guide/integrations/sdks/ruby/index.html
index 19a85a62a2..c3216c7e46 100644
--- a/user-guide/integrations/sdks/ruby/index.html
+++ b/user-guide/integrations/sdks/ruby/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Ruby

    How to use the AWS SDK for Ruby with LocalStack.

      2 minute read  

    Overview

    The AWS SDK for Ruby, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the Ruby SDK with LocalStack.

    Example

    Here is an example of how to create a S3 bucket with the AWS configuration endpoint set to LocalStack:

    require "aws-sdk-s3"
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags

    Ruby

    How to use the AWS SDK for Ruby with LocalStack.

      2 minute read  

    Overview

    The AWS SDK for Ruby, like other AWS SDKs, lets you set the endpoint when creating resource clients, which is the preferred way of integrating the Ruby SDK with LocalStack.

    Example

    Here is an example of how to create a S3 bucket with the AWS configuration endpoint set to LocalStack:

    require "aws-sdk-s3"
 
 # Wraps Amazon S3 bucket actions.
 class BucketCreateWrapper
diff --git a/user-guide/integrations/serverless-framework/index.html b/user-guide/integrations/serverless-framework/index.html
index 13929f7b0c..cb1ab26bbd 100644
--- a/user-guide/integrations/serverless-framework/index.html
+++ b/user-guide/integrations/serverless-framework/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Serverless Framework

    Use the Serverless Framework with LocalStack

      4 minute read  

    Serverless logo

    Overview

    This guide explains how to integrate LocalStack with the Serverless Framework. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Serverless Framework

    Use the Serverless Framework with LocalStack

      4 minute read  

    Serverless logo

    Overview

    This guide explains how to integrate LocalStack with the Serverless Framework. Although it probably requires a few code changes, integrating LocalStack with the Serverless Framework is fairly straightforward.

    In particular, the setup consists of the following two steps.

    1. Installing and configuring the Serverless-LocalStack plugin.
    2. Adjusting AWS endpoints in Lambda functions.

    Prerequisites

    This guide assumes that you have the following tools installed.

    It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a serverless.yml file similar to the following. An example Serverless app integrated with LocalStack can be found here: Simple REST API using the Serverless Framework and LocalStack

    service: my-service
 
diff --git a/user-guide/integrations/spring-cloud-function/index.html b/user-guide/integrations/spring-cloud-function/index.html
index e20392c7e8..df41d79744 100644
--- a/user-guide/integrations/spring-cloud-function/index.html
+++ b/user-guide/integrations/spring-cloud-function/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Spring Cloud Function

    Use Spring Cloud Function framework with LocalStack

      13 minute read  

    Spring logo

    Overview

    In this guide, you will learn how to use LocalStack to test + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Spring Cloud Function

    Use Spring Cloud Function framework with LocalStack

      13 minute read  

    Spring logo

    Overview

    In this guide, you will learn how to use LocalStack to test your serverless applications powered by Spring Cloud Function framework.

    Covered Topics

    We will create a new Rest API application that will route requests to a Cloud Function using functionRouter and routing expressions.

    The primary language for the application is Kotlin powered by Gradle build tool, but the described concepts would work for diff --git a/user-guide/integrations/terraform/index.html b/user-guide/integrations/terraform/index.html index f29fea75a8..86798ea071 100644 --- a/user-guide/integrations/terraform/index.html +++ b/user-guide/integrations/terraform/index.html @@ -155,10 +155,10 @@

  • +

    • Terraform

    Use the Terraform Infrastructure as Code framework with LocalStack

      10 minute read  

    Introduction

    Terraform is an Infrastructure-as-Code (IaC) framework developed by HashiCorp. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Terraform

    Use the Terraform Infrastructure as Code framework with LocalStack

      10 minute read  

    Introduction

    Terraform is an Infrastructure-as-Code (IaC) framework developed by HashiCorp. It enables users to define and provision infrastructure using a high-level configuration language. Terraform uses HashiCorp Configuration Language (HCL) as its configuration syntax. HCL is a domain-specific language designed for writing configurations that define infrastructure elements and their relationships.

    LocalStack supports Terraform via the AWS provider through custom service endpoints. diff --git a/user-guide/integrations/testcontainers/index.html b/user-guide/integrations/testcontainers/index.html index 76b0caa37c..b926198e65 100644 --- a/user-guide/integrations/testcontainers/index.html +++ b/user-guide/integrations/testcontainers/index.html @@ -155,10 +155,10 @@

  • +

    • Testcontainers

    Use Testcontainers with LocalStack

      3 minute read  

    Testcontainers logo

    Overview

    Testcontainers is a library that helps you to run your + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Testcontainers

    Use Testcontainers with LocalStack

      3 minute read  

    Testcontainers logo

    Overview

    Testcontainers is a library that helps you to run your tests against real dependencies.

    In this guide, you will learn how to use Testcontainers with LocalStack.

    Covered Topics

    Installing the Localstack module

  • +

    • Remote Debugging

    Attach a debugger to your Lambda functions from within your IDE

      8 minute read  

    Overview

    This guide covers remote debugging of Lambda functions with the IDEs Visual Studio Code and IntelliJ IDEA. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Remote Debugging

    Attach a debugger to your Lambda functions from within your IDE

      8 minute read  

    Overview

    This guide covers remote debugging of Lambda functions with the IDEs Visual Studio Code and IntelliJ IDEA. For a simple working example of this feature, check out Pro sample lambda-mounting-and-debugging.

    More examples and tooling support for local Lambda debugging (including support for other IDEs like PyCharm) is coming soon - stay tuned!

    Covered Topics

    Debugging Python lambdas

    Lambda functions debugging used to be a difficult task. LocalStack changes that with the same local code mounting functionality that also helps you diff --git a/user-guide/lambda-tools/hot-reloading/index.html b/user-guide/lambda-tools/hot-reloading/index.html index 3ef9d8f1d4..038bc37afb 100644 --- a/user-guide/lambda-tools/hot-reloading/index.html +++ b/user-guide/lambda-tools/hot-reloading/index.html @@ -155,10 +155,10 @@

  • +

    • Hot Reloading

    Hot code reloading continuously applies code changes to Lambda functions

      13 minute read  

    Hot reloading (formerly known as hot swapping) continuously applies code changes to Lambda functions without manual redeployment.

    Quickly iterating over Lambda function code can be quite cumbersome, as you need to deploy your function on every change. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Hot Reloading

    Hot code reloading continuously applies code changes to Lambda functions

      13 minute read  

    Hot reloading (formerly known as hot swapping) continuously applies code changes to Lambda functions without manual redeployment.

    Quickly iterating over Lambda function code can be quite cumbersome, as you need to deploy your function on every change. LocalStack enables fast feedback cycles during development by automatically reloading your function code. Pro users can also hot-reload Lambda layers.

    Lambda Tools

    Develop your Lambdas more efficiently.

      less than a minute  

    Lambda Tools by LocalStack offers a suite of utilities to streamline the development of Lambda functions on your local machine. + Create project issue

    Categories
    Persistence
    Tags

    Lambda Tools

    Develop your Lambdas more efficiently.

      less than a minute  

    Lambda Tools by LocalStack offers a suite of utilities to streamline the development of Lambda functions on your local machine. LocalStack’s Lambda emulation enables you to develop, deploy, and test your functions in a local environment, removing the need for deployment on AWS, while integrating with other AWS services. These tools aim to enhance the developer experience by providing quicker feedback cycles.

    With Lambda Tools, you can:

    • Debug your Lambda function directly from your IDE by attaching a debugger, allowing for breakpoint setting, variable inspection, and code execution.
    • Implement hot reload configurations to automatically update your Lambda function whenever code changes are made, eliminating the need for repeated redeployments.
    • Directly deploy and invoke Lambda functions from VSCode utilizing the LocalStack VSCode extension, leveraging Serverless Application Model (SAM) or CloudFormation.
    Hot Reloading

    Hot code reloading continuously applies code changes to Lambda functions

    Remote Debugging

    Attach a debugger to your Lambda functions from within your IDE

    VSCode Extension

    Deploy and invoke Lambda functions in LocalStack directly from VSCode

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/lambda-tools/vscode-extension/index.html b/user-guide/lambda-tools/vscode-extension/index.html index be70a463ba..cc4ed1017a 100644 --- a/user-guide/lambda-tools/vscode-extension/index.html +++ b/user-guide/lambda-tools/vscode-extension/index.html @@ -155,10 +155,10 @@
  • +

    • VSCode Extension

    Deploy and invoke Lambda functions in LocalStack directly from VSCode

      less than a minute  

    Introduction

    LocalStack VSCode Extension supports deploying and invoking Python Lambda functions through AWS SAM or AWS CloudFormation.

    Prerequisites

    Getting Started

    You can use a sample project to get started with the extension. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    VSCode Extension

    Deploy and invoke Lambda functions in LocalStack directly from VSCode

      less than a minute  

    Introduction

    LocalStack VSCode Extension supports deploying and invoking Python Lambda functions through AWS SAM or AWS CloudFormation.

    Prerequisites

    Getting Started

    You can use a sample project to get started with the extension. The sample project contains a simple Lambda function and a SAM template. Clone the repository and open the project in VSCode.

    $ git clone https://github.com/joe4dev/lambda-python.git
 $ cd lambda-python
diff --git a/user-guide/security-testing/explainable-iam/index.html b/user-guide/security-testing/explainable-iam/index.html
index 5af1e16340..ea4b2cb5ae 100644
--- a/user-guide/security-testing/explainable-iam/index.html
+++ b/user-guide/security-testing/explainable-iam/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Explainable IAM

    Discover IAM Policy Engine logs related to failed policy evaluation
    Tags:

      3 minute read  

    Introduction

    The IAM Policy Engine logs output related to failed policy evaluation directly to the LocalStack logs. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Explainable IAM

    Discover IAM Policy Engine logs related to failed policy evaluation
    Tags:

      3 minute read  

    Introduction

    The IAM Policy Engine logs output related to failed policy evaluation directly to the LocalStack logs. You can enable DEBUG=1 to gain visibility into these log messages, allowing you to identify the additional policies required for your request to succeed.

    Getting started

    This guide is designed for users new to Explainable IAM and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container with the DEBUG=1 and ENFORCE_IAM=1 environment variables set:

    $ DEBUG=1 ENFORCE_IAM=1 localstack start

    In this guide, we will create a policy for creating Lambda functions by only allowing the lambda:CreateFunction permission. However we have not included the iam:PassRole permission, and we will use the Policy Engine’s log to point out adding the necessary permission.

    Create a new user

    Create a policy document named policy_1.json and add the following content:

    {
   "Version": "2012-10-17",
diff --git a/user-guide/security-testing/iam-enforcement/index.html b/user-guide/security-testing/iam-enforcement/index.html
index ad9104bb88..9a9509ae84 100644
--- a/user-guide/security-testing/iam-enforcement/index.html
+++ b/user-guide/security-testing/iam-enforcement/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • IAM Policy Enforcement

    Enforce IAM policies in LocalStack to test your policies
    Tags:

      3 minute read  

    Introduction

    IAM Policy Enforcement feature can be used to test your security policies and create a more realistic environment that more closely resembles real AWS. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IAM Policy Enforcement

    Enforce IAM policies in LocalStack to test your policies
    Tags:

      3 minute read  

    Introduction

    IAM Policy Enforcement feature can be used to test your security policies and create a more realistic environment that more closely resembles real AWS. The environment configuration ENFORCE_IAM=1 is required while starting LocalStack to enable this feature. Per default, IAM enforcement is disabled, and all APIs can be accessed without authentication.

    Getting started

    This guide is designed for users new to IAM Policy Enforcement and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

    Start your LocalStack container with the DEBUG=1 and ENFORCE_IAM=1 environment variables set:

    $ DEBUG=1 ENFORCE_IAM=1 localstack start

    We will demonstrate IAM Policy Enforcement, by creating a user and obtaining the access/secret keys. We will make an attempt to create a bucket using the user’s credentials, which inevitably fails due to insufficient permissions.

    Lastly, a policy is attached to the user, granting the necessary s3:CreateBucket permission, thereby enabling the successful creation of the bucket.

    Create a user

    To follow this guide, open two separate terminal sessions: Terminal 1 for the administrative IAM commands, which will utilize the default root IAM user, and Terminal 2 for executing the commands under the test IAM user you are about to create. diff --git a/user-guide/security-testing/iam-policy-stream/index.html b/user-guide/security-testing/iam-policy-stream/index.html index 3e46a023dc..2e3f3fcd10 100644 --- a/user-guide/security-testing/iam-policy-stream/index.html +++ b/user-guide/security-testing/iam-policy-stream/index.html @@ -152,10 +152,10 @@

  • +

    • IAM Policy Stream

    Generate a stream of IAM policies as requests are coming into LocalStack using IAM Policy Stream.
    Tags:

      3 minute read  

    Introduction

    The IAM Policy Stream generates a steady stream of policies along with their corresponding principals or resources. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    IAM Policy Stream

    Generate a stream of IAM policies as requests are coming into LocalStack using IAM Policy Stream.
    Tags:

      3 minute read  

    Introduction

    The IAM Policy Stream generates a steady stream of policies along with their corresponding principals or resources. When a request is made, it initially displays the principal or resource to which the policy will be attached. This is typically a service resource for resource-based policies, or an IAM principal for other cases. Subsequently, it displays the suggested policy. diff --git a/user-guide/security-testing/index.html b/user-guide/security-testing/index.html index 1aa1fb1778..f4dc0faf00 100644 --- a/user-guide/security-testing/index.html +++ b/user-guide/security-testing/index.html @@ -155,10 +155,10 @@

  • +

    • Security Testing

    Security Testing in LocalStack allows you to test your IAM policies and permissions locally resembling the AWS environment.

      less than a minute  

    Introduction

    Security Testing in LocalStack enables you to enforce your IAM permissions allowing you to test your security policies and create a more realistic environment that more closely resembles the real AWS. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Security Testing

    Security Testing in LocalStack allows you to test your IAM policies and permissions locally resembling the AWS environment.

      less than a minute  

    Introduction

    Security Testing in LocalStack enables you to enforce your IAM permissions allowing you to test your security policies and create a more realistic environment that more closely resembles the real AWS. Security Testing in LocalStack encompasses the following features:

    • Enforce IAM policies & permissions in your setup to test your application security.
    • Retrieve IAM policy engine logs to gain visibility into the policy evaluation.
    • Discover appropriate permissions using IAM policy streams to fix logical errors.
    IAM Policy Enforcement

    Enforce IAM policies in LocalStack to test your policies

    Explainable IAM

    Discover IAM Policy Engine logs related to failed policy evaluation

    IAM Policy Stream

    Generate a stream of IAM policies as requests are coming into LocalStack using IAM Policy Stream.

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/state-management/cloud-pods/index.html b/user-guide/state-management/cloud-pods/index.html index 8b9b0b9bc5..cec91c9a76 100644 --- a/user-guide/state-management/cloud-pods/index.html +++ b/user-guide/state-management/cloud-pods/index.html @@ -152,10 +152,10 @@
  • +

    • Cloud Pods

    Get started with Cloud Pods to manage the state of your LocalStack instance state
    Tags:

      15 minute read  

    Introduction

    Cloud pods are persistent state snapshots of your LocalStack instance that can easily be stored, versioned, shared, and restored. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Cloud Pods

    Get started with Cloud Pods to manage the state of your LocalStack instance state
    Tags:

      15 minute read  

    Introduction

    Cloud pods are persistent state snapshots of your LocalStack instance that can easily be stored, versioned, shared, and restored. Cloud Pods can be used for various purposes, such as:

    • Save and manage snapshots of active LocalStack instances.
    • Share state snapshots with your team to debug collectively.
    • Automate your testing pipelines by pre-seeding CI environments.
    • Create reproducible development and testing environments locally.
    Cloud Pods Web UI

    Installation

    You can save and load the persistent state of Cloud Pods, you can use the Cloud Pods command-line interface (CLI). LocalStack provides a remote storage backend that can be used to store the state of your running application and share it with your team members. You can interact with the Cloud Pods over the storage backend via the LocalStack Web Application.

    Cloud Pods CLI is included in the LocalStack CLI installation, so there’s no need for additional installations to begin using it. diff --git a/user-guide/state-management/export-import-state/index.html b/user-guide/state-management/export-import-state/index.html index 6fa8f854b7..2cfcae7923 100644 --- a/user-guide/state-management/export-import-state/index.html +++ b/user-guide/state-management/export-import-state/index.html @@ -152,10 +152,10 @@

  • +

    • Export & Import State

    Export and import the state of the current infrastructure state into a file or a LocalStack instance respectively!
    Tags:

      3 minute read  

    Introduction

    The Export/Import State feature enables you to export the state of your LocalStack instance into a file and import it into another LocalStack instance. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Export & Import State

    Export and import the state of the current infrastructure state into a file or a LocalStack instance respectively!
    Tags:

      3 minute read  

    Introduction

    The Export/Import State feature enables you to export the state of your LocalStack instance into a file and import it into another LocalStack instance. This feature is useful when you want to save your LocalStack instance’s state for later use.

    LocalStack CLI

    The LocalStack CLI enables you to export your infrastructure state to a file and import it into another LocalStack instance. You can access the state management commands by running localstack state in your terminal.

    $ localstack state --help
 
    
diff --git a/user-guide/state-management/index.html b/user-guide/state-management/index.html
index 9f362ca18e..172394c68b 100644
--- a/user-guide/state-management/index.html
+++ b/user-guide/state-management/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  • 
 
    • State Management
    Cloud Pods provides a new way of collaborating in cloud application development workflows.
      2 minute read  
    State Management in LocalStack allows you to save and load the state of your LocalStack instance.
+ Create project issue
    Categories
    Persistence
    Tags
    State Management
    Cloud Pods provides a new way of collaborating in cloud application development workflows.
      2 minute read  
    State Management in LocalStack allows you to save and load the state of your LocalStack instance.
 LocalStack is ephemeral in nature, so when you stop and restart your LocalStack instance, all the data is lost.
 With State Management, you can save the state of your LocalStack instance and load it back when you restart your LocalStack instance.
    State Management in LocalStack encompasses the following features:
    • Cloud Pods: Cloud Pods are persistent state snapshots of your LocalStack instance that can easily be shared, stored, versioned, and restored.
    • Export & Import State: Export and import the state of your LocalStack instance on your local machine as a local file.
    • Persistence: Persist the state of your LocalStack instance on your local machine using a configuration variable.
    Anything that is inside a LocalStack container constitutes the “state.” The “state” can either be persisted on your local
 machine and be loaded at startup (persistence), exported anytime as a single local file (state export), or stored on the LocalStack platform (cloud pods).
diff --git a/user-guide/state-management/launchpad/index.html b/user-guide/state-management/launchpad/index.html
index def355e8a1..415df60712 100644
--- a/user-guide/state-management/launchpad/index.html
+++ b/user-guide/state-management/launchpad/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  • 
 
    • Launchpad
    Get started with Cloud Pods Launchpad to share and inject Cloud Pods into your LocalStack instance via a URL
    Tags:
      2 minute read  
    The LocalStack Cloud Pods Launchpad enables you to easily share and inject Cloud Pods into a LocalStack instance.
    You can visit Cloud Pods launchpad to generate a shareable link for your pods.
    Cloud Pods Launchpad Link Generator
    Enter a public URL to your pod Cloud Pod the first input field, then click Generate Link.
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags
    Launchpad
    Get started with Cloud Pods Launchpad to share and inject Cloud Pods into your LocalStack instance via a URL
    Tags:
      2 minute read  
    The LocalStack Cloud Pods Launchpad enables you to easily share and inject Cloud Pods into a LocalStack instance.
    You can visit Cloud Pods launchpad to generate a shareable link for your pods.
    Cloud Pods Launchpad Link Generator
    Enter a public URL to your pod Cloud Pod the first input field, then click Generate Link.
 You can copy the resulting link and share it with others.
 Additionally, you have the option to copy a markdown snippet for quickly adding a badge to your repository.
    Adding a badge to your repository
    To add a badge to your README that links to the Cloud Pod Launchpad, you can include the following markdown snippet:
    [![Launch LocalStack Cloudpod](https://localstack.cloud/gh/launch-pod-badge.svg)](https://app.localstack.cloud/launchpad?url=url_of_your_pod)
diff --git a/user-guide/state-management/persistence/index.html b/user-guide/state-management/persistence/index.html
index a3764cd692..f913712e66 100644
--- a/user-guide/state-management/persistence/index.html
+++ b/user-guide/state-management/persistence/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  • 
 
    • Persistence
    Internals of LocalStack persistence mechanism
    Tags:
      5 minute read  
    Introduction
    LocalStack’s Persistence mechanism enables the saving and restoration of the entire LocalStack state, including all AWS resources and data, on your local machine.
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags
    Persistence
    Internals of LocalStack persistence mechanism
    Tags:
      5 minute read  
    Introduction
    LocalStack’s Persistence mechanism enables the saving and restoration of the entire LocalStack state, including all AWS resources and data, on your local machine.
 It functions as a “pause and resume” feature, allowing you to take a snapshot of your LocalStack instance and save this data to disk.
 This mechanism ensures a quick and efficient way to preserve and continue your work with AWS resources locally.
    Configuration
    To start snapshot-based persistence, launch LocalStack with the configuration option PERSISTENCE=1.
 This setting instructs LocalStack to save all AWS resources and their respective application states into the LocalStack Volume Directory.
diff --git a/user-guide/state-management/pods-cli/index.html b/user-guide/state-management/pods-cli/index.html
index 30c415adc0..15597f54a2 100644
--- a/user-guide/state-management/pods-cli/index.html
+++ b/user-guide/state-management/pods-cli/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  • 
 
    • CLI command reference
    Reference guide for LocalStack Cloud Pods CLI commands and how to get started on using them!
    Tags:
      9 minute read  
    This reference provides descriptions and example commands for LocalStack Cloud Pods CLI (pod) commands.
    Syntax
    Use the following syntax to run localstack pod commands from your terminal window:
    $ localstack pod [OPTIONS] COMMAND [ARGS]...
    In the above syntax:
    • COMMAND specifies the operation you want to perform with your Cloud Pods (save or load).
    • OPTIONS specifies the optional flags.
    • ARGS specifies the command arguments.
    Commands
    The following section lists the available commands for the Cloud Pods CLI.
+ Create project issue
    Table of Contents
    Categories
    Persistence
    Tags
    CLI command reference
    Reference guide for LocalStack Cloud Pods CLI commands and how to get started on using them!
    Tags:
      9 minute read  
    This reference provides descriptions and example commands for LocalStack Cloud Pods CLI (pod) commands.
    Syntax
    Use the following syntax to run localstack pod commands from your terminal window:
    $ localstack pod [OPTIONS] COMMAND [ARGS]...
    In the above syntax:
    • COMMAND specifies the operation you want to perform with your Cloud Pods (save or load).
    • OPTIONS specifies the optional flags.
    • ARGS specifies the command arguments.
    Commands
    The following section lists the available commands for the Cloud Pods CLI.
 You can have an overview of these command by typing localstack pod --help:
    
 Usage: pod [OPTIONS] COMMAND [ARGS]...
 
diff --git a/user-guide/state-management/support/index.html b/user-guide/state-management/support/index.html
index a4ce33aae1..8e7ffd4475 100644
--- a/user-guide/state-management/support/index.html
+++ b/user-guide/state-management/support/index.html
@@ -152,10 +152,10 @@
 
  • 
 
  • 
 
  • 
+
  • 
 
    • Persistence Coverage for AWS Services
    Overview of the persistence coverage across the implemented AWS services
    Tags:
    Persistence Coverage Overview
    ServiceSupportedPersistence Test SuiteLimitations
    AWS Account Management
    ACM (AWS Certificate Manager)
    AWS Private Certificate Authority (CA)✔️✔️
    Amplify✔️✔️
    API Gateway✔️✔️
    AppConfig✔️
    applicationautoscaling✔️✔️
    AppSync
    Athena
    Auto Scaling
    Backup✔️✔️
    Batch✔️
    CE (Cost Explorer API)
    CloudFormation✔️Users need to be sure that the stacks are completely deployed before saving LocalStack state. Users with complex inter-stack relationships may experience issues. Furthermore, we cannot guarantee that all the created services will be correctly restored.
    CloudFront✔️✔️
    CloudTrail✔️✔️
    CloudWatch✔️✔️
    CodeCommit✔️✔️
    Cognito Identity✔️✔️
    Cognito IDP (Cognito User Pools API)✔️✔️
    Config✔️✔️
    DMS (Database Migration Service)
    DocumentDB
    DynamoDB✔️✔️
    DynamoDB Streams
    EC2 (Elastic Compute Cloud)✔️Instances (Docker containers) are not persisted. The mock VM manager fully support persistence.
    ECR (Elastic Container Registry)✔️✔️
    ECS (Elastic Container Service)
    EFS (Elastic File System)
    EKS (Elastic Kubernetes Service)
    ElastiCache✔️✔️
    Elastic Beanstalk
    ELB (Elastic Load Balancer)
    ELB v2 (Elastic Load Balancer v2)
    EMR (Elastic MapReduce)
    ES (OpenSearch, legacy Elasticsearch)
    EventBridge
    Kinesis Data Firehose
    FIS (Fault Injection Simulator)
    Glacier (S3 Glacier)✔️✔️
    Glue
    IAM (Identity and Access Management)✔️✔️
    identitystore
    IoT (Internet of Things)
    IoT Data
    IoT Analytics
    IoT Wireless
    MSK (Managed Streaming for Apache Kafka)✔️✔️The Kafka instances are restored. However, their content is not.
    Kinesis✔️✔️
    Kinesis Data Analytics API
    Kinesis Data Analytics API v2
    KMS (Key Management Service)✔️✔️
    Lake Formation
    Lambda✔️✔️Hot-reloading Lambdas need special configuration. Visit the “Share deployment configuration between different machines” section in the Hot Reloading documentation page.
    CloudWatch Logs✔️✔️
    managedblockchain
    mediaconvert
    Elemental MediaStore
    MemoryDB for Redis
    Amazon MQ
    MWAA (Managed Workflows for Apache Airflow)
    Neptune
    OpenSearch
    Organizations
    pinpoint✔️✔️
    Pipes (EventBridge Pipes)
    QLDB (Quantum Ledger Database)
    ram (Resource Access Manager)
    RDS (Relational Database Service)✔️✔️MSSQL does not support persistence.
    RDS data (Relational Database Service Data)
    Redshift
    Resource Groups
    Resource Groups Tagging API
    Route 53✔️✔️
    Route 53 Resolver✔️
    S3 (Simple Storage Service)✔️✔️
    SageMaker
    scheduler (EventBridge Scheduler)
    Secrets Manager✔️✔️
    Serverless Application Repository
    Service Discovery (Cloud Map)
    SES (Simple Email Service)✔️✔️
    SES v2 (Simple Email Service v2)
    SNS (Simple Notification Service)✔️✔️
    SQS (Simple Queue Service)✔️✔️
    SSM (Web Services Systems Manager)✔️✔️
    sso-admin (IAM Identity Center (successor to Single Sign-On))✔️✔️
    Step Functions
    STS (Security Token Service)✔️✔️
    Support API✔️✔️
    SWF (Simple Workflow Service)
    textract✔️✔️
    timestream✔️✔️
    Transcribe✔️✔️
    Transfer
    wafv2
    X-Ray✔️

    Terminology
    Table of Contents
    Categories
    Persistence
    Tags
    Persistence Coverage for AWS Services
    Overview of the persistence coverage across the implemented AWS services
    Tags:
    Persistence Coverage Overview
    ServiceSupportedPersistence Test SuiteLimitations
    AWS Account Management
    ACM (AWS Certificate Manager)
    AWS Private Certificate Authority (CA)✔️✔️
    Amplify✔️✔️
    API Gateway✔️✔️
    AppConfig✔️
    applicationautoscaling✔️✔️
    AppSync
    Athena
    Auto Scaling
    Backup✔️✔️
    Batch✔️
    CE (Cost Explorer API)
    CloudFormation✔️Users need to be sure that the stacks are completely deployed before saving LocalStack state. Users with complex inter-stack relationships may experience issues. Furthermore, we cannot guarantee that all the created services will be correctly restored.
    CloudFront✔️✔️
    CloudTrail✔️✔️
    CloudWatch✔️✔️
    CodeCommit✔️✔️
    Cognito Identity✔️✔️
    Cognito IDP (Cognito User Pools API)✔️✔️
    Config✔️✔️
    DMS (Database Migration Service)
    DocumentDB
    DynamoDB✔️✔️
    DynamoDB Streams
    EC2 (Elastic Compute Cloud)✔️Instances (Docker containers) are not persisted. The mock VM manager fully support persistence.
    ECR (Elastic Container Registry)✔️✔️
    ECS (Elastic Container Service)
    EFS (Elastic File System)
    EKS (Elastic Kubernetes Service)
    ElastiCache✔️✔️
    Elastic Beanstalk
    ELB (Elastic Load Balancer)
    ELB v2 (Elastic Load Balancer v2)
    EMR (Elastic MapReduce)
    ES (OpenSearch, legacy Elasticsearch)
    EventBridge
    Kinesis Data Firehose
    FIS (Fault Injection Simulator)
    Glacier (S3 Glacier)✔️✔️
    Glue
    IAM (Identity and Access Management)✔️✔️
    identitystore
    IoT (Internet of Things)
    IoT Data
    IoT Analytics
    IoT Wireless
    MSK (Managed Streaming for Apache Kafka)✔️✔️The Kafka instances are restored. However, their content is not.
    Kinesis✔️✔️
    Kinesis Data Analytics API
    Kinesis Data Analytics API v2
    KMS (Key Management Service)✔️✔️
    Lake Formation
    Lambda✔️✔️Hot-reloading Lambdas need special configuration. Visit the “Share deployment configuration between different machines” section in the Hot Reloading documentation page.
    CloudWatch Logs✔️✔️
    managedblockchain
    mediaconvert
    Elemental MediaStore
    MemoryDB for Redis
    Amazon MQ
    MWAA (Managed Workflows for Apache Airflow)
    Neptune
    OpenSearch
    Organizations
    pinpoint✔️✔️
    Pipes (EventBridge Pipes)
    QLDB (Quantum Ledger Database)
    ram (Resource Access Manager)
    RDS (Relational Database Service)✔️✔️MSSQL does not support persistence.
    RDS data (Relational Database Service Data)
    Redshift
    Resource Groups
    Resource Groups Tagging API
    Route 53✔️✔️
    Route 53 Resolver✔️
    S3 (Simple Storage Service)✔️✔️
    SageMaker
    scheduler (EventBridge Scheduler)
    Secrets Manager✔️✔️
    Serverless Application Repository
    Service Discovery (Cloud Map)
    SES (Simple Email Service)✔️✔️
    SES v2 (Simple Email Service v2)
    SNS (Simple Notification Service)✔️✔️
    SQS (Simple Queue Service)✔️✔️
    SSM (Web Services Systems Manager)✔️✔️
    sso-admin (IAM Identity Center (successor to Single Sign-On))✔️✔️
    Step Functions
    STS (Security Token Service)✔️✔️
    Support API✔️✔️
    SWF (Simple Workflow Service)
    textract✔️✔️
    timestream✔️✔️
    Transcribe✔️✔️
    Transfer
    wafv2
    X-Ray✔️

    Terminology
    • Persistence Test Suite: tested by LocalStack’s internal persistence test suite.
 To test persistence, we use an approach similar to snapshot parity test:
 we first record API responses from LocalStack, we then reset and restore the snapshotted state,
 and finally verify that the same API responses matches with the initial ones.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    
\ No newline at end of file
diff --git a/user-guide/tools/dns-server/index.html b/user-guide/tools/dns-server/index.html
index a8b82554e7..3c292309b8 100644
--- a/user-guide/tools/dns-server/index.html
+++ b/user-guide/tools/dns-server/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • DNS Server

    Use LocalStack as DNS server to resolve AWS queries to LocalStack

      8 minute read  

    LocalStack includes a DNS server that enables seamless connectivity to LocalStack from different environments using localhost.localstack.cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    DNS Server

    Use LocalStack as DNS server to resolve AWS queries to LocalStack

      8 minute read  

    LocalStack includes a DNS server that enables seamless connectivity to LocalStack from different environments using localhost.localstack.cloud. The DNS server is available on all IPv4 addresses within the LocalStack container (i.e., listening to 0.0.0.0) and resolves localhost.localstack.cloud to the LocalStack container. Therefore, containers that are configured to use the DNS server can reach LocalStack using localhost.localstack.cloud. This configuration happens automatically for containers created by LocalStack, including compute resources such as Lambda, ECS, and EC2. diff --git a/user-guide/tools/index.html b/user-guide/tools/index.html index fa51cb8063..122ac71ca6 100644 --- a/user-guide/tools/index.html +++ b/user-guide/tools/index.html @@ -155,10 +155,10 @@

  • +

    • LocalStack Tools

    Increase your development efficiency with LocalStack Cloud Developer Tools.

      less than a minute  

    The core of LocalStack is the cloud service emulation. + Create project issue

    Categories
    Persistence
    Tags

    LocalStack Tools

    Increase your development efficiency with LocalStack Cloud Developer Tools.

      less than a minute  

    The core of LocalStack is the cloud service emulation. But LocalStack also provides a variety of tools to make your life as a cloud developer easier.

    With LocalStack Cloud Developer Tools you can:

    • persist the state of the AWS services running in your LocalStack instance via Cloud Pods
    • hot-swap your Lambda code changes instantly
    • debug Lambda executions directly from your IDE
    • inject LocalStack service endpoints automatically into your application
    • … and much more!
    Testing Utils

    Tools to simplify application testing on LocalStack

    LocalSurf

    Browser plugin to redirect AWS service calls to LocalStack

    LocalStack Desktop

    Getting started with the LocalStack Desktop application

    LocalStack Docker Extension

    Getting started with LocalStack Extension for Docker Desktop

    Transparent Endpoint Injection

    Transparently resolve your AWS calls to LocalStack

    DNS Server

    Use LocalStack as DNS server to resolve AWS queries to LocalStack

    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/tools/localstack-desktop/index.html b/user-guide/tools/localstack-desktop/index.html index c619c376bb..6976c84fdc 100644 --- a/user-guide/tools/localstack-desktop/index.html +++ b/user-guide/tools/localstack-desktop/index.html @@ -155,10 +155,10 @@
  • +

    • LocalStack Desktop

    Getting started with the LocalStack Desktop application

      2 minute read  

    LocalStack Desktop is a desktop client that allows users to easily control and interact with their LocalStack instance. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    LocalStack Desktop

    Getting started with the LocalStack Desktop application

      2 minute read  

    LocalStack Desktop is a desktop client that allows users to easily control and interact with their LocalStack instance. Using LocalStack Desktop, users can start and stop their LocalStack instance with a single click, create a new container, view logs, interact with LocalStack container via cli and use our resource browser.

    LocalStack Desktop

    Installation

    You can download LocalStack Desktop from our web application. To install LocalStack Desktop, Docker is the only prerequisite.

    Features

    LocalStack Desktop helps users to interact with their LocalStack instance with a simple and intuitive UI. diff --git a/user-guide/tools/localstack-docker-extension/index.html b/user-guide/tools/localstack-docker-extension/index.html index 80912acce0..bb041c55ba 100644 --- a/user-guide/tools/localstack-docker-extension/index.html +++ b/user-guide/tools/localstack-docker-extension/index.html @@ -155,10 +155,10 @@

  • +

    • LocalStack Docker Extension

    Getting started with LocalStack Extension for Docker Desktop

      2 minute read  

    Introduction

    The LocalStack Extension for Docker Desktop enables developers working with LocalStack to operate their LocalStack container via Docker Desktop, including checking service status, container logs, and configuring profiles. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    LocalStack Docker Extension

    Getting started with LocalStack Extension for Docker Desktop

      2 minute read  

    Introduction

    The LocalStack Extension for Docker Desktop enables developers working with LocalStack to operate their LocalStack container via Docker Desktop, including checking service status, container logs, and configuring profiles. To install the LocalStack Extension for Docker Desktop, you need to have Docker Desktop installed on your machine.

    LocalStack Extension for Docker Desktop

    Installation

    To utilize LocalStack’s Docker Extension, it is necessary to have a recent version of Docker Desktop (v4.8 or higher) installed on the local machine. To enable the extension, access the Extensions tab and select the Enable Docker Extensions and Show Docker Extensions system containers option.

    Enable Docker Extensions in the Preferences within the Extensions tab

    The LocalStack Extension for Docker Desktop has been validated and can be accessed on the Extensions Marketplace. To begin using it, navigate to the Extensions Marketplace, search for LocalStack, and click the Install button to proceed with the installation.

    Discover the LocalStack Extension on the Docker Desktop Marketplace and install it!

    An alternative method for installing the LocalStack’s Extension for Docker Desktop is pulling the public Docker image from Docker Hub and installing it!

    $ docker extension install localstack/localstack-docker-desktop:0.5.3

    After installation, you can access the LocalStack Extension for Docker Desktop from the Extensions tab. diff --git a/user-guide/tools/localsurf/index.html b/user-guide/tools/localsurf/index.html index 0fccc179b0..8b2dbab84c 100644 --- a/user-guide/tools/localsurf/index.html +++ b/user-guide/tools/localsurf/index.html @@ -155,10 +155,10 @@

  • +

    • LocalSurf

    Browser plugin to redirect AWS service calls to LocalStack

      3 minute read  

    Introduction

    LocalSurf is a Chrome browser plugin to repoint AWS service calls to LocalStack. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    LocalSurf

    Browser plugin to redirect AWS service calls to LocalStack

      3 minute read  

    Introduction

    LocalSurf is a Chrome browser plugin to repoint AWS service calls to LocalStack. While developing and testing AWS cloud Web applications locally with LocalStack, we need to make the browser connect to the local endpoint (http://localhost:4566) instead of the AWS production servers (*.amazonaws.com). LocalSurf enables you to use the production code without changes, and have the browser make requests to LocalStack instead of AWS directly by explicitly setting the endpoint attribute in the AWS JavaScript SDK.

    This plugin is experimental and still under active development. Please report any issues or feature requests on our GitHub repository.

    Installation

    This extension is not yet available in the Chrome Web Store, but can be installed directly from source. diff --git a/user-guide/tools/testing-utils/index.html b/user-guide/tools/testing-utils/index.html index 557f17df81..ca051c0ca3 100644 --- a/user-guide/tools/testing-utils/index.html +++ b/user-guide/tools/testing-utils/index.html @@ -155,10 +155,10 @@

  • +

    • Testing Utils

    Tools to simplify application testing on LocalStack

      less than a minute  

    Introduction

    LocalStack provides a set of tools to simplify application testing on LocalStack. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Testing Utils

    Tools to simplify application testing on LocalStack

      less than a minute  

    Introduction

    LocalStack provides a set of tools to simplify application testing on LocalStack. These tools are available for Python and JVM (Java and Kotlin) and can be used to integrate with various unit testing frameworks and simplify the setup of AWS clients with LocalStack.

    Python

    This Python Testing Utils streamlines the integration of Localstack with your unit tests.

    Installation

    $ pip install localstack-utils

    Usage

    import time
 import boto3
 import unittest
diff --git a/user-guide/tools/transparent-endpoint-injection/index.html b/user-guide/tools/transparent-endpoint-injection/index.html
index 5762444e72..ab0c642979 100644
--- a/user-guide/tools/transparent-endpoint-injection/index.html
+++ b/user-guide/tools/transparent-endpoint-injection/index.html
@@ -155,10 +155,10 @@
 
  • 
 
  • 
 
  • 
+
  •

    • Transparent Endpoint Injection

    Transparently resolve your AWS calls to LocalStack
    Tags:

      3 minute read  

    LocalStack provides Transparent Endpoint Injection, + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Transparent Endpoint Injection

    Transparently resolve your AWS calls to LocalStack
    Tags:

      3 minute read  

    LocalStack provides Transparent Endpoint Injection, which enables seamless connectivity to LocalStack without modifying your application code targeting AWS. The DNS Server resolves AWS domains such as *.amazonaws.com including subdomains to the LocalStack container. Therefore, your application seamlessly accesses the LocalStack APIs instead of the real AWS APIs. diff --git a/user-guide/web-application/accounts/index.html b/user-guide/web-application/accounts/index.html index 608e139d5f..8009b9f736 100644 --- a/user-guide/web-application/accounts/index.html +++ b/user-guide/web-application/accounts/index.html @@ -155,10 +155,10 @@

  • +

    • Accounts

    The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.

      less than a minute  

    A LocalStack account is required to access features in the web app, and to access any of our paid offerings.

    Creating an Account

    Visit app.localstack.cloud/sign-up to create a user account for LocalStack. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Accounts

    The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.

      less than a minute  

    A LocalStack account is required to access features in the web app, and to access any of our paid offerings.

    Creating an Account

    Visit app.localstack.cloud/sign-up to create a user account for LocalStack. You can sign up with your email address or one of our supported social identity providers (such as GitHub).

    The Terms and Conditions can be found at https://www.localstack.cloud/legal/tos and our privacy policy can be found at https://www.localstack.cloud/legal/privacy-policy

    A screenshot of the sign up form

    Updating Account Info and Settings

    To update your account info, password and settings select the corresponding entry from the sidebar under the ‘Account’ menu entry.

    A screenshot of the 'Account Information' page with the 'Account' section highlighted in the navigation sidebar on the left.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/web-application/ci-analytics/index.html b/user-guide/web-application/ci-analytics/index.html index 51acd12984..cfb866e177 100644 --- a/user-guide/web-application/ci-analytics/index.html +++ b/user-guide/web-application/ci-analytics/index.html @@ -152,10 +152,10 @@
  • +

    • CI Analytics

    Get insights into your continuous integration (CI) builds with LocalStack CI Analytics
    Tags:

      5 minute read  

    Introduction

    CI Analytics is a feature of LocalStack Web Application that allows users to get insights into their CI builds. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    CI Analytics

    Get insights into your continuous integration (CI) builds with LocalStack CI Analytics
    Tags:

      5 minute read  

    Introduction

    CI Analytics is a feature of LocalStack Web Application that allows users to get insights into their CI builds. CI Analytics unifies additional features, such as Cloud Pods & Stack Insights, and augments them with an integrated view of CI builds to provide users with insights and facilitate debugging. The features include:

    • CI Project Runs: Offers a unified view of all CI builds for a particular project.
    • Log Output: Enables viewing of detailed logs for individual CI builds.
    • Request/Response Traces: Provides detailed traces of requests and responses, including the AWS service and operation involved, with expandable details of request and response data.
    • Cloud Pod State: Allows viewing the state of LocalStack resources for a specific CI build, accessible via a Cloud Pod.
    • Stack Insights: Displays a log of AWS API usage telemetry in your application stack, allowing you to examine the most frequently used services and API calls.

    CI Analytics integrates with all of the popular CI/CD tools, including GitHub Actions, GitLab CI, CircleCI, to gather pipeline metrics that track the performance and results of your cloud infrastructure deployments.

    Key Concepts

    • CI Project: It represents an application executing builds and tests in a Continuous Integration (CI) pipeline. diff --git a/user-guide/web-application/ci-keys/index.html b/user-guide/web-application/ci-keys/index.html index dffc756a87..9545a3ddba 100644 --- a/user-guide/web-application/ci-keys/index.html +++ b/user-guide/web-application/ci-keys/index.html @@ -152,10 +152,10 @@
  • +

    • CI Keys

    A CI key is used to access LocalStack in CI or other machine environments.

      2 minute read  

    LocalStack requires a CI Key for use in Continuous Integration (CI) or similar machine environments. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    CI Keys

    A CI key is used to access LocalStack in CI or other machine environments.

      2 minute read  

    LocalStack requires a CI Key for use in Continuous Integration (CI) or similar machine environments. Each instance startup in a CI or comparable environment consumes one CI token.

    CI Keys are administered on the CI Keys page of the LocalStack Web Application. These keys are linked to specific CI pipelines or projects, rather than individual developers.

    A screenshot of the LocalStack web app. The screenshot shows the page to manage CI keys

    CI Keys are not meant for individual developers. To grant a developer access to LocalStack and its advanced features, assign a license to them on the Users & Licenses page.

    LocalStack Web Application

    The LocalStack web app allows you to access additional features of LocalStack as well as to manage subscription and licenses, workspace members and permissions.

      less than a minute  

    LocalStack Web Application is a web-based user interface that allows you to manage your LocalStack account and all aspects of the LocalStack platform, including licenses and subscription, and additional features like the resource browser, extensions, Stack Insights, Cloud Pods, CI analytics and more.

    Accounts

    The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.

    Workspaces

    A workspace is the base organizational unit in the LocalStack web application.

    Managing Users and Licenses

    Invite new users and manage a user’s license and legacy API key.

    Resource Browser

    The Resource Browser allows you to view and manage your local AWS resources through the LocalStack Web Application.

    Instance Management

    Instance Management allows you to view and manage your LocalStack instances through the LocalStack Web Application alongside other auxiliary features.

    Stack Insights

    Stack Insights enable users to report AWS API usage telemetry of LocalStack runs to their LocalStack account.

    CI Analytics

    Get insights into your continuous integration (CI) builds with LocalStack CI Analytics

    CI Keys

    A CI key is used to access LocalStack in CI or other machine environments.

    Single-Sign On

    Configuring Custom Single-Sign On (SSO) Providers in LocalStack Web Application

    Last modified November 16, 2023: update docs with new license management flow and UX (#864) (e72c11cdf)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    LocalStack Web Application

    The LocalStack web app allows you to access additional features of LocalStack as well as to manage subscription and licenses, workspace members and permissions.

      less than a minute  

    LocalStack Web Application is a web-based user interface that allows you to manage your LocalStack account and all aspects of the LocalStack platform, including licenses and subscription, and additional features like the resource browser, extensions, Stack Insights, Cloud Pods, CI analytics and more.

    Accounts

    The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.

    Workspaces

    A workspace is the base organizational unit in the LocalStack web application.

    Managing Users and Licenses

    Invite new users and manage a user’s license and legacy API key.

    Resource Browser

    The Resource Browser allows you to view and manage your local AWS resources through the LocalStack Web Application.

    Instance Management

    Instance Management allows you to view and manage your LocalStack instances through the LocalStack Web Application alongside other auxiliary features.

    Stack Insights

    Stack Insights enable users to report AWS API usage telemetry of LocalStack runs to their LocalStack account.

    CI Analytics

    Get insights into your continuous integration (CI) builds with LocalStack CI Analytics

    CI Keys

    A CI key is used to access LocalStack in CI or other machine environments.

    Single-Sign On

    Configuring Custom Single-Sign On (SSO) Providers in LocalStack Web Application

    Last modified November 16, 2023: update docs with new license management flow and UX (#864) (e72c11cdf)
    \ No newline at end of file diff --git a/user-guide/web-application/instance-management/index.html b/user-guide/web-application/instance-management/index.html index a9024d5bc4..a129b92f12 100644 --- a/user-guide/web-application/instance-management/index.html +++ b/user-guide/web-application/instance-management/index.html @@ -152,10 +152,10 @@
  • +

    • Instance Management

    Instance Management allows you to view and manage your LocalStack instances through the LocalStack Web Application alongside other auxiliary features.

      2 minute read  

    Introduction

    LocalStack Instance Management lets you view and manage your LocalStack instances while you build and test your cloud applications locally. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Instance Management

    Instance Management allows you to view and manage your LocalStack instances through the LocalStack Web Application alongside other auxiliary features.

      2 minute read  

    Introduction

    LocalStack Instance Management lets you view and manage your LocalStack instances while you build and test your cloud applications locally. You can access this feature through the LocalStack Instances section in the sidebar of the LocalStack Web Application.

    Instance Management offers these features:

    • Status: Shows the status of the services running in the LocalStack container.
    • Resource Browser: Lets you view and manage your local AWS resources.
    • State: Allows you to export and import the state of your LocalStack instances.
    • Extensions: Provides extra integrations to improve your LocalStack experience.
    LocalStack Web Application's Instance Management page

    Instance Bookmark

    Instance Bookmark lets users save references to instances without directly creating or managing them. To create an Instance Bookmark, do the following:

    • Click on the Add Bookmark button on the Instance Management page.
    • Enter a name for the bookmark, specify the endpoint, and add a description.
    • Click on the Save Bookmark button.
    Instance Bookmark

    Connect to an instance on a different machine

    You can use the Instance Bookmark feature to connect the LocalStack Web Application to a LocalStack instance running on a different machine.

    To connect the Web Application with your running LocalStack instance, you need to ensure the endpoint URL’s server SSL certificate corresponds to the hostname/IP address of the URL. This is necessary when the endpoint URL is set as something like https://myhost:4566 or uses an IP address like https://1.2.3.4:4566. diff --git a/user-guide/web-application/resource-browser/index.html b/user-guide/web-application/resource-browser/index.html index febdabba78..7beae69b95 100644 --- a/user-guide/web-application/resource-browser/index.html +++ b/user-guide/web-application/resource-browser/index.html @@ -155,10 +155,10 @@

  • +

    • Resource Browser

    The Resource Browser allows you to view and manage your local AWS resources through the LocalStack Web Application.

      2 minute read  

    Introduction

    The LocalStack Resource Browser allow you to view, manage, and deploy AWS resources locally while building & testing their cloud applications locally. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Resource Browser

    The Resource Browser allows you to view and manage your local AWS resources through the LocalStack Web Application.

      2 minute read  

    Introduction

    The LocalStack Resource Browser allow you to view, manage, and deploy AWS resources locally while building & testing their cloud applications locally. It provides an internal, integrated experience, similar to the AWS Management Console, to manage the ephemeral resources in a LocalStack container on your local machine.

    LocalStack Web Application's Resource Browsers outlining various local AWS services

    The Resource Browser provide an experience similar to the AWS Management Console. However, the Resource Browser is not a replacement for the AWS Management Console and only replicate some of the features of the AWS Management Console. We recommend using our integrations to create your resources, with the Resource Browser being used for quick viewing and management of your resources.

    The LocalStack Web Application connects to your LocalStack container and retrieves the information about your local resources directly via localhost without using the internet. diff --git a/user-guide/web-application/single-sign-on/azure-ad/index.html b/user-guide/web-application/single-sign-on/azure-ad/index.html index 9f4dd103d7..0181be9564 100644 --- a/user-guide/web-application/single-sign-on/azure-ad/index.html +++ b/user-guide/web-application/single-sign-on/azure-ad/index.html @@ -155,10 +155,10 @@

  • +

    • SSO for Azure AD

    Configuring Azure AD for Single Sign-on in LocalStack Enterprise
    Tags:

      less than a minute  

    To configure SSO with an Azure AD Enterprise application, we provide a simple step-by-step solution below:

    1. Navigate to “Set up single sign on” in your Azure AD Enterprise application.

      Azure AD First Configuration Step

    2. In the Basic SAML Configuration, ensure that the settings match the following details

      Azure AD Second Configuration Step

    Take the correct values for Identifier (Entity ID) and Reply URL from the Identity Provider configuration page.

    1. In the Attributes & Claims section, add a group claim with the following configuration and save it.

      Azure AD Third Configuration Step

    2. In the SAML Certificates section, copy the App Federation Metadata Url

      Azure AD Fourth Configuration Step

    3. Navigate to our web application, or follow this link, and:

    • Create a new Identity provider
    • Enter a name for you Identity provider, and choose SAML as the provider type.
    • Select URL for the Metadata file and paste the link that you copied previously in step 4.
    • For the attribute mapping, provide the following value for the Email attribute: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name - (This should match the Claim name of user.userprincipalname in your Attributes & Claims)
    • Leave First name attribute and Last name attribute blank.
    1. Let your team members sign up to your LocalStack Organization via the Sign Up Portal Link.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file + Create project issue
    Categories
    Persistence
    Tags

    SSO for Azure AD

    Configuring Azure AD for Single Sign-on in LocalStack Enterprise
    Tags:

      less than a minute  

    To configure SSO with an Azure AD Enterprise application, we provide a simple step-by-step solution below:

    1. Navigate to “Set up single sign on” in your Azure AD Enterprise application.

      Azure AD First Configuration Step

    2. In the Basic SAML Configuration, ensure that the settings match the following details

      Azure AD Second Configuration Step

    Take the correct values for Identifier (Entity ID) and Reply URL from the Identity Provider configuration page.

    1. In the Attributes & Claims section, add a group claim with the following configuration and save it.

      Azure AD Third Configuration Step

    2. In the SAML Certificates section, copy the App Federation Metadata Url

      Azure AD Fourth Configuration Step

    3. Navigate to our web application, or follow this link, and:

    • Create a new Identity provider
    • Enter a name for you Identity provider, and choose SAML as the provider type.
    • Select URL for the Metadata file and paste the link that you copied previously in step 4.
    • For the attribute mapping, provide the following value for the Email attribute: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name - (This should match the Claim name of user.userprincipalname in your Attributes & Claims)
    • Leave First name attribute and Last name attribute blank.
    1. Let your team members sign up to your LocalStack Organization via the Sign Up Portal Link.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file diff --git a/user-guide/web-application/single-sign-on/index.html b/user-guide/web-application/single-sign-on/index.html index 10422f8ae6..32f7c1fe90 100644 --- a/user-guide/web-application/single-sign-on/index.html +++ b/user-guide/web-application/single-sign-on/index.html @@ -155,10 +155,10 @@
  • +

    • Single-Sign On

    Configuring Custom Single-Sign On (SSO) Providers in LocalStack Web Application
    Tags:

      3 minute read  

    Custom Single-Sign On (SSO) Identity providers, can be enabled to facilitate the process of quickly onboarding team members from your organization.

    In order to configure SSO access, first sign in to the LocalStack Web application under app.localstack.cloud. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Single-Sign On

    Configuring Custom Single-Sign On (SSO) Providers in LocalStack Web Application
    Tags:

      3 minute read  

    Custom Single-Sign On (SSO) Identity providers, can be enabled to facilitate the process of quickly onboarding team members from your organization.

    In order to configure SSO access, first sign in to the LocalStack Web application under app.localstack.cloud. In your profile settings, navigate to the Single Sign-on tab which will list existing SSO Identity Providers (if any exist).

    Adding SSO Identity providers in LocalStack Settings

    Next, click the button to create a new identity provider (IdP), where you can choose between the two leading industry standards:

    Configuring SSO using OpenID Connect (OIDC)

    In the form illustrated below, you can then enter the main information for the new IdP (using OpenID Connect):

    • Name of your identity provider
    • Client ID, Client Secret, Attributes request method, OIDC issues, Authorize scopes, and more.
      • You should be able to find these attributes in your OIDC IdP configuration.
    Configuring SSO using OpenID Connect (OIDC)

    Configuring SSO using SAML

    When configuring SSO using SAML, you can configure the settings of the Identity Provider via a standard SAML metadata file (see illustration below). The SAML metadata file can be specified either via URL or via a file upload.

    Select Enable IdP sign out flow if you want your users to be logged out from our app and your SAML IdP when they log out from your our Web Application.

    Configuring SSO using SAML

    Attribute mapping

    These attributes can be defined to automatically map attributes of user entities in your internal IdP to user attributes in the LocalStack platform.

    The following user attribute mappings can currently be configured:

    • Email
    • First name
    • Last name

    The Email should be configured to ensure correct functionality.

    Attribute Mapping

    Callback URL, Sign Up Portal URL and Identifier (Entity Id)

    After configuring the base details for your Identity Provider (IdP), the following additional information can be copied from the UI:

    • Callback URL: The Callback URL that you may need to configure in the settings of your IdP.
    • Identifier (Entity Id): The Identifier (Entity Id) that you may need to configure in the settings of your IdP.
    • Sign Up Portal URL: This is the URL that can be shared with your users to start the SSO signup flow for the LocalStack Web Application. The format of this endpoint is https://app.localstack.cloud/auth/sso/<organizationId>/<ssoName>
    Callback URL, Sign Up Portal URL, and Identifier (Entity Id)

    User Roles and Permissions

    For each new member that joins your org, you can specify user roles and permissions that should be assigned to them.

    • Default User Role: The Role that should be assigned to users of your organization signing up via SSO. diff --git a/user-guide/web-application/stack-insights/index.html b/user-guide/web-application/stack-insights/index.html index ad88e1aecd..1a5ae88ebf 100644 --- a/user-guide/web-application/stack-insights/index.html +++ b/user-guide/web-application/stack-insights/index.html @@ -155,10 +155,10 @@
  • +

    • Stack Insights

    Stack Insights enable users to report AWS API usage telemetry of LocalStack runs to their LocalStack account.
    Tags:

      2 minute read  

    Introduction

    LocalStack collects execution events to provide usage analytics and insights into development and testing. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Stack Insights

    Stack Insights enable users to report AWS API usage telemetry of LocalStack runs to their LocalStack account.
    Tags:

      2 minute read  

    Introduction

    LocalStack collects execution events to provide usage analytics and insights into development and testing. Stack Insights let users report AWS API usage telemetry to their LocalStack account.

    Stack Insights show which APIs are used, which clients or integrations use specific services and API operations, and which services cause the most API errors.

    Managing Users and Licenses

    Invite new users and manage a user’s license and legacy API key.

      4 minute read  

    Within a workspace, users and their associated licenses are managed on the Users & Licenses page. + Create project issue

    Table of Contents
    Categories
    Persistence
    Tags

    Managing Users and Licenses

    Invite new users and manage a user’s license and legacy API key.

      4 minute read  

    Within a workspace, users and their associated licenses are managed on the Users & Licenses page. This page allows to manage users and assign licenses to them.

    Illustrative screenshot of the LocalStack web app showing the page 'Users & Licenses'

    Managing Users

    Inviting Users to the Workspace

    New and existing LocalStack users can be invited to a workspace in the ‘Invite Users’ section. To invite a user, provide the user’s name and email address. If the invitee does not have a LocalStack account yet, an invitation to create an account will be sent to the provided email address. diff --git a/user-guide/web-application/workspaces/index.html b/user-guide/web-application/workspaces/index.html index b9968b60e3..e5c2ffe520 100644 --- a/user-guide/web-application/workspaces/index.html +++ b/user-guide/web-application/workspaces/index.html @@ -155,10 +155,10 @@

  • +

    • Workspaces

    A workspace is the base organizational unit in the LocalStack web application.

      less than a minute  

    In LocalStack, a workspace allows you to collaborate with members of your organization and it encapsulates user and license management, subscriptions and billing, as well as access to shared resources and features like Cloud Pods or Stack Insights.

    A workspace represents the base organizational unit in the web application. + Create project issue

    Categories
    Persistence
    Tags

    Workspaces

    A workspace is the base organizational unit in the LocalStack web application.

      less than a minute  

    In LocalStack, a workspace allows you to collaborate with members of your organization and it encapsulates user and license management, subscriptions and billing, as well as access to shared resources and features like Cloud Pods or Stack Insights.

    A workspace represents the base organizational unit in the web application. Users can be invited to join a workspace, and an admin can manage their license and permissions inside a workspace.

    A screenshot of the LocalStack web application. The section labeled 'Workspace' in the sidebar on the left is highlighted and shows sub menu entries like 'Workspace Info', 'Auth Token', Users & Licenses', 'Subscriptions'.
    Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)
    \ No newline at end of file