Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Glue.GetPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets code to perform a specified mapping.

Synopsis

data GetPlan = GetPlan' {
- additionalPlanOptionsMap :: Maybe (HashMap Text Text)
- language :: Maybe Language
- location :: Maybe Location
- sinks :: Maybe [CatalogEntry]
- mapping :: [MappingEntry]
- source :: CatalogEntry
}
newGetPlan :: CatalogEntry -> GetPlan
getPlan_additionalPlanOptionsMap :: Lens' GetPlan (Maybe (HashMap Text Text))
getPlan_language :: Lens' GetPlan (Maybe Language)
getPlan_location :: Lens' GetPlan (Maybe Location)
getPlan_sinks :: Lens' GetPlan (Maybe [CatalogEntry])
getPlan_mapping :: Lens' GetPlan [MappingEntry]
getPlan_source :: Lens' GetPlan CatalogEntry
data GetPlanResponse = GetPlanResponse' {
- pythonScript :: Maybe Text
- scalaCode :: Maybe Text
- httpStatus :: Int
}
newGetPlanResponse :: Int -> GetPlanResponse
getPlanResponse_pythonScript :: Lens' GetPlanResponse (Maybe Text)
getPlanResponse_scalaCode :: Lens' GetPlanResponse (Maybe Text)
getPlanResponse_httpStatus :: Lens' GetPlanResponse Int

Creating a Request

data GetPlan Source #

See: newGetPlan smart constructor.

Constructors

GetPlan'

Fields

additionalPlanOptionsMap :: Maybe (HashMap Text Text)
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 Glue job. For example, to set inferSchema to true, pass the following key value pair:
```
--additional-plan-options-map '{"inferSchema":"true"}'
```
language :: Maybe Language
The programming language of the code to perform the mapping.
location :: Maybe Location
The parameters for the mapping.
sinks :: Maybe [CatalogEntry]
The target tables.
mapping :: [MappingEntry]
The list of mappings from a source table to target tables.
source :: CatalogEntry
The source table.

Instances

Instances details

ToJSON GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods toJSON :: GetPlan -> Value # toEncoding :: GetPlan -> Encoding # toJSONList :: [GetPlan] -> Value # toEncodingList :: [GetPlan] -> Encoding #
ToHeaders GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods toHeaders :: GetPlan -> [Header] #
ToPath GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods toPath :: GetPlan -> ByteString #
ToQuery GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods toQuery :: GetPlan -> QueryString #
AWSRequest GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Associated Types type AWSResponse GetPlan # Methods request :: (Service -> Service) -> GetPlan -> Request GetPlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPlan))) #
Generic GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Associated Types type Rep GetPlan :: Type -> Type # Methods from :: GetPlan -> Rep GetPlan x # to :: Rep GetPlan x -> GetPlan #
Read GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods readsPrec :: Int -> ReadS GetPlan # readList :: ReadS [GetPlan] # readPrec :: ReadPrec GetPlan # readListPrec :: ReadPrec [GetPlan] #
Show GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods showsPrec :: Int -> GetPlan -> ShowS # show :: GetPlan -> String # showList :: [GetPlan] -> ShowS #
NFData GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods rnf :: GetPlan -> () #
Eq GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods (==) :: GetPlan -> GetPlan -> Bool # (/=) :: GetPlan -> GetPlan -> Bool #
Hashable GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods hashWithSalt :: Int -> GetPlan -> Int # hash :: GetPlan -> Int #
type AWSResponse GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan type AWSResponse GetPlan = GetPlanResponse
type Rep GetPlan Source #
Instance details Defined in Amazonka.Glue.GetPlan type Rep GetPlan = D1 ('MetaData "GetPlan" "Amazonka.Glue.GetPlan" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetPlan'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalPlanOptionsMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Language)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location)))) :: (S1 ('MetaSel ('Just "sinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CatalogEntry])) :: (S1 ('MetaSel ('Just "mapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MappingEntry]) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CatalogEntry)))))

newGetPlan Source #

Arguments

:: CatalogEntry	`GetPlan`
-> GetPlan

Create a value of GetPlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalPlanOptionsMap:GetPlan', getPlan_additionalPlanOptionsMap - 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 Glue job. For example, to set inferSchema to true, pass the following key value pair:
```
--additional-plan-options-map '{"inferSchema":"true"}'
```

$sel:language:GetPlan', getPlan_language - The programming language of the code to perform the mapping.

GetPlan, getPlan_location - The parameters for the mapping.

$sel:sinks:GetPlan', getPlan_sinks - The target tables.

GetPlan, getPlan_mapping - The list of mappings from a source table to target tables.

GetPlan, getPlan_source - The source table.

Request Lenses

getPlan_additionalPlanOptionsMap :: Lens' GetPlan (Maybe (HashMap Text Text)) Source #

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 Glue job. For example, to set inferSchema to true, pass the following key value pair:
```
--additional-plan-options-map '{"inferSchema":"true"}'
```

getPlan_language :: Lens' GetPlan (Maybe Language) Source #

The programming language of the code to perform the mapping.

getPlan_location :: Lens' GetPlan (Maybe Location) Source #

The parameters for the mapping.

getPlan_sinks :: Lens' GetPlan (Maybe [CatalogEntry]) Source #

The target tables.

getPlan_mapping :: Lens' GetPlan [MappingEntry] Source #

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

getPlan_source :: Lens' GetPlan CatalogEntry Source #

The source table.

Destructuring the Response

data GetPlanResponse Source #

See: newGetPlanResponse smart constructor.

Constructors

GetPlanResponse'
Fields pythonScript :: Maybe Text A Python script to perform the mapping. scalaCode :: Maybe Text The Scala code to perform the mapping. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan Associated Types type Rep GetPlanResponse :: Type -> Type # Methods from :: GetPlanResponse -> Rep GetPlanResponse x # to :: Rep GetPlanResponse x -> GetPlanResponse #
Read GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods readsPrec :: Int -> ReadS GetPlanResponse # readList :: ReadS [GetPlanResponse] # readPrec :: ReadPrec GetPlanResponse # readListPrec :: ReadPrec [GetPlanResponse] #
Show GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods showsPrec :: Int -> GetPlanResponse -> ShowS # show :: GetPlanResponse -> String # showList :: [GetPlanResponse] -> ShowS #
NFData GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods rnf :: GetPlanResponse -> () #
Eq GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan Methods (==) :: GetPlanResponse -> GetPlanResponse -> Bool # (/=) :: GetPlanResponse -> GetPlanResponse -> Bool #
type Rep GetPlanResponse Source #
Instance details Defined in Amazonka.Glue.GetPlan type Rep GetPlanResponse = D1 ('MetaData "GetPlanResponse" "Amazonka.Glue.GetPlan" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetPlanResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pythonScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scalaCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetPlanResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetPlanResponse'`
-> GetPlanResponse

Create a value of GetPlanResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pythonScript:GetPlanResponse', getPlanResponse_pythonScript - A Python script to perform the mapping.

$sel:scalaCode:GetPlanResponse', getPlanResponse_scalaCode - The Scala code to perform the mapping.

$sel:httpStatus:GetPlanResponse', getPlanResponse_httpStatus - The response's http status code.

Response Lenses

getPlanResponse_pythonScript :: Lens' GetPlanResponse (Maybe Text) Source #

A Python script to perform the mapping.

getPlanResponse_scalaCode :: Lens' GetPlanResponse (Maybe Text) Source #

The Scala code to perform the mapping.

getPlanResponse_httpStatus :: Lens' GetPlanResponse Int Source #

The response's http status code.