AWS Glue
Web API Reference (API Version 2017-03-31)

GetPlan

Gets code to perform a specified mapping.

Request Syntax

{ "Language": "string", "Location": { "DynamoDB": [ { "Name": "string", "Param": boolean, "Value": "string" } ], "Jdbc": [ { "Name": "string", "Param": boolean, "Value": "string" } ], "S3": [ { "Name": "string", "Param": boolean, "Value": "string" } ] }, "Mapping": [ { "SourcePath": "string", "SourceTable": "string", "SourceType": "string", "TargetPath": "string", "TargetTable": "string", "TargetType": "string" } ], "Sinks": [ { "DatabaseName": "string", "TableName": "string" } ], "Source": { "DatabaseName": "string", "TableName": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Language

The programming language of the code to perform the mapping.

Type: String

Valid Values: PYTHON | SCALA

Required: No

Location

Parameters for the mapping.

Type: Location object

Required: No

Mapping

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

Type: Array of MappingEntry objects

Required: Yes

Sinks

The target tables.

Type: Array of CatalogEntry objects

Required: No

Source

The source table.

Type: CatalogEntry object

Required: Yes

Response Syntax

{ "PythonScript": "string", "ScalaCode": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PythonScript

A Python script to perform the mapping.

Type: String

ScalaCode

Scala code to perform the mapping.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: