1{ 2 "version": "2.0", 3 "service": "<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand. </p> <note> <p>You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html\">Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p> </note> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>", 4 "operations": { 5 "AssociateFleet": "<p>Associates the specified fleet with the specified stack.</p>", 6 "BatchAssociateUserStack": "<p>Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.</p>", 7 "BatchDisassociateUserStack": "<p>Disassociates the specified users from the specified stacks.</p>", 8 "CopyImage": "<p>Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.</p>", 9 "CreateDirectoryConfig": "<p>Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>", 10 "CreateFleet": "<p>Creates a fleet. A fleet consists of streaming instances that run a specified image.</p>", 11 "CreateImageBuilder": "<p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>", 12 "CreateImageBuilderStreamingURL": "<p>Creates a URL to start an image builder streaming session.</p>", 13 "CreateStack": "<p>Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </p>", 14 "CreateStreamingURL": "<p>Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. </p>", 15 "CreateUsageReportSubscription": "<p>Creates a usage report subscription. Usage reports are generated daily.</p>", 16 "CreateUser": "<p>Creates a new user in the user pool.</p>", 17 "DeleteDirectoryConfig": "<p>Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>", 18 "DeleteFleet": "<p>Deletes the specified fleet.</p>", 19 "DeleteImage": "<p>Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.</p>", 20 "DeleteImageBuilder": "<p>Deletes the specified image builder and releases the capacity.</p>", 21 "DeleteImagePermissions": "<p>Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.</p>", 22 "DeleteStack": "<p>Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.</p>", 23 "DeleteUsageReportSubscription": "<p>Disables usage report generation.</p>", 24 "DeleteUser": "<p>Deletes a user from the user pool.</p>", 25 "DescribeDirectoryConfigs": "<p>Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. </p> <p>Although the response syntax in this topic includes the account password, this password is not returned in the actual response.</p>", 26 "DescribeFleets": "<p>Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.</p>", 27 "DescribeImageBuilders": "<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>", 28 "DescribeImagePermissions": "<p>Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. </p>", 29 "DescribeImages": "<p>Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.</p>", 30 "DescribeSessions": "<p>Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>", 31 "DescribeStacks": "<p>Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.</p>", 32 "DescribeUsageReportSubscriptions": "<p>Retrieves a list that describes one or more usage report subscriptions.</p>", 33 "DescribeUserStackAssociations": "<p>Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:</p> <ul> <li> <p>The stack name</p> </li> <li> <p>The user name (email address of the user associated with the stack) and the authentication type for the user</p> </li> </ul>", 34 "DescribeUsers": "<p>Retrieves a list that describes one or more specified users in the user pool.</p>", 35 "DisableUser": "<p>Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. </p>", 36 "DisassociateFleet": "<p>Disassociates the specified fleet from the specified stack.</p>", 37 "EnableUser": "<p>Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.</p>", 38 "ExpireSession": "<p>Immediately stops the specified streaming session.</p>", 39 "ListAssociatedFleets": "<p>Retrieves the name of the fleet that is associated with the specified stack.</p>", 40 "ListAssociatedStacks": "<p>Retrieves the name of the stack with which the specified fleet is associated.</p>", 41 "ListTagsForResource": "<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 42 "StartFleet": "<p>Starts the specified fleet.</p>", 43 "StartImageBuilder": "<p>Starts the specified image builder.</p>", 44 "StopFleet": "<p>Stops the specified fleet.</p>", 45 "StopImageBuilder": "<p>Stops the specified image builder.</p>", 46 "TagResource": "<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 47 "UntagResource": "<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 48 "UpdateDirectoryConfig": "<p>Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>", 49 "UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, <code>IdleDisconnectTimeoutInSeconds</code>, and <code>DisconnectTimeoutInSeconds</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>", 50 "UpdateImagePermissions": "<p>Adds or updates permissions for the specified private image. </p>", 51 "UpdateStack": "<p>Updates the specified fields for the specified stack.</p>" 52 }, 53 "shapes": { 54 "AccessEndpoint": { 55 "base": "<p>Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.</p>", 56 "refs": { 57 "AccessEndpointList$member": null 58 } 59 }, 60 "AccessEndpointList": { 61 "base": null, 62 "refs": { 63 "CreateImageBuilderRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.</p>", 64 "CreateStackRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>", 65 "ImageBuilder$AccessEndpoints": "<p>The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.</p>", 66 "Stack$AccessEndpoints": "<p>The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. </p>", 67 "UpdateStackRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>" 68 } 69 }, 70 "AccessEndpointType": { 71 "base": null, 72 "refs": { 73 "AccessEndpoint$EndpointType": "<p>The type of interface endpoint.</p>" 74 } 75 }, 76 "AccountName": { 77 "base": null, 78 "refs": { 79 "ServiceAccountCredentials$AccountName": "<p>The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.</p>" 80 } 81 }, 82 "AccountPassword": { 83 "base": null, 84 "refs": { 85 "ServiceAccountCredentials$AccountPassword": "<p>The password for the account.</p>" 86 } 87 }, 88 "Action": { 89 "base": null, 90 "refs": { 91 "UserSetting$Action": "<p>The action that is enabled or disabled.</p>" 92 } 93 }, 94 "Application": { 95 "base": "<p>Describes an application in the application catalog.</p>", 96 "refs": { 97 "Applications$member": null 98 } 99 }, 100 "ApplicationSettings": { 101 "base": "<p>The persistent application settings for users of a stack.</p>", 102 "refs": { 103 "CreateStackRequest$ApplicationSettings": "<p>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.</p>", 104 "UpdateStackRequest$ApplicationSettings": "<p>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.</p>" 105 } 106 }, 107 "ApplicationSettingsResponse": { 108 "base": "<p>Describes the persistent application settings for users of a stack.</p>", 109 "refs": { 110 "Stack$ApplicationSettings": "<p>The persistent application settings for users of the stack.</p>" 111 } 112 }, 113 "Applications": { 114 "base": null, 115 "refs": { 116 "Image$Applications": "<p>The applications associated with the image.</p>" 117 } 118 }, 119 "AppstreamAgentVersion": { 120 "base": null, 121 "refs": { 122 "CreateImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>", 123 "Image$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>", 124 "ImageBuilder$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>", 125 "StartImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>" 126 } 127 }, 128 "Arn": { 129 "base": null, 130 "refs": { 131 "ArnList$member": null, 132 "CreateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>", 133 "CreateFleetRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 134 "CreateImageBuilderRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>", 135 "CreateImageBuilderRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 136 "Fleet$Arn": "<p>The Amazon Resource Name (ARN) for the fleet.</p>", 137 "Fleet$ImageArn": "<p>The ARN for the public, private, or shared image.</p>", 138 "Fleet$IamRoleArn": "<p>The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 139 "Image$Arn": "<p>The ARN of the image.</p>", 140 "Image$BaseImageArn": "<p>The ARN of the image from which this image was created.</p>", 141 "ImageBuilder$Arn": "<p>The ARN for the image builder.</p>", 142 "ImageBuilder$ImageArn": "<p>The ARN of the image from which this builder was created.</p>", 143 "ImageBuilder$IamRoleArn": "<p>The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 144 "ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 145 "Stack$Arn": "<p>The ARN of the stack.</p>", 146 "TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 147 "UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 148 "UpdateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>", 149 "UpdateFleetRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 150 "User$Arn": "<p>The ARN of the user.</p>" 151 } 152 }, 153 "ArnList": { 154 "base": null, 155 "refs": { 156 "DescribeImagesRequest$Arns": "<p>The ARNs of the public, private, and shared images to describe.</p>" 157 } 158 }, 159 "AssociateFleetRequest": { 160 "base": null, 161 "refs": { 162 } 163 }, 164 "AssociateFleetResult": { 165 "base": null, 166 "refs": { 167 } 168 }, 169 "AuthenticationType": { 170 "base": null, 171 "refs": { 172 "CreateUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL. </p>", 173 "DeleteUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>", 174 "DescribeSessionsRequest$AuthenticationType": "<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>", 175 "DescribeUserStackAssociationsRequest$AuthenticationType": "<p>The authentication type for the user who is associated with the stack. You must specify USERPOOL.</p>", 176 "DescribeUsersRequest$AuthenticationType": "<p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>", 177 "DisableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>", 178 "EnableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>", 179 "Session$AuthenticationType": "<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML 2.0 federation (<code>SAML</code>).</p>", 180 "User$AuthenticationType": "<p>The authentication type for the user.</p>", 181 "UserStackAssociation$AuthenticationType": "<p>The authentication type for the user.</p>" 182 } 183 }, 184 "AwsAccountId": { 185 "base": null, 186 "refs": { 187 "AwsAccountIdList$member": null, 188 "DeleteImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which to delete image permissions.</p>", 189 "SharedImagePermissions$sharedAccountId": "<p>The 12-digit identifier of the AWS account with which the image is shared.</p>", 190 "UpdateImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which you want add or update image permissions.</p>" 191 } 192 }, 193 "AwsAccountIdList": { 194 "base": null, 195 "refs": { 196 "DescribeImagePermissionsRequest$SharedAwsAccountIds": "<p>The 12-digit identifier of one or more AWS accounts with which the image is shared.</p>" 197 } 198 }, 199 "BatchAssociateUserStackRequest": { 200 "base": null, 201 "refs": { 202 } 203 }, 204 "BatchAssociateUserStackResult": { 205 "base": null, 206 "refs": { 207 } 208 }, 209 "BatchDisassociateUserStackRequest": { 210 "base": null, 211 "refs": { 212 } 213 }, 214 "BatchDisassociateUserStackResult": { 215 "base": null, 216 "refs": { 217 } 218 }, 219 "Boolean": { 220 "base": null, 221 "refs": { 222 "Application$Enabled": "<p>If there is a problem, the application can be disabled after image creation.</p>", 223 "ApplicationSettings$Enabled": "<p>Enables or disables persistent application settings for users during their streaming sessions. </p>", 224 "ApplicationSettingsResponse$Enabled": "<p>Specifies whether persistent application settings are enabled for users during their streaming sessions.</p>", 225 "Image$ImageBuilderSupported": "<p>Indicates whether an image builder can be launched from this image.</p>", 226 "UpdateFleetRequest$DeleteVpcConfig": "<p>Deletes the VPC association for the specified fleet.</p>", 227 "UpdateStackRequest$DeleteStorageConnectors": "<p>Deletes the storage connectors currently enabled for the stack.</p>", 228 "User$Enabled": "<p>Specifies whether the user in the user pool is enabled.</p>", 229 "UserStackAssociation$SendEmailNotification": "<p>Specifies whether a welcome email is sent to a user after the user is created in the user pool.</p>" 230 } 231 }, 232 "BooleanObject": { 233 "base": null, 234 "refs": { 235 "CreateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>", 236 "CreateImageBuilderRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>", 237 "Fleet$EnableDefaultInternetAccess": "<p>Indicates whether default internet access is enabled for the fleet.</p>", 238 "ImageBuilder$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>", 239 "ImagePermissions$allowFleet": "<p>Indicates whether the image can be used for a fleet.</p>", 240 "ImagePermissions$allowImageBuilder": "<p>Indicates whether the image can be used for an image builder.</p>", 241 "UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>" 242 } 243 }, 244 "ComputeCapacity": { 245 "base": "<p>Describes the capacity for a fleet.</p>", 246 "refs": { 247 "CreateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>", 248 "UpdateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>" 249 } 250 }, 251 "ComputeCapacityStatus": { 252 "base": "<p>Describes the capacity status for a fleet.</p>", 253 "refs": { 254 "Fleet$ComputeCapacityStatus": "<p>The capacity status for the fleet.</p>" 255 } 256 }, 257 "ConcurrentModificationException": { 258 "base": "<p>An API error occurred. Wait a few minutes and try again.</p>", 259 "refs": { 260 } 261 }, 262 "CopyImageRequest": { 263 "base": null, 264 "refs": { 265 } 266 }, 267 "CopyImageResponse": { 268 "base": null, 269 "refs": { 270 } 271 }, 272 "CreateDirectoryConfigRequest": { 273 "base": null, 274 "refs": { 275 } 276 }, 277 "CreateDirectoryConfigResult": { 278 "base": null, 279 "refs": { 280 } 281 }, 282 "CreateFleetRequest": { 283 "base": null, 284 "refs": { 285 } 286 }, 287 "CreateFleetResult": { 288 "base": null, 289 "refs": { 290 } 291 }, 292 "CreateImageBuilderRequest": { 293 "base": null, 294 "refs": { 295 } 296 }, 297 "CreateImageBuilderResult": { 298 "base": null, 299 "refs": { 300 } 301 }, 302 "CreateImageBuilderStreamingURLRequest": { 303 "base": null, 304 "refs": { 305 } 306 }, 307 "CreateImageBuilderStreamingURLResult": { 308 "base": null, 309 "refs": { 310 } 311 }, 312 "CreateStackRequest": { 313 "base": null, 314 "refs": { 315 } 316 }, 317 "CreateStackResult": { 318 "base": null, 319 "refs": { 320 } 321 }, 322 "CreateStreamingURLRequest": { 323 "base": null, 324 "refs": { 325 } 326 }, 327 "CreateStreamingURLResult": { 328 "base": null, 329 "refs": { 330 } 331 }, 332 "CreateUsageReportSubscriptionRequest": { 333 "base": null, 334 "refs": { 335 } 336 }, 337 "CreateUsageReportSubscriptionResult": { 338 "base": null, 339 "refs": { 340 } 341 }, 342 "CreateUserRequest": { 343 "base": null, 344 "refs": { 345 } 346 }, 347 "CreateUserResult": { 348 "base": null, 349 "refs": { 350 } 351 }, 352 "DeleteDirectoryConfigRequest": { 353 "base": null, 354 "refs": { 355 } 356 }, 357 "DeleteDirectoryConfigResult": { 358 "base": null, 359 "refs": { 360 } 361 }, 362 "DeleteFleetRequest": { 363 "base": null, 364 "refs": { 365 } 366 }, 367 "DeleteFleetResult": { 368 "base": null, 369 "refs": { 370 } 371 }, 372 "DeleteImageBuilderRequest": { 373 "base": null, 374 "refs": { 375 } 376 }, 377 "DeleteImageBuilderResult": { 378 "base": null, 379 "refs": { 380 } 381 }, 382 "DeleteImagePermissionsRequest": { 383 "base": null, 384 "refs": { 385 } 386 }, 387 "DeleteImagePermissionsResult": { 388 "base": null, 389 "refs": { 390 } 391 }, 392 "DeleteImageRequest": { 393 "base": null, 394 "refs": { 395 } 396 }, 397 "DeleteImageResult": { 398 "base": null, 399 "refs": { 400 } 401 }, 402 "DeleteStackRequest": { 403 "base": null, 404 "refs": { 405 } 406 }, 407 "DeleteStackResult": { 408 "base": null, 409 "refs": { 410 } 411 }, 412 "DeleteUsageReportSubscriptionRequest": { 413 "base": null, 414 "refs": { 415 } 416 }, 417 "DeleteUsageReportSubscriptionResult": { 418 "base": null, 419 "refs": { 420 } 421 }, 422 "DeleteUserRequest": { 423 "base": null, 424 "refs": { 425 } 426 }, 427 "DeleteUserResult": { 428 "base": null, 429 "refs": { 430 } 431 }, 432 "DescribeDirectoryConfigsRequest": { 433 "base": null, 434 "refs": { 435 } 436 }, 437 "DescribeDirectoryConfigsResult": { 438 "base": null, 439 "refs": { 440 } 441 }, 442 "DescribeFleetsRequest": { 443 "base": null, 444 "refs": { 445 } 446 }, 447 "DescribeFleetsResult": { 448 "base": null, 449 "refs": { 450 } 451 }, 452 "DescribeImageBuildersRequest": { 453 "base": null, 454 "refs": { 455 } 456 }, 457 "DescribeImageBuildersResult": { 458 "base": null, 459 "refs": { 460 } 461 }, 462 "DescribeImagePermissionsRequest": { 463 "base": null, 464 "refs": { 465 } 466 }, 467 "DescribeImagePermissionsResult": { 468 "base": null, 469 "refs": { 470 } 471 }, 472 "DescribeImagesMaxResults": { 473 "base": null, 474 "refs": { 475 "DescribeImagesRequest$MaxResults": "<p>The maximum size of each page of results.</p>" 476 } 477 }, 478 "DescribeImagesRequest": { 479 "base": null, 480 "refs": { 481 } 482 }, 483 "DescribeImagesResult": { 484 "base": null, 485 "refs": { 486 } 487 }, 488 "DescribeSessionsRequest": { 489 "base": null, 490 "refs": { 491 } 492 }, 493 "DescribeSessionsResult": { 494 "base": null, 495 "refs": { 496 } 497 }, 498 "DescribeStacksRequest": { 499 "base": null, 500 "refs": { 501 } 502 }, 503 "DescribeStacksResult": { 504 "base": null, 505 "refs": { 506 } 507 }, 508 "DescribeUsageReportSubscriptionsRequest": { 509 "base": null, 510 "refs": { 511 } 512 }, 513 "DescribeUsageReportSubscriptionsResult": { 514 "base": null, 515 "refs": { 516 } 517 }, 518 "DescribeUserStackAssociationsRequest": { 519 "base": null, 520 "refs": { 521 } 522 }, 523 "DescribeUserStackAssociationsResult": { 524 "base": null, 525 "refs": { 526 } 527 }, 528 "DescribeUsersRequest": { 529 "base": null, 530 "refs": { 531 } 532 }, 533 "DescribeUsersResult": { 534 "base": null, 535 "refs": { 536 } 537 }, 538 "Description": { 539 "base": null, 540 "refs": { 541 "CopyImageRequest$DestinationImageDescription": "<p>The description that the image will have when it is copied to the destination.</p>", 542 "CreateFleetRequest$Description": "<p>The description to display.</p>", 543 "CreateImageBuilderRequest$Description": "<p>The description to display.</p>", 544 "CreateStackRequest$Description": "<p>The description to display.</p>", 545 "UpdateFleetRequest$Description": "<p>The description to display.</p>", 546 "UpdateStackRequest$Description": "<p>The description to display.</p>" 547 } 548 }, 549 "DirectoryConfig": { 550 "base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>", 551 "refs": { 552 "CreateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>", 553 "DirectoryConfigList$member": null, 554 "UpdateDirectoryConfigResult$DirectoryConfig": "<p>Information about the Directory Config object.</p>" 555 } 556 }, 557 "DirectoryConfigList": { 558 "base": null, 559 "refs": { 560 "DescribeDirectoryConfigsResult$DirectoryConfigs": "<p>Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. </p>" 561 } 562 }, 563 "DirectoryName": { 564 "base": null, 565 "refs": { 566 "CreateDirectoryConfigRequest$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>", 567 "DeleteDirectoryConfigRequest$DirectoryName": "<p>The name of the directory configuration.</p>", 568 "DirectoryConfig$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>", 569 "DirectoryNameList$member": null, 570 "DomainJoinInfo$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>", 571 "UpdateDirectoryConfigRequest$DirectoryName": "<p>The name of the Directory Config object.</p>" 572 } 573 }, 574 "DirectoryNameList": { 575 "base": null, 576 "refs": { 577 "DescribeDirectoryConfigsRequest$DirectoryNames": "<p>The directory names.</p>" 578 } 579 }, 580 "DisableUserRequest": { 581 "base": null, 582 "refs": { 583 } 584 }, 585 "DisableUserResult": { 586 "base": null, 587 "refs": { 588 } 589 }, 590 "DisassociateFleetRequest": { 591 "base": null, 592 "refs": { 593 } 594 }, 595 "DisassociateFleetResult": { 596 "base": null, 597 "refs": { 598 } 599 }, 600 "DisplayName": { 601 "base": null, 602 "refs": { 603 "CreateFleetRequest$DisplayName": "<p>The fleet name to display.</p>", 604 "CreateImageBuilderRequest$DisplayName": "<p>The image builder name to display.</p>", 605 "CreateStackRequest$DisplayName": "<p>The stack name to display.</p>", 606 "UpdateFleetRequest$DisplayName": "<p>The fleet name to display.</p>", 607 "UpdateStackRequest$DisplayName": "<p>The stack name to display.</p>" 608 } 609 }, 610 "Domain": { 611 "base": "GSuite domain for GDrive integration.", 612 "refs": { 613 "DomainList$member": null 614 } 615 }, 616 "DomainJoinInfo": { 617 "base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>", 618 "refs": { 619 "CreateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>", 620 "CreateImageBuilderRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>", 621 "Fleet$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>", 622 "ImageBuilder$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>", 623 "UpdateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>" 624 } 625 }, 626 "DomainList": { 627 "base": null, 628 "refs": { 629 "StorageConnector$Domains": "<p>The names of the domains for the account.</p>" 630 } 631 }, 632 "EmbedHostDomain": { 633 "base": "Specifies a valid domain that can embed AppStream. Valid examples include: [\"testorigin.tt--com\", \"testingorigin.com.us\", \"test.com.us\"] Invalid examples include: [\"test,com\", \".com\", \"h*llo.com\". \"\"]", 634 "refs": { 635 "EmbedHostDomains$member": null 636 } 637 }, 638 "EmbedHostDomains": { 639 "base": null, 640 "refs": { 641 "CreateStackRequest$EmbedHostDomains": "<p>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.</p>", 642 "Stack$EmbedHostDomains": "<p>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.</p>", 643 "UpdateStackRequest$EmbedHostDomains": "<p>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.</p>" 644 } 645 }, 646 "EnableUserRequest": { 647 "base": null, 648 "refs": { 649 } 650 }, 651 "EnableUserResult": { 652 "base": null, 653 "refs": { 654 } 655 }, 656 "ErrorMessage": { 657 "base": "<p>The error message in the exception.</p>", 658 "refs": { 659 "ConcurrentModificationException$Message": null, 660 "IncompatibleImageException$Message": null, 661 "InvalidAccountStatusException$Message": null, 662 "InvalidParameterCombinationException$Message": null, 663 "InvalidRoleException$Message": null, 664 "LimitExceededException$Message": null, 665 "OperationNotPermittedException$Message": null, 666 "ResourceAlreadyExistsException$Message": null, 667 "ResourceInUseException$Message": null, 668 "ResourceNotAvailableException$Message": null, 669 "ResourceNotFoundException$Message": null 670 } 671 }, 672 "ExpireSessionRequest": { 673 "base": null, 674 "refs": { 675 } 676 }, 677 "ExpireSessionResult": { 678 "base": null, 679 "refs": { 680 } 681 }, 682 "FeedbackURL": { 683 "base": null, 684 "refs": { 685 "CreateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>", 686 "Stack$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>", 687 "UpdateStackRequest$FeedbackURL": "<p>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.</p>" 688 } 689 }, 690 "Fleet": { 691 "base": "<p>Describes a fleet.</p>", 692 "refs": { 693 "CreateFleetResult$Fleet": "<p>Information about the fleet.</p>", 694 "FleetList$member": null, 695 "UpdateFleetResult$Fleet": "<p>Information about the fleet.</p>" 696 } 697 }, 698 "FleetAttribute": { 699 "base": "<p>The fleet attribute.</p>", 700 "refs": { 701 "FleetAttributes$member": null 702 } 703 }, 704 "FleetAttributes": { 705 "base": "<p>The fleet attributes.</p>", 706 "refs": { 707 "UpdateFleetRequest$AttributesToDelete": "<p>The fleet attributes to delete.</p>" 708 } 709 }, 710 "FleetError": { 711 "base": "<p>Describes a fleet error.</p>", 712 "refs": { 713 "FleetErrors$member": null 714 } 715 }, 716 "FleetErrorCode": { 717 "base": null, 718 "refs": { 719 "FleetError$ErrorCode": "<p>The error code.</p>", 720 "ResourceError$ErrorCode": "<p>The error code.</p>" 721 } 722 }, 723 "FleetErrors": { 724 "base": null, 725 "refs": { 726 "Fleet$FleetErrors": "<p>The fleet errors.</p>" 727 } 728 }, 729 "FleetList": { 730 "base": "<p>The fleets.</p>", 731 "refs": { 732 "DescribeFleetsResult$Fleets": "<p>Information about the fleets.</p>" 733 } 734 }, 735 "FleetState": { 736 "base": null, 737 "refs": { 738 "Fleet$State": "<p>The current state for the fleet.</p>" 739 } 740 }, 741 "FleetType": { 742 "base": null, 743 "refs": { 744 "CreateFleetRequest$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>", 745 "Fleet$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>" 746 } 747 }, 748 "Image": { 749 "base": "<p>Describes an image.</p>", 750 "refs": { 751 "DeleteImageResult$Image": "<p>Information about the image.</p>", 752 "ImageList$member": null 753 } 754 }, 755 "ImageBuilder": { 756 "base": "<p>Describes a virtual machine that is used to create an image. </p>", 757 "refs": { 758 "CreateImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>", 759 "DeleteImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>", 760 "ImageBuilderList$member": null, 761 "StartImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>", 762 "StopImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>" 763 } 764 }, 765 "ImageBuilderList": { 766 "base": null, 767 "refs": { 768 "DescribeImageBuildersResult$ImageBuilders": "<p>Information about the image builders.</p>" 769 } 770 }, 771 "ImageBuilderState": { 772 "base": null, 773 "refs": { 774 "ImageBuilder$State": "<p>The state of the image builder.</p>" 775 } 776 }, 777 "ImageBuilderStateChangeReason": { 778 "base": "<p>Describes the reason why the last image builder state change occurred.</p>", 779 "refs": { 780 "ImageBuilder$StateChangeReason": "<p>The reason why the last state change occurred.</p>" 781 } 782 }, 783 "ImageBuilderStateChangeReasonCode": { 784 "base": null, 785 "refs": { 786 "ImageBuilderStateChangeReason$Code": "<p>The state change reason code.</p>" 787 } 788 }, 789 "ImageList": { 790 "base": null, 791 "refs": { 792 "DescribeImagesResult$Images": "<p>Information about the images.</p>" 793 } 794 }, 795 "ImagePermissions": { 796 "base": "<p>Describes the permissions for an image. </p>", 797 "refs": { 798 "Image$ImagePermissions": "<p>The permissions to provide to the destination AWS account for the specified image.</p>", 799 "SharedImagePermissions$imagePermissions": "<p>Describes the permissions for a shared image.</p>", 800 "UpdateImagePermissionsRequest$ImagePermissions": "<p>The permissions for the image.</p>" 801 } 802 }, 803 "ImageState": { 804 "base": null, 805 "refs": { 806 "Image$State": "<p>The image starts in the <code>PENDING</code> state. If image creation succeeds, the state is <code>AVAILABLE</code>. If image creation fails, the state is <code>FAILED</code>.</p>" 807 } 808 }, 809 "ImageStateChangeReason": { 810 "base": "<p>Describes the reason why the last image state change occurred.</p>", 811 "refs": { 812 "Image$StateChangeReason": "<p>The reason why the last state change occurred.</p>" 813 } 814 }, 815 "ImageStateChangeReasonCode": { 816 "base": null, 817 "refs": { 818 "ImageStateChangeReason$Code": "<p>The state change reason code.</p>" 819 } 820 }, 821 "IncompatibleImageException": { 822 "base": "<p>The image does not support storage connectors.</p>", 823 "refs": { 824 } 825 }, 826 "Integer": { 827 "base": null, 828 "refs": { 829 "ComputeCapacity$DesiredInstances": "<p>The desired number of streaming instances.</p>", 830 "ComputeCapacityStatus$Desired": "<p>The desired number of streaming instances.</p>", 831 "ComputeCapacityStatus$Running": "<p>The total number of simultaneous streaming instances that are running.</p>", 832 "ComputeCapacityStatus$InUse": "<p>The number of instances in use for streaming.</p>", 833 "ComputeCapacityStatus$Available": "<p>The number of currently available instances that can be used to stream sessions.</p>", 834 "CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>", 835 "CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>", 836 "CreateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>", 837 "DescribeDirectoryConfigsRequest$MaxResults": "<p>The maximum size of each page of results.</p>", 838 "DescribeImageBuildersRequest$MaxResults": "<p>The maximum size of each page of results.</p>", 839 "DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>", 840 "DescribeUsageReportSubscriptionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>", 841 "DescribeUsersRequest$MaxResults": "<p>The maximum size of each page of results.</p>", 842 "Fleet$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. </p> <p>Specify a value between 600 and 360000.</p>", 843 "Fleet$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p> <p>Specify a value between 60 and 360000.</p>", 844 "Fleet$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>", 845 "UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>", 846 "UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>", 847 "UpdateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected. </p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>" 848 } 849 }, 850 "InvalidAccountStatusException": { 851 "base": "<p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>", 852 "refs": { 853 } 854 }, 855 "InvalidParameterCombinationException": { 856 "base": "<p>Indicates an incorrect combination of parameters, or a missing parameter.</p>", 857 "refs": { 858 } 859 }, 860 "InvalidRoleException": { 861 "base": "<p>The specified role is invalid.</p>", 862 "refs": { 863 } 864 }, 865 "LastReportGenerationExecutionError": { 866 "base": "<p>Describes the error that is returned when a usage report can't be generated.</p>", 867 "refs": { 868 "LastReportGenerationExecutionErrors$member": null 869 } 870 }, 871 "LastReportGenerationExecutionErrors": { 872 "base": null, 873 "refs": { 874 "UsageReportSubscription$SubscriptionErrors": "<p>The errors that were returned if usage reports couldn't be generated.</p>" 875 } 876 }, 877 "LimitExceededException": { 878 "base": "<p>The requested limit exceeds the permitted limit for an account.</p>", 879 "refs": { 880 } 881 }, 882 "ListAssociatedFleetsRequest": { 883 "base": null, 884 "refs": { 885 } 886 }, 887 "ListAssociatedFleetsResult": { 888 "base": null, 889 "refs": { 890 } 891 }, 892 "ListAssociatedStacksRequest": { 893 "base": null, 894 "refs": { 895 } 896 }, 897 "ListAssociatedStacksResult": { 898 "base": null, 899 "refs": { 900 } 901 }, 902 "ListTagsForResourceRequest": { 903 "base": null, 904 "refs": { 905 } 906 }, 907 "ListTagsForResourceResponse": { 908 "base": null, 909 "refs": { 910 } 911 }, 912 "Long": { 913 "base": null, 914 "refs": { 915 "CreateImageBuilderStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>", 916 "CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p>" 917 } 918 }, 919 "MaxResults": { 920 "base": null, 921 "refs": { 922 "DescribeImagePermissionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>", 923 "DescribeUserStackAssociationsRequest$MaxResults": "<p>The maximum size of each page of results.</p>" 924 } 925 }, 926 "MessageAction": { 927 "base": null, 928 "refs": { 929 "CreateUserRequest$MessageAction": "<p>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </p> <note> <p>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</p> </note>" 930 } 931 }, 932 "Metadata": { 933 "base": null, 934 "refs": { 935 "Application$Metadata": "<p>Additional attributes that describe the application.</p>" 936 } 937 }, 938 "Name": { 939 "base": null, 940 "refs": { 941 "CopyImageRequest$SourceImageName": "<p>The name of the image to copy.</p>", 942 "CopyImageRequest$DestinationImageName": "<p>The name that the image will have when it is copied to the destination.</p>", 943 "CopyImageResponse$DestinationImageName": "<p>The name of the destination image.</p>", 944 "CreateFleetRequest$Name": "<p>A unique name for the fleet.</p>", 945 "CreateImageBuilderRequest$Name": "<p>A unique name for the image builder.</p>", 946 "CreateStackRequest$Name": "<p>The name of the stack.</p>", 947 "DeleteImageBuilderRequest$Name": "<p>The name of the image builder.</p>", 948 "DeleteImagePermissionsRequest$Name": "<p>The name of the private image.</p>", 949 "DeleteImageRequest$Name": "<p>The name of the image.</p>", 950 "DescribeImagePermissionsRequest$Name": "<p>The name of the private image for which to describe permissions. The image must be one that you own. </p>", 951 "DescribeImagePermissionsResult$Name": "<p>The name of the private image.</p>", 952 "UpdateImagePermissionsRequest$Name": "<p>The name of the private image.</p>" 953 } 954 }, 955 "NetworkAccessConfiguration": { 956 "base": "<p>Describes the network details of the fleet or image builder instance.</p>", 957 "refs": { 958 "ImageBuilder$NetworkAccessConfiguration": null, 959 "Session$NetworkAccessConfiguration": "<p>The network details for the streaming session.</p>" 960 } 961 }, 962 "OperationNotPermittedException": { 963 "base": "<p>The attempted operation is not permitted.</p>", 964 "refs": { 965 } 966 }, 967 "OrganizationalUnitDistinguishedName": { 968 "base": null, 969 "refs": { 970 "DomainJoinInfo$OrganizationalUnitDistinguishedName": "<p>The distinguished name of the organizational unit for computer accounts.</p>", 971 "OrganizationalUnitDistinguishedNamesList$member": null 972 } 973 }, 974 "OrganizationalUnitDistinguishedNamesList": { 975 "base": null, 976 "refs": { 977 "CreateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>", 978 "DirectoryConfig$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>", 979 "UpdateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>" 980 } 981 }, 982 "Permission": { 983 "base": null, 984 "refs": { 985 "UserSetting$Permission": "<p>Indicates whether the action is enabled or disabled.</p>" 986 } 987 }, 988 "PlatformType": { 989 "base": null, 990 "refs": { 991 "Image$Platform": "<p>The operating system platform of the image.</p>", 992 "ImageBuilder$Platform": "<p>The operating system platform of the image builder.</p>" 993 } 994 }, 995 "RedirectURL": { 996 "base": null, 997 "refs": { 998 "CreateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>", 999 "Stack$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>", 1000 "UpdateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>" 1001 } 1002 }, 1003 "RegionName": { 1004 "base": null, 1005 "refs": { 1006 "CopyImageRequest$DestinationRegion": "<p>The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.</p>" 1007 } 1008 }, 1009 "ResourceAlreadyExistsException": { 1010 "base": "<p>The specified resource already exists.</p>", 1011 "refs": { 1012 } 1013 }, 1014 "ResourceError": { 1015 "base": "<p>Describes a resource error.</p>", 1016 "refs": { 1017 "ResourceErrors$member": null 1018 } 1019 }, 1020 "ResourceErrors": { 1021 "base": null, 1022 "refs": { 1023 "ImageBuilder$ImageBuilderErrors": "<p>The image builder errors.</p>" 1024 } 1025 }, 1026 "ResourceIdentifier": { 1027 "base": "<p>The ARN of the resource.</p>", 1028 "refs": { 1029 "StorageConnector$ResourceIdentifier": "<p>The ARN of the storage connector.</p>" 1030 } 1031 }, 1032 "ResourceInUseException": { 1033 "base": "<p>The specified resource is in use.</p>", 1034 "refs": { 1035 } 1036 }, 1037 "ResourceNotAvailableException": { 1038 "base": "<p>The specified resource exists and is not in use, but isn't available.</p>", 1039 "refs": { 1040 } 1041 }, 1042 "ResourceNotFoundException": { 1043 "base": "<p>The specified resource was not found.</p>", 1044 "refs": { 1045 } 1046 }, 1047 "SecurityGroupIdList": { 1048 "base": "<p>The security group identifiers.</p>", 1049 "refs": { 1050 "VpcConfig$SecurityGroupIds": "<p>The identifiers of the security groups for the fleet or image builder.</p>" 1051 } 1052 }, 1053 "ServiceAccountCredentials": { 1054 "base": "<p>Describes the credentials for the service account used by the fleet or image builder to connect to the directory.</p>", 1055 "refs": { 1056 "CreateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>", 1057 "DirectoryConfig$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>", 1058 "UpdateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>" 1059 } 1060 }, 1061 "Session": { 1062 "base": "<p>Describes a streaming session.</p>", 1063 "refs": { 1064 "SessionList$member": null 1065 } 1066 }, 1067 "SessionConnectionState": { 1068 "base": null, 1069 "refs": { 1070 "Session$ConnectionState": "<p>Specifies whether a user is connected to the streaming session.</p>" 1071 } 1072 }, 1073 "SessionList": { 1074 "base": "<p>List of sessions.</p>", 1075 "refs": { 1076 "DescribeSessionsResult$Sessions": "<p>Information about the streaming sessions.</p>" 1077 } 1078 }, 1079 "SessionState": { 1080 "base": "<p>Possible values for the state of a streaming session.</p>", 1081 "refs": { 1082 "Session$State": "<p>The current state of the streaming session.</p>" 1083 } 1084 }, 1085 "SettingsGroup": { 1086 "base": null, 1087 "refs": { 1088 "ApplicationSettings$SettingsGroup": "<p>The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. </p>", 1089 "ApplicationSettingsResponse$SettingsGroup": "<p>The path prefix for the S3 bucket where users’ persistent application settings are stored.</p>" 1090 } 1091 }, 1092 "SharedImagePermissions": { 1093 "base": "<p>Describes the permissions that are available to the specified AWS account for a shared image.</p>", 1094 "refs": { 1095 "SharedImagePermissionsList$member": null 1096 } 1097 }, 1098 "SharedImagePermissionsList": { 1099 "base": null, 1100 "refs": { 1101 "DescribeImagePermissionsResult$SharedImagePermissionsList": "<p>The permissions for a private image that you own. </p>" 1102 } 1103 }, 1104 "Stack": { 1105 "base": "<p>Describes a stack.</p>", 1106 "refs": { 1107 "CreateStackResult$Stack": "<p>Information about the stack.</p>", 1108 "StackList$member": null, 1109 "UpdateStackResult$Stack": "<p>Information about the stack.</p>" 1110 } 1111 }, 1112 "StackAttribute": { 1113 "base": null, 1114 "refs": { 1115 "StackAttributes$member": null 1116 } 1117 }, 1118 "StackAttributes": { 1119 "base": null, 1120 "refs": { 1121 "UpdateStackRequest$AttributesToDelete": "<p>The stack attributes to delete.</p>" 1122 } 1123 }, 1124 "StackError": { 1125 "base": "<p>Describes a stack error.</p>", 1126 "refs": { 1127 "StackErrors$member": null 1128 } 1129 }, 1130 "StackErrorCode": { 1131 "base": null, 1132 "refs": { 1133 "StackError$ErrorCode": "<p>The error code.</p>" 1134 } 1135 }, 1136 "StackErrors": { 1137 "base": "<p>The stack errors.</p>", 1138 "refs": { 1139 "Stack$StackErrors": "<p>The errors for the stack.</p>" 1140 } 1141 }, 1142 "StackList": { 1143 "base": "<p>The stacks.</p>", 1144 "refs": { 1145 "DescribeStacksResult$Stacks": "<p>Information about the stacks.</p>" 1146 } 1147 }, 1148 "StartFleetRequest": { 1149 "base": null, 1150 "refs": { 1151 } 1152 }, 1153 "StartFleetResult": { 1154 "base": null, 1155 "refs": { 1156 } 1157 }, 1158 "StartImageBuilderRequest": { 1159 "base": null, 1160 "refs": { 1161 } 1162 }, 1163 "StartImageBuilderResult": { 1164 "base": null, 1165 "refs": { 1166 } 1167 }, 1168 "StopFleetRequest": { 1169 "base": null, 1170 "refs": { 1171 } 1172 }, 1173 "StopFleetResult": { 1174 "base": null, 1175 "refs": { 1176 } 1177 }, 1178 "StopImageBuilderRequest": { 1179 "base": null, 1180 "refs": { 1181 } 1182 }, 1183 "StopImageBuilderResult": { 1184 "base": null, 1185 "refs": { 1186 } 1187 }, 1188 "StorageConnector": { 1189 "base": "<p>Describes a connector that enables persistent storage for users.</p>", 1190 "refs": { 1191 "StorageConnectorList$member": null 1192 } 1193 }, 1194 "StorageConnectorList": { 1195 "base": "<p>The storage connectors.</p>", 1196 "refs": { 1197 "CreateStackRequest$StorageConnectors": "<p>The storage connectors to enable.</p>", 1198 "Stack$StorageConnectors": "<p>The storage connectors to enable.</p>", 1199 "UpdateStackRequest$StorageConnectors": "<p>The storage connectors to enable.</p>" 1200 } 1201 }, 1202 "StorageConnectorType": { 1203 "base": "<p>The type of storage connector.</p>", 1204 "refs": { 1205 "StorageConnector$ConnectorType": "<p>The type of storage connector.</p>" 1206 } 1207 }, 1208 "StreamingUrlUserId": { 1209 "base": null, 1210 "refs": { 1211 "CreateStreamingURLRequest$UserId": "<p>The identifier of the user.</p>" 1212 } 1213 }, 1214 "String": { 1215 "base": null, 1216 "refs": { 1217 "AccessEndpoint$VpceId": "<p>The identifier (ID) of the VPC in which the interface endpoint is used.</p>", 1218 "Application$Name": "<p>The name of the application.</p>", 1219 "Application$DisplayName": "<p>The application name to display.</p>", 1220 "Application$IconURL": "<p>The URL for the application icon. This URL might be time-limited.</p>", 1221 "Application$LaunchPath": "<p>The path to the application executable in the instance.</p>", 1222 "Application$LaunchParameters": "<p>The arguments that are passed to the application at launch.</p>", 1223 "ApplicationSettingsResponse$S3BucketName": "<p>The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. </p>", 1224 "AssociateFleetRequest$FleetName": "<p>The name of the fleet. </p>", 1225 "AssociateFleetRequest$StackName": "<p>The name of the stack.</p>", 1226 "CreateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>", 1227 "CreateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>", 1228 "CreateImageBuilderRequest$ImageName": "<p>The name of the image used to create the image builder.</p>", 1229 "CreateImageBuilderRequest$InstanceType": "<p>The instance type to use when launching the image builder. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>", 1230 "CreateImageBuilderStreamingURLRequest$Name": "<p>The name of the image builder.</p>", 1231 "CreateImageBuilderStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>", 1232 "CreateStreamingURLRequest$StackName": "<p>The name of the stack.</p>", 1233 "CreateStreamingURLRequest$FleetName": "<p>The name of the fleet.</p>", 1234 "CreateStreamingURLRequest$ApplicationId": "<p>The name of the application to launch after the session starts. This is the name that you specified as <b>Name</b> in the Image Assistant.</p>", 1235 "CreateStreamingURLRequest$SessionContext": "<p>The session context. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 1236 "CreateStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>", 1237 "CreateUsageReportSubscriptionResult$S3BucketName": "<p>The Amazon S3 bucket where generated reports are stored.</p> <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.</p>", 1238 "DeleteFleetRequest$Name": "<p>The name of the fleet.</p>", 1239 "DeleteStackRequest$Name": "<p>The name of the stack.</p>", 1240 "DescribeDirectoryConfigsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1241 "DescribeDirectoryConfigsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1242 "DescribeFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1243 "DescribeFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1244 "DescribeImageBuildersRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1245 "DescribeImageBuildersResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1246 "DescribeImagePermissionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1247 "DescribeImagePermissionsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1248 "DescribeImagesRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1249 "DescribeImagesResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1250 "DescribeSessionsRequest$StackName": "<p>The name of the stack. This value is case-sensitive.</p>", 1251 "DescribeSessionsRequest$FleetName": "<p>The name of the fleet. This value is case-sensitive.</p>", 1252 "DescribeSessionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1253 "DescribeSessionsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1254 "DescribeStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1255 "DescribeStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1256 "DescribeUsageReportSubscriptionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1257 "DescribeUsageReportSubscriptionsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1258 "DescribeUserStackAssociationsRequest$StackName": "<p>The name of the stack that is associated with the user.</p>", 1259 "DescribeUserStackAssociationsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1260 "DescribeUserStackAssociationsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1261 "DescribeUsersRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1262 "DescribeUsersResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1263 "DisassociateFleetRequest$FleetName": "<p>The name of the fleet.</p>", 1264 "DisassociateFleetRequest$StackName": "<p>The name of the stack.</p>", 1265 "ExpireSessionRequest$SessionId": "<p>The identifier of the streaming session.</p>", 1266 "Fleet$Name": "<p>The name of the fleet.</p>", 1267 "Fleet$DisplayName": "<p>The fleet name to display.</p>", 1268 "Fleet$Description": "<p>The description to display.</p>", 1269 "Fleet$ImageName": "<p>The name of the image used to create the fleet.</p>", 1270 "Fleet$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>", 1271 "FleetError$ErrorMessage": "<p>The error message.</p>", 1272 "Image$Name": "<p>The name of the image.</p>", 1273 "Image$DisplayName": "<p>The image name to display.</p>", 1274 "Image$ImageBuilderName": "<p>The name of the image builder that was used to create the private image. If the image is shared, this value is null.</p>", 1275 "Image$Description": "<p>The description to display.</p>", 1276 "ImageBuilder$Name": "<p>The name of the image builder.</p>", 1277 "ImageBuilder$Description": "<p>The description to display.</p>", 1278 "ImageBuilder$DisplayName": "<p>The image builder name to display.</p>", 1279 "ImageBuilder$InstanceType": "<p>The instance type for the image builder. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>", 1280 "ImageBuilderStateChangeReason$Message": "<p>The state change reason message.</p>", 1281 "ImageStateChangeReason$Message": "<p>The state change reason message.</p>", 1282 "LastReportGenerationExecutionError$ErrorMessage": "<p>The error message for the error that is returned when a usage report can't be generated.</p>", 1283 "ListAssociatedFleetsRequest$StackName": "<p>The name of the stack.</p>", 1284 "ListAssociatedFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1285 "ListAssociatedFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1286 "ListAssociatedStacksRequest$FleetName": "<p>The name of the fleet.</p>", 1287 "ListAssociatedStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>", 1288 "ListAssociatedStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>", 1289 "Metadata$key": null, 1290 "Metadata$value": null, 1291 "NetworkAccessConfiguration$EniPrivateIpAddress": "<p>The private IP address of the elastic network interface that is attached to instances in your VPC.</p>", 1292 "NetworkAccessConfiguration$EniId": "<p>The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.</p>", 1293 "ResourceError$ErrorMessage": "<p>The error message.</p>", 1294 "SecurityGroupIdList$member": null, 1295 "Session$Id": "<p>The identifier of the streaming session.</p>", 1296 "Session$StackName": "<p>The name of the stack for the streaming session.</p>", 1297 "Session$FleetName": "<p>The name of the fleet for the streaming session.</p>", 1298 "Stack$Name": "<p>The name of the stack.</p>", 1299 "Stack$Description": "<p>The description to display.</p>", 1300 "Stack$DisplayName": "<p>The stack name to display.</p>", 1301 "StackError$ErrorMessage": "<p>The error message.</p>", 1302 "StartFleetRequest$Name": "<p>The name of the fleet.</p>", 1303 "StartImageBuilderRequest$Name": "<p>The name of the image builder.</p>", 1304 "StopFleetRequest$Name": "<p>The name of the fleet.</p>", 1305 "StopImageBuilderRequest$Name": "<p>The name of the image builder.</p>", 1306 "StringList$member": null, 1307 "SubnetIdList$member": null, 1308 "UpdateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>", 1309 "UpdateFleetRequest$Name": "<p>A unique name for the fleet.</p>", 1310 "UpdateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>", 1311 "UpdateStackRequest$Name": "<p>The name of the stack.</p>", 1312 "UsageReportSubscription$S3BucketName": "<p>The Amazon S3 bucket where generated reports are stored.</p> <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.</p>", 1313 "User$Status": "<p>The status of the user in the user pool. The status can be one of the following:</p> <ul> <li> <p>UNCONFIRMED – The user is created but not confirmed.</p> </li> <li> <p>CONFIRMED – The user is confirmed.</p> </li> <li> <p>ARCHIVED – The user is no longer active.</p> </li> <li> <p>COMPROMISED – The user is disabled because of a potential security threat.</p> </li> <li> <p>UNKNOWN – The user status is not known.</p> </li> </ul>", 1314 "UserStackAssociation$StackName": "<p>The name of the stack that is associated with the user.</p>", 1315 "UserStackAssociationError$ErrorMessage": "<p>The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>" 1316 } 1317 }, 1318 "StringList": { 1319 "base": null, 1320 "refs": { 1321 "DescribeFleetsRequest$Names": "<p>The names of the fleets to describe.</p>", 1322 "DescribeImageBuildersRequest$Names": "<p>The names of the image builders to describe.</p>", 1323 "DescribeImagesRequest$Names": "<p>The names of the public or private images to describe.</p>", 1324 "DescribeStacksRequest$Names": "<p>The names of the stacks to describe.</p>", 1325 "ListAssociatedFleetsResult$Names": "<p>The name of the fleet.</p>", 1326 "ListAssociatedStacksResult$Names": "<p>The name of the stack.</p>" 1327 } 1328 }, 1329 "SubnetIdList": { 1330 "base": "<p>The subnet identifiers.</p>", 1331 "refs": { 1332 "VpcConfig$SubnetIds": "<p>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</p>" 1333 } 1334 }, 1335 "TagKey": { 1336 "base": null, 1337 "refs": { 1338 "TagKeyList$member": null, 1339 "Tags$key": null 1340 } 1341 }, 1342 "TagKeyList": { 1343 "base": null, 1344 "refs": { 1345 "UntagResourceRequest$TagKeys": "<p>The tag keys for the tags to disassociate.</p>" 1346 } 1347 }, 1348 "TagResourceRequest": { 1349 "base": null, 1350 "refs": { 1351 } 1352 }, 1353 "TagResourceResponse": { 1354 "base": null, 1355 "refs": { 1356 } 1357 }, 1358 "TagValue": { 1359 "base": null, 1360 "refs": { 1361 "Tags$value": null 1362 } 1363 }, 1364 "Tags": { 1365 "base": null, 1366 "refs": { 1367 "CreateFleetRequest$Tags": "<p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 1368 "CreateImageBuilderRequest$Tags": "<p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 1369 "CreateStackRequest$Tags": "<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>", 1370 "ListTagsForResourceResponse$Tags": "<p>The information about the tags.</p>", 1371 "TagResourceRequest$Tags": "<p>The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p>" 1372 } 1373 }, 1374 "Timestamp": { 1375 "base": null, 1376 "refs": { 1377 "CreateImageBuilderStreamingURLResult$Expires": "<p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>", 1378 "CreateStreamingURLResult$Expires": "<p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>", 1379 "DirectoryConfig$CreatedTime": "<p>The time the directory configuration was created.</p>", 1380 "Fleet$CreatedTime": "<p>The time the fleet was created.</p>", 1381 "Image$CreatedTime": "<p>The time the image was created.</p>", 1382 "Image$PublicBaseImageReleasedDate": "<p>The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>", 1383 "ImageBuilder$CreatedTime": "<p>The time stamp when the image builder was created.</p>", 1384 "ResourceError$ErrorTimestamp": "<p>The time the error occurred.</p>", 1385 "Session$StartTime": "<p>The time when a streaming instance is dedicated for the user.</p>", 1386 "Session$MaxExpirationTime": "<p>The time when the streaming session is set to expire. This time is based on the <code>MaxUserDurationinSeconds</code> value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in <code>SessionMaxExpirationTime</code>, when the <code>DisconnectTimeOutInSeconds</code> elapses or the user chooses to end his or her session. If the <code>DisconnectTimeOutInSeconds</code> elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.</p>", 1387 "Stack$CreatedTime": "<p>The time the stack was created.</p>", 1388 "UsageReportSubscription$LastGeneratedReportDate": "<p>The time when the last usage report was generated.</p>", 1389 "User$CreatedTime": "<p>The date and time the user was created in the user pool.</p>" 1390 } 1391 }, 1392 "UntagResourceRequest": { 1393 "base": null, 1394 "refs": { 1395 } 1396 }, 1397 "UntagResourceResponse": { 1398 "base": null, 1399 "refs": { 1400 } 1401 }, 1402 "UpdateDirectoryConfigRequest": { 1403 "base": null, 1404 "refs": { 1405 } 1406 }, 1407 "UpdateDirectoryConfigResult": { 1408 "base": null, 1409 "refs": { 1410 } 1411 }, 1412 "UpdateFleetRequest": { 1413 "base": null, 1414 "refs": { 1415 } 1416 }, 1417 "UpdateFleetResult": { 1418 "base": null, 1419 "refs": { 1420 } 1421 }, 1422 "UpdateImagePermissionsRequest": { 1423 "base": null, 1424 "refs": { 1425 } 1426 }, 1427 "UpdateImagePermissionsResult": { 1428 "base": null, 1429 "refs": { 1430 } 1431 }, 1432 "UpdateStackRequest": { 1433 "base": null, 1434 "refs": { 1435 } 1436 }, 1437 "UpdateStackResult": { 1438 "base": null, 1439 "refs": { 1440 } 1441 }, 1442 "UsageReportExecutionErrorCode": { 1443 "base": null, 1444 "refs": { 1445 "LastReportGenerationExecutionError$ErrorCode": "<p>The error code for the error that is returned when a usage report can't be generated.</p>" 1446 } 1447 }, 1448 "UsageReportSchedule": { 1449 "base": null, 1450 "refs": { 1451 "CreateUsageReportSubscriptionResult$Schedule": "<p>The schedule for generating usage reports.</p>", 1452 "UsageReportSubscription$Schedule": "<p>The schedule for generating usage reports.</p>" 1453 } 1454 }, 1455 "UsageReportSubscription": { 1456 "base": "<p>Describes information about the usage report subscription.</p>", 1457 "refs": { 1458 "UsageReportSubscriptionList$member": null 1459 } 1460 }, 1461 "UsageReportSubscriptionList": { 1462 "base": null, 1463 "refs": { 1464 "DescribeUsageReportSubscriptionsResult$UsageReportSubscriptions": "<p>Information about the usage report subscription.</p>" 1465 } 1466 }, 1467 "User": { 1468 "base": "<p>Describes a user in the user pool.</p>", 1469 "refs": { 1470 "UserList$member": null 1471 } 1472 }, 1473 "UserAttributeValue": { 1474 "base": null, 1475 "refs": { 1476 "CreateUserRequest$FirstName": "<p>The first name, or given name, of the user.</p>", 1477 "CreateUserRequest$LastName": "<p>The last name, or surname, of the user.</p>", 1478 "User$FirstName": "<p>The first name, or given name, of the user.</p>", 1479 "User$LastName": "<p>The last name, or surname, of the user.</p>" 1480 } 1481 }, 1482 "UserId": { 1483 "base": null, 1484 "refs": { 1485 "DescribeSessionsRequest$UserId": "<p>The user identifier.</p>", 1486 "Session$UserId": "<p>The identifier of the user for whom the session was created.</p>" 1487 } 1488 }, 1489 "UserList": { 1490 "base": null, 1491 "refs": { 1492 "DescribeUsersResult$Users": "<p>Information about users in the user pool.</p>" 1493 } 1494 }, 1495 "UserSetting": { 1496 "base": "<p>Describes an action and whether the action is enabled or disabled for users during their streaming sessions.</p>", 1497 "refs": { 1498 "UserSettingList$member": null 1499 } 1500 }, 1501 "UserSettingList": { 1502 "base": null, 1503 "refs": { 1504 "CreateStackRequest$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>", 1505 "Stack$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.</p>", 1506 "UpdateStackRequest$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.</p>" 1507 } 1508 }, 1509 "UserStackAssociation": { 1510 "base": "<p>Describes a user in the user pool and the associated stack.</p>", 1511 "refs": { 1512 "UserStackAssociationError$UserStackAssociation": "<p>Information about the user and associated stack.</p>", 1513 "UserStackAssociationList$member": null 1514 } 1515 }, 1516 "UserStackAssociationError": { 1517 "base": "<p>Describes the error that is returned when a user can’t be associated with or disassociated from a stack. </p>", 1518 "refs": { 1519 "UserStackAssociationErrorList$member": null 1520 } 1521 }, 1522 "UserStackAssociationErrorCode": { 1523 "base": null, 1524 "refs": { 1525 "UserStackAssociationError$ErrorCode": "<p>The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>" 1526 } 1527 }, 1528 "UserStackAssociationErrorList": { 1529 "base": null, 1530 "refs": { 1531 "BatchAssociateUserStackResult$errors": "<p>The list of UserStackAssociationError objects.</p>", 1532 "BatchDisassociateUserStackResult$errors": "<p>The list of UserStackAssociationError objects.</p>" 1533 } 1534 }, 1535 "UserStackAssociationList": { 1536 "base": null, 1537 "refs": { 1538 "BatchAssociateUserStackRequest$UserStackAssociations": "<p>The list of UserStackAssociation objects.</p>", 1539 "BatchDisassociateUserStackRequest$UserStackAssociations": "<p>The list of UserStackAssociation objects.</p>", 1540 "DescribeUserStackAssociationsResult$UserStackAssociations": "<p>The UserStackAssociation objects.</p>" 1541 } 1542 }, 1543 "Username": { 1544 "base": null, 1545 "refs": { 1546 "CreateUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.</p> </note>", 1547 "DeleteUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>", 1548 "DescribeUserStackAssociationsRequest$UserName": "<p>The email address of the user who is associated with the stack.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>", 1549 "DisableUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>", 1550 "EnableUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays. </p> </note>", 1551 "User$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>", 1552 "UserStackAssociation$UserName": "<p>The email address of the user who is associated with the stack.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>" 1553 } 1554 }, 1555 "VisibilityType": { 1556 "base": null, 1557 "refs": { 1558 "DescribeImagesRequest$Type": "<p>The type of image (public, private, or shared) to describe. </p>", 1559 "Image$Visibility": "<p>Indicates whether the image is public or private.</p>" 1560 } 1561 }, 1562 "VpcConfig": { 1563 "base": "<p>Describes VPC configuration information for fleets and image builders.</p>", 1564 "refs": { 1565 "CreateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>", 1566 "CreateImageBuilderRequest$VpcConfig": "<p>The VPC configuration for the image builder. You can specify only one subnet.</p>", 1567 "Fleet$VpcConfig": "<p>The VPC configuration for the fleet.</p>", 1568 "ImageBuilder$VpcConfig": "<p>The VPC configuration of the image builder.</p>", 1569 "UpdateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>" 1570 } 1571 } 1572 } 1573} 1574