Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data StopStreamingSession = StopStreamingSession' {}
- newStopStreamingSession :: Text -> Text -> StopStreamingSession
- stopStreamingSession_clientToken :: Lens' StopStreamingSession (Maybe Text)
- stopStreamingSession_volumeRetentionMode :: Lens' StopStreamingSession (Maybe VolumeRetentionMode)
- stopStreamingSession_sessionId :: Lens' StopStreamingSession Text
- stopStreamingSession_studioId :: Lens' StopStreamingSession Text
- data StopStreamingSessionResponse = StopStreamingSessionResponse' {}
- newStopStreamingSessionResponse :: Int -> StopStreamingSessionResponse
- stopStreamingSessionResponse_session :: Lens' StopStreamingSessionResponse (Maybe StreamingSession)
- stopStreamingSessionResponse_httpStatus :: Lens' StopStreamingSessionResponse Int
Creating a Request
data StopStreamingSession Source #
See: newStopStreamingSession
smart constructor.
StopStreamingSession' | |
|
Instances
newStopStreamingSession Source #
Create a value of StopStreamingSession
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:StopStreamingSession'
, stopStreamingSession_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.
StopStreamingSession
, stopStreamingSession_volumeRetentionMode
- Adds additional instructions to a streaming session stop action to
either retain the EBS volumes or delete the EBS volumes.
StopStreamingSession
, stopStreamingSession_sessionId
- The streaming session ID for the StopStreamingSessionRequest
.
StopStreamingSession
, stopStreamingSession_studioId
- The studioId for the StopStreamingSessionRequest.
Request Lenses
stopStreamingSession_clientToken :: Lens' StopStreamingSession (Maybe Text) Source #
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.
stopStreamingSession_volumeRetentionMode :: Lens' StopStreamingSession (Maybe VolumeRetentionMode) Source #
Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
stopStreamingSession_sessionId :: Lens' StopStreamingSession Text Source #
The streaming session ID for the StopStreamingSessionRequest
.
stopStreamingSession_studioId :: Lens' StopStreamingSession Text Source #
The studioId for the StopStreamingSessionRequest.
Destructuring the Response
data StopStreamingSessionResponse Source #
See: newStopStreamingSessionResponse
smart constructor.
StopStreamingSessionResponse' | |
|
Instances
newStopStreamingSessionResponse Source #
Create a value of StopStreamingSessionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:session:StopStreamingSessionResponse'
, stopStreamingSessionResponse_session
- Undocumented member.
$sel:httpStatus:StopStreamingSessionResponse'
, stopStreamingSessionResponse_httpStatus
- The response's http status code.
Response Lenses
stopStreamingSessionResponse_session :: Lens' StopStreamingSessionResponse (Maybe StreamingSession) Source #
Undocumented member.
stopStreamingSessionResponse_httpStatus :: Lens' StopStreamingSessionResponse Int Source #
The response's http status code.