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✔️✔️✔️Show Tests
ListTagsForResource✔️pro✔️✔️✔️Show Tests
StartPipe
StopPipe
TagResource✔️pro✔️✔️✔️Show Tests
UntagResource✔️pro✔️✔️✔️Show Tests
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: Enrichment, LogConfiguration, Name, RoleArn, Source, SourceParameters, Target
  • LocalStack Pro
    • test_pipe_logging LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_logging HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Enrichment, Name, RoleArn, Source, SourceParameters, Target
  • LocalStack Pro
    • test_pipe_filter_enrichment LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_enrichment HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Enrichment, Name, RoleArn, Source, SourceParameters, Target, TargetParameters
  • LocalStack Pro
    • test_kinesis_dlq_behavior LocalStack Pro: tests/aws/services/pipes/test_pipes_kinesis.py::TestPipesKinesis::test_kinesis_dlq_behavior HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: LogConfiguration, Name, RoleArn, Source, SourceParameters, Target
  • LocalStack Pro
    • test_sqs_fifo_dlq_partial_batch_failures LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_sqs_fifo_dlq_partial_batch_failures_delete LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures_delete HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Name, RoleArn, Source, SourceParameters, Target
  • LocalStack Pro
    • test_dynamodb_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_dynamodb_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_sns_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_sns_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_filter_on_error LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_on_error HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Name, RoleArn, Source, SourceParameters, Target, TargetParameters
  • LocalStack Pro
    • test_kinesis_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Name, RoleArn, Source, Target
  • LocalStack Pro
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_pipes_empty LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipes_empty HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: Name, RoleArn, Source, Target, TargetParameters
  • LocalStack Pro
    • test_target_events LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_events HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_target_stepfunctions LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_stepfunctions HTTP Status Code: 200 AWS validated Snapshot Tested

DeletePipe

Parameters: Name
  • LocalStack Pro
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_dynamodb_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_dynamodb_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_sns_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_sns_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_filter_enrichment LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_enrichment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_filter_on_error LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_on_error HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_logging LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_logging HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_sqs_fifo_dlq_partial_batch_failures LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_sqs_fifo_dlq_partial_batch_failures_delete LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures_delete HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_behavior LocalStack Pro: tests/aws/services/pipes/test_pipes_kinesis.py::TestPipesKinesis::test_kinesis_dlq_behavior HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_pipe_source_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_source_prefix HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_target_events LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_events HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_target_stepfunctions LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_stepfunctions HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested

DescribePipe

Parameters: Name
  • LocalStack Pro
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_dynamodb_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_dynamodb_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_sns_dlq_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_kinesis_sns_dlq_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_filter_enrichment LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_enrichment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_filter_on_error LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_filter_on_error HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_logging LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_logging HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_sqs_fifo_dlq_partial_batch_failures LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_sqs_fifo_dlq_partial_batch_failures_delete LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_sqs_fifo_dlq_partial_batch_failures_delete HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_behavior LocalStack Pro: tests/aws/services/pipes/test_pipes_kinesis.py::TestPipesKinesis::test_kinesis_dlq_behavior HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_kinesis_dlq_behavior LocalStack Pro: tests/aws/services/pipes/test_pipes_kinesis.py::TestPipesKinesis::test_kinesis_dlq_behavior HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_pipe_source_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_source_prefix HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_pipes_empty LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipes_empty HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_target_events LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_events HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_target_stepfunctions LocalStack Pro: tests/aws/services/pipes/test_pipes_targets.py::TestPipesTargets::test_target_stepfunctions HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
    • test_black_box LocalStack Pro: tests/aws/services/cloudformation/resource_providers/pipes/aws_pipes_pipe/test_basic.py::TestBasicCRD::test_black_box HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
    • test_kinesis_dlq_behavior LocalStack Pro: tests/aws/services/pipes/test_pipes_kinesis.py::TestPipesKinesis::test_kinesis_dlq_behavior HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
    • test_list_pipe_source_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_source_prefix HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested

ListPipes

Parameters: NamePrefix
  • LocalStack Pro
    • test_list_pipe_name_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_name_prefix HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_pipes_empty LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipes_empty HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: SourcePrefix
  • LocalStack Pro
    • test_list_pipe_source_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_source_prefix HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: TargetPrefix
  • LocalStack Pro
    • test_list_pipe_target_prefix LocalStack Pro: tests/aws/services/pipes/test_pipes_list.py::TestPipesList::test_list_pipe_target_prefix HTTP Status Code: 200 AWS validated Snapshot Tested

ListTagsForResource

Parameters: resourceArn
  • LocalStack Pro
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested

TagResource

Parameters: resourceArn, tags
  • LocalStack Pro
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested

UntagResource

Parameters: resourceArn, tagKeys
  • LocalStack Pro
    • test_pipe_tags LocalStack Pro: tests/aws/services/pipes/test_pipes.py::TestPipes::test_pipe_tags HTTP Status Code: 200 AWS validated Snapshot Tested

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