CreateStreamUrl

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.

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

Pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

Required: Yes

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.

Type: String

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

Pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

Required: Yes

A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its AWS 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.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

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

Required: Yes

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

Type: String

Valid Values: WebRTC

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

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.

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [_a-zA-Z][_a-zA-Z0-9]*

Value Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

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.

Type: String

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

Pattern: [\x21-\x7E]+

Required: No

A 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

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

Type: DisplayConfiguration object

Required: No

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.

Type: String

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

Pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/.+

Required: No

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

Type: Integer

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

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [_a-zA-Z][_a-zA-Z0-9]*

Value Length Constraints: Minimum length of 0. Maximum length of 4096.

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

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

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

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

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

Type: DisplayConfiguration object

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

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.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

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

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

Type: String

Valid Values: WebRTC

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

Type: Integer

Valid Range: Minimum value of 0.

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.

Type: String

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

Pattern: arn:aws[a-zA-Z-]*:iam::\d{12}:role/.+

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.

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

Type: String

Valid Values: ACTIVE | EXPIRED | REVOKED | LIMIT_REACHED

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:

Type: String

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

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

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.

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

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

Type: Integer

Valid Range: Minimum value of 1.

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.

HTTP Status Code: 403

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

The service encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

The resource specified in the request was not found. Correct the request before you try again.

HTTP Status Code: 404

The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.

HTTP Status Code: 402

The request was denied due to request throttling. Retry the request after the suggested wait time.

HTTP Status Code: 429

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.

HTTP Status Code: 400