UpdateApplicationCommand

Suggest an Edit

Updates the specified application.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppStreamClient, UpdateApplicationCommand } from "@aws-sdk/client-appstream"; // ES Modules import
// const { AppStreamClient, UpdateApplicationCommand } = require("@aws-sdk/client-appstream"); // CommonJS import
const client = new AppStreamClient(config);
const input = { // UpdateApplicationRequest
  Name: "STRING_VALUE", // required
  DisplayName: "STRING_VALUE",
  Description: "STRING_VALUE",
  IconS3Location: { // S3Location
    S3Bucket: "STRING_VALUE", // required
    S3Key: "STRING_VALUE",
  },
  LaunchPath: "STRING_VALUE",
  WorkingDirectory: "STRING_VALUE",
  LaunchParameters: "STRING_VALUE",
  AppBlockArn: "STRING_VALUE",
  AttributesToDelete: [ // ApplicationAttributes
    "LAUNCH_PARAMETERS" || "WORKING_DIRECTORY",
  ],
};
const command = new UpdateApplicationCommand(input);
const response = await client.send(command);
// { // UpdateApplicationResult
//   Application: { // Application
//     Name: "STRING_VALUE",
//     DisplayName: "STRING_VALUE",
//     IconURL: "STRING_VALUE",
//     LaunchPath: "STRING_VALUE",
//     LaunchParameters: "STRING_VALUE",
//     Enabled: true || false,
//     Metadata: { // Metadata
//       "<keys>": "STRING_VALUE",
//     },
//     WorkingDirectory: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     AppBlockArn: "STRING_VALUE",
//     IconS3Location: { // S3Location
//       S3Bucket: "STRING_VALUE", // required
//       S3Key: "STRING_VALUE",
//     },
//     Platforms: [ // Platforms
//       "WINDOWS" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "AMAZON_LINUX2" || "RHEL8" || "ROCKY_LINUX8",
//     ],
//     InstanceFamilies: [ // StringList
//       "STRING_VALUE",
//     ],
//     CreatedTime: new Date("TIMESTAMP"),
//   },
// };

UpdateApplicationCommand Input

See UpdateApplicationCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

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

AppBlockArn
string | undefined

The ARN of the app block.

AttributesToDelete
ApplicationAttribute[] | undefined

The attributes to delete for an application.

Description
string | undefined

The description of the application.

DisplayName
string | undefined

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

IconS3Location
S3Location | undefined

The icon S3 location of the application.

LaunchParameters
string | undefined

The launch parameters of the application.

LaunchPath
string | undefined

The launch path of the application.

WorkingDirectory
string | undefined

The working directory of the application.

UpdateApplicationCommand Output

See UpdateApplicationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Application
Application | undefined

Describes an application in the application catalog.

Throws

Name
Fault
Details
ConcurrentModificationException
client

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

OperationNotPermittedException
client

The attempted operation is not permitted.

ResourceNotFoundException
client

The specified resource was not found.

AppStreamServiceException
Base exception class for all service exceptions from AppStream service.