/AWS1/CL_GMZGETSTREAMURLOUTPUT¶
GetStreamUrlOutput
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/GMZARN /AWS1/GMZARN¶
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].
Optional arguments:¶
iv_streamurlid TYPE /AWS1/GMZID /AWS1/GMZID¶
The unique identifier for the stream URL resource, for example
su-1AB2C3De4.
iv_streamurl TYPE /AWS1/GMZSTREAMSESSTREAMURL /AWS1/GMZSTREAMSESSTREAMURL¶
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.
iv_status TYPE /AWS1/GMZSTREAMURLSTATUS /AWS1/GMZSTREAMURLSTATUS¶
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.
iv_statusreason TYPE /AWS1/GMZSTREAMURLSTATUSREASON /AWS1/GMZSTREAMURLSTATUSREASON¶
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.
iv_expiresat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP¶
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).
iv_createdat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP¶
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).
iv_usagelimit TYPE /AWS1/GMZUSAGELIMIT /AWS1/GMZUSAGELIMIT¶
The maximum number of times the stream URL can start a stream session.
iv_remaininguses TYPE /AWS1/GMZREMAININGUSES /AWS1/GMZREMAININGUSES¶
The number of times the stream URL can still be used to start a stream session.
iv_streamgrouparn TYPE /AWS1/GMZARN /AWS1/GMZARN¶
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.
iv_applicationarn TYPE /AWS1/GMZARN /AWS1/GMZARN¶
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.
iv_protocol TYPE /AWS1/GMZPROTOCOL /AWS1/GMZPROTOCOL¶
The data transport protocol used for stream sessions started from this stream URL.
it_locations TYPE /AWS1/CL_GMZLOCATIONLIST_W=>TT_LOCATIONLIST TT_LOCATIONLIST¶
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.
iv_sessionlengthseconds TYPE /AWS1/GMZSESSIONLENGTHSECONDS /AWS1/GMZSESSIONLENGTHSECONDS¶
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
iv_description TYPE /AWS1/GMZDESCRIPTION /AWS1/GMZDESCRIPTION¶
The descriptive label for the stream URL.
it_additionallaunchargs TYPE /AWS1/CL_GMZGAMELAUNCHARGLST_W=>TT_GAMELAUNCHARGLIST TT_GAMELAUNCHARGLIST¶
The command-line arguments passed to the application when a stream session starts.
it_addlenvironmentvariables TYPE /AWS1/CL_GMZENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES¶
The environment variables made available to the application when a stream session starts.
iv_rolearn TYPE /AWS1/GMZIAMROLEARN /AWS1/GMZIAMROLEARN¶
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.
io_displayconfiguration TYPE REF TO /AWS1/CL_GMZDISPLAYCONF /AWS1/CL_GMZDISPLAYCONF¶
The display settings, such as resolution, for stream sessions started from this stream URL.
it_streamsessions TYPE /AWS1/CL_GMZSTREAMSESSSUMMARY=>TT_STREAMSESSIONSUMMARYLIST TT_STREAMSESSIONSUMMARYLIST¶
A list of the stream sessions that have been started through this stream URL.
Queryable Attributes¶
Arn¶
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].
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
StreamUrlId¶
The unique identifier for the stream URL resource, for example
su-1AB2C3De4.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMURLID() |
Getter for STREAMURLID, with configurable default |
ASK_STREAMURLID() |
Getter for STREAMURLID w/ exceptions if field has no value |
HAS_STREAMURLID() |
Determine if STREAMURLID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMURL() |
Getter for STREAMURL, with configurable default |
ASK_STREAMURL() |
Getter for STREAMURL w/ exceptions if field has no value |
HAS_STREAMURL() |
Determine if STREAMURL has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRESAT() |
Getter for EXPIRESAT, with configurable default |
ASK_EXPIRESAT() |
Getter for EXPIRESAT w/ exceptions if field has no value |
HAS_EXPIRESAT() |
Determine if EXPIRESAT has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
UsageLimit¶
The maximum number of times the stream URL can start a stream session.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USAGELIMIT() |
Getter for USAGELIMIT, with configurable default |
ASK_USAGELIMIT() |
Getter for USAGELIMIT w/ exceptions if field has no value |
HAS_USAGELIMIT() |
Determine if USAGELIMIT has a value |
RemainingUses¶
The number of times the stream URL can still be used to start a stream session.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REMAININGUSES() |
Getter for REMAININGUSES, with configurable default |
ASK_REMAININGUSES() |
Getter for REMAININGUSES w/ exceptions if field has no value |
HAS_REMAININGUSES() |
Determine if REMAININGUSES has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMGROUPARN() |
Getter for STREAMGROUPARN, with configurable default |
ASK_STREAMGROUPARN() |
Getter for STREAMGROUPARN w/ exceptions if field has no valu |
HAS_STREAMGROUPARN() |
Determine if STREAMGROUPARN has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONARN() |
Getter for APPLICATIONARN, with configurable default |
ASK_APPLICATIONARN() |
Getter for APPLICATIONARN w/ exceptions if field has no valu |
HAS_APPLICATIONARN() |
Determine if APPLICATIONARN has a value |
Protocol¶
The data transport protocol used for stream sessions started from this stream URL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROTOCOL() |
Getter for PROTOCOL, with configurable default |
ASK_PROTOCOL() |
Getter for PROTOCOL w/ exceptions if field has no value |
HAS_PROTOCOL() |
Determine if PROTOCOL has a value |
Locations¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOCATIONS() |
Getter for LOCATIONS, with configurable default |
ASK_LOCATIONS() |
Getter for LOCATIONS w/ exceptions if field has no value |
HAS_LOCATIONS() |
Determine if LOCATIONS has a value |
SessionLengthSeconds¶
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONLENGTHSECONDS() |
Getter for SESSIONLENGTHSECONDS, with configurable default |
ASK_SESSIONLENGTHSECONDS() |
Getter for SESSIONLENGTHSECONDS w/ exceptions if field has n |
HAS_SESSIONLENGTHSECONDS() |
Determine if SESSIONLENGTHSECONDS has a value |
Description¶
The descriptive label for the stream URL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
AdditionalLaunchArgs¶
The command-line arguments passed to the application when a stream session starts.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDITIONALLAUNCHARGS() |
Getter for ADDITIONALLAUNCHARGS, with configurable default |
ASK_ADDITIONALLAUNCHARGS() |
Getter for ADDITIONALLAUNCHARGS w/ exceptions if field has n |
HAS_ADDITIONALLAUNCHARGS() |
Determine if ADDITIONALLAUNCHARGS has a value |
AdditionalEnvironmentVariables¶
The environment variables made available to the application when a stream session starts.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDLENVIRONMENTVARIABLES() |
Getter for ADDLENVIRONMENTVARIABLES, with configurable defau |
ASK_ADDLENVIRONMENTVARIABLES() |
Getter for ADDLENVIRONMENTVARIABLES w/ exceptions if field h |
HAS_ADDLENVIRONMENTVARIABLES() |
Determine if ADDLENVIRONMENTVARIABLES has a value |
RoleArn¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
DisplayConfiguration¶
The display settings, such as resolution, for stream sessions started from this stream URL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYCONFIGURATION() |
Getter for DISPLAYCONFIGURATION |
StreamSessions¶
A list of the stream sessions that have been started through this stream URL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMSESSIONS() |
Getter for STREAMSESSIONS, with configurable default |
ASK_STREAMSESSIONS() |
Getter for STREAMSESSIONS w/ exceptions if field has no valu |
HAS_STREAMSESSIONS() |
Determine if STREAMSESSIONS has a value |