libZSservicesZSamazonka-nimbleZSamazonka-nimble
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Nimble.CreateStreamingSession

Description

Creates a streaming session in a studio.

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

Synopsis

Creating a Request

data CreateStreamingSession Source #

A collection of streaming sessions.

See: newCreateStreamingSession smart constructor.

Constructors

CreateStreamingSession' 

Fields

  • ownedBy :: Maybe Text

    The user ID of the user that owns the streaming session.

  • clientToken :: Maybe Text

    To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

  • ec2InstanceType :: Maybe StreamingInstanceType

    The EC2 Instance type used for the streaming session.

  • launchProfileId :: Maybe Text

    The launch profile ID.

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

  • studioId :: Text

    The studio ID.

Instances

Instances details
Eq CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

(==) :: CreateStreamingSession -> CreateStreamingSession -> Bool #

(/=) :: CreateStreamingSession -> CreateStreamingSession -> Bool #

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 #

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 #

NFData CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

rnf :: CreateStreamingSession -> () #

Hashable CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

hashWithSalt :: Int -> CreateStreamingSession -> Int #

hash :: CreateStreamingSession -> Int #

ToJSON CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

toJSON :: CreateStreamingSession -> Value #

toEncoding :: CreateStreamingSession -> Encoding #

toJSONList :: [CreateStreamingSession] -> Value #

toEncodingList :: [CreateStreamingSession] -> Encoding #

AWSRequest CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Associated Types

type AWSResponse CreateStreamingSession #

Methods

request :: CreateStreamingSession -> Request CreateStreamingSession #

response :: MonadResource m => Logger -> Service -> Proxy CreateStreamingSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStreamingSession))) #

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 #

type Rep CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

type Rep CreateStreamingSession = D1 ('MetaData "CreateStreamingSession" "Amazonka.Nimble.CreateStreamingSession" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" 'False) (C1 ('MetaCons "CreateStreamingSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ownedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ec2InstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingInstanceType)))) :*: ((S1 ('MetaSel ('Just "launchProfileId") '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 "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateStreamingSession Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

type AWSResponse CreateStreamingSession = CreateStreamingSessionResponse

newCreateStreamingSession Source #

Arguments

:: Text

$sel:studioId: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:ownedBy:CreateStreamingSession', createStreamingSession_ownedBy - The user ID of the user that owns the streaming session.

$sel:clientToken:CreateStreamingSession', createStreamingSession_clientToken - To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

$sel:ec2InstanceType:CreateStreamingSession', createStreamingSession_ec2InstanceType - The EC2 Instance type used for the streaming session.

$sel:launchProfileId:CreateStreamingSession', createStreamingSession_launchProfileId - The launch profile ID.

$sel:streamingImageId:CreateStreamingSession', createStreamingSession_streamingImageId - The ID of the streaming image.

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

$sel:studioId:CreateStreamingSession', createStreamingSession_studioId - The studio ID.

Request Lenses

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

The user ID of the user that owns the streaming session.

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

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

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

The EC2 Instance type used for the streaming session.

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

The launch profile ID.

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_studioId :: Lens' CreateStreamingSession Text Source #

The studio ID.

Destructuring the Response

data CreateStreamingSessionResponse Source #

See: newCreateStreamingSessionResponse smart constructor.

Constructors

CreateStreamingSessionResponse' 

Fields

Instances

Instances details
Eq CreateStreamingSessionResponse Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

(==) :: CreateStreamingSessionResponse -> CreateStreamingSessionResponse -> Bool #

(/=) :: CreateStreamingSessionResponse -> CreateStreamingSessionResponse -> Bool #

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 #

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 #

NFData CreateStreamingSessionResponse Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

Methods

rnf :: CreateStreamingSessionResponse -> () #

type Rep CreateStreamingSessionResponse Source # 
Instance details

Defined in Amazonka.Nimble.CreateStreamingSession

type Rep CreateStreamingSessionResponse = D1 ('MetaData "CreateStreamingSessionResponse" "Amazonka.Nimble.CreateStreamingSession" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" '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.