Skip to content

CreateApplicationOutput

Source code in docs_src/capo_gameliftstreams/types/create_application_output.py
class CreateApplicationOutput(TypedDict, closed=True):
    arn: "capo_gameliftstreams.types.identifier.Identifier"
    """<p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>.</p>"""
    description: NotRequired["capo_gameliftstreams.types.description.Description"]
    """<p>A human-readable label for the application. You can edit this value. </p>"""
    runtime_environment: NotRequired[
        "capo_gameliftstreams.types.runtime_environment.RuntimeEnvironment"
    ]
    """<p> Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. </p> <p>A runtime environment can be one of the following:</p> <ul> <li> <p> For Linux applications </p> <ul> <li> <p> Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) </p> </li> </ul> </li> <li> <p> For Windows applications </p> <ul> <li> <p>Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>)</p> </li> <li> <p>Proton 10.0-4 (<code>Type=PROTON, Version=20260204</code>)</p> </li> <li> <p>Proton 9.0-2 (<code>Type=PROTON, Version=20250516</code>)</p> </li> <li> <p>Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>)</p> </li> <li> <p>Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>)</p> </li> </ul> </li> </ul>"""
    executable_path: NotRequired[
        "capo_gameliftstreams.types.executable_path.ExecutablePath"
    ]
    """<p>The relative path and file name of the executable file that launches the content for streaming.</p>"""
    application_log_paths: NotRequired[
        "capo_gameliftstreams.types.file_paths.FilePaths"
    ]
    """<p>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 <code>ApplicationLogOutputUri</code> at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> and get the <code>LogFileLocationUri</code>.</p>"""
    application_log_output_uri: NotRequired[
        "capo_gameliftstreams.types.application_log_output_uri.ApplicationLogOutputUri"
    ]
    """<p>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 <code>ApplicationLogPaths</code>.</p>"""
    application_source_uri: NotRequired[
        "capo_gameliftstreams.types.application_source_uri.ApplicationSourceUri"
    ]
    """<p>The original Amazon S3 location of uploaded stream content for the application.</p>"""
    id: NotRequired["capo_gameliftstreams.types.id.Id"]
    """<p>A unique ID value that is assigned to the resource when it's created. Format example: <code>a-9ZY8X7Wv6</code>.</p>"""
    status: NotRequired[
        "capo_gameliftstreams.types.application_status.ApplicationStatus"
    ]
    """<p>The current status of the application resource. Possible statuses include the following:</p> <ul> <li> <p> <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. </p> </li> <li> <p> <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.</p> </li> <li> <p> <code>READY</code>: The application is ready to deploy in a stream group.</p> </li> <li> <p> <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information.</p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_gameliftstreams.types.application_status_reason.ApplicationStatusReason"
    ]
    """<p>A short description of the status reason when the application is in <code>ERROR</code> status.</p>"""
    replication_statuses: NotRequired[
        "capo_gameliftstreams.types.replication_statuses.ReplicationStatuses"
    ]
    """<p>A set of replication statuses for each location.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>"""
    last_updated_at: NotRequired["datetime.datetime"]
    """<p>A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>"""
    associated_stream_groups: NotRequired["capo_gameliftstreams.types.arn_list.ArnList"]
    """<p>A newly created application is not associated to any stream groups. This value is empty.</p>"""

application_log_output_uri instance-attribute

application_log_output_uri: NotRequired[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.

application_log_paths instance-attribute

application_log_paths: NotRequired[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 ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.

application_source_uri instance-attribute

application_source_uri: NotRequired[ApplicationSourceUri]

The original Amazon S3 location of uploaded stream content for the application.

arn instance-attribute

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

associated_stream_groups instance-attribute

associated_stream_groups: NotRequired[ArnList]

A newly created application is not associated to any stream groups. This value is empty.

created_at instance-attribute

created_at: NotRequired[datetime]

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

description instance-attribute

description: NotRequired[Description]

A human-readable label for the application. You can edit this value.

executable_path instance-attribute

executable_path: NotRequired[ExecutablePath]

The relative path and file name of the executable file that launches the content for streaming.

id instance-attribute

id: NotRequired[Id]

A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.

last_updated_at instance-attribute

last_updated_at: NotRequired[datetime]

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

replication_statuses instance-attribute

replication_statuses: NotRequired[ReplicationStatuses]

A set of replication statuses for each location.

runtime_environment instance-attribute

runtime_environment: NotRequired[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 10.0-4 (Type=PROTON, Version=20260204)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

status instance-attribute

status: NotRequired[ApplicationStatus]

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. See StatusReason for more information.

  • DELETING: Amazon GameLift Streams is in the process of deleting the application.

status_reason instance-attribute

status_reason: NotRequired[ApplicationStatusReason]

A short description of the status reason when the application is in ERROR status.