> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdia-data-integration/9.3-data-integration/pdi-transformation-steps-reference-overview/kinesis-consumer/general.md).

# General

The Kinesis Consumer step requires definitions for setup, batch, fields, result fields, and Kinesis Data Streams specific options to consume messages.

![Kinesis Consumer step](/files/CeUrNuJSNgi7LLN5v7hW)

Enter the following information in the **Step name** and **Transformation** fields:

| Option             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Step name**      | Specifies the unique name of the step on the canvas. The **Step name** is set to Kinesis Consumer by default.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **Transformation** | <p>Specify the child transformation to execute by performing any of the following actions.- Entering its path.</p><ul><li>Clicking <strong>Browse</strong> to select an existing child transformation.</li><li>Clicking <strong>New</strong> to create and save a new child transformation. See <a href="/pages/YBgh1MvVMyJbPNjfyO55">Create and save a new child transformation</a> for more details.</li></ul><p>The selected child transformation must start with the Get Records from Stream step.</p><p>If you select a transformation that has the same root path as the current transformation, the variable <em>${Internal.Entry.Current.Directory}</em> is automatically inserted in place of the common root path. For example, if the current transformation's path is <code>/home/admin/transformation.ktr</code> and you select a transformation in the directory <code>/home/admin/path/sub.ktr</code>, then the path is automatically converted to <code>*${Internal.Entry.Current.Directory}*/path/sub.ktr</code>.</p><p>If you are working with a repository, you must specify the name of the transformation. If you are not working with a repository, you must specify the XML file name of the transformation.</p><p>Transformations previously specified by reference are automatically converted to be specified by the transformation name in the Pentaho Repository.</p> |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pentaho.com/pdia-data-integration/9.3-data-integration/pdi-transformation-steps-reference-overview/kinesis-consumer/general.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.