{ "version": "2.0", "service": "Amazon AppStream 2.0

You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.

", "operations": { "AssociateFleet": "

Associates the specified fleet with the specified stack.

", "CopyImage": "

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.

", "CreateDirectoryConfig": "

Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

", "CreateFleet": "

Creates a fleet. A fleet consists of streaming instances that run a specified image.

", "CreateImageBuilder": "

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

", "CreateImageBuilderStreamingURL": "

Creates a URL to start an image builder streaming session.

", "CreateStack": "

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

", "CreateStreamingURL": "

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.

", "DeleteDirectoryConfig": "

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.

", "DeleteFleet": "

Deletes the specified fleet.

", "DeleteImage": "

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.

", "DeleteImageBuilder": "

Deletes the specified image builder and releases the capacity.

", "DeleteImagePermissions": "

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.

", "DeleteStack": "

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.

", "DescribeDirectoryConfigs": "

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 information required to join streaming instances to an Active Directory domain.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

", "DescribeFleets": "

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

", "DescribeImageBuilders": "

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.

", "DescribeImagePermissions": "

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

", "DescribeImages": "

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.

", "DescribeSessions": "

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a user ID 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.

", "DescribeStacks": "

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

", "DisassociateFleet": "

Disassociates the specified fleet from the specified stack.

", "ExpireSession": "

Immediately stops the specified streaming session.

", "ListAssociatedFleets": "

Retrieves the name of the fleet that is associated with the specified stack.

", "ListAssociatedStacks": "

Retrieves the name of the stack with which the specified fleet is associated.

", "ListTagsForResource": "

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.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

", "StartFleet": "

Starts the specified fleet.

", "StartImageBuilder": "

Starts the specified image builder.

", "StopFleet": "

Stops the specified fleet.

", "StopImageBuilder": "

Stops the specified image builder.

", "TagResource": "

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.

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.

To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

", "UntagResource": "

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

", "UpdateDirectoryConfig": "

Updates the specified Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

", "UpdateFleet": "

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

", "UpdateImagePermissions": "

Adds or updates permissions for the specified private image.

", "UpdateStack": "

Updates the specified fields for the specified stack.

" }, "shapes": { "AccountName": { "base": null, "refs": { "ServiceAccountCredentials$AccountName": "

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.

" } }, "AccountPassword": { "base": null, "refs": { "ServiceAccountCredentials$AccountPassword": "

The password for the account.

" } }, "Action": { "base": null, "refs": { "UserSetting$Action": "

The action that is enabled or disabled.

" } }, "Application": { "base": "

Describes an application in the application catalog.

", "refs": { "Applications$member": null } }, "ApplicationSettings": { "base": "

The persistent application settings for users of a stack.

", "refs": { "CreateStackRequest$ApplicationSettings": "

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

", "UpdateStackRequest$ApplicationSettings": "

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

" } }, "ApplicationSettingsResponse": { "base": "

Describes the persistent application settings for users of a stack.

", "refs": { "Stack$ApplicationSettings": "

The persistent application settings for users of the stack.

" } }, "Applications": { "base": null, "refs": { "Image$Applications": "

The applications associated with the image.

" } }, "AppstreamAgentVersion": { "base": null, "refs": { "CreateImageBuilderRequest$AppstreamAgentVersion": "

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].

", "Image$AppstreamAgentVersion": "

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

", "ImageBuilder$AppstreamAgentVersion": "

The version of the AppStream 2.0 agent that is currently being used by this image builder.

", "StartImageBuilderRequest$AppstreamAgentVersion": "

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].

" } }, "Arn": { "base": null, "refs": { "ArnList$member": null, "CreateFleetRequest$ImageArn": "

The ARN of the public, private, or shared image to use.

", "CreateImageBuilderRequest$ImageArn": "

The ARN of the public, private, or shared image to use.

", "Fleet$Arn": "

The ARN for the fleet.

", "Fleet$ImageArn": "

The ARN for the public, private, or shared image.

", "Image$Arn": "

The ARN of the image.

", "Image$BaseImageArn": "

The ARN of the image from which this image was created.

", "ImageBuilder$Arn": "

The ARN for the image builder.

", "ImageBuilder$ImageArn": "

The ARN of the image from which this builder was created.

", "ListTagsForResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", "Stack$Arn": "

The ARN of the stack.

", "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", "UpdateFleetRequest$ImageArn": "

The ARN of the public, private, or shared image to use.

" } }, "ArnList": { "base": null, "refs": { "DescribeImagesRequest$Arns": "

The ARNs of the public, private, and shared images to describe.

" } }, "AssociateFleetRequest": { "base": null, "refs": { } }, "AssociateFleetResult": { "base": null, "refs": { } }, "AuthenticationType": { "base": null, "refs": { "DescribeSessionsRequest$AuthenticationType": "

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

", "Session$AuthenticationType": "

The authentication method. The user is authenticated using a streaming URL (API) or SAML federation (SAML).

" } }, "AwsAccountId": { "base": null, "refs": { "AwsAccountIdList$member": null, "DeleteImagePermissionsRequest$SharedAccountId": "

The 12-digit ID of the AWS account for which to delete image permissions.

", "SharedImagePermissions$sharedAccountId": "

The 12-digit ID of the AWS account with which the image is shared.

", "UpdateImagePermissionsRequest$SharedAccountId": "

The 12-digit ID of the AWS account for which you want add or update image permissions.

" } }, "AwsAccountIdList": { "base": null, "refs": { "DescribeImagePermissionsRequest$SharedAwsAccountIds": "

The 12-digit ID of one or more AWS accounts with which the image is shared.

" } }, "Boolean": { "base": null, "refs": { "Application$Enabled": "

If there is a problem, the application can be disabled after image creation.

", "ApplicationSettings$Enabled": "

Enables or disables persistent application settings for users during their streaming sessions.

", "ApplicationSettingsResponse$Enabled": "

Specifies whether persistent application settings are enabled for users during their streaming sessions.

", "Image$ImageBuilderSupported": "

Indicates whether an image builder can be launched from this image.

", "UpdateFleetRequest$DeleteVpcConfig": "

Deletes the VPC association for the specified fleet.

", "UpdateStackRequest$DeleteStorageConnectors": "

Deletes the storage connectors currently enabled for the stack.

" } }, "BooleanObject": { "base": null, "refs": { "CreateFleetRequest$EnableDefaultInternetAccess": "

Enables or disables default internet access for the fleet.

", "CreateImageBuilderRequest$EnableDefaultInternetAccess": "

Enables or disables default internet access for the image builder.

", "Fleet$EnableDefaultInternetAccess": "

Indicates whether default internet access is enabled for the fleet.

", "ImageBuilder$EnableDefaultInternetAccess": "

Enables or disables default internet access for the image builder.

", "ImagePermissions$allowFleet": "

Indicates whether the image can be used for a fleet.

", "ImagePermissions$allowImageBuilder": "

Indicates whether the image can be used for an image builder.

", "UpdateFleetRequest$EnableDefaultInternetAccess": "

Enables or disables default internet access for the fleet.

" } }, "ComputeCapacity": { "base": "

Describes the capacity for a fleet.

", "refs": { "CreateFleetRequest$ComputeCapacity": "

The desired capacity for the fleet.

", "UpdateFleetRequest$ComputeCapacity": "

The desired capacity for the fleet.

" } }, "ComputeCapacityStatus": { "base": "

Describes the capacity status for a fleet.

", "refs": { "Fleet$ComputeCapacityStatus": "

The capacity status for the fleet.

" } }, "ConcurrentModificationException": { "base": "

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

", "refs": { } }, "CopyImageRequest": { "base": null, "refs": { } }, "CopyImageResponse": { "base": null, "refs": { } }, "CreateDirectoryConfigRequest": { "base": null, "refs": { } }, "CreateDirectoryConfigResult": { "base": null, "refs": { } }, "CreateFleetRequest": { "base": null, "refs": { } }, "CreateFleetResult": { "base": null, "refs": { } }, "CreateImageBuilderRequest": { "base": null, "refs": { } }, "CreateImageBuilderResult": { "base": null, "refs": { } }, "CreateImageBuilderStreamingURLRequest": { "base": null, "refs": { } }, "CreateImageBuilderStreamingURLResult": { "base": null, "refs": { } }, "CreateStackRequest": { "base": null, "refs": { } }, "CreateStackResult": { "base": null, "refs": { } }, "CreateStreamingURLRequest": { "base": null, "refs": { } }, "CreateStreamingURLResult": { "base": null, "refs": { } }, "DeleteDirectoryConfigRequest": { "base": null, "refs": { } }, "DeleteDirectoryConfigResult": { "base": null, "refs": { } }, "DeleteFleetRequest": { "base": null, "refs": { } }, "DeleteFleetResult": { "base": null, "refs": { } }, "DeleteImageBuilderRequest": { "base": null, "refs": { } }, "DeleteImageBuilderResult": { "base": null, "refs": { } }, "DeleteImagePermissionsRequest": { "base": null, "refs": { } }, "DeleteImagePermissionsResult": { "base": null, "refs": { } }, "DeleteImageRequest": { "base": null, "refs": { } }, "DeleteImageResult": { "base": null, "refs": { } }, "DeleteStackRequest": { "base": null, "refs": { } }, "DeleteStackResult": { "base": null, "refs": { } }, "DescribeDirectoryConfigsRequest": { "base": null, "refs": { } }, "DescribeDirectoryConfigsResult": { "base": null, "refs": { } }, "DescribeFleetsRequest": { "base": null, "refs": { } }, "DescribeFleetsResult": { "base": null, "refs": { } }, "DescribeImageBuildersRequest": { "base": null, "refs": { } }, "DescribeImageBuildersResult": { "base": null, "refs": { } }, "DescribeImagePermissionsRequest": { "base": null, "refs": { } }, "DescribeImagePermissionsResult": { "base": null, "refs": { } }, "DescribeImagesMaxResults": { "base": null, "refs": { "DescribeImagesRequest$MaxResults": "

The maximum size of each page of results.

" } }, "DescribeImagesRequest": { "base": null, "refs": { } }, "DescribeImagesResult": { "base": null, "refs": { } }, "DescribeSessionsRequest": { "base": null, "refs": { } }, "DescribeSessionsResult": { "base": null, "refs": { } }, "DescribeStacksRequest": { "base": null, "refs": { } }, "DescribeStacksResult": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "CopyImageRequest$DestinationImageDescription": "

The description that the image will have when it is copied to the destination.

", "CreateFleetRequest$Description": "

The description for display.

", "CreateImageBuilderRequest$Description": "

The description for display.

", "CreateStackRequest$Description": "

The description for display.

", "UpdateFleetRequest$Description": "

The description for display.

", "UpdateStackRequest$Description": "

The description for display.

" } }, "DirectoryConfig": { "base": "

Configuration information for the directory used to join domains.

", "refs": { "CreateDirectoryConfigResult$DirectoryConfig": "

Information about the directory configuration.

", "DirectoryConfigList$member": null, "UpdateDirectoryConfigResult$DirectoryConfig": "

Information about the Directory Config object.

" } }, "DirectoryConfigList": { "base": null, "refs": { "DescribeDirectoryConfigsResult$DirectoryConfigs": "

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.

" } }, "DirectoryName": { "base": null, "refs": { "CreateDirectoryConfigRequest$DirectoryName": "

The fully qualified name of the directory (for example, corp.example.com).

", "DeleteDirectoryConfigRequest$DirectoryName": "

The name of the directory configuration.

", "DirectoryConfig$DirectoryName": "

The fully qualified name of the directory (for example, corp.example.com).

", "DirectoryNameList$member": null, "DomainJoinInfo$DirectoryName": "

The fully qualified name of the directory (for example, corp.example.com).

", "UpdateDirectoryConfigRequest$DirectoryName": "

The name of the Directory Config object.

" } }, "DirectoryNameList": { "base": null, "refs": { "DescribeDirectoryConfigsRequest$DirectoryNames": "

The directory names.

" } }, "DisassociateFleetRequest": { "base": null, "refs": { } }, "DisassociateFleetResult": { "base": null, "refs": { } }, "DisplayName": { "base": null, "refs": { "CreateFleetRequest$DisplayName": "

The fleet name for display.

", "CreateImageBuilderRequest$DisplayName": "

The image builder name for display.

", "CreateStackRequest$DisplayName": "

The stack name for display.

", "UpdateFleetRequest$DisplayName": "

The fleet name for display.

", "UpdateStackRequest$DisplayName": "

The stack name for display.

" } }, "Domain": { "base": "GSuite domain for GDrive integration.", "refs": { "DomainList$member": null } }, "DomainJoinInfo": { "base": "

Contains the information needed to join a Microsoft Active Directory domain.

", "refs": { "CreateFleetRequest$DomainJoinInfo": "

The information needed to join a Microsoft Active Directory domain.

", "CreateImageBuilderRequest$DomainJoinInfo": "

The information needed to join a Microsoft Active Directory domain.

", "Fleet$DomainJoinInfo": "

The information needed to join a Microsoft Active Directory domain.

", "ImageBuilder$DomainJoinInfo": "

The information needed to join a Microsoft Active Directory domain.

", "UpdateFleetRequest$DomainJoinInfo": "

The information needed to join a Microsoft Active Directory domain.

" } }, "DomainList": { "base": null, "refs": { "StorageConnector$Domains": "

The names of the domains for the G Suite account.

" } }, "ErrorMessage": { "base": "

The error message in the exception.

", "refs": { "ConcurrentModificationException$Message": null, "IncompatibleImageException$Message": null, "InvalidAccountStatusException$Message": null, "InvalidParameterCombinationException$Message": null, "InvalidRoleException$Message": null, "LimitExceededException$Message": null, "OperationNotPermittedException$Message": null, "ResourceAlreadyExistsException$Message": null, "ResourceInUseException$Message": null, "ResourceNotAvailableException$Message": null, "ResourceNotFoundException$Message": null } }, "ExpireSessionRequest": { "base": null, "refs": { } }, "ExpireSessionResult": { "base": null, "refs": { } }, "FeedbackURL": { "base": null, "refs": { "CreateStackRequest$FeedbackURL": "

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.

", "Stack$FeedbackURL": "

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.

", "UpdateStackRequest$FeedbackURL": "

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.

" } }, "Fleet": { "base": "

Contains the parameters for a fleet.

", "refs": { "CreateFleetResult$Fleet": "

Information about the fleet.

", "FleetList$member": null, "UpdateFleetResult$Fleet": "

Information about the fleet.

" } }, "FleetAttribute": { "base": "

The fleet attribute.

", "refs": { "FleetAttributes$member": null } }, "FleetAttributes": { "base": "

The fleet attributes.

", "refs": { "UpdateFleetRequest$AttributesToDelete": "

The fleet attributes to delete.

" } }, "FleetError": { "base": "

Describes a fleet error.

", "refs": { "FleetErrors$member": null } }, "FleetErrorCode": { "base": null, "refs": { "FleetError$ErrorCode": "

The error code.

", "ResourceError$ErrorCode": "

The error code.

" } }, "FleetErrors": { "base": null, "refs": { "Fleet$FleetErrors": "

The fleet errors.

" } }, "FleetList": { "base": "

The fleets.

", "refs": { "DescribeFleetsResult$Fleets": "

Information about the fleets.

" } }, "FleetState": { "base": null, "refs": { "Fleet$State": "

The current state for the fleet.

" } }, "FleetType": { "base": null, "refs": { "CreateFleetRequest$FleetType": "

The fleet type.

ALWAYS_ON

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.

ON_DEMAND

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.

", "Fleet$FleetType": "

The fleet type.

ALWAYS_ON

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.

ON_DEMAND

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.

" } }, "Image": { "base": "

Describes an image.

", "refs": { "DeleteImageResult$Image": "

Information about the image.

", "ImageList$member": null } }, "ImageBuilder": { "base": "

Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

", "refs": { "CreateImageBuilderResult$ImageBuilder": "

Information about the image builder.

", "DeleteImageBuilderResult$ImageBuilder": "

Information about the image builder.

", "ImageBuilderList$member": null, "StartImageBuilderResult$ImageBuilder": "

Information about the image builder.

", "StopImageBuilderResult$ImageBuilder": "

Information about the image builder.

" } }, "ImageBuilderList": { "base": null, "refs": { "DescribeImageBuildersResult$ImageBuilders": "

Information about the image builders.

" } }, "ImageBuilderState": { "base": null, "refs": { "ImageBuilder$State": "

The state of the image builder.

" } }, "ImageBuilderStateChangeReason": { "base": "

Describes the reason why the last image builder state change occurred.

", "refs": { "ImageBuilder$StateChangeReason": "

The reason why the last state change occurred.

" } }, "ImageBuilderStateChangeReasonCode": { "base": null, "refs": { "ImageBuilderStateChangeReason$Code": "

The state change reason code.

" } }, "ImageList": { "base": null, "refs": { "DescribeImagesResult$Images": "

Information about the images.

" } }, "ImagePermissions": { "base": "

Describes the permissions for an image.

", "refs": { "Image$ImagePermissions": "

The permissions to provide to the destination AWS account for the specified image.

", "SharedImagePermissions$imagePermissions": "

Describes the permissions for a shared image.

", "UpdateImagePermissionsRequest$ImagePermissions": "

The permissions for the image.

" } }, "ImageState": { "base": null, "refs": { "Image$State": "

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

" } }, "ImageStateChangeReason": { "base": "

Describes the reason why the last image state change occurred.

", "refs": { "Image$StateChangeReason": "

The reason why the last state change occurred.

" } }, "ImageStateChangeReasonCode": { "base": null, "refs": { "ImageStateChangeReason$Code": "

The state change reason code.

" } }, "IncompatibleImageException": { "base": "

The image does not support storage connectors.

", "refs": { } }, "Integer": { "base": null, "refs": { "ComputeCapacity$DesiredInstances": "

The desired number of streaming instances.

", "ComputeCapacityStatus$Desired": "

The desired number of streaming instances.

", "ComputeCapacityStatus$Running": "

The total number of simultaneous streaming instances that are running.

", "ComputeCapacityStatus$InUse": "

The number of instances in use for streaming.

", "ComputeCapacityStatus$Available": "

The number of currently available instances that can be used to stream sessions.

", "CreateFleetRequest$MaxUserDurationInSeconds": "

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

", "CreateFleetRequest$DisconnectTimeoutInSeconds": "

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

", "DescribeDirectoryConfigsRequest$MaxResults": "

The maximum size of each page of results.

", "DescribeImageBuildersRequest$MaxResults": "

The maximum size of each page of results.

", "DescribeSessionsRequest$Limit": "

The size of each page of results. The default value is 20 and the maximum value is 50.

", "Fleet$MaxUserDurationInSeconds": "

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

", "Fleet$DisconnectTimeoutInSeconds": "

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

", "UpdateFleetRequest$MaxUserDurationInSeconds": "

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

", "UpdateFleetRequest$DisconnectTimeoutInSeconds": "

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

" } }, "InvalidAccountStatusException": { "base": "

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

", "refs": { } }, "InvalidParameterCombinationException": { "base": "

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

", "refs": { } }, "InvalidRoleException": { "base": "

The specified role is invalid.

", "refs": { } }, "LimitExceededException": { "base": "

The requested limit exceeds the permitted limit for an account.

", "refs": { } }, "ListAssociatedFleetsRequest": { "base": null, "refs": { } }, "ListAssociatedFleetsResult": { "base": null, "refs": { } }, "ListAssociatedStacksRequest": { "base": null, "refs": { } }, "ListAssociatedStacksResult": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "CreateImageBuilderStreamingURLRequest$Validity": "

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

", "CreateStreamingURLRequest$Validity": "

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

" } }, "MaxResults": { "base": null, "refs": { "DescribeImagePermissionsRequest$MaxResults": "

The maximum size of each results page.

" } }, "Metadata": { "base": null, "refs": { "Application$Metadata": "

Additional attributes that describe the application.

" } }, "Name": { "base": null, "refs": { "CopyImageRequest$SourceImageName": "

The name of the image to copy.

", "CopyImageRequest$DestinationImageName": "

The name that the image will have when it is copied to the destination.

", "CopyImageResponse$DestinationImageName": "

The name of the destination image.

", "CreateFleetRequest$Name": "

A unique name for the fleet.

", "CreateImageBuilderRequest$Name": "

A unique name for the image builder.

", "CreateStackRequest$Name": "

The name of the stack.

", "DeleteImageBuilderRequest$Name": "

The name of the image builder.

", "DeleteImagePermissionsRequest$Name": "

The name of the private image.

", "DeleteImageRequest$Name": "

The name of the image.

", "DescribeImagePermissionsRequest$Name": "

The name of the private image for which to describe permissions. The image must be one that you own.

", "DescribeImagePermissionsResult$Name": "

The name of the private image.

", "UpdateImagePermissionsRequest$Name": "

The name of the private image.

" } }, "NetworkAccessConfiguration": { "base": "

The network details of the fleet instance for the streaming session.

", "refs": { "Session$NetworkAccessConfiguration": "

The network details for the streaming session.

" } }, "OperationNotPermittedException": { "base": "

The attempted operation is not permitted.

", "refs": { } }, "OrganizationalUnitDistinguishedName": { "base": null, "refs": { "DomainJoinInfo$OrganizationalUnitDistinguishedName": "

The distinguished name of the organizational unit for computer accounts.

", "OrganizationalUnitDistinguishedNamesList$member": null } }, "OrganizationalUnitDistinguishedNamesList": { "base": null, "refs": { "CreateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "

The distinguished names of the organizational units for computer accounts.

", "DirectoryConfig$OrganizationalUnitDistinguishedNames": "

The distinguished names of the organizational units for computer accounts.

", "UpdateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "

The distinguished names of the organizational units for computer accounts.

" } }, "Permission": { "base": null, "refs": { "UserSetting$Permission": "

Indicates whether the action is enabled or disabled.

" } }, "PlatformType": { "base": null, "refs": { "Image$Platform": "

The operating system platform of the image.

", "ImageBuilder$Platform": "

The operating system platform of the image builder.

" } }, "RedirectURL": { "base": null, "refs": { "CreateStackRequest$RedirectURL": "

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

", "Stack$RedirectURL": "

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

", "UpdateStackRequest$RedirectURL": "

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

" } }, "RegionName": { "base": null, "refs": { "CopyImageRequest$DestinationRegion": "

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.

" } }, "ResourceAlreadyExistsException": { "base": "

The specified resource already exists.

", "refs": { } }, "ResourceError": { "base": "

Describes a resource error.

", "refs": { "ResourceErrors$member": null } }, "ResourceErrors": { "base": null, "refs": { "ImageBuilder$ImageBuilderErrors": "

The image builder errors.

" } }, "ResourceIdentifier": { "base": "

The ARN of the resource.

", "refs": { "StorageConnector$ResourceIdentifier": "

The ARN of the storage connector.

" } }, "ResourceInUseException": { "base": "

The specified resource is in use.

", "refs": { } }, "ResourceNotAvailableException": { "base": "

The specified resource exists and is not in use, but isn't available.

", "refs": { } }, "ResourceNotFoundException": { "base": "

The specified resource was not found.

", "refs": { } }, "SecurityGroupIdList": { "base": "

The security group IDs.

", "refs": { "VpcConfig$SecurityGroupIds": "

The security groups for the fleet.

" } }, "ServiceAccountCredentials": { "base": "

Describes the credentials for the service account used by the streaming instance to connect to the directory.

", "refs": { "CreateDirectoryConfigRequest$ServiceAccountCredentials": "

The credentials for the service account used by the streaming instance to connect to the directory.

", "DirectoryConfig$ServiceAccountCredentials": "

The credentials for the service account used by the streaming instance to connect to the directory.

", "UpdateDirectoryConfigRequest$ServiceAccountCredentials": "

The credentials for the service account used by the streaming instance to connect to the directory.

" } }, "Session": { "base": "

Describes a streaming session.

", "refs": { "SessionList$member": null } }, "SessionList": { "base": "

List of sessions.

", "refs": { "DescribeSessionsResult$Sessions": "

Information about the streaming sessions.

" } }, "SessionState": { "base": "

Possible values for the state of a streaming session.

", "refs": { "Session$State": "

The current state of the streaming session.

" } }, "SettingsGroup": { "base": null, "refs": { "ApplicationSettings$SettingsGroup": "

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.

", "ApplicationSettingsResponse$SettingsGroup": "

The path prefix for the S3 bucket where users’ persistent application settings are stored.

" } }, "SharedImagePermissions": { "base": "

Describes the permissions that are available to the specified AWS account for a shared image.

", "refs": { "SharedImagePermissionsList$member": null } }, "SharedImagePermissionsList": { "base": null, "refs": { "DescribeImagePermissionsResult$SharedImagePermissionsList": "

The permissions for a private image that you own.

" } }, "Stack": { "base": "

Describes a stack.

", "refs": { "CreateStackResult$Stack": "

Information about the stack.

", "StackList$member": null, "UpdateStackResult$Stack": "

Information about the stack.

" } }, "StackAttribute": { "base": null, "refs": { "StackAttributes$member": null } }, "StackAttributes": { "base": null, "refs": { "UpdateStackRequest$AttributesToDelete": "

The stack attributes to delete.

" } }, "StackError": { "base": "

Describes a stack error.

", "refs": { "StackErrors$member": null } }, "StackErrorCode": { "base": null, "refs": { "StackError$ErrorCode": "

The error code.

" } }, "StackErrors": { "base": "

The stack errors.

", "refs": { "Stack$StackErrors": "

The errors for the stack.

" } }, "StackList": { "base": "

The stacks.

", "refs": { "DescribeStacksResult$Stacks": "

Information about the stacks.

" } }, "StartFleetRequest": { "base": null, "refs": { } }, "StartFleetResult": { "base": null, "refs": { } }, "StartImageBuilderRequest": { "base": null, "refs": { } }, "StartImageBuilderResult": { "base": null, "refs": { } }, "StopFleetRequest": { "base": null, "refs": { } }, "StopFleetResult": { "base": null, "refs": { } }, "StopImageBuilderRequest": { "base": null, "refs": { } }, "StopImageBuilderResult": { "base": null, "refs": { } }, "StorageConnector": { "base": "

Describes a connector to enable persistent storage for users.

", "refs": { "StorageConnectorList$member": null } }, "StorageConnectorList": { "base": "

The storage connectors.

", "refs": { "CreateStackRequest$StorageConnectors": "

The storage connectors to enable.

", "Stack$StorageConnectors": "

The storage connectors to enable.

", "UpdateStackRequest$StorageConnectors": "

The storage connectors to enable.

" } }, "StorageConnectorType": { "base": "

The type of storage connector.

", "refs": { "StorageConnector$ConnectorType": "

The type of storage connector.

" } }, "StreamingUrlUserId": { "base": null, "refs": { "CreateStreamingURLRequest$UserId": "

The ID of the user.

" } }, "String": { "base": null, "refs": { "Application$Name": "

The name of the application.

", "Application$DisplayName": "

The application name for display.

", "Application$IconURL": "

The URL for the application icon. This URL might be time-limited.

", "Application$LaunchPath": "

The path to the application executable in the instance.

", "Application$LaunchParameters": "

The arguments that are passed to the application at launch.

", "ApplicationSettingsResponse$S3BucketName": "

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.

", "AssociateFleetRequest$FleetName": "

The name of the fleet.

", "AssociateFleetRequest$StackName": "

The name of the stack.

", "CreateFleetRequest$ImageName": "

The name of the image used to create the fleet.

", "CreateFleetRequest$InstanceType": "

The instance type to use when launching fleet instances. The following instance types are available:

", "CreateImageBuilderRequest$ImageName": "

The name of the image used to create the builder.

", "CreateImageBuilderRequest$InstanceType": "

The instance type to use when launching the image builder.

", "CreateImageBuilderStreamingURLRequest$Name": "

The name of the image builder.

", "CreateImageBuilderStreamingURLResult$StreamingURL": "

The URL to start the AppStream 2.0 streaming session.

", "CreateStreamingURLRequest$StackName": "

The name of the stack.

", "CreateStreamingURLRequest$FleetName": "

The name of the fleet.

", "CreateStreamingURLRequest$ApplicationId": "

The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.

", "CreateStreamingURLRequest$SessionContext": "

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Developer Guide.

", "CreateStreamingURLResult$StreamingURL": "

The URL to start the AppStream 2.0 streaming session.

", "DeleteFleetRequest$Name": "

The name of the fleet.

", "DeleteStackRequest$Name": "

The name of the stack.

", "DescribeDirectoryConfigsRequest$NextToken": "

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.

", "DescribeDirectoryConfigsResult$NextToken": "

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.

", "DescribeFleetsRequest$NextToken": "

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.

", "DescribeFleetsResult$NextToken": "

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.

", "DescribeImageBuildersRequest$NextToken": "

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.

", "DescribeImageBuildersResult$NextToken": "

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.

", "DescribeImagePermissionsRequest$NextToken": "

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

", "DescribeImagePermissionsResult$NextToken": "

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

", "DescribeImagesRequest$NextToken": "

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

", "DescribeImagesResult$NextToken": "

The pagination token to use to retrieve the next page of results. If there are no more pages, this value is null.

", "DescribeSessionsRequest$StackName": "

The name of the stack. This value is case-sensitive.

", "DescribeSessionsRequest$FleetName": "

The name of the fleet. This value is case-sensitive.

", "DescribeSessionsRequest$NextToken": "

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.

", "DescribeSessionsResult$NextToken": "

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.

", "DescribeStacksRequest$NextToken": "

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.

", "DescribeStacksResult$NextToken": "

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.

", "DisassociateFleetRequest$FleetName": "

The name of the fleet.

", "DisassociateFleetRequest$StackName": "

The name of the stack.

", "ExpireSessionRequest$SessionId": "

The ID of the streaming session.

", "Fleet$Name": "

The name of the fleet.

", "Fleet$DisplayName": "

The fleet name for display.

", "Fleet$Description": "

The description for display.

", "Fleet$ImageName": "

The name of the image used to create the fleet.

", "Fleet$InstanceType": "

The instance type to use when launching fleet instances.

", "FleetError$ErrorMessage": "

The error message.

", "Image$Name": "

The name of the image.

", "Image$DisplayName": "

The image name for display.

", "Image$Description": "

The description for display.

", "ImageBuilder$Name": "

The name of the image builder.

", "ImageBuilder$Description": "

The description for display.

", "ImageBuilder$DisplayName": "

The image builder name for display.

", "ImageBuilder$InstanceType": "

The instance type for the image builder.

", "ImageBuilderStateChangeReason$Message": "

The state change reason message.

", "ImageStateChangeReason$Message": "

The state change reason message.

", "ListAssociatedFleetsRequest$StackName": "

The name of the stack.

", "ListAssociatedFleetsRequest$NextToken": "

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.

", "ListAssociatedFleetsResult$NextToken": "

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.

", "ListAssociatedStacksRequest$FleetName": "

The name of the fleet.

", "ListAssociatedStacksRequest$NextToken": "

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.

", "ListAssociatedStacksResult$NextToken": "

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.

", "Metadata$key": null, "Metadata$value": null, "NetworkAccessConfiguration$EniPrivateIpAddress": "

The private IP address of the elastic network interface that is attached to instances in your VPC.

", "NetworkAccessConfiguration$EniId": "

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.

", "ResourceError$ErrorMessage": "

The error message.

", "SecurityGroupIdList$member": null, "Session$Id": "

The ID of the streaming session.

", "Session$StackName": "

The name of the stack for the streaming session.

", "Session$FleetName": "

The name of the fleet for the streaming session.

", "Stack$Name": "

The name of the stack.

", "Stack$Description": "

The description for display.

", "Stack$DisplayName": "

The stack name for display.

", "StackError$ErrorMessage": "

The error message.

", "StartFleetRequest$Name": "

The name of the fleet.

", "StartImageBuilderRequest$Name": "

The name of the image builder.

", "StopFleetRequest$Name": "

The name of the fleet.

", "StopImageBuilderRequest$Name": "

The name of the image builder.

", "StringList$member": null, "SubnetIdList$member": null, "UpdateFleetRequest$ImageName": "

The name of the image used to create the fleet.

", "UpdateFleetRequest$Name": "

A unique name for the fleet.

", "UpdateFleetRequest$InstanceType": "

The instance type to use when launching fleet instances. The following instance types are available:

", "UpdateStackRequest$Name": "

The name of the stack.

" } }, "StringList": { "base": null, "refs": { "DescribeFleetsRequest$Names": "

The names of the fleets to describe.

", "DescribeImageBuildersRequest$Names": "

The names of the image builders to describe.

", "DescribeImagesRequest$Names": "

The names of the public or private images to describe.

", "DescribeStacksRequest$Names": "

The names of the stacks to describe.

", "ListAssociatedFleetsResult$Names": "

The name of the fleet.

", "ListAssociatedStacksResult$Names": "

The name of the stack.

" } }, "SubnetIdList": { "base": "

The subnet IDs.

", "refs": { "VpcConfig$SubnetIds": "

The subnets to which a network interface is established from the fleet instance.

" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "

The tag keys for the tags to disassociate.

" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "ListTagsForResourceResponse$Tags": "

The information about the tags.

", "TagResourceRequest$Tags": "

The tags to associate. A tag is a key-value pair (the value is optional). For example, Environment=Test, or, if you do not specify a value, Environment=.

If you do not specify a value, we set the value to an empty string.

" } }, "Timestamp": { "base": null, "refs": { "CreateImageBuilderStreamingURLResult$Expires": "

The elapsed time, in seconds after the Unix epoch, when this URL expires.

", "CreateStreamingURLResult$Expires": "

The elapsed time, in seconds after the Unix epoch, when this URL expires.

", "DirectoryConfig$CreatedTime": "

The time the directory configuration was created.

", "Fleet$CreatedTime": "

The time the fleet was created.

", "Image$CreatedTime": "

The time the image was created.

", "Image$PublicBaseImageReleasedDate": "

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.

", "ImageBuilder$CreatedTime": "

The time stamp when the image builder was created.

", "ResourceError$ErrorTimestamp": "

The time the error occurred.

", "Stack$CreatedTime": "

The time the stack was created.

" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateDirectoryConfigRequest": { "base": null, "refs": { } }, "UpdateDirectoryConfigResult": { "base": null, "refs": { } }, "UpdateFleetRequest": { "base": null, "refs": { } }, "UpdateFleetResult": { "base": null, "refs": { } }, "UpdateImagePermissionsRequest": { "base": null, "refs": { } }, "UpdateImagePermissionsResult": { "base": null, "refs": { } }, "UpdateStackRequest": { "base": null, "refs": { } }, "UpdateStackResult": { "base": null, "refs": { } }, "UserId": { "base": null, "refs": { "DescribeSessionsRequest$UserId": "

The user ID.

", "Session$UserId": "

The identifier of the user for whom the session was created.

" } }, "UserSetting": { "base": "

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

", "refs": { "UserSettingList$member": null } }, "UserSettingList": { "base": null, "refs": { "CreateStackRequest$UserSettings": "

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

", "Stack$UserSettings": "

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

", "UpdateStackRequest$UserSettings": "

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

" } }, "VisibilityType": { "base": null, "refs": { "DescribeImagesRequest$Type": "

The type of image (public, private, or shared) to describe.

", "Image$Visibility": "

Indicates whether the image is public or private.

" } }, "VpcConfig": { "base": "

Describes VPC configuration information.

", "refs": { "CreateFleetRequest$VpcConfig": "

The VPC configuration for the fleet.

", "CreateImageBuilderRequest$VpcConfig": "

The VPC configuration for the image builder. You can specify only one subnet.

", "Fleet$VpcConfig": "

The VPC configuration for the fleet.

", "ImageBuilder$VpcConfig": "

The VPC configuration of the image builder.

", "UpdateFleetRequest$VpcConfig": "

The VPC configuration for the fleet.

" } } } }