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.CreateStreamingSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.

Synopsis

data CreateStreamingSession = CreateStreamingSession' {
- clientToken :: Maybe Text
- ec2InstanceType :: Maybe StreamingInstanceType
- ownedBy :: Maybe Text
- streamingImageId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- launchProfileId :: Text
- studioId :: Text
}
newCreateStreamingSession :: Text -> Text -> CreateStreamingSession
createStreamingSession_clientToken :: Lens' CreateStreamingSession (Maybe Text)
createStreamingSession_ec2InstanceType :: Lens' CreateStreamingSession (Maybe StreamingInstanceType)
createStreamingSession_ownedBy :: Lens' CreateStreamingSession (Maybe Text)
createStreamingSession_streamingImageId :: Lens' CreateStreamingSession (Maybe Text)
createStreamingSession_tags :: Lens' CreateStreamingSession (Maybe (HashMap Text Text))
createStreamingSession_launchProfileId :: Lens' CreateStreamingSession Text
createStreamingSession_studioId :: Lens' CreateStreamingSession Text
data CreateStreamingSessionResponse = CreateStreamingSessionResponse' {
- session :: Maybe StreamingSession
- httpStatus :: Int
}
newCreateStreamingSessionResponse :: Int -> CreateStreamingSessionResponse
createStreamingSessionResponse_session :: Lens' CreateStreamingSessionResponse (Maybe StreamingSession)
createStreamingSessionResponse_httpStatus :: Lens' CreateStreamingSessionResponse Int

Creating a Request

data CreateStreamingSession Source #

See: newCreateStreamingSession smart constructor.

Constructors

CreateStreamingSession'

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.
ec2InstanceType :: Maybe StreamingInstanceType
The EC2 Instance type used for the streaming session.
ownedBy :: Maybe Text
The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
streamingImageId :: Maybe Text
The ID of the streaming image.
tags :: Maybe (HashMap Text Text)
A collection of labels, in the form of key-value pairs, that apply to this resource.
launchProfileId :: Text
The ID of the launch profile used to control access from the streaming session.
studioId :: Text
The studio ID.

Instances

Instances details

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

newCreateStreamingSession Source #

Arguments

:: Text	`CreateStreamingSession`
-> Text	`CreateStreamingSession`
-> CreateStreamingSession

Create a value of CreateStreamingSession 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:CreateStreamingSession', createStreamingSession_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.

CreateStreamingSession, createStreamingSession_ec2InstanceType - The EC2 Instance type used for the streaming session.

CreateStreamingSession, createStreamingSession_ownedBy - The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

CreateStreamingSession, createStreamingSession_streamingImageId - The ID of the streaming image.

CreateStreamingSession, createStreamingSession_tags - A collection of labels, in the form of key-value pairs, that apply to this resource.

CreateStreamingSession, createStreamingSession_launchProfileId - The ID of the launch profile used to control access from the streaming session.

CreateStreamingSession, createStreamingSession_studioId - The studio ID.

Request Lenses

createStreamingSession_clientToken :: Lens' CreateStreamingSession (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.

createStreamingSession_ec2InstanceType :: Lens' CreateStreamingSession (Maybe StreamingInstanceType) Source #

The EC2 Instance type used for the streaming session.

createStreamingSession_ownedBy :: Lens' CreateStreamingSession (Maybe Text) Source #

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

createStreamingSession_streamingImageId :: Lens' CreateStreamingSession (Maybe Text) Source #

The ID of the streaming image.

createStreamingSession_tags :: Lens' CreateStreamingSession (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStreamingSession_launchProfileId :: Lens' CreateStreamingSession Text Source #

The ID of the launch profile used to control access from the streaming session.

createStreamingSession_studioId :: Lens' CreateStreamingSession Text Source #

The studio ID.

Destructuring the Response

data CreateStreamingSessionResponse Source #

See: newCreateStreamingSessionResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateStreamingSessionResponse Source #

Arguments

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

Create a value of CreateStreamingSessionResponse 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:CreateStreamingSessionResponse', createStreamingSessionResponse_session - The session.

$sel:httpStatus:CreateStreamingSessionResponse', createStreamingSessionResponse_httpStatus - The response's http status code.

Response Lenses

createStreamingSessionResponse_session :: Lens' CreateStreamingSessionResponse (Maybe StreamingSession) Source #

The session.

createStreamingSessionResponse_httpStatus :: Lens' CreateStreamingSessionResponse Int Source #

The response's http status code.