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

CreateImageBuilderStreamingURL

Creates a URL to start an image builder streaming session.

Request Syntax

{
   "Name": "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.

Name

The name of the image builder.

Type: String

Length Constraints: Minimum length of 1.

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

OperationNotPermittedException

The attempted operation is not permitted.

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: