REST API Reference

Back Next

Amazon Kinesis Streams sources and targets

When the source and target connection of the task is Amazon Kinesis Streams, you can include the following fields and key-value pairs in the config array of the source and target connection:

Key	Type	Required	Description
appendGUID	Boolean		Specifies whether or not to add a GUID as a suffix to the Amazon DynamoDB table name. Enter one of the following values: true false
dynamoDB	String		Amazon DynamoDB table name where to store the checkpoint details of the Kinesis source data. You can enter a string of up to 128 characters.
Stream	String	Yes	Name of the Kinesis Stream to read data from. Enter a string of up to 128 characters. Appears in the source node.
Stream Name/Expression	String	Yes	Kinesis Stream name or a regular expression to write data to. Enter a string of up to 128 characters. Appears in the target node.

POST request example

To update a

streaming ingestion and replication

task with an Amazon Kinesis Streams source and target, you might send a request similar to the following example:

POST <serverUrl>/sisvc/restapi/v1/UpdateEntity/Documents('<document ID>')
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>

{
  "name": "kinesis to kinesis",
  "description": "kinesis to kinesis",
  "runtimeId": "01000025000000000003",
  "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
  "currentVersion": "2",
  "messageFormat": "binary",
  "nodes": [
    {
      "name": "kinesis to kinesis_source",
      "type": "source",
      "connectionId": "012MGS0B00000000000F",
      "transformationType": "",
      "config": [
        {
          "key": "appendGUID",
          "value": true
        },
        {
          "key": "dynamoDB",
          "value": "table"
        },
        {
          "key": "Stream",
          "value": "test"
        }
      ]
    },
    {
      "name": "kinesis to kinesis_target",
      "type": "target",
      "connectionId": "012MGS0B00000000000F",
      "transformationType": "",
      "config": [
        {
          "key": "Stream Name/Expression",
          "value": "trgt"
        }
      ]
    }
  ],
  "edges": [
    {
      "from": "kinesis to kinesis_source",
      "to": "kinesis to kinesis_target"
    }
  ]
}

The response returns only the fields that you entered in the request. If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example in a

Success

node:

{
    "Success": {
    "name": "kinesis to kinesis",
    "description": "kinesis to kinesis",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "kinesis to kinesis_source",
        "type": "source",
        "connectionId": "012MGS0B00000000000F",
        "transformationType": "",
        "config": [
          {
            "key": "appendGUID",
            "value": true
          },
          {
            "key": "dynamoDB",
            "value": "table"
          },
          {
            "key": "Stream",
            "value": "test"
          }
        ]
      },
      {
        "name": "kinesis to kinesis_target",
        "type": "target",
        "connectionId": "012MGS0B00000000000F",
        "transformationType": "",
        "config": [
          {
            "key": "Stream Name/Expression",
            "value": "trgt"
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "kinesis to kinesis_source",
        "to": "kinesis to kinesis_target"
      }
    ]
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Amazon Kinesis Streams sources and targets

Amazon Kinesis Streams sources and targets

POST request example

POST response example