[ aws . glue ]

get-plan

Description

Gets code to perform a specified mapping.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-plan
--mapping <value>
--source <value>
[--sinks <value>]
[--location <value>]
[--language <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--mapping (list)

The list of mappings from a source table to target tables.

(structure)

Defines a mapping.

SourceTable -> (string)

The name of the source table.

SourcePath -> (string)

The source path.

SourceType -> (string)

The source type.

TargetTable -> (string)

The target table.

TargetPath -> (string)

The target path.

TargetType -> (string)

The target type.

Shorthand Syntax:

SourceTable=string,SourcePath=string,SourceType=string,TargetTable=string,TargetPath=string,TargetType=string ...

JSON Syntax:

[
  {
    "SourceTable": "string",
    "SourcePath": "string",
    "SourceType": "string",
    "TargetTable": "string",
    "TargetPath": "string",
    "TargetType": "string"
  }
  ...
]

--source (structure)

The source table.

DatabaseName -> (string)

The database in which the table metadata resides.

TableName -> (string)

The name of the table in question.

Shorthand Syntax:

DatabaseName=string,TableName=string

JSON Syntax:

{
  "DatabaseName": "string",
  "TableName": "string"
}

--sinks (list)

The target tables.

(structure)

Specifies a table definition in the AWS Glue Data Catalog.

DatabaseName -> (string)

The database in which the table metadata resides.

TableName -> (string)

The name of the table in question.

Shorthand Syntax:

DatabaseName=string,TableName=string ...

JSON Syntax:

[
  {
    "DatabaseName": "string",
    "TableName": "string"
  }
  ...
]

--location (structure)

The parameters for the mapping.

Jdbc -> (list)

A JDBC location.

(structure)

An argument or property of a node.

Name -> (string)

The name of the argument or property.

Value -> (string)

The value of the argument or property.

Param -> (boolean)

True if the value is used as a parameter.

S3 -> (list)

An Amazon Simple Storage Service (Amazon S3) location.

(structure)

An argument or property of a node.

Name -> (string)

The name of the argument or property.

Value -> (string)

The value of the argument or property.

Param -> (boolean)

True if the value is used as a parameter.

DynamoDB -> (list)

An Amazon DynamoDB table location.

(structure)

An argument or property of a node.

Name -> (string)

The name of the argument or property.

Value -> (string)

The value of the argument or property.

Param -> (boolean)

True if the value is used as a parameter.

Shorthand Syntax:

Jdbc=[{Name=string,Value=string,Param=boolean},{Name=string,Value=string,Param=boolean}],S3=[{Name=string,Value=string,Param=boolean},{Name=string,Value=string,Param=boolean}],DynamoDB=[{Name=string,Value=string,Param=boolean},{Name=string,Value=string,Param=boolean}]

JSON Syntax:

{
  "Jdbc": [
    {
      "Name": "string",
      "Value": "string",
      "Param": true|false
    }
    ...
  ],
  "S3": [
    {
      "Name": "string",
      "Value": "string",
      "Param": true|false
    }
    ...
  ],
  "DynamoDB": [
    {
      "Name": "string",
      "Value": "string",
      "Param": true|false
    }
    ...
  ]
}

--language (string)

The programming language of the code to perform the mapping.

Possible values:

• PYTHON

• SCALA

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

PythonScript -> (string)

A Python script to perform the mapping.

ScalaCode -> (string)

The Scala code to perform the mapping.