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
  • LocalStack Pro
    • test_amplify_env_variables LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::test_amplify_env_variables HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: description, name
  • LocalStack Pro
    • test_create_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_app HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: description, name, tags
  • LocalStack Pro
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: name
  • LocalStack Pro
    • test_create_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_backend_environment HTTP Status Code: 200
    • test_create_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_branch HTTP Status Code: 200
    • test_create_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_webhook HTTP Status Code: 200
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 200
    • test_delete_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_branch HTTP Status Code: 200
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_get_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_app HTTP Status Code: 200
    • test_get_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_backend_environment HTTP Status Code: 200
    • test_get_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_branch HTTP Status Code: 200
    • test_get_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_webhook HTTP Status Code: 200
    • test_list_apps LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_apps HTTP Status Code: 200
    • test_list_branches LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_branches HTTP Status Code: 200
    • test_tag_untag_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_untag_resource HTTP Status Code: 200
    • test_update_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_app HTTP Status Code: 200
    • test_update_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_webhook HTTP Status Code: 200
    • test_amplify LocalStack Pro: tests/aws/test_network_configuration.py::test_amplify HTTP Status Code: 200

CreateBackendEnvironment

Parameters: appId, environmentName
  • LocalStack Pro
    • test_create_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_backend_environment HTTP Status Code: 200
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 200
    • test_get_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_backend_environment HTTP Status Code: 200

CreateBranch

Parameters: appId, branchName
  • LocalStack Pro
    • test_create_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_branch HTTP Status Code: 200
    • test_create_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_webhook HTTP Status Code: 200
    • test_delete_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_branch HTTP Status Code: 200
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_get_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_branch HTTP Status Code: 200
    • test_get_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_webhook HTTP Status Code: 200
    • test_list_branches LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_branches HTTP Status Code: 200
    • test_update_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_webhook HTTP Status Code: 200
Parameters: appId, branchName, stage, tags
  • LocalStack Pro
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 200 AWS validated Snapshot Tested

CreateWebhook

Parameters: appId, branchName
  • LocalStack Pro
    • test_create_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_webhook HTTP Status Code: 200
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_get_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_webhook HTTP Status Code: 200
    • test_update_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_webhook HTTP Status Code: 200
    • test_amplify LocalStack Pro: tests/aws/test_network_configuration.py::test_amplify HTTP Status Code: 200

DeleteApp

Parameters: appId
  • LocalStack Pro
    • test_create_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_app HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_backend_environment HTTP Status Code: 200
    • test_create_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_branch HTTP Status Code: 200
    • test_create_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_create_webhook HTTP Status Code: 200
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 200
    • test_delete_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_branch HTTP Status Code: 200
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_get_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_app HTTP Status Code: 200
    • test_get_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_backend_environment HTTP Status Code: 200
    • test_get_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_branch HTTP Status Code: 200
    • test_get_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_webhook HTTP Status Code: 200
    • test_list_apps LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_apps HTTP Status Code: 200
    • test_list_branches LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_branches HTTP Status Code: 200
    • test_tag_untag_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_untag_resource HTTP Status Code: 200
    • test_update_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_app HTTP Status Code: 200
    • test_update_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_webhook HTTP Status Code: 200
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_amplify_env_variables LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::test_amplify_env_variables HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_amplify LocalStack Pro: tests/aws/test_network_configuration.py::test_amplify HTTP Status Code: 200

DeleteBackendEnvironment

Parameters: appId, environmentName
  • LocalStack Pro
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 200

DeleteBranch

Parameters: appId, branchName
  • LocalStack Pro
    • test_delete_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_branch HTTP Status Code: 200
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested

DeleteWebhook

Parameters: webhookId
  • LocalStack Pro
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_amplify LocalStack Pro: tests/aws/test_network_configuration.py::test_amplify HTTP Status Code: 404 (NotFoundException)

GetApp

Parameters: appId
  • LocalStack Pro
    • test_get_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_app HTTP Status Code: 200
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_amplify_env_variables LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::test_amplify_env_variables HTTP Status Code: 200 AWS validated Snapshot Tested

GetBackendEnvironment

Parameters: appId, environmentName
  • LocalStack Pro
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 200
    • test_get_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_backend_environment HTTP Status Code: 200
    • test_delete_backend_environment LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_backend_environment HTTP Status Code: 404 (NotFoundException)

GetBranch

Parameters: appId, branchName
  • LocalStack Pro
    • test_get_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_branch HTTP Status Code: 200

GetWebhook

Parameters: webhookId
  • LocalStack Pro
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 200
    • test_get_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_get_webhook HTTP Status Code: 200
    • test_delete_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_webhook HTTP Status Code: 404 (NotFoundException)

ListApps

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_list_apps LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_apps HTTP Status Code: 200
Parameters: maxResults
  • LocalStack Pro
    • test_list_apps LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_apps HTTP Status Code: 200

ListBranches

Parameters: appId
  • LocalStack Pro
    • test_delete_branch LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_delete_branch HTTP Status Code: 200
    • test_list_branches LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_branches HTTP Status Code: 200
    • test_amplify_resources LocalStack Pro: tests/aws/services/cloudformation/resources/test_amplify.py::TestCfnAmplifyResources::test_amplify_resources HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: appId, maxResults
  • LocalStack Pro
    • test_list_branches LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_list_branches HTTP Status Code: 200

ListTagsForResource

Parameters: resourceArn
  • LocalStack Pro
    • test_tag_untag_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_untag_resource HTTP Status Code: 200

TagResource

Parameters: resourceArn, tags
  • LocalStack Pro
    • test_tag_untag_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_untag_resource HTTP Status Code: 200
    • test_tag_illegal_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_illegal_resource HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
    • test_tag_non_existing_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_non_existing_app HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested

UntagResource

Parameters: resourceArn, tagKeys
  • LocalStack Pro
    • test_tag_untag_resource LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_tag_untag_resource HTTP Status Code: 200

UpdateApp

Parameters: appId, name
  • LocalStack Pro
    • test_update_app LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_app HTTP Status Code: 200

UpdateWebhook

Parameters: branchName, webhookId
  • LocalStack Pro
    • test_update_webhook LocalStack Pro: tests/aws/services/amplify/test_amplify.py::TestAmplifyProvider::test_update_webhook HTTP Status Code: 200

Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)