Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetApplication

Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.

Request Syntax


GET /applications/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 or ID a-9ZY8X7Wv6.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationLogOutputUri": "string",
   "ApplicationLogPaths": [ "string" ],
   "ApplicationSourceUri": "string",
   "Arn": "string",
   "AssociatedStreamGroups": [ "string" ],
   "CreatedAt": number,
   "Description": "string",
   "ExecutablePath": "string",
   "Id": "string",
   "LastUpdatedAt": number,
   "ReplicationStatuses": [ 
      { 
         "Location": "string",
         "Status": "string"
      }
   ],
   "RuntimeEnvironment": { 
      "Type": "string",
      "Version": "string"
   },
   "Status": "string",
   "StatusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all AWS Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)$

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: ^$|^s3://([a-zA-Z0-9][a-zA-Z0-9._-]{1,61}[a-zA-Z0-9])(/[a-zA-Z0-9._-]+)*/?$

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 0. Maximum length of 1024.

ApplicationSourceUri

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$

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

Type: Timestamp

Description

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: ^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$

ExecutablePath

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Id

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9-]+$

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

Type: Timestamp

ReplicationStatuses

A set of replication statuses for each location.

Type: Array of ReplicationStatus objects

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 8.0-5 (Type=PROTON, Version=20241007)
- Proton 8.0-2c (Type=PROTON, Version=20230704)

Type: RuntimeEnvironment object

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. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the application.

Type: String

Valid Values: INITIALIZED | PROCESSING | READY | DELETING | ERROR

StatusReason

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

Type: String

Valid Values: internalError | accessDenied

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found. Correct the request before you try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Retry the request after the suggested wait time.

HTTP Status Code: 429

ValidationException

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.

HTTP Status Code: 400

Examples

CLI Example

The following example shows how to use the AWS CLI to retrieve information about a Amazon GameLift Streams application. This example uses the application ID value.

Sample Request


aws gameliftstreams get-application \
  --identifier arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6