AWS Kinesis · Schema

CopyCommand

Describes a COPY command for Amazon Redshift.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
DataTableName object
DataTableColumns object
CopyOptions object
View JSON Schema on GitHub

JSON Schema

kinesis-copycommand-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CopyCommand",
  "title": "CopyCommand",
  "type": "object",
  "required": [
    "DataTableName"
  ],
  "properties": {
    "DataTableName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataTableName"
        },
        {
          "description": "The name of the target table. The table must already exist in the database."
        }
      ]
    },
    "DataTableColumns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataTableColumns"
        },
        {
          "description": "A comma-separated list of column names."
        }
      ]
    },
    "CopyOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CopyOptions"
        },
        {
          "description": "<p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the \"Optional Parameters\" section of <a href=\"https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html\">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Data Firehose are as follows:</p> <p> <code>delimiter '\\t' lzop;</code> - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with \"|\" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href=\"https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html\">Amazon Redshift COPY command examples</a>.</p>"
        }
      ]
    }
  },
  "description": "Describes a <code>COPY</code> command for Amazon Redshift."
}