Amazonka.Nimble.StartStreamingSession

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.

Creating a Request

data StartStreamingSession

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

ToJSON StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

toJSON :: StartStreamingSession -> Value

toEncoding :: StartStreamingSession -> Encoding

toJSONList :: [StartStreamingSession] -> Value

toEncodingList :: [StartStreamingSession] -> Encoding

ToHeaders StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

toHeaders :: StartStreamingSession -> [Header]

ToPath StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

toPath :: StartStreamingSession -> ByteString

ToQuery StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

toQuery :: StartStreamingSession -> QueryString

AWSRequest StartStreamingSession

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

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

Defined in Amazonka.Nimble.StartStreamingSession

Methods

readsPrec :: Int -> ReadS StartStreamingSession

readList :: ReadS [StartStreamingSession]

readPrec :: ReadPrec StartStreamingSession

readListPrec :: ReadPrec [StartStreamingSession]

Show StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

showsPrec :: Int -> StartStreamingSession -> ShowS

show :: StartStreamingSession -> String

showList :: [StartStreamingSession] -> ShowS

NFData StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

rnf :: StartStreamingSession -> ()

Eq StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

(==) :: StartStreamingSession -> StartStreamingSession -> Bool

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

Hashable StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

Methods

hashWithSalt :: Int -> StartStreamingSession -> Int

hash :: StartStreamingSession -> Int

type AWSResponse StartStreamingSession

Defined in Amazonka.Nimble.StartStreamingSession

type AWSResponse StartStreamingSession = StartStreamingSessionResponse

type Rep StartStreamingSession

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

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)

The ID of the backup.

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

startStreamingSession_sessionId :: Lens' StartStreamingSession Text

The streaming session ID for the StartStreamingSessionRequest.

startStreamingSession_studioId :: Lens' StartStreamingSession Text

The studio ID for the StartStreamingSessionRequest.

Destructuring the Response

data StartStreamingSessionResponse

See: newStartStreamingSessionResponse smart constructor.

Constructors

StartStreamingSessionResponse'

Fields

• session :: Maybe StreamingSession
• httpStatus :: Int

  The response's http status code.

Instances

Generic StartStreamingSessionResponse

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

Defined in Amazonka.Nimble.StartStreamingSession

Methods

readsPrec :: Int -> ReadS StartStreamingSessionResponse

readList :: ReadS [StartStreamingSessionResponse]

readPrec :: ReadPrec StartStreamingSessionResponse

readListPrec :: ReadPrec [StartStreamingSessionResponse]

Show StartStreamingSessionResponse

Defined in Amazonka.Nimble.StartStreamingSession

Methods

showsPrec :: Int -> StartStreamingSessionResponse -> ShowS

show :: StartStreamingSessionResponse -> String

showList :: [StartStreamingSessionResponse] -> ShowS

NFData StartStreamingSessionResponse

Defined in Amazonka.Nimble.StartStreamingSession

Methods

rnf :: StartStreamingSessionResponse -> ()

Eq StartStreamingSessionResponse

Defined in Amazonka.Nimble.StartStreamingSession

Methods

(==) :: StartStreamingSessionResponse -> StartStreamingSessionResponse -> Bool

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

type Rep StartStreamingSessionResponse

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

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)

Undocumented member.

startStreamingSessionResponse_httpStatus :: Lens' StartStreamingSessionResponse Int

The response's http status code.