Class: Aws::Glue::Types::CreateSessionRequest

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::CreateSessionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass CreateSessionRequest data as a hash:

{
  id: "NameString", # required
  description: "DescriptionString",
  role: "OrchestrationRoleArn", # required
  command: { # required
    name: "NameString",
    python_version: "PythonVersionString",
  },
  timeout: 1,
  idle_timeout: 1,
  default_arguments: {
    "OrchestrationNameString" => "OrchestrationArgumentsValue",
  },
  connections: {
    connections: ["GenericString"],
  },
  max_capacity: 1.0,
  number_of_workers: 1,
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
  security_configuration: "NameString",
  glue_version: "GlueVersionString",
  tags: {
    "TagKey" => "TagValue",
  },
  request_origin: "OrchestrationNameString",
}

Request to create a new session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command ⇒ Types::SessionCommand

  The `SessionCommand` that runs the job.

• #connections ⇒ Types::ConnectionsList

  The number of connections to use for the session.

• #default_arguments ⇒ Hash<String,String>

  A map array of key-value pairs.

• #description ⇒ String

  The description of the session.

• #glue_version ⇒ String

  The Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

• #id ⇒ String

  The ID of the session request.

• #idle_timeout ⇒ Integer

  The number of seconds when idle before request times out.

• #max_capacity ⇒ Float

  The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs.

• #number_of_workers ⇒ Integer

  The number of workers to use for the session.

• #request_origin ⇒ String

  The origin of the request.

• #role ⇒ String

  The IAM Role ARN.

• #security_configuration ⇒ String

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

• #tags ⇒ Hash<String,String>

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

• #timeout ⇒ Integer

  The number of seconds before request times out.

• #worker_type ⇒ String

  The Worker Type.

Instance Attribute Details

#command ⇒ Types::SessionCommand

The `SessionCommand` that runs the job.

Returns:

• (Types::SessionCommand)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#connections ⇒ Types::ConnectionsList

The number of connections to use for the session.

Returns:

• (Types::ConnectionsList)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#default_arguments ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the session.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the session request.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#idle_timeout ⇒ Integer

The number of seconds when idle before request times out.

Returns:

• (Integer)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ Float

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.

Returns:

• (Float)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_workers ⇒ Integer

The number of workers to use for the session.

Returns:

• (Integer)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#request_origin ⇒ String

The origin of the request.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

The IAM Role ARN

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#security_configuration ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

The number of seconds before request times out.

Returns:

• (Integer)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end

#worker_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 4931

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin)
  SENSITIVE = []
  include Aws::Structure
end