Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppStream.CreateStreamingURL

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

Synopsis

data CreateStreamingURL = CreateStreamingURL' {
- sessionContext :: Maybe Text
- applicationId :: Maybe Text
- validity :: Maybe Integer
- stackName :: Text
- fleetName :: Text
- userId :: Text
}
newCreateStreamingURL :: Text -> Text -> Text -> CreateStreamingURL
createStreamingURL_sessionContext :: Lens' CreateStreamingURL (Maybe Text)
createStreamingURL_applicationId :: Lens' CreateStreamingURL (Maybe Text)
createStreamingURL_validity :: Lens' CreateStreamingURL (Maybe Integer)
createStreamingURL_stackName :: Lens' CreateStreamingURL Text
createStreamingURL_fleetName :: Lens' CreateStreamingURL Text
createStreamingURL_userId :: Lens' CreateStreamingURL Text
data CreateStreamingURLResponse = CreateStreamingURLResponse' {
- streamingURL :: Maybe Text
- expires :: Maybe POSIX
- httpStatus :: Int
}
newCreateStreamingURLResponse :: Int -> CreateStreamingURLResponse
createStreamingURLResponse_streamingURL :: Lens' CreateStreamingURLResponse (Maybe Text)
createStreamingURLResponse_expires :: Lens' CreateStreamingURLResponse (Maybe UTCTime)
createStreamingURLResponse_httpStatus :: Lens' CreateStreamingURLResponse Int

Creating a Request

data CreateStreamingURL Source #

See: newCreateStreamingURL smart constructor.

Constructors

CreateStreamingURL'

Fields

sessionContext :: Maybe Text
The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
applicationId :: Maybe Text
The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
validity :: Maybe Integer
The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
stackName :: Text
The name of the stack.
fleetName :: Text
The name of the fleet.
userId :: Text
The identifier of the user.

Instances

Instances details

Eq CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods (==) :: CreateStreamingURL -> CreateStreamingURL -> Bool # (/=) :: CreateStreamingURL -> CreateStreamingURL -> Bool #
Read CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods readsPrec :: Int -> ReadS CreateStreamingURL # readList :: ReadS [CreateStreamingURL] # readPrec :: ReadPrec CreateStreamingURL # readListPrec :: ReadPrec [CreateStreamingURL] #
Show CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods showsPrec :: Int -> CreateStreamingURL -> ShowS # show :: CreateStreamingURL -> String # showList :: [CreateStreamingURL] -> ShowS #
Generic CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Associated Types type Rep CreateStreamingURL :: Type -> Type # Methods from :: CreateStreamingURL -> Rep CreateStreamingURL x # to :: Rep CreateStreamingURL x -> CreateStreamingURL #
NFData CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods rnf :: CreateStreamingURL -> () #
Hashable CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods hashWithSalt :: Int -> CreateStreamingURL -> Int # hash :: CreateStreamingURL -> Int #
ToJSON CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods toJSON :: CreateStreamingURL -> Value # toEncoding :: CreateStreamingURL -> Encoding # toJSONList :: [CreateStreamingURL] -> Value # toEncodingList :: [CreateStreamingURL] -> Encoding #
AWSRequest CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Associated Types type AWSResponse CreateStreamingURL # Methods request :: CreateStreamingURL -> Request CreateStreamingURL # response :: MonadResource m => Logger -> Service -> Proxy CreateStreamingURL -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStreamingURL))) #
ToHeaders CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods toHeaders :: CreateStreamingURL -> [Header] #
ToPath CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods toPath :: CreateStreamingURL -> ByteString #
ToQuery CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods toQuery :: CreateStreamingURL -> QueryString #
type Rep CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL type Rep CreateStreamingURL = D1 ('MetaData "CreateStreamingURL" "Amazonka.AppStream.CreateStreamingURL" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateStreamingURL'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sessionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "validity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "fleetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateStreamingURL Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL type AWSResponse CreateStreamingURL = CreateStreamingURLResponse

newCreateStreamingURL Source #

Arguments

:: Text	`$sel:stackName:CreateStreamingURL'`
-> Text	`$sel:fleetName:CreateStreamingURL'`
-> Text	`$sel:userId:CreateStreamingURL'`
-> CreateStreamingURL

Create a value of CreateStreamingURL 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:sessionContext:CreateStreamingURL', createStreamingURL_sessionContext - The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

$sel:applicationId:CreateStreamingURL', createStreamingURL_applicationId - The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.

$sel:validity:CreateStreamingURL', createStreamingURL_validity - The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

$sel:stackName:CreateStreamingURL', createStreamingURL_stackName - The name of the stack.

$sel:fleetName:CreateStreamingURL', createStreamingURL_fleetName - The name of the fleet.

$sel:userId:CreateStreamingURL', createStreamingURL_userId - The identifier of the user.

Request Lenses

createStreamingURL_sessionContext :: Lens' CreateStreamingURL (Maybe Text) Source #

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

createStreamingURL_applicationId :: Lens' CreateStreamingURL (Maybe Text) Source #

The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.

createStreamingURL_validity :: Lens' CreateStreamingURL (Maybe Integer) Source #

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

createStreamingURL_stackName :: Lens' CreateStreamingURL Text Source #

The name of the stack.

createStreamingURL_fleetName :: Lens' CreateStreamingURL Text Source #

The name of the fleet.

createStreamingURL_userId :: Lens' CreateStreamingURL Text Source #

The identifier of the user.

Destructuring the Response

data CreateStreamingURLResponse Source #

See: newCreateStreamingURLResponse smart constructor.

Constructors

CreateStreamingURLResponse'
Fields streamingURL :: Maybe Text The URL to start the AppStream 2.0 streaming session. expires :: Maybe POSIX The elapsed time, in seconds after the Unix epoch, when this URL expires. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods (==) :: CreateStreamingURLResponse -> CreateStreamingURLResponse -> Bool # (/=) :: CreateStreamingURLResponse -> CreateStreamingURLResponse -> Bool #
Read CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods readsPrec :: Int -> ReadS CreateStreamingURLResponse # readList :: ReadS [CreateStreamingURLResponse] # readPrec :: ReadPrec CreateStreamingURLResponse # readListPrec :: ReadPrec [CreateStreamingURLResponse] #
Show CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods showsPrec :: Int -> CreateStreamingURLResponse -> ShowS # show :: CreateStreamingURLResponse -> String # showList :: [CreateStreamingURLResponse] -> ShowS #
Generic CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Associated Types type Rep CreateStreamingURLResponse :: Type -> Type # Methods from :: CreateStreamingURLResponse -> Rep CreateStreamingURLResponse x # to :: Rep CreateStreamingURLResponse x -> CreateStreamingURLResponse #
NFData CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL Methods rnf :: CreateStreamingURLResponse -> () #
type Rep CreateStreamingURLResponse Source #
Instance details Defined in Amazonka.AppStream.CreateStreamingURL type Rep CreateStreamingURLResponse = D1 ('MetaData "CreateStreamingURLResponse" "Amazonka.AppStream.CreateStreamingURL" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateStreamingURLResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamingURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateStreamingURLResponse Source #

Arguments

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

Create a value of CreateStreamingURLResponse 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:streamingURL:CreateStreamingURLResponse', createStreamingURLResponse_streamingURL - The URL to start the AppStream 2.0 streaming session.

$sel:expires:CreateStreamingURLResponse', createStreamingURLResponse_expires - The elapsed time, in seconds after the Unix epoch, when this URL expires.

$sel:httpStatus:CreateStreamingURLResponse', createStreamingURLResponse_httpStatus - The response's http status code.

Response Lenses

createStreamingURLResponse_streamingURL :: Lens' CreateStreamingURLResponse (Maybe Text) Source #

The URL to start the AppStream 2.0 streaming session.

createStreamingURLResponse_expires :: Lens' CreateStreamingURLResponse (Maybe UTCTime) Source #

The elapsed time, in seconds after the Unix epoch, when this URL expires.

createStreamingURLResponse_httpStatus :: Lens' CreateStreamingURLResponse Int Source #

The response's http status code.