Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateApplication

Creates an application.

Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.

This is only supported for Elastic fleets.

Request Syntax


{
   "AppBlockArn": "string",
   "Description": "string",
   "DisplayName": "string",
   "IconS3Location": { 
      "S3Bucket": "string",
      "S3Key": "string"
   },
   "InstanceFamilies": [ "string" ],
   "LaunchParameters": "string",
   "LaunchPath": "string",
   "Name": "string",
   "Platforms": [ "string" ],
   "Tags": { 
      "string" : "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 app block ARN to which the application should be associated

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: Yes

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 location in S3 of the application icon.

Type: S3Location object

Required: Yes

InstanceFamilies

The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: Yes

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: Yes

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

Platforms

The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

Type: Array of strings

Array Members: Maximum number of 4 items.

Valid Values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2

Required: Yes

Tags

The tags assigned to the application.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(^(?!aws:).[\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

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

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400