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

Amazonka.Nimble.StartStreamingSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

Synopsis

data StartStreamingSession = StartStreamingSession' {
- backupId :: Maybe Text
- clientToken :: Maybe Text
- sessionId :: Text
- studioId :: Text
}
newStartStreamingSession :: Text -> Text -> StartStreamingSession
startStreamingSession_backupId :: Lens' StartStreamingSession (Maybe Text)
startStreamingSession_clientToken :: Lens' StartStreamingSession (Maybe Text)
startStreamingSession_sessionId :: Lens' StartStreamingSession Text
startStreamingSession_studioId :: Lens' StartStreamingSession Text
data StartStreamingSessionResponse = StartStreamingSessionResponse' {
- session :: Maybe StreamingSession
- httpStatus :: Int
}
newStartStreamingSessionResponse :: Int -> StartStreamingSessionResponse
startStreamingSessionResponse_session :: Lens' StartStreamingSessionResponse (Maybe StreamingSession)
startStreamingSessionResponse_httpStatus :: Lens' StartStreamingSessionResponse Int

Creating a Request

data StartStreamingSession Source #

See: newStartStreamingSession smart constructor.

Constructors

StartStreamingSession'

Fields

backupId :: Maybe Text
The ID of the backup.
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.
sessionId :: Text
The streaming session ID for the StartStreamingSessionRequest.
studioId :: Text
The studio ID for the StartStreamingSessionRequest.

Instances

Instances details

ToJSON StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods toJSON :: StartStreamingSession -> Value # toEncoding :: StartStreamingSession -> Encoding # toJSONList :: [StartStreamingSession] -> Value # toEncodingList :: [StartStreamingSession] -> Encoding #
ToHeaders StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods toHeaders :: StartStreamingSession -> [Header] #
ToPath StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods toPath :: StartStreamingSession -> ByteString #
ToQuery StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods toQuery :: StartStreamingSession -> QueryString #
AWSRequest StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Associated Types type AWSResponse StartStreamingSession # Methods request :: (Service -> Service) -> StartStreamingSession -> Request StartStreamingSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartStreamingSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartStreamingSession))) #
Generic StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Associated Types type Rep StartStreamingSession :: Type -> Type # Methods from :: StartStreamingSession -> Rep StartStreamingSession x # to :: Rep StartStreamingSession x -> StartStreamingSession #
Read StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods readsPrec :: Int -> ReadS StartStreamingSession # readList :: ReadS [StartStreamingSession] # readPrec :: ReadPrec StartStreamingSession # readListPrec :: ReadPrec [StartStreamingSession] #
Show StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods showsPrec :: Int -> StartStreamingSession -> ShowS # show :: StartStreamingSession -> String # showList :: [StartStreamingSession] -> ShowS #
NFData StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods rnf :: StartStreamingSession -> () #
Eq StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods (==) :: StartStreamingSession -> StartStreamingSession -> Bool # (/=) :: StartStreamingSession -> StartStreamingSession -> Bool #
Hashable StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods hashWithSalt :: Int -> StartStreamingSession -> Int # hash :: StartStreamingSession -> Int #
type AWSResponse StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession type AWSResponse StartStreamingSession = StartStreamingSessionResponse
type Rep StartStreamingSession Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession type Rep StartStreamingSession = D1 ('MetaData "StartStreamingSession" "Amazonka.Nimble.StartStreamingSession" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "StartStreamingSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartStreamingSession Source #

Arguments

:: Text	`StartStreamingSession`
-> Text	`StartStreamingSession`
-> StartStreamingSession

Create a value of StartStreamingSession 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:

StartStreamingSession, startStreamingSession_backupId - The ID of the backup.

$sel:clientToken:StartStreamingSession', startStreamingSession_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.

StartStreamingSession, startStreamingSession_sessionId - The streaming session ID for the StartStreamingSessionRequest.

StartStreamingSession, startStreamingSession_studioId - The studio ID for the StartStreamingSessionRequest.

Request Lenses

startStreamingSession_backupId :: Lens' StartStreamingSession (Maybe Text) Source #

The ID of the backup.

startStreamingSession_clientToken :: Lens' StartStreamingSession (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.

startStreamingSession_sessionId :: Lens' StartStreamingSession Text Source #

The streaming session ID for the StartStreamingSessionRequest.

startStreamingSession_studioId :: Lens' StartStreamingSession Text Source #

The studio ID for the StartStreamingSessionRequest.

Destructuring the Response

data StartStreamingSessionResponse Source #

See: newStartStreamingSessionResponse smart constructor.

Constructors

StartStreamingSessionResponse'
Fields session :: Maybe StreamingSession httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Associated Types type Rep StartStreamingSessionResponse :: Type -> Type # Methods from :: StartStreamingSessionResponse -> Rep StartStreamingSessionResponse x # to :: Rep StartStreamingSessionResponse x -> StartStreamingSessionResponse #
Read StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods readsPrec :: Int -> ReadS StartStreamingSessionResponse # readList :: ReadS [StartStreamingSessionResponse] # readPrec :: ReadPrec StartStreamingSessionResponse # readListPrec :: ReadPrec [StartStreamingSessionResponse] #
Show StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods showsPrec :: Int -> StartStreamingSessionResponse -> ShowS # show :: StartStreamingSessionResponse -> String # showList :: [StartStreamingSessionResponse] -> ShowS #
NFData StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods rnf :: StartStreamingSessionResponse -> () #
Eq StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession Methods (==) :: StartStreamingSessionResponse -> StartStreamingSessionResponse -> Bool # (/=) :: StartStreamingSessionResponse -> StartStreamingSessionResponse -> Bool #
type Rep StartStreamingSessionResponse Source #
Instance details Defined in Amazonka.Nimble.StartStreamingSession type Rep StartStreamingSessionResponse = D1 ('MetaData "StartStreamingSessionResponse" "Amazonka.Nimble.StartStreamingSession" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "StartStreamingSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingSession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartStreamingSessionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartStreamingSessionResponse'`
-> StartStreamingSessionResponse

Create a value of StartStreamingSessionResponse 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:StartStreamingSessionResponse', startStreamingSessionResponse_session - Undocumented member.

$sel:httpStatus:StartStreamingSessionResponse', startStreamingSessionResponse_httpStatus - The response's http status code.

Response Lenses

startStreamingSessionResponse_session :: Lens' StartStreamingSessionResponse (Maybe StreamingSession) Source #

Undocumented member.

startStreamingSessionResponse_httpStatus :: Lens' StartStreamingSessionResponse Int Source #

The response's http status code.