[ aws . glue ]

batch-create-partition

Description

Creates one or more partitions in a batch operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-create-partition
[--catalog-id <value>]
--database-name <value>
--table-name <value>
--partition-input-list <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.

--database-name (string)

The name of the metadata database in which the partition is to be created.

--table-name (string)

The name of the metadata table in which the partition is to be created.

--partition-input-list (list)

A list of PartitionInput structures that define the partitions to be created.

(structure)

The structure used to create and update a partition.

Values -> (list)

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

(string)

LastAccessTime -> (timestamp)

The last time at which the partition was accessed.

StorageDescriptor -> (structure)

Provides information about the physical location where the partition is stored.

Columns -> (list)

A list of the Columns in the table.

(structure)

A column in a Table .

Name -> (string)

The name of the Column .

Type -> (string)

The data type of the Column .

Comment -> (string)

A free-form text comment.

Parameters -> (map)

These key-value pairs define properties associated with the column.

key -> (string)

value -> (string)

Location -> (string)

The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

AdditionalLocations -> (list)

(string)

InputFormat -> (string)

The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.

OutputFormat -> (string)

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.

Compressed -> (boolean)

True if the data in the table is compressed, or False if not.

NumberOfBuckets -> (integer)

Must be specified if the table contains any dimension columns.

SerdeInfo -> (structure)

The serialization/deserialization (SerDe) information.

Name -> (string)

Name of the SerDe.

SerializationLibrary -> (string)

Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .

Parameters -> (map)

These key-value pairs define initialization parameters for the SerDe.

key -> (string)

value -> (string)

BucketColumns -> (list)

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

(string)

SortColumns -> (list)

A list specifying the sort order of each bucket in the table.

(structure)

Specifies the sort order of a sorted column.

Column -> (string)

The name of the column.

SortOrder -> (integer)

Indicates that the column is sorted in ascending order (== 1 ), or in descending order (==0 ).

Parameters -> (map)

The user-supplied properties in key-value form.

key -> (string)

value -> (string)

SkewedInfo -> (structure)

The information about values that appear frequently in a column (skewed values).

SkewedColumnNames -> (list)

A list of names of columns that contain skewed values.

(string)

SkewedColumnValues -> (list)

A list of values that appear so frequently as to be considered skewed.

(string)

SkewedColumnValueLocationMaps -> (map)

A mapping of skewed values to the columns that contain them.

key -> (string)

value -> (string)

StoredAsSubDirectories -> (boolean)

True if the table data is stored in subdirectories, or False if not.

SchemaReference -> (structure)

An object that references a schema stored in the Glue Schema Registry.

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

SchemaId -> (structure)

A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

SchemaArn -> (string)

The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaName -> (string)

The name of the schema. One of SchemaArn or SchemaName has to be provided.

RegistryName -> (string)

The name of the schema registry that contains the schema.

SchemaVersionId -> (string)

The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

SchemaVersionNumber -> (long)

The version number of the schema.

Parameters -> (map)

These key-value pairs define partition parameters.

key -> (string)

value -> (string)

LastAnalyzedTime -> (timestamp)

The last time at which column statistics were computed for this partition.

JSON Syntax:

[
  {
    "Values": ["string", ...],
    "LastAccessTime": timestamp,
    "StorageDescriptor": {
      "Columns": [
        {
          "Name": "string",
          "Type": "string",
          "Comment": "string",
          "Parameters": {"string": "string"
            ...}
        }
        ...
      ],
      "Location": "string",
      "AdditionalLocations": ["string", ...],
      "InputFormat": "string",
      "OutputFormat": "string",
      "Compressed": true|false,
      "NumberOfBuckets": integer,
      "SerdeInfo": {
        "Name": "string",
        "SerializationLibrary": "string",
        "Parameters": {"string": "string"
          ...}
      },
      "BucketColumns": ["string", ...],
      "SortColumns": [
        {
          "Column": "string",
          "SortOrder": integer
        }
        ...
      ],
      "Parameters": {"string": "string"
        ...},
      "SkewedInfo": {
        "SkewedColumnNames": ["string", ...],
        "SkewedColumnValues": ["string", ...],
        "SkewedColumnValueLocationMaps": {"string": "string"
          ...}
      },
      "StoredAsSubDirectories": true|false,
      "SchemaReference": {
        "SchemaId": {
          "SchemaArn": "string",
          "SchemaName": "string",
          "RegistryName": "string"
        },
        "SchemaVersionId": "string",
        "SchemaVersionNumber": long
      }
    },
    "Parameters": {"string": "string"
      ...},
    "LastAnalyzedTime": timestamp
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Errors -> (list)

The errors encountered when trying to create the requested partitions.

(structure)

Contains information about a partition error.

PartitionValues -> (list)

The values that define the partition.

(string)

ErrorDetail -> (structure)

The details about the partition error.

ErrorCode -> (string)

The code associated with this error.

ErrorMessage -> (string)

A message describing the error.