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
  • LocalStack Pro
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Name, Type
  • LocalStack Pro
    • test_create_data_catalog LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_data_catalog HTTP Status Code: 200

CreateNamedQuery

Parameters: ClientRequestToken, Database, Description, Name, QueryString, WorkGroup
  • LocalStack Pro
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: ClientRequestToken, Database, Name, QueryString
  • LocalStack Pro
    • test_create_named_query LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_named_query HTTP Status Code: 200

CreateWorkGroup

Parameters: Configuration, Description, Name, Tags
  • LocalStack Pro
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Description, Name
  • LocalStack Pro
    • test_create_workgroup LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_workgroup HTTP Status Code: 200
Parameters: Description, Name, Tags
  • LocalStack Pro
    • test_list_tags_for_resource LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_list_tags_for_resource HTTP Status Code: 200

DeleteDataCatalog

Parameters: Name
  • LocalStack Pro
    • test_create_data_catalog LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_data_catalog HTTP Status Code: 200
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteNamedQuery

Parameters: NamedQueryId
  • LocalStack Pro
    • test_create_named_query LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_named_query HTTP Status Code: 200
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteWorkGroup

Parameters: RecursiveDeleteOption, WorkGroup
  • LocalStack Pro
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: WorkGroup
  • LocalStack Pro
    • test_create_workgroup LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_workgroup HTTP Status Code: 200
    • test_list_tags_for_resource LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_list_tags_for_resource HTTP Status Code: 200

GetDataCatalog

Parameters: Name
  • LocalStack Pro
    • test_create_data_catalog LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_data_catalog HTTP Status Code: 200
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested

GetNamedQuery

Parameters: NamedQueryId
  • LocalStack Pro
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested

GetWorkGroup

Parameters: WorkGroup
  • LocalStack Pro
    • test_create_workgroup LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_workgroup HTTP Status Code: 200
    • test_athena LocalStack Pro: tests/aws/services/cloudformation/resources/test_athena.py::test_athena HTTP Status Code: 200 AWS validated Snapshot Tested

ListDataCatalogs

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_data_catalog LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_data_catalog HTTP Status Code: 200

ListNamedQueries

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_named_query LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_named_query HTTP Status Code: 200

ListTagsForResource

Parameters: ResourceARN
  • LocalStack Pro
    • test_list_tags_for_resource LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_list_tags_for_resource HTTP Status Code: 200

ListWorkGroups

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_workgroup LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_create_workgroup HTTP Status Code: 200

TagResource

Parameters: ResourceARN, Tags
  • LocalStack Pro
    • test_list_tags_for_resource LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_list_tags_for_resource HTTP Status Code: 200

UntagResource

Parameters: ResourceARN, TagKeys
  • LocalStack Pro
    • test_list_tags_for_resource LocalStack Pro: tests/aws/services/athena/test_athena.py::TestAthenaCrud::test_list_tags_for_resource HTTP Status Code: 200

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