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✔️Show Tests
CreateUser✔️pro✔️Show Tests
CreateWebApp
CreateWorkflow
DeleteAccess
DeleteAgreement
DeleteCertificate
DeleteConnector
DeleteHostKey
DeleteProfile
DeleteServer✔️pro✔️Show Tests
DeleteSshPublicKey✔️pro✔️Show Tests
DeleteUser✔️pro✔️Show Tests
DeleteWebApp
DeleteWebAppCustomization
DeleteWorkflow
DescribeAccess
DescribeAgreement
DescribeCertificate
DescribeConnector
DescribeExecution
DescribeHostKey
DescribeProfile
DescribeSecurityPolicy
DescribeServer✔️pro✔️Show Tests
DescribeUser✔️pro✔️Show Tests
DescribeWebApp
DescribeWebAppCustomization
DescribeWorkflow
ImportCertificate
ImportHostKey
ImportSshPublicKey✔️pro✔️Show Tests
ListAccesses
ListAgreements
ListCertificates
ListConnectors
ListExecutions
ListFileTransferResults
ListHostKeys
ListProfiles
ListSecurityPolicies
ListServers✔️pro
ListTagsForResource
ListUsers✔️pro✔️Show Tests
ListWebApps
ListWorkflows
SendWorkflowStepState
StartDirectoryListing
StartFileTransfer
StartServer
StopServer
TagResource
TestConnection
TestIdentityProvider
UntagResource
UpdateAccess
UpdateAgreement
UpdateCertificate
UpdateConnector
UpdateHostKey
UpdateProfile
UpdateServer
UpdateUser✔️pro✔️Show Tests
UpdateWebApp
UpdateWebAppCustomization

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


CreateServer

Parameters: EndpointType, IdentityProviderType, Protocols, Tags
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

CreateUser

Parameters: HomeDirectory, HomeDirectoryType, Role, ServerId, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

DeleteServer

Parameters: ServerId
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

DeleteSshPublicKey

Parameters: ServerId, SshPublicKeyId, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

DeleteUser

Parameters: ServerId, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

DescribeServer

Parameters: ServerId
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 400 (ResourceNotFoundException)

DescribeUser

Parameters: ServerId, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

ImportSshPublicKey

Parameters: ServerId, SshPublicKeyBody, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

ListUsers

Parameters: ServerId
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

UpdateUser

Parameters: HomeDirectory, HomeDirectoryType, ServerId, UserName
  • LocalStack Pro
    • test_basic_transfer_api LocalStack Pro: tests/aws/services/transfer/test_transfer.py::TestAWSTransfer::test_basic_transfer_api HTTP Status Code: 200

Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)