[ aws . emr ]

list-sessions

Description

Lists the sessions on a cluster. You can filter the results by session state. Newer sessions are returned first.

See also: AWS API Documentation

list-sessions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Sessions

Synopsis

  list-sessions
--cluster-id <value>
[--session-states <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--cluster-id (string) [required]

The ID of the cluster to list sessions for.

Constraints:

• max: 256

--session-states (list)

An optional filter that limits the results to sessions in the specified states.

(string)

Possible values:

• SUBMITTED
• STARTING
• STARTED
• IDLE
• BUSY
• TERMINATING
• TERMINATED
• FAILED

Syntax:

"string" "string" ...

--max-results (integer)

The maximum number of sessions to return in each page of results.

Constraints:

• min: 1
• max: 100

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Sessions -> (list)

The sessions that match the request.

(structure)

Detailed information about a Spark Connect session.

Id -> (string) [required]

The ID of the session.

Constraints:

• min: 0
• max: 256

ClusterId -> (string) [required]

The ID of the cluster that the session belongs to.

Constraints:

• max: 256

Name -> (string)

The name of the session, if one was provided at creation time.

Constraints:

• min: 0
• max: 256
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the session.

Constraints:

• min: 20
• max: 2048

State -> (string) [required]

The current state of the session. Valid values are SUBMITTED , STARTING , STARTED , IDLE , BUSY , TERMINATING , TERMINATED , and FAILED .

Possible values:

• SUBMITTED
• STARTING
• STARTED
• IDLE
• BUSY
• TERMINATING
• TERMINATED
• FAILED

StateChangeReason -> (string)

A human-readable message describing the most recent state change.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ReleaseLabel -> (string)

The Amazon EMR release label of the cluster that the session is running on.

Constraints:

• min: 0
• max: 256
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

Constraints:

• min: 20
• max: 2048
• pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$

AccountId -> (string)

The Amazon Web Services account ID that owns the session.

Constraints:

• min: 0
• max: 256
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

CreatedAt -> (timestamp)

The date and time that the session was created.

UpdatedAt -> (timestamp)

The date and time that the session was last updated.

StartedAt -> (timestamp)

The date and time that the session entered the STARTED state.

EndedAt -> (timestamp)

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

IdleSince -> (timestamp)

The date and time that the session last entered the IDLE state.

EngineConfigurations -> (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)

MonitoringConfiguration -> (structure)

The monitoring configuration for the session.

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.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

LogStreamNamePrefix -> (string)

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

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

EncryptionKeyArn -> (string)

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

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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)

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

value -> (list)

(string)

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

EncryptionKeyArn -> (string)

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

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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)

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

value -> (list)

(string)

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

SessionIdleTimeoutInMinutes -> (long)

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

CertificateAuthority -> (structure)

The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.

CertificateArn -> (string)

The Amazon Resource Name (ARN) of the certificate authority in Amazon Web Services Private CA that issued the Spark Connect server certificate.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

CertificateData -> (string)

The PEM-encoded root CA certificate data. Provide this certificate to your client’s trust store when connecting directly to the Spark Connect server over VPC peering.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ServerUrl -> (string)

The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.

Constraints:

• min: 0
• max: 10280
• pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Tags -> (list)

The tags associated with 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 .

NextToken -> (string)

The pagination token to use in a subsequent ListSessions call to retrieve the next page of results. This field is absent when there are no more results.