In this section, we provide guides and references to use the AWS Kinesis Firehose connector.
Configure and schedule AWS Kinesis Firehose metadata and profiler workflows from the OpenMetadata UI:
Requirements
To extract metadata from AWS Kinesis Firehose, you need to configure AWS credentials with appropriate permissions:
- AWS Credentials: Valid AWS credentials (Access Key ID and Secret Access Key) or IAM role with permissions to access Kinesis Firehose
- Permissions Required:
firehose:DescribeDeliveryStream - To describe delivery stream details
firehose:ListDeliveryStreams - To list all delivery streams
Python Requirements
We have support for Python versions 3.9-3.11
To run the AWS Kinesis Firehose ingestion, you will need to install:
pip3 install "openmetadata-ingestion[kinesis-firehose]"
All connectors are defined as JSON Schemas.
Here
you can find the structure to create a connection to AWS Kinesis Firehose.
In order to create and run a Metadata Ingestion workflow, we will follow
the steps to create a YAML configuration able to connect to the source,
process the Entities if needed, and reach the OpenMetadata server.
The workflow is modeled around the following
JSON Schema
1. Define the YAML Config
This is a sample config for AWS Kinesis Firehose:
2. Run with the CLI
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration,
you will be able to extract metadata from different sources.