Stop Streaming Session
nimblestudio_stop_streaming_session | R Documentation |
Transitions sessions from the READY state into the STOPPED state¶
Description¶
Transitions sessions from the READY
state into the STOPPED
state.
The STOP_IN_PROGRESS
state is the intermediate state between the
READY
and STOPPED
states.
Usage¶
Arguments¶
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
sessionId
[required] The streaming session ID for the
StopStreamingSessionRequest
.studioId
[required] The studioId for the StopStreamingSessionRequest.
volumeRetentionMode
Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
Value¶
A list with the following syntax:
list(
session = list(
arn = "string",
automaticTerminationMode = "DEACTIVATED"|"ACTIVATED",
backupMode = "AUTOMATIC"|"DEACTIVATED",
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
ec2InstanceType = "string",
launchProfileId = "string",
maxBackupsToRetain = 123,
ownedBy = "string",
sessionId = "string",
sessionPersistenceMode = "DEACTIVATED"|"ACTIVATED",
startedAt = as.POSIXct(
"2015-01-01"
),
startedBy = "string",
startedFromBackupId = "string",
state = "CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"READY"|"DELETED"|"CREATE_FAILED"|"DELETE_FAILED"|"STOP_IN_PROGRESS"|"START_IN_PROGRESS"|"STOPPED"|"STOP_FAILED"|"START_FAILED",
statusCode = "STREAMING_SESSION_READY"|"STREAMING_SESSION_DELETED"|"STREAMING_SESSION_CREATE_IN_PROGRESS"|"STREAMING_SESSION_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"INSUFFICIENT_CAPACITY"|"ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"|"NETWORK_CONNECTION_ERROR"|"INITIALIZATION_SCRIPT_ERROR"|"DECRYPT_STREAMING_IMAGE_ERROR"|"NETWORK_INTERFACE_ERROR"|"STREAMING_SESSION_STOPPED"|"STREAMING_SESSION_STARTED"|"STREAMING_SESSION_STOP_IN_PROGRESS"|"STREAMING_SESSION_START_IN_PROGRESS"|"AMI_VALIDATION_ERROR",
statusMessage = "string",
stopAt = as.POSIXct(
"2015-01-01"
),
stoppedAt = as.POSIXct(
"2015-01-01"
),
stoppedBy = "string",
streamingImageId = "string",
tags = list(
"string"
),
terminateAt = as.POSIXct(
"2015-01-01"
),
updatedAt = as.POSIXct(
"2015-01-01"
),
updatedBy = "string",
volumeConfiguration = list(
iops = 123,
size = 123,
throughput = 123
),
volumeRetentionMode = "RETAIN"|"DELETE"
)
)