AWS CLI Command Reference

[ aws . gameliftstreams ]

list-stream-urls

Description

Retrieves a list of the stream URLs in the current Amazon Web Services Region for your Amazon Web Services account. You can filter the results by status or by stream group. Use the pagination parameters to retrieve results as a set of sequential pages. If you delete the stream group or application that backs a stream URL, this operation updates that stream URL’s status to REVOKED .

See also: AWS API Documentation

list-stream-urls is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Items

Synopsis

  list-stream-urls
[--status <value>]
[--stream-group-identifier <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--status (string)

Filters the list to stream URLs with the specified status.

  • 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

--stream-group-identifier (string)

Filters the list to stream URLs that belong to the specified stream group.

This value is 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 .

Constraints:

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Items -> (list)

A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.

(structure)

Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl .

Arn -> (string) [required]

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}):([^: ]*)

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-_.!+@/ ]*

NextToken -> (string)

A token that marks the start of the next sequential page of results. If an operation doesn’t return a token, you’ve reached the end of the list.
© Copyright 2026, Amazon Web Services. Created using Sphinx.