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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new session.

Synopsis

data CreateSession = CreateSession' {
- connections :: Maybe ConnectionsList
- defaultArguments :: Maybe (HashMap Text Text)
- description :: Maybe Text
- glueVersion :: Maybe Text
- idleTimeout :: Maybe Natural
- maxCapacity :: Maybe Double
- numberOfWorkers :: Maybe Int
- requestOrigin :: Maybe Text
- securityConfiguration :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- workerType :: Maybe WorkerType
- id :: Text
- role' :: Text
- command :: SessionCommand
}
newCreateSession :: Text -> Text -> SessionCommand -> CreateSession
createSession_connections :: Lens' CreateSession (Maybe ConnectionsList)
createSession_defaultArguments :: Lens' CreateSession (Maybe (HashMap Text Text))
createSession_description :: Lens' CreateSession (Maybe Text)
createSession_glueVersion :: Lens' CreateSession (Maybe Text)
createSession_idleTimeout :: Lens' CreateSession (Maybe Natural)
createSession_maxCapacity :: Lens' CreateSession (Maybe Double)
createSession_numberOfWorkers :: Lens' CreateSession (Maybe Int)
createSession_requestOrigin :: Lens' CreateSession (Maybe Text)
createSession_securityConfiguration :: Lens' CreateSession (Maybe Text)
createSession_tags :: Lens' CreateSession (Maybe (HashMap Text Text))
createSession_timeout :: Lens' CreateSession (Maybe Natural)
createSession_workerType :: Lens' CreateSession (Maybe WorkerType)
createSession_id :: Lens' CreateSession Text
createSession_role :: Lens' CreateSession Text
createSession_command :: Lens' CreateSession SessionCommand
data CreateSessionResponse = CreateSessionResponse' {
- session :: Maybe Session
- httpStatus :: Int
}
newCreateSessionResponse :: Int -> CreateSessionResponse
createSessionResponse_session :: Lens' CreateSessionResponse (Maybe Session)
createSessionResponse_httpStatus :: Lens' CreateSessionResponse Int

Creating a Request

data CreateSession Source #

Request to create a new session.

See: newCreateSession smart constructor.

Constructors

CreateSession'

Fields

connections :: Maybe ConnectionsList
The number of connections to use for the session.
defaultArguments :: Maybe (HashMap Text Text)
A map array of key-value pairs. Max is 75 pairs.
description :: Maybe Text
The description of the session.
glueVersion :: Maybe Text
The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
idleTimeout :: Maybe Natural
The number of seconds when idle before request times out.
maxCapacity :: Maybe Double
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
numberOfWorkers :: Maybe Int
The number of workers of a defined WorkerType to use for the session.
requestOrigin :: Maybe Text
The origin of the request.
securityConfiguration :: Maybe Text
The name of the SecurityConfiguration structure to be used with the session
tags :: Maybe (HashMap Text Text)
The map of key value pairs (tags) belonging to the session.
timeout :: Maybe Natural
The number of seconds before request times out.
workerType :: Maybe WorkerType
The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.
- For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
- For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
- For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
- For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
id :: Text
The ID of the session request.
role' :: Text
The IAM Role ARN
command :: SessionCommand
The SessionCommand that runs the job.

Instances

Instances details

ToJSON CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods toJSON :: CreateSession -> Value # toEncoding :: CreateSession -> Encoding # toJSONList :: [CreateSession] -> Value # toEncodingList :: [CreateSession] -> Encoding #
ToHeaders CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods toHeaders :: CreateSession -> [Header] #
ToPath CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods toPath :: CreateSession -> ByteString #
ToQuery CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods toQuery :: CreateSession -> QueryString #
AWSRequest CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Associated Types type AWSResponse CreateSession # Methods request :: (Service -> Service) -> CreateSession -> Request CreateSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSession))) #
Generic CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Associated Types type Rep CreateSession :: Type -> Type # Methods from :: CreateSession -> Rep CreateSession x # to :: Rep CreateSession x -> CreateSession #
Read CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods readsPrec :: Int -> ReadS CreateSession # readList :: ReadS [CreateSession] # readPrec :: ReadPrec CreateSession # readListPrec :: ReadPrec [CreateSession] #
Show CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods showsPrec :: Int -> CreateSession -> ShowS # show :: CreateSession -> String # showList :: [CreateSession] -> ShowS #
NFData CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods rnf :: CreateSession -> () #
Eq CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods (==) :: CreateSession -> CreateSession -> Bool # (/=) :: CreateSession -> CreateSession -> Bool #
Hashable CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession Methods hashWithSalt :: Int -> CreateSession -> Int # hash :: CreateSession -> Int #
type AWSResponse CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession type AWSResponse CreateSession = CreateSessionResponse
type Rep CreateSession Source #
Instance details Defined in Amazonka.Glue.CreateSession type Rep CreateSession = D1 ('MetaData "CreateSession" "Amazonka.Glue.CreateSession" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "CreateSession'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionsList)) :: (S1 ('MetaSel ('Just "defaultArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "glueVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "idleTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "requestOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SessionCommand))))))

newCreateSession Source #

Arguments

:: Text	`CreateSession`
-> Text	`CreateSession`
-> SessionCommand	`CreateSession`
-> CreateSession

Create a value of CreateSession 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:

CreateSession, createSession_connections - The number of connections to use for the session.

CreateSession, createSession_defaultArguments - A map array of key-value pairs. Max is 75 pairs.

CreateSession, createSession_description - The description of the session.

CreateSession, createSession_glueVersion - The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

$sel:idleTimeout:CreateSession', createSession_idleTimeout - The number of seconds when idle before request times out.

CreateSession, createSession_maxCapacity - The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

CreateSession, createSession_numberOfWorkers - The number of workers of a defined WorkerType to use for the session.

$sel:requestOrigin:CreateSession', createSession_requestOrigin - The origin of the request.

CreateSession, createSession_securityConfiguration - The name of the SecurityConfiguration structure to be used with the session

$sel:tags:CreateSession', createSession_tags - The map of key value pairs (tags) belonging to the session.

CreateSession, createSession_timeout - The number of seconds before request times out.

CreateSession, createSession_workerType - The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.

For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.

CreateSession, createSession_id - The ID of the session request.

CreateSession, createSession_role - The IAM Role ARN

CreateSession, createSession_command - The SessionCommand that runs the job.

Request Lenses

createSession_connections :: Lens' CreateSession (Maybe ConnectionsList) Source #

The number of connections to use for the session.

createSession_defaultArguments :: Lens' CreateSession (Maybe (HashMap Text Text)) Source #

A map array of key-value pairs. Max is 75 pairs.

createSession_description :: Lens' CreateSession (Maybe Text) Source #

The description of the session.

createSession_glueVersion :: Lens' CreateSession (Maybe Text) Source #

The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

createSession_idleTimeout :: Lens' CreateSession (Maybe Natural) Source #

The number of seconds when idle before request times out.

createSession_maxCapacity :: Lens' CreateSession (Maybe Double) Source #

The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

createSession_numberOfWorkers :: Lens' CreateSession (Maybe Int) Source #

The number of workers of a defined WorkerType to use for the session.

createSession_requestOrigin :: Lens' CreateSession (Maybe Text) Source #

The origin of the request.

createSession_securityConfiguration :: Lens' CreateSession (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with the session

createSession_tags :: Lens' CreateSession (Maybe (HashMap Text Text)) Source #

The map of key value pairs (tags) belonging to the session.

createSession_timeout :: Lens' CreateSession (Maybe Natural) Source #

The number of seconds before request times out.

createSession_workerType :: Lens' CreateSession (Maybe WorkerType) Source #

The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.

For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.

createSession_id :: Lens' CreateSession Text Source #

The ID of the session request.

createSession_role :: Lens' CreateSession Text Source #

The IAM Role ARN

createSession_command :: Lens' CreateSession SessionCommand Source #

The SessionCommand that runs the job.

Destructuring the Response

data CreateSessionResponse Source #

See: newCreateSessionResponse smart constructor.

Constructors

CreateSessionResponse'
Fields session :: Maybe Session Returns the session object in the response. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateSessionResponse Source #

Arguments

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

Create a value of CreateSessionResponse 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:session:CreateSessionResponse', createSessionResponse_session - Returns the session object in the response.

$sel:httpStatus:CreateSessionResponse', createSessionResponse_httpStatus - The response's http status code.

Response Lenses

createSessionResponse_session :: Lens' CreateSessionResponse (Maybe Session) Source #

Returns the session object in the response.

createSessionResponse_httpStatus :: Lens' CreateSessionResponse Int Source #

The response's http status code.