Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

CreateStreamingURL

Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.

Request Syntax

Copy
{ "ApplicationId": "string", "FleetName": "string", "SessionContext": "string", "StackName": "string", "UserId": "string", "Validity": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationId

The ID of the application that must be launched after the session starts.

Type: String

Length Constraints: Minimum length of 1.

Required: No

FleetName

The fleet for which the URL is generated.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

SessionContext

The sessionContext of the streaming URL.

Type: String

Length Constraints: Minimum length of 1.

Required: No

StackName

The stack for which the URL is generated.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

UserId

A unique user ID for whom the URL is generated.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 32.

Required: Yes

Validity

The duration up to which the URL returned by this action is valid. The input can be any numeric value in seconds between 1 and 604800 seconds.

Type: Long

Required: No

Response Syntax

Copy
{ "Expires": number, "StreamingURL": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Expires

Elapsed seconds after the Unix epoch, at which time this URL expires.

Type: Timestamp

StreamingURL

The URL to start the AppStream 2.0 streaming session.

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotAvailableException

The specified resource exists and is not in use, but isn't available.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: