AWS CLI Command Reference

[ aws . gameliftstreams ]

create-stream-url

Description

Creates a stream URL that grants temporary access to a stream session in a web browser without requiring an Amazon Web Services account or client integration.

You can use the stream URL to start a stream session up to the number of times set by UsageLimit , until it expires after UrlExpiresAfterMinutes . Each successful use starts a new stream session.

To make the request idempotent, provide a ClientToken .

See also: AWS API Documentation

Synopsis

  create-stream-url
--identifier <value>
--application-identifier <value>
--protocol <value>
--url-expires-after-minutes <value>
[--usage-limit <value>]
[--description <value>]
--locations <value>
[--session-length-seconds <value>]
[--additional-launch-args <value>]
[--additional-environment-variables <value>]
[--role-arn <value>]
[--display-configuration <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--identifier (string) [required]

An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 . Example ID: sg-1AB2C3De4 .

The stream session runs in this stream group.

Constraints:

  • min: 1
  • max: 128
  • pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

--application-identifier (string) [required]

An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 . Example ID: a-9ZY8X7Wv6 .

This application must be associated with the stream group.

Constraints:

  • min: 1
  • max: 128
  • pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

--protocol (string) [required]

The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC .

Possible values:

  • WebRTC

--url-expires-after-minutes (integer) [required]

The number of minutes after creation that the stream URL remains valid. After this period, the status of the stream URL changes to EXPIRED and it can no longer start stream sessions. The minimum is 1 minute. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 1

--usage-limit (integer)

The maximum number of times the stream URL can start a stream session. Each successful use reduces the remaining uses by one. The minimum is 1, and the default is 1. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 1

--description (string)

A descriptive label for the stream URL.

Constraints:

  • min: 1
  • max: 80
  • pattern: [a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*

--locations (list) [required]

A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 1

(string)

Constraints:

  • min: 1
  • max: 20
  • pattern: [a-zA-Z0-9-]+

Syntax:

"string" "string" ...

--session-length-seconds (integer)

The maximum length of time, in seconds, that a stream session started from this stream URL can run. Valid values are 1-86400 seconds (1 second to 24 hours). The default is 43200 seconds (12 hours).

Constraints:

  • min: 1
  • max: 86400

--additional-launch-args (list)

A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.

AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

Constraints:

  • min: 0
  • max: 100

(string)

Syntax:

"string" "string" ...

--additional-environment-variables (map)

A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.

Note

If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.

AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [_a-zA-Z][_a-zA-Z0-9]*

value -> (string)

Constraints:

  • min: 0
  • max: 4096

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--role-arn (string)

The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/.+

--display-configuration (structure)

The display settings, such as resolution, for stream sessions started from this stream URL.

Resolution -> (structure)

The resolution to apply to the stream session’s virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.

Width -> (integer) [required]

The width of the stream session’s virtual monitor, in pixels. The value must be an even number.

Constraints:

  • min: 320
  • max: 4096

Height -> (integer) [required]

The height of the stream session’s virtual monitor, in pixels. The value must be an even number.

Constraints:

  • min: 320
  • max: 4096

Shorthand Syntax:

Resolution={Width=integer,Height=integer}

JSON Syntax:

{
  "Resolution": {
    "Width": integer,
    "Height": integer
  }
}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure this request is idempotent. If you retry a request with the same ClientToken , Amazon GameLift Streams returns the original response without performing the operation again.

Constraints:

  • min: 32
  • max: 128
  • pattern: [\x21-\x7E]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Arn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID] .

Constraints:

  • min: 1
  • max: 128
  • pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

StreamUrlId -> (string)

The unique identifier for the stream URL resource, for example su-1AB2C3De4 .

Constraints:

  • min: 1
  • max: 32
  • pattern: [a-zA-Z0-9-]+

StreamUrl -> (string)

The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.

Constraints:

  • min: 1
  • max: 2048

Status -> (string)

The current status of the stream URL. Possible statuses include the following:

  • ACTIVE : The stream URL is valid and can start stream sessions.
  • EXPIRED : The stream URL has passed its expiration time and can no longer start stream sessions.
  • REVOKED : The stream URL was revoked and can no longer start stream sessions.
  • LIMIT_REACHED : The stream URL has been used the maximum number of times and can no longer start stream sessions.

Possible values:

  • ACTIVE
  • EXPIRED
  • REVOKED
  • LIMIT_REACHED

StatusReason -> (string)

Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED . Possible values include the following:

  • userRevoked : You revoked the stream URL.
  • revokedAndTerminatingSessions : You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.
  • revokedAndSessionsTerminated : You revoked the stream URL and its running stream sessions have ended.
  • streamGroupDeleted : The stream group was deleted, which revoked the stream URL.
  • applicationDeleted : The application was deleted, which revoked the stream URL.

Possible values:

  • userRevoked
  • revokedAndTerminatingSessions
  • revokedAndSessionsTerminated
  • streamGroupDeleted
  • applicationDeleted

ExpiresAt -> (timestamp)

The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

CreatedAt -> (timestamp)

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

UsageLimit -> (integer)

The maximum number of times the stream URL can start a stream session.

Constraints:

  • min: 1

RemainingUses -> (integer)

The number of times the stream URL can still be used to start a stream session.

Constraints:

  • min: 0

StreamGroupArn -> (string)

The stream group that runs the stream sessions.

This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4 .

Constraints:

  • min: 1
  • max: 128
  • pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

ApplicationArn -> (string)

The application that runs in the stream sessions.

This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .

Constraints:

  • min: 1
  • max: 128
  • pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Protocol -> (string)

The data transport protocol used for stream sessions started from this stream URL.

Possible values:

  • WebRTC

Locations -> (list)

The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 1

(string)

Constraints:

  • min: 1
  • max: 20
  • pattern: [a-zA-Z0-9-]+

SessionLengthSeconds -> (integer)

The maximum length of time, in seconds, that a stream session started from this stream URL can run.

Constraints:

  • min: 1
  • max: 86400

Description -> (string)

The descriptive label for the stream URL.

Constraints:

  • min: 1
  • max: 80
  • pattern: [a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*

AdditionalLaunchArgs -> (list)

The command-line arguments passed to the application when a stream session starts.

Constraints:

  • min: 0
  • max: 100

(string)

AdditionalEnvironmentVariables -> (map)

The environment variables made available to the application when a stream session starts.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [_a-zA-Z][_a-zA-Z0-9]*

value -> (string)

Constraints:

  • min: 0
  • max: 4096

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide .

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/.+

DisplayConfiguration -> (structure)

The display settings, such as resolution, for stream sessions started from this stream URL.

Resolution -> (structure)

The resolution to apply to the stream session’s virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.

Width -> (integer) [required]

The width of the stream session’s virtual monitor, in pixels. The value must be an even number.

Constraints:

  • min: 320
  • max: 4096

Height -> (integer) [required]

The height of the stream session’s virtual monitor, in pixels. The value must be an even number.

Constraints:

  • min: 320
  • max: 4096
© Copyright 2026, Amazon Web Services. Created using Sphinx.