/AWS1/CL_GMZUPDAPPLICATIONOUT¶
UpdateApplicationOutput
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/GMZIDENTIFIER /AWS1/GMZIDENTIFIER¶
The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is
arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
Optional arguments:¶
iv_description TYPE /AWS1/GMZDESCRIPTION /AWS1/GMZDESCRIPTION¶
A human-readable label for the application. You can edit this value.
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)
iv_executablepath TYPE /AWS1/GMZEXECUTABLEPATH /AWS1/GMZEXECUTABLEPATH¶
The relative path and file name of the executable file that launches the content for streaming.
it_applicationlogpaths TYPE /AWS1/CL_GMZFILEPATHS_W=>TT_FILEPATHS TT_FILEPATHS¶
Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in
ApplicationLogOutputUriat the end of a stream session. To retrieve stored log files, call GetStreamSession and get theLogFileLocationUri.
iv_applicationlogoutputuri TYPE /AWS1/GMZAPPLICATIONLOGOUTURI /AWS1/GMZAPPLICATIONLOGOUTURI¶
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more
ApplicationLogPaths.
iv_applicationsourceuri TYPE /AWS1/GMZAPPLICATIONSOURCEURI /AWS1/GMZAPPLICATIONSOURCEURI¶
The original Amazon S3 location of uploaded stream content for the application.
iv_id TYPE /AWS1/GMZID /AWS1/GMZID¶
A unique ID value that is assigned to the resource when it's created. Format example:
a-9ZY8X7Wv6.
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. SeeStatusReasonfor more information.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
iv_statusreason TYPE /AWS1/GMZAPPLICATIONSTATUSRSN /AWS1/GMZAPPLICATIONSTATUSRSN¶
A short description of the status reason when the application is in
ERRORstatus.
it_replicationstatuses TYPE /AWS1/CL_GMZREPLICATIONSTATUS=>TT_REPLICATIONSTATUSES TT_REPLICATIONSTATUSES¶
A set of replication statuses for each location.
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).
it_associatedstreamgroups TYPE /AWS1/CL_GMZARNLIST_W=>TT_ARNLIST TT_ARNLIST¶
A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
Queryable Attributes¶
Arn¶
The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it 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 |
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 |
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 |
ExecutablePath¶
The relative path and file name of the executable file that launches the content for streaming.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTABLEPATH() |
Getter for EXECUTABLEPATH, with configurable default |
ASK_EXECUTABLEPATH() |
Getter for EXECUTABLEPATH w/ exceptions if field has no valu |
HAS_EXECUTABLEPATH() |
Determine if EXECUTABLEPATH has a value |
ApplicationLogPaths¶
Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in
ApplicationLogOutputUriat the end of a stream session. To retrieve stored log files, call GetStreamSession and get theLogFileLocationUri.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONLOGPATHS() |
Getter for APPLICATIONLOGPATHS, with configurable default |
ASK_APPLICATIONLOGPATHS() |
Getter for APPLICATIONLOGPATHS w/ exceptions if field has no |
HAS_APPLICATIONLOGPATHS() |
Determine if APPLICATIONLOGPATHS has a value |
ApplicationLogOutputUri¶
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more
ApplicationLogPaths.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONLOGOUTPUTURI() |
Getter for APPLICATIONLOGOUTPUTURI, with configurable defaul |
ASK_APPLICATIONLOGOUTPUTURI() |
Getter for APPLICATIONLOGOUTPUTURI w/ exceptions if field ha |
HAS_APPLICATIONLOGOUTPUTURI() |
Determine if APPLICATIONLOGOUTPUTURI has a value |
ApplicationSourceUri¶
The original Amazon S3 location of uploaded stream content for the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONSOURCEURI() |
Getter for APPLICATIONSOURCEURI, with configurable default |
ASK_APPLICATIONSOURCEURI() |
Getter for APPLICATIONSOURCEURI w/ exceptions if field has n |
HAS_APPLICATIONSOURCEURI() |
Determine if APPLICATIONSOURCEURI has a value |
Id¶
A unique ID value that is assigned to the resource when it's created. Format example:
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 |
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. SeeStatusReasonfor more information.
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 |
StatusReason¶
A short description of the status reason when the application is in
ERRORstatus.
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 |
ReplicationStatuses¶
A set of replication statuses for each location.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REPLICATIONSTATUSES() |
Getter for REPLICATIONSTATUSES, with configurable default |
ASK_REPLICATIONSTATUSES() |
Getter for REPLICATIONSTATUSES w/ exceptions if field has no |
HAS_REPLICATIONSTATUSES() |
Determine if REPLICATIONSTATUSES 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 |
AssociatedStreamGroups¶
A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCIATEDSTREAMGROUPS() |
Getter for ASSOCIATEDSTREAMGROUPS, with configurable default |
ASK_ASSOCIATEDSTREAMGROUPS() |
Getter for ASSOCIATEDSTREAMGROUPS w/ exceptions if field has |
HAS_ASSOCIATEDSTREAMGROUPS() |
Determine if ASSOCIATEDSTREAMGROUPS has a value |