REST API Reference

Back Next

Configuration information in the config array for Amazon Kinesis Streams as a source and as a target

The response returns only the fields that you entered in the request.

If the request is successful, the response returns the following fields:

Key	Type	Description
appendGUID	Boolean	Specifies whether or not to add a GUID as a suffix to the Amazon DynamoDB table name.
dynamoDB	String	Amazon DynamoDB table name where to store the checkpoint details of the Kinesis source data.
Stream	String	Name of the Kinesis Stream from where to read data. Applies when you use Amazon Kinesis Streams as a source.
Stream Name/Expression	String	Kinesis stream name or a regular expression for the Kinesis stream name pattern. Applies when you use Amazon Kinesis Streams as a target.

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"
      }
    ]
  }
}

POST response

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage