UpdateApplication - Amazon AppStream 2.0

UpdateApplication

Updates the specified application.

Request Syntax

{ "AppBlockArn": "string", "AttributesToDelete": [ "string" ], "Description": "string", "DisplayName": "string", "IconS3Location": { "S3Bucket": "string", "S3Key": "string" }, "LaunchParameters": "string", "LaunchPath": "string", "Name": "string", "WorkingDirectory": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AppBlockArn

The ARN of the app block.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: No

AttributesToDelete

The attributes to delete for an application.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: LAUNCH_PARAMETERS | WORKING_DIRECTORY

Required: No

Description

The description of the application.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisplayName

The display name of the application. This name is visible to users in the application catalog.

Type: String

Length Constraints: Maximum length of 100.

Required: No

IconS3Location

The icon S3 location of the application.

Type: S3Location object

Required: No

LaunchParameters

The launch parameters of the application.

Type: String

Length Constraints: Minimum length of 1.

Required: No

LaunchPath

The launch path of the application.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Name

The name of the application. This name is visible to users when display name is not specified.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

WorkingDirectory

The working directory of the application.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "Application": { "AppBlockArn": "string", "Arn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "Enabled": boolean, "IconS3Location": { "S3Bucket": "string", "S3Key": "string" }, "IconURL": "string", "InstanceFamilies": [ "string" ], "LaunchParameters": "string", "LaunchPath": "string", "Metadata": { "string" : "string" }, "Name": "string", "Platforms": [ "string" ], "WorkingDirectory": "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.

Application

Describes an application in the application catalog.

Type: Application object

Errors

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

ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: