Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

create-session

Description

Creates a new session.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-session
--id <value>
[--description <value>]
--role <value>
--command <value>
[--timeout <value>]
[--idle-timeout <value>]
[--default-arguments <value>]
[--connections <value>]
[--max-capacity <value>]
[--number-of-workers <value>]
[--worker-type <value>]
[--security-configuration <value>]
[--glue-version <value>]
[--tags <value>]
[--request-origin <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the session request.

--description (string)

The description of the session.

--role (string)

The IAM Role ARN

--command (structure)

The SessionCommand that runs the job.

Name -> (string)

Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.

PythonVersion -> (string)

Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

Shorthand Syntax:

Name=string,PythonVersion=string

JSON Syntax:

{
  "Name": "string",
  "PythonVersion": "string"
}

--timeout (integer)

The number of seconds before request times out.

--idle-timeout (integer)

The number of seconds when idle before request times out.

--default-arguments (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--connections (structure)

The number of connections to use for the session.

Connections -> (list)

A list of connections used by the job.

(string)

Shorthand Syntax:

Connections=string,string

JSON Syntax:

{
  "Connections": ["string", ...]
}

--max-capacity (double)

The number of AWS 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.

--number-of-workers (integer)

The number of workers to use for the session.

--worker-type (string)

The Worker Type. Can be one of G.1X, G.2X, Standard

Possible values:

  • Standard
  • G.1X
  • G.2X

--security-configuration (string)

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

--glue-version (string)

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

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--request-origin (string)

The origin of the request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Session -> (structure)

Returns the session object in the response.

Id -> (string)

The ID of the session.

CreatedOn -> (timestamp)

The time and date when the session was created.

Status -> (string)

The session status.

ErrorMessage -> (string)

The error message displayed during the session.

Description -> (string)

The description of the session.

Role -> (string)

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

Command -> (structure)

The command object.See SessionCommand.

Name -> (string)

Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.

PythonVersion -> (string)

Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

DefaultArguments -> (map)

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

key -> (string)

value -> (string)

Connections -> (structure)

The number of connections used for the session.

Connections -> (list)

A list of connections used by the job.

(string)

Progress -> (double)

The code execution progress of the session.

MaxCapacity -> (double)

The number of AWS 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.

SecurityConfiguration -> (string)

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

GlueVersion -> (string)

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