Amazonka.Nimble.StopStreamingSession

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.

Creating a Request

data StopStreamingSession

See: newStopStreamingSession smart constructor.

Constructors

StopStreamingSession'

Fields

• clientToken :: Maybe Text

  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.

• volumeRetentionMode :: Maybe VolumeRetentionMode

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

• sessionId :: Text

  The streaming session ID for the StopStreamingSessionRequest.

• studioId :: Text

  The studioId for the StopStreamingSessionRequest.

Instances

ToJSON StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

toJSON :: StopStreamingSession -> Value

toEncoding :: StopStreamingSession -> Encoding

toJSONList :: [StopStreamingSession] -> Value

toEncodingList :: [StopStreamingSession] -> Encoding

ToHeaders StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

toHeaders :: StopStreamingSession -> [Header]

ToPath StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

toPath :: StopStreamingSession -> ByteString

ToQuery StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

toQuery :: StopStreamingSession -> QueryString

AWSRequest StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Associated Types

type AWSResponse StopStreamingSession

Methods

request :: (Service -> Service) -> StopStreamingSession -> Request StopStreamingSession

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopStreamingSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopStreamingSession)))

Generic StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Associated Types

type Rep StopStreamingSession :: Type -> Type

Methods

from :: StopStreamingSession -> Rep StopStreamingSession x

to :: Rep StopStreamingSession x -> StopStreamingSession

Read StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

readsPrec :: Int -> ReadS StopStreamingSession

readList :: ReadS [StopStreamingSession]

readPrec :: ReadPrec StopStreamingSession

readListPrec :: ReadPrec [StopStreamingSession]

Show StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

showsPrec :: Int -> StopStreamingSession -> ShowS

show :: StopStreamingSession -> String

showList :: [StopStreamingSession] -> ShowS

NFData StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

rnf :: StopStreamingSession -> ()

Eq StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

(==) :: StopStreamingSession -> StopStreamingSession -> Bool

(/=) :: StopStreamingSession -> StopStreamingSession -> Bool

Hashable StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

Methods

hashWithSalt :: Int -> StopStreamingSession -> Int

hash :: StopStreamingSession -> Int

type AWSResponse StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

type AWSResponse StopStreamingSession = StopStreamingSessionResponse

type Rep StopStreamingSession

Defined in Amazonka.Nimble.StopStreamingSession

type Rep StopStreamingSession = D1 ('MetaData "StopStreamingSession" "Amazonka.Nimble.StopStreamingSession" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "StopStreamingSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeRetentionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeRetentionMode))) :*: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStopStreamingSession

Arguments

:: Text

StopStreamingSession

-> Text

StopStreamingSession

-> StopStreamingSession

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)

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)

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

The streaming session ID for the StopStreamingSessionRequest.

stopStreamingSession_studioId :: Lens' StopStreamingSession Text

The studioId for the StopStreamingSessionRequest.

Destructuring the Response

data StopStreamingSessionResponse

See: newStopStreamingSessionResponse smart constructor.

Constructors

StopStreamingSessionResponse'

Fields

• session :: Maybe StreamingSession
• httpStatus :: Int

  The response's http status code.

Instances

Generic StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

Associated Types

type Rep StopStreamingSessionResponse :: Type -> Type

Methods

from :: StopStreamingSessionResponse -> Rep StopStreamingSessionResponse x

to :: Rep StopStreamingSessionResponse x -> StopStreamingSessionResponse

Read StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

Methods

readsPrec :: Int -> ReadS StopStreamingSessionResponse

readList :: ReadS [StopStreamingSessionResponse]

readPrec :: ReadPrec StopStreamingSessionResponse

readListPrec :: ReadPrec [StopStreamingSessionResponse]

Show StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

Methods

showsPrec :: Int -> StopStreamingSessionResponse -> ShowS

show :: StopStreamingSessionResponse -> String

showList :: [StopStreamingSessionResponse] -> ShowS

NFData StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

Methods

rnf :: StopStreamingSessionResponse -> ()

Eq StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

Methods

(==) :: StopStreamingSessionResponse -> StopStreamingSessionResponse -> Bool

(/=) :: StopStreamingSessionResponse -> StopStreamingSessionResponse -> Bool

type Rep StopStreamingSessionResponse

Defined in Amazonka.Nimble.StopStreamingSession

type Rep StopStreamingSessionResponse = D1 ('MetaData "StopStreamingSessionResponse" "Amazonka.Nimble.StopStreamingSession" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "StopStreamingSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingSession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopStreamingSessionResponse

Arguments

:: Int

$sel:httpStatus:StopStreamingSessionResponse'

-> StopStreamingSessionResponse

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)

Undocumented member.

stopStreamingSessionResponse_httpStatus :: Lens' StopStreamingSessionResponse Int

The response's http status code.