/AWS1/CL_GMZAPPLICATIONSUMMARY¶
Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/GMZIDENTIFIER /AWS1/GMZIDENTIFIER¶
An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is
arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
Optional arguments:¶
iv_id TYPE /AWS1/GMZID /AWS1/GMZID¶
An ID that uniquely identifies the application resource. Example ID:
a-9ZY8X7Wv6.
iv_description TYPE /AWS1/GMZDESCRIPTION /AWS1/GMZDESCRIPTION¶
A human-readable label for the application. You can edit this value.
iv_status TYPE /AWS1/GMZAPPLICATIONSTATUS /AWS1/GMZAPPLICATIONSTATUS¶
The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. For more information about the error, callGetApplicationand refer toStatusReason.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
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_lastupdatedat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP¶
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC).
io_runtimeenvironment TYPE REF TO /AWS1/CL_GMZRUNTIMEENVIRONMENT /AWS1/CL_GMZRUNTIMEENVIRONMENT¶
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (
Type=UBUNTU, Version=22_04_LTS)For Windows applications
Microsoft Windows Server 2022 Base (
Type=WINDOWS, Version=2022)Proton 9.0-2 (
Type=PROTON, Version=20250516)Proton 8.0-5 (
Type=PROTON, Version=20241007)Proton 8.0-2c (
Type=PROTON, Version=20230704)
Queryable Attributes¶
Arn¶
An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is
arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[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 |
Id¶
An ID that uniquely identifies the application resource. Example ID:
a-9ZY8X7Wv6.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Description¶
A human-readable label for the application. You can edit this value.
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 |
Status¶
The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. For more information about the error, callGetApplicationand refer toStatusReason.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
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 |
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 |
LastUpdatedAt¶
A timestamp that indicates when this resource was last updated. 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_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT, with configurable default |
ASK_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT w/ exceptions if field has no value |
HAS_LASTUPDATEDAT() |
Determine if LASTUPDATEDAT has a value |
RuntimeEnvironment¶
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (
Type=UBUNTU, Version=22_04_LTS)For Windows applications
Microsoft Windows Server 2022 Base (
Type=WINDOWS, Version=2022)Proton 9.0-2 (
Type=PROTON, Version=20250516)Proton 8.0-5 (
Type=PROTON, Version=20241007)Proton 8.0-2c (
Type=PROTON, Version=20230704)
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RUNTIMEENVIRONMENT() |
Getter for RUNTIMEENVIRONMENT |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_APPLICATIONSUMMARYLIST¶
TYPES TT_APPLICATIONSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMZAPPLICATIONSUMMARY WITH DEFAULT KEY
.