/AWS1/CL_GMZSTREAMURLSUMMARY¶
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.
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_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.
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 |
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 |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_STREAMURLSUMMARYLIST¶
TYPES TT_STREAMURLSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMZSTREAMURLSUMMARY WITH DEFAULT KEY
.