Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr ]

start-session¶

Description¶

Creates and starts a new Spark Connect session on the specified cluster. The cluster must be in the RUNNING or WAITING state and have sessions enabled. This operation is supported in Amazon EMR Spark 8.0.0 and later.

Synopsis¶

  start-session
[--name <value>]
--cluster-id <value>
[--execution-role-arn <value>]
[--engine-configurations <value>]
[--monitoring-configuration <value>]
[--session-idle-timeout-in-minutes <value>]
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--name (string)

An optional name for the session.

--cluster-id (string)

The ID of the cluster on which to start the session.

--execution-role-arn (string)

The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

--engine-configurations (list)

The configuration overrides for the session. Only runtime configuration overrides are supported.

(structure)

Note
Amazon EMR releases 4.x or later.

An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .

Classification -> (string)

The classification within a configuration.

Configurations -> (list)

A list of additional configurations to apply within a configuration object.

(structure)

Note
Amazon EMR releases 4.x or later.

An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications .

Classification -> (string)

The classification within a configuration.

Properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

Properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

JSON Syntax:

[
  {
    "Classification": "string",
    "Configurations": [
      {
        "Classification": "string",
        "Configurations": ,
        "Properties": {"string": "string"
          ...}
      }
      ...
    ],
    "Properties": {"string": "string"
      ...}
  }
  ...
]

--monitoring-configuration (structure)

The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.

CloudWatchLoggingConfiguration -> (structure)

The CloudWatch Logs configuration for the session.

Enabled -> (boolean)

Whether CloudWatch Logs is enabled for the session.

LogGroup -> (string)

The name of the log group where session logs are published.

LogStreamNamePrefix -> (string)

The prefix applied to the log stream name where session logs are published.

EncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs.

LogTypes -> (map)

A map of log component names (for example, SPARK_DRIVER , SPARK_EXECUTOR ) to the list of log types to publish for that component (for example, stdout , stderr ).

key -> (string)

value -> (list)

(string)

ManagedLoggingConfiguration -> (structure)

The Amazon EMR-managed logging configuration for the session.

Enabled -> (boolean)

Whether Amazon EMR-managed logging is enabled for the session.

EncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the managed logs.

S3LoggingConfiguration -> (structure)

The Amazon S3 logging configuration for the session.

Enabled -> (boolean)

Whether Amazon S3 logging is enabled for the session.

LogUri -> (string)

The Amazon S3 destination URI where session logs are published.

EncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt logs published to Amazon S3.

LogTypes -> (map)

A map of log component names (for example, SPARK_DRIVER , SPARK_EXECUTOR ) to the list of log types to publish for that component (for example, stdout , stderr ).

key -> (string)

value -> (list)

(string)

JSON Syntax:

{
  "CloudWatchLoggingConfiguration": {
    "Enabled": true|false,
    "LogGroup": "string",
    "LogStreamNamePrefix": "string",
    "EncryptionKeyArn": "string",
    "LogTypes": {"string": ["string", ...]
      ...}
  },
  "ManagedLoggingConfiguration": {
    "Enabled": true|false,
    "EncryptionKeyArn": "string"
  },
  "S3LoggingConfiguration": {
    "Enabled": true|false,
    "LogUri": "string",
    "EncryptionKeyArn": "string",
    "LogTypes": {"string": ["string", ...]
      ...}
  }
}

--session-idle-timeout-in-minutes (long)

The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.

--client-request-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.

--tags (list)

The tags to assign to the session.

(structure)

A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters .

Key -> (string)

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .

Value -> (string)

A user-defined value, which is optional in a tag. For more information, see Tag Clusters .

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

Id -> (string)

The output contains the ID of the session.

ClusterId -> (string)

The ID of the cluster that the session was started on.

Arn -> (string)

The output contains the ARN of the session.

AccountId -> (string)

The Amazon Web Services account ID that owns the session.

State -> (string)

The state of the session at the time the request returned. When a session is first created, it enters the SUBMITTED state.

Table of Contents

Feedback

User Guide

Note:

start-session¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶