Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateStack

Updates the specified fields for the specified stack.

Request Syntax


{
   "AccessEndpoints": [ 
      { 
         "EndpointType": "string",
         "VpceId": "string"
      }
   ],
   "ApplicationSettings": { 
      "Enabled": boolean,
      "SettingsGroup": "string"
   },
   "AttributesToDelete": [ "string" ],
   "DeleteStorageConnectors": boolean,
   "Description": "string",
   "DisplayName": "string",
   "EmbedHostDomains": [ "string" ],
   "FeedbackURL": "string",
   "Name": "string",
   "RedirectURL": "string",
   "StorageConnectors": [ 
      { 
         "ConnectorType": "string",
         "Domains": [ "string" ],
         "ResourceIdentifier": "string"
      }
   ],
   "StreamingExperienceSettings": { 
      "PreferredProtocol": "string"
   },
   "UserSettings": [ 
      { 
         "Action": "string",
         "MaximumLength": number,
         "Permission": "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.

AccessEndpoints

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

Type: Array of AccessEndpoint objects

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Required: No

ApplicationSettings

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

Type: ApplicationSettings object

Required: No

AttributesToDelete

The stack attributes to delete.

Type: Array of strings

Required: No

DeleteStorageConnectors

This parameter has been deprecated.

Deletes the storage connectors currently enabled for the stack.

Type: Boolean

Required: No

Description

The description to display.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisplayName

The stack name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

EmbedHostDomains

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Length Constraints: Maximum length of 128.

Pattern: (?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]

Required: No

FeedbackURL

The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

Type: String

Length Constraints: Maximum length of 1000.

Required: No

Name

The name of the stack.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

RedirectURL

The URL that users are redirected to after their streaming session ends.

Type: String

Length Constraints: Maximum length of 1000.

Required: No

StorageConnectors

The storage connectors to enable.

Type: Array of StorageConnector objects

Required: No

StreamingExperienceSettings

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

Type: StreamingExperienceSettings object

Required: No

UserSettings

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

Type: Array of UserSetting objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax


{
   "Stack": { 
      "AccessEndpoints": [ 
         { 
            "EndpointType": "string",
            "VpceId": "string"
         }
      ],
      "ApplicationSettings": { 
         "Enabled": boolean,
         "S3BucketName": "string",
         "SettingsGroup": "string"
      },
      "Arn": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "EmbedHostDomains": [ "string" ],
      "FeedbackURL": "string",
      "Name": "string",
      "RedirectURL": "string",
      "StackErrors": [ 
         { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         }
      ],
      "StorageConnectors": [ 
         { 
            "ConnectorType": "string",
            "Domains": [ "string" ],
            "ResourceIdentifier": "string"
         }
      ],
      "StreamingExperienceSettings": { 
         "PreferredProtocol": "string"
      },
      "UserSettings": [ 
         { 
            "Action": "string",
            "MaximumLength": number,
            "Permission": "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.

Stack

Information about the stack.

Type: Stack 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

IncompatibleImageException

The image can't be updated because it's not compatible for updates.

HTTP Status Code: 400

InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

HTTP Status Code: 400

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

InvalidRoleException

The specified role is invalid.

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

ResourceInUseException

The specified resource is in use.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400