get-session¶

Description¶

Displays detailed information about a session.

Synopsis¶

  get-session
--application-id <value>
--session-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--application-id (string) [required]

The ID of the application that the session belongs to.

Constraints:

min: 1

max: 64

pattern: [0-9a-z]+

--session-id (string) [required]

The ID of the session.

Constraints:

min: 1

max: 64

pattern: [0-9a-z]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

session -> (structure)

The output displays information about the session.

applicationId -> (string) [required]

The ID of the application that the session belongs to.

Constraints:

min: 1

max: 64

pattern: [0-9a-z]+

sessionId -> (string) [required]

The ID of the session.

Constraints:

min: 1

max: 64

pattern: [0-9a-z]+

arn -> (string) [required]

The Amazon Resource Name (ARN) of the session.

Constraints:

min: 60

max: 1024

pattern: arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\d{12}):\/applications\/[0-9a-zA-Z]+\/sessions\/[0-9a-zA-Z]+

name -> (string)

The optional name of the session.

Constraints:

min: 1

max: 256

pattern: .*\S.*

state -> (string) [required]

The state of the session.

Possible values:

SUBMITTED

STARTING

STARTED

IDLE

BUSY

FAILED

TERMINATING

TERMINATED

stateDetails -> (string) [required]

Additional details about the current state of the session.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

releaseLabel -> (string) [required]

The Amazon EMR release label associated with the session.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9._/-]+

executionRoleArn -> (string) [required]

The Amazon Resource Name (ARN) of the execution role for the session.

Constraints:

min: 20

max: 2048

pattern: arn:(aws[a-zA-Z0-9-]*):iam::([0-9]{12}):(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)

createdBy -> (string) [required]

The IAM principal that created the session.

Constraints:

min: 20

max: 2048

pattern: arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+

createdAt -> (timestamp) [required]

The date and time that the session was created.

updatedAt -> (timestamp) [required]

The date and time that the session was last updated.

startedAt -> (timestamp)

The date and time that the session moved to a running state.

endedAt -> (timestamp)

The date and time that the session was terminated or failed.

idleSince -> (timestamp)

The date and time that the session became idle.

configurationOverrides -> (structure)

The configuration overrides for the session, including runtime configuration properties.

runtimeConfiguration -> (list)

The runtime configuration for the session. Contains Spark configuration properties specified at session creation time.

Constraints:

min: 0

max: 100

(structure)

A configuration specification to be used when provisioning an application. 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.

classification -> (string) [required]

The classification within a configuration.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

properties -> (map)

A set of properties specified within a configuration classification.

Constraints:

min: 0

max: 100

key -> (string)

Constraints:

min: 1

max: 1024

pattern: .*\S.*

value -> (string)

Constraints:

min: 0

max: 1024

pattern: .*\S.*

configurations -> (list)

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

Constraints:

min: 0

max: 100

(structure)

A configuration specification to be used when provisioning an application. 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.

classification -> (string) [required]

The classification within a configuration.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

properties -> (map)

A set of properties specified within a configuration classification.

Constraints:

min: 0

max: 100

key -> (string)

Constraints:

min: 1

max: 1024

pattern: .*\S.*

value -> (string)

Constraints:

min: 0

max: 1024

pattern: .*\S.*

networkConfiguration -> (structure)

The network configuration for customer VPC connectivity for the session.

subnetIds -> (list)

The array of subnet Ids for customer VPC connectivity.

Constraints:

min: 0

max: 16

(string)

Constraints:

min: 1

max: 32

pattern: [-0-9a-zA-Z]+.*

securityGroupIds -> (list)

The array of security group Ids for customer VPC connectivity.

Constraints:

min: 0

max: 5

(string)

Constraints:

min: 1

max: 32

pattern: [-0-9a-zA-Z]+.*

idleTimeoutMinutes -> (long)

The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.

Constraints:

min: 0

max: 1000000

tags -> (map)

The tags assigned to the session.

Constraints:

min: 0

max: 200

key -> (string)

Constraints:

min: 1

max: 128

pattern: [A-Za-z0-9 /_.:=+@-]+

value -> (string)

Constraints:

min: 0

max: 256

pattern: [A-Za-z0-9 /_.:=+@-]*

totalResourceUtilization -> (structure)

The aggregate vCPU, memory, and storage resources used from the time the session starts to execute, until the time the session terminates, rounded up to the nearest second.

vCPUHour -> (double)

The aggregated vCPU used per hour from the time job start executing till the time job is terminated.

memoryGBHour -> (double)

The aggregated memory used per hour from the time job start executing till the time job is terminated.

storageGBHour -> (double)

The aggregated storage used per hour from the time job start executing till the time job is terminated.

billedResourceUtilization -> (structure)

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the session. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.

vCPUHour -> (double)

The aggregated vCPU used per hour from the time the job starts executing until the job is terminated.

memoryGBHour -> (double)

The aggregated memory used per hour from the time the job starts executing until the job is terminated.

storageGBHour -> (double)

The aggregated storage used per hour from the time the job starts executing until the job is terminated.

totalExecutionDurationSeconds -> (long)

The total execution duration of the session in seconds.

Table of Contents

Feedback

User Guide