aws_sdk_gameliftstreams/client/

get_application.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetApplication`](crate::operation::get_application::builders::GetApplicationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`identifier(impl Into<String>)`](crate::operation::get_application::builders::GetApplicationFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_application::builders::GetApplicationFluentBuilder::set_identifier):<br>required: **true**<br><p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>.</p><br>
    /// - On success, responds with [`GetApplicationOutput`](crate::operation::get_application::GetApplicationOutput) with field(s):
    ///   - [`arn(String)`](crate::operation::get_application::GetApplicationOutput::arn): <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(Option<String>)`](crate::operation::get_application::GetApplicationOutput::description): <p>A human-readable label for the application. You can edit this value.</p>
    ///   - [`runtime_environment(Option<RuntimeEnvironment>)`](crate::operation::get_application::GetApplicationOutput::runtime_environment): <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 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(Option<String>)`](crate::operation::get_application::GetApplicationOutput::executable_path): <p>The path and file name of the executable file that launches the content for streaming.</p>
    ///   - [`application_log_paths(Option<Vec::<String>>)`](crate::operation::get_application::GetApplicationOutput::application_log_paths): <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(Option<String>)`](crate::operation::get_application::GetApplicationOutput::application_log_output_uri): <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(Option<String>)`](crate::operation::get_application::GetApplicationOutput::application_source_uri): <p>The original Amazon S3 location of uploaded stream content for the application.</p>
    ///   - [`id(Option<String>)`](crate::operation::get_application::GetApplicationOutput::id): <p>A unique ID value that is assigned to the resource when it's created. Format example: <code>a-9ZY8X7Wv6</code>.</p>
    ///   - [`status(Option<ApplicationStatus>)`](crate::operation::get_application::GetApplicationOutput::status): <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(Option<ApplicationStatusReason>)`](crate::operation::get_application::GetApplicationOutput::status_reason): <p>A short description of the status reason when the application is in <code>ERROR</code> status.</p>
    ///   - [`replication_statuses(Option<Vec::<ReplicationStatus>>)`](crate::operation::get_application::GetApplicationOutput::replication_statuses): <p>A set of replication statuses for each location.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_application::GetApplicationOutput::created_at): <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(Option<DateTime>)`](crate::operation::get_application::GetApplicationOutput::last_updated_at): <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(Option<Vec::<String>>)`](crate::operation::get_application::GetApplicationOutput::associated_stream_groups): <p>A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.</p> <p>This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify stream group resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>.</p>
    /// - On failure, responds with [`SdkError<GetApplicationError>`](crate::operation::get_application::GetApplicationError)
    pub fn get_application(&self) -> crate::operation::get_application::builders::GetApplicationFluentBuilder {
        crate::operation::get_application::builders::GetApplicationFluentBuilder::new(self.handle.clone())
    }
}