StreamUrlSummary

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.

Note

In the following list, the required parameters are described first.

Arn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Required: Yes

ApplicationArn

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Required: No

CreatedAt

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

Type: Timestamp

Required: No

Description

The descriptive label for the stream URL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: [a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*

Required: No

ExpiresAt

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

Type: Timestamp

Required: No

RemainingUses

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

SessionLengthSeconds

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 86400.

Required: No

Status

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.

Type: String

Valid Values: ACTIVE | EXPIRED | REVOKED | LIMIT_REACHED

Required: No

StatusReason

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.

Type: String

Valid Values: userRevoked | revokedAndTerminatingSessions | revokedAndSessionsTerminated | streamGroupDeleted | applicationDeleted

Required: No

StreamGroupArn

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Required: No

StreamUrl

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

StreamUrlId

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

Type: String

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

Pattern: [a-zA-Z0-9-]+

Required: No

UsageLimit

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

StreamUrlSummary

Contents

Note

See Also