Session
Information about a session, including the session state, configuration, and timestamps.
Contents
- applicationId
-
The ID of the application that the session belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-z]+Required: Yes
- arn
-
The Amazon Resource Name (ARN) of the session.
Type: String
Length Constraints: Minimum length of 60. Maximum length of 1024.
Pattern:
arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\d{12}):\/applications\/[0-9a-zA-Z]+\/sessions\/[0-9a-zA-Z]+Required: Yes
- createdAt
-
The date and time that the session was created.
Type: Timestamp
Required: Yes
- createdBy
-
The IAM principal that created the session.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+Required: Yes
- executionRoleArn
-
The Amazon Resource Name (ARN) of the execution role for the session.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z0-9-]*):iam::([0-9]{12}):(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)Required: Yes
- releaseLabel
-
The Amazon EMR release label associated with the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9._/-]+Required: Yes
- sessionId
-
The ID of the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-z]+Required: Yes
- state
-
The state of the session.
Type: String
Valid Values:
SUBMITTED | STARTING | STARTED | IDLE | BUSY | FAILED | TERMINATING | TERMINATEDRequired: Yes
- stateDetails
-
Additional details about the current state of the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*Required: Yes
- updatedAt
-
The date and time that the session was last updated.
Type: Timestamp
Required: Yes
- billedResourceUtilization
-
The aggregate vCPU, memory, and storage that AWS 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.
Type: ResourceUtilization object
Required: No
- configurationOverrides
-
The configuration overrides for the session, including runtime configuration properties.
Type: SessionConfigurationOverrides object
Required: No
- endedAt
-
The date and time that the session was terminated or failed.
Type: Timestamp
Required: No
- idleSince
-
The date and time that the session became idle.
Type: Timestamp
Required: No
- idleTimeoutMinutes
-
The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 1000000.
Required: No
- name
-
The optional name of the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.*\S.*Required: No
- networkConfiguration
-
The network configuration for customer VPC connectivity for the session.
Type: NetworkConfiguration object
Required: No
- startedAt
-
The date and time that the session moved to a running state.
Type: Timestamp
Required: No
-
The tags assigned to the session.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[A-Za-z0-9 /_.:=+@-]+Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[A-Za-z0-9 /_.:=+@-]*Required: No
- totalExecutionDurationSeconds
-
The total execution duration of the session in seconds.
Type: Long
Required: No
- totalResourceUtilization
-
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.
Type: TotalResourceUtilization object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: