# GetPlan
<a name="API_GetPlan"></a>

Gets code to perform a specified mapping.

## Request Syntax
<a name="API_GetPlan_RequestSyntax"></a>

```
{
   "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
<a name="API_GetPlan_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AdditionalPlanOptionsMap](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-AdditionalPlanOptionsMap"></a>
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

 ** [Language](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-Language"></a>
The programming language of the code to perform the mapping.  
Type: String  
Valid Values: `PYTHON | SCALA`   
Required: No

 ** [Location](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-Location"></a>
The parameters for the mapping.  
Type: [Location](API_Location.md) object  
Required: No

 ** [Mapping](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-Mapping"></a>
The list of mappings from a source table to target tables.  
Type: Array of [MappingEntry](API_MappingEntry.md) objects  
Required: Yes

 ** [Sinks](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-Sinks"></a>
The target tables.  
Type: Array of [CatalogEntry](API_CatalogEntry.md) objects  
Required: No

 ** [Source](#API_GetPlan_RequestSyntax) **   <a name="Glue-GetPlan-request-Source"></a>
The source table.  
Type: [CatalogEntry](API_CatalogEntry.md) object  
Required: Yes

## Response Syntax
<a name="API_GetPlan_ResponseSyntax"></a>

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

## Response Elements
<a name="API_GetPlan_ResponseElements"></a>

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](#API_GetPlan_ResponseSyntax) **   <a name="Glue-GetPlan-response-PythonScript"></a>
A Python script to perform the mapping.  
Type: String

 ** [ScalaCode](#API_GetPlan_ResponseSyntax) **   <a name="Glue-GetPlan-response-ScalaCode"></a>
The Scala code to perform the mapping.  
Type: String

## Errors
<a name="API_GetPlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceException **   
An internal service error occurred.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 500

 ** InvalidInputException **   
The input provided was not valid.    
 ** FromFederationSource **   
Indicates whether or not the exception relates to a federated source.  
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** OperationTimeoutException **   
The operation timed out.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

## See Also
<a name="API_GetPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/glue-2017-03-31/GetPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/glue-2017-03-31/GetPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/glue-2017-03-31/GetPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/glue-2017-03-31/GetPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/glue-2017-03-31/GetPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/glue-2017-03-31/GetPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/glue-2017-03-31/GetPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/glue-2017-03-31/GetPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/glue-2017-03-31/GetPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/glue-2017-03-31/GetPlan)