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-serverless ]
get-session¶
Synopsis¶
get-session
--application-id <value>
--session-id <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¶
--application-id (string)
The ID of the application that the session belongs to.
--session-id (string)
The ID of the session.
--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¶
session -> (structure)
The output displays information about the session.
applicationId -> (string)
The ID of the application that the session belongs to.sessionId -> (string)
The ID of the session.arn -> (string)
The Amazon Resource Name (ARN) of the session.name -> (string)
The optional name of the session.state -> (string)
The state of the session.stateDetails -> (string)
Additional details about the current state of the session.releaseLabel -> (string)
The Amazon EMR release label associated with the session.executionRoleArn -> (string)
The Amazon Resource Name (ARN) of the execution role for the session.createdBy -> (string)
The IAM principal that created the session.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 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.
(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)
The classification within a configuration.properties -> (map)
A set of properties specified within a configuration classification.
key -> (string)
value -> (string)
configurations -> (list)
A list of additional configurations to apply within a configuration object.
(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)
The classification within a configuration.properties -> (map)
A set of properties specified within a configuration classification.
key -> (string)
value -> (string)
networkConfiguration -> (structure)
The network configuration for customer VPC connectivity for the session.
subnetIds -> (list)
The array of subnet Ids for customer VPC connectivity.
(string)
securityGroupIds -> (list)
The array of security group Ids for customer VPC connectivity.
(string)
idleTimeoutMinutes -> (long)
The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.tags -> (map)
The tags assigned to the session.
key -> (string)
value -> (string)
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.