GetPlan - AWS Glue


Gets code to perform a specified mapping.

Request Syntax

{ "AdditionalPlanOptionsMap": { "string" : "string" }, "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.


A map to hold additional optional key-value parameters.

Currently, these key-value pairs are supported:

  • inferSchema  —  Specifies whether to set inferSchema to true or false for the default script generated by an AWS Glue job. For example, to set inferSchema to true, pass the following key value pair:

    --additional-plan-options-map '{"inferSchema":"true"}'

Type: String to string map

Required: No


The programming language of the code to perform the mapping.

Type: String

Valid Values: PYTHON | SCALA

Required: No


The parameters for the mapping.

Type: Location object

Required: No


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

Type: Array of MappingEntry objects

Required: Yes


The target tables.

Type: Array of CatalogEntry objects

Required: No


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.


A Python script to perform the mapping.

Type: String


The Scala code to perform the mapping.

Type: String


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


An internal service error occurred.

HTTP Status Code: 500


The input provided was not valid.

HTTP Status Code: 400


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: