Skip to content

Start Session

emrserverless_start_session R Documentation

Creates and starts a new session on the specified application

Description

Creates and starts a new session on the specified application. The application must be in the STARTED state or have AutoStart enabled, and have interactive sessions enabled. This operation is supported for EMR release 7.13.0 and later.

Usage

emrserverless_start_session(applicationId, clientToken,
  executionRoleArn, configurationOverrides, tags, idleTimeoutMinutes,
  name)

Arguments

applicationId

[required] The ID of the application on which to start the session.

clientToken

[required] 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 token, the server returns the successful response without performing the operation again.

executionRoleArn

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

configurationOverrides

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

tags

The tags to assign to the session.

idleTimeoutMinutes

The idle timeout in minutes for the session. After the session remains idle for this duration, Amazon EMR Serverless automatically terminates it.

name

The optional name for the session.

Value

A list with the following syntax:

list(
  applicationId = "string",
  sessionId = "string",
  arn = "string"
)

Request syntax

svc$start_session(
  applicationId = "string",
  clientToken = "string",
  executionRoleArn = "string",
  configurationOverrides = list(
    runtimeConfiguration = list(
      list(
        classification = "string",
        properties = list(
          "string"
        ),
        configurations = list()
      )
    )
  ),
  tags = list(
    "string"
  ),
  idleTimeoutMinutes = 123,
  name = "string"
)