[ aws . gameliftstreams ]

update-application

Description

Updates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the Description , ApplicationLogOutputUri , and ApplicationLogPaths .

To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.

See also: AWS API Documentation

Synopsis

  update-application
[--application-log-output-uri <value>]
[--application-log-paths <value>]
[--description <value>]
--identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--application-log-output-uri (string)

An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix] . Required if you specify one or more LogPaths .

Note

The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide.

--application-log-paths (list)

Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location. You can specify up to 10 log locations. Amazon GameLift Streams uploads designated 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 .

(string)

Syntax:

"string" "string" ...

--description (string)

A human-readable label for the application.

--identifier (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ApplicationLogOutputUri -> (string)

An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix] . Required if you specify one or more LogPaths .

ApplicationLogPaths -> (list)

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 .

(string)

ApplicationSourceUri -> (string)

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

Arn -> (string)

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

AssociatedStreamGroups -> (list)

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/1AB2C3De4 .

(string)

CreatedAt -> (timestamp)

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 -> (string)

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

ExecutablePath -> (string)

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

Id -> (string)

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

LastUpdatedAt -> (timestamp)

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

ReplicationStatuses -> (list)

A set of replication statuses for each location.

(structure)

Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there.

Location -> (string)

A location’s name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .

Status -> (string)

The current status of the replication process.

RuntimeEnvironment -> (structure)

A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 -> (string)

The operating system and other drivers. For Proton, this also includes the Proton compatibility layer.

Version -> (string)

Versioned container environment for the application operating system.

Status -> (string)

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.

StatusReason -> (string)

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