CreateStreamingURL
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.
Request Syntax
{
"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 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.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- FleetName
-
The name of the fleet.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- SessionContext
-
The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- StackName
-
The name of the stack.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- UserId
-
The identifier of the user.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 32.
Pattern:
[\w+=,.@-]*Required: Yes
- 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.
Type: Long
Required: No
Response Syntax
{
"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
-
The elapsed time, in seconds after the Unix epoch, when 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:
