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 |
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' {}
- 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' {}
- newCreateStreamingSessionResponse :: Int -> CreateStreamingSessionResponse
- createStreamingSessionResponse_session :: Lens' CreateStreamingSessionResponse (Maybe StreamingSession)
- createStreamingSessionResponse_httpStatus :: Lens' CreateStreamingSessionResponse Int
Creating a Request
data CreateStreamingSession Source #
See: newCreateStreamingSession
smart constructor.
CreateStreamingSession' | |
|
Instances
newCreateStreamingSession Source #
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.
CreateStreamingSessionResponse' | |
|
Instances
Generic CreateStreamingSessionResponse Source # | |
Read CreateStreamingSessionResponse Source # | |
Show CreateStreamingSessionResponse Source # | |
Defined in Amazonka.Nimble.CreateStreamingSession | |
NFData CreateStreamingSessionResponse Source # | |
Defined in Amazonka.Nimble.CreateStreamingSession rnf :: CreateStreamingSessionResponse -> () # | |
Eq CreateStreamingSessionResponse Source # | |
type Rep CreateStreamingSessionResponse Source # | |
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 #
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.