POST

/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop

http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop

Transitions sessions from the <code>READY</code> state into the <code>STOPPED</code> state. The <code>STOP_IN_PROGRESS</code> state is the intermediate state between the <code>READY</code> and <code>STOPPED</code> states.

Access Token Required: API Key

Path Parameters

sessionIdstringrequired

The streaming session ID for the <code>StopStreamingSessionRequest</code>.

studioIdstringrequired

The studioId for the StopStreamingSessionRequest.

Body Params

volumeRetentionModestring

Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}