eaming.smithy.aws-appstream-spec.2023.02.09.source-code.appstream.smithy Maven / Gradle / Ivy
Show all versions of aws-appstream-spec Show documentation
$version: "2.0"
metadata suppressions = [
{
id: "HttpMethodSemantics"
namespace: "*"
}
{
id: "HttpResponseCodeSemantics"
namespace: "*"
}
{
id: "PaginatedTrait"
namespace: "*"
}
{
id: "HttpHeaderTrait"
namespace: "*"
}
{
id: "HttpUriConflict"
namespace: "*"
}
{
id: "Service"
namespace: "*"
}
]
namespace com.amazonaws.appstream
use aws.api#service
use aws.auth#sigv4
use aws.protocols#awsJson1_1
use smithy.waiters#waitable
/// Amazon AppStream 2.0
/// This is the Amazon AppStream 2.0 API Reference. 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.
///
/// You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
///
/// To learn more about AppStream 2.0, see the following resources:
///
/// -
///
///
/// -
///
///
///
@service(
sdkId: "AppStream"
arnNamespace: "appstream"
cloudFormationName: "AppStream"
cloudTrailEventSource: "appstream.amazonaws.com"
endpointPrefix: "appstream2"
)
@sigv4(
name: "appstream"
)
@awsJson1_1
@title("Amazon AppStream")
service PhotonAdminProxyService {
version: "2016-12-01"
operations: [
AssociateApplicationFleet
AssociateApplicationToEntitlement
AssociateFleet
BatchAssociateUserStack
BatchDisassociateUserStack
CopyImage
CreateAppBlock
CreateApplication
CreateDirectoryConfig
CreateEntitlement
CreateFleet
CreateImageBuilder
CreateImageBuilderStreamingURL
CreateStack
CreateStreamingURL
CreateUpdatedImage
CreateUsageReportSubscription
CreateUser
DeleteAppBlock
DeleteApplication
DeleteDirectoryConfig
DeleteEntitlement
DeleteFleet
DeleteImage
DeleteImageBuilder
DeleteImagePermissions
DeleteStack
DeleteUsageReportSubscription
DeleteUser
DescribeAppBlocks
DescribeApplicationFleetAssociations
DescribeApplications
DescribeDirectoryConfigs
DescribeEntitlements
DescribeFleets
DescribeImageBuilders
DescribeImagePermissions
DescribeImages
DescribeSessions
DescribeStacks
DescribeUsageReportSubscriptions
DescribeUsers
DescribeUserStackAssociations
DisableUser
DisassociateApplicationFleet
DisassociateApplicationFromEntitlement
DisassociateFleet
EnableUser
ExpireSession
ListAssociatedFleets
ListAssociatedStacks
ListEntitledApplications
ListTagsForResource
StartFleet
StartImageBuilder
StopFleet
StopImageBuilder
TagResource
UntagResource
UpdateApplication
UpdateDirectoryConfig
UpdateEntitlement
UpdateFleet
UpdateImagePermissions
UpdateStack
]
}
/// Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
operation AssociateApplicationFleet {
input: AssociateApplicationFleetRequest
output: AssociateApplicationFleetResult
errors: [
ConcurrentModificationException
InvalidParameterCombinationException
LimitExceededException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Associates an application to entitle.
operation AssociateApplicationToEntitlement {
input: AssociateApplicationToEntitlementRequest
output: AssociateApplicationToEntitlementResult
errors: [
EntitlementNotFoundException
LimitExceededException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Associates the specified fleet with the specified stack.
operation AssociateFleet {
input: AssociateFleetRequest
output: AssociateFleetResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
LimitExceededException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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.
operation BatchAssociateUserStack {
input: BatchAssociateUserStackRequest
output: BatchAssociateUserStackResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
]
}
/// Disassociates the specified users from the specified stacks.
operation BatchDisassociateUserStack {
input: BatchDisassociateUserStackRequest
output: BatchDisassociateUserStackResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
]
}
/// 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.
operation CopyImage {
input: CopyImageRequest
output: CopyImageResponse
errors: [
IncompatibleImageException
InvalidAccountStatusException
LimitExceededException
ResourceAlreadyExistsException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Creates an app block.
/// App blocks are an Amazon AppStream 2.0 resource that stores the details about the
/// virtual hard disk in an S3 bucket. It also stores the setup script with details about
/// how to mount the virtual hard disk. The virtual hard disk includes the application
/// binaries and other files necessary to launch your applications. Multiple applications
/// can be assigned to a single app block.
/// This is only supported for Elastic fleets.
operation CreateAppBlock {
input: CreateAppBlockRequest
output: CreateAppBlockResult
errors: [
ConcurrentModificationException
LimitExceededException
OperationNotPermittedException
ResourceAlreadyExistsException
]
}
/// Creates an application.
/// Applications are an Amazon AppStream 2.0 resource that stores the details about how to
/// launch applications on Elastic fleet streaming instances. An application consists of the
/// launch details, icon, and display name. Applications are associated with an app block
/// that contains the application binaries and other files. The applications assigned to an
/// Elastic fleet are the applications users can launch.
/// This is only supported for Elastic fleets.
operation CreateApplication {
input: CreateApplicationRequest
output: CreateApplicationResult
errors: [
ConcurrentModificationException
LimitExceededException
OperationNotPermittedException
ResourceAlreadyExistsException
ResourceNotFoundException
]
}
/// 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.
operation CreateDirectoryConfig {
input: CreateDirectoryConfigRequest
output: CreateDirectoryConfigResult
errors: [
InvalidAccountStatusException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
ResourceAlreadyExistsException
ResourceNotFoundException
]
}
/// Creates a new entitlement. Entitlements control access to specific applications within
/// a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user
/// identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all
/// applications in a stack. Entitlements don't apply to the desktop stream view
/// application, or to applications managed by a dynamic app provider using the Dynamic
/// Application Framework.
operation CreateEntitlement {
input: CreateEntitlementRequest
output: CreateEntitlementResult
errors: [
EntitlementAlreadyExistsException
LimitExceededException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
operation CreateFleet {
input: CreateFleetRequest
output: CreateFleetResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
InvalidParameterCombinationException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
RequestLimitExceededException
ResourceAlreadyExistsException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// 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
.
operation CreateImageBuilder {
input: CreateImageBuilderRequest
output: CreateImageBuilderResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
InvalidParameterCombinationException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
RequestLimitExceededException
ResourceAlreadyExistsException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Creates a URL to start an image builder streaming session.
operation CreateImageBuilderStreamingURL {
input: CreateImageBuilderStreamingURLRequest
output: CreateImageBuilderStreamingURLResult
errors: [
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
operation CreateStack {
input: CreateStackRequest
output: CreateStackResult
errors: [
ConcurrentModificationException
InvalidAccountStatusException
InvalidParameterCombinationException
InvalidRoleException
LimitExceededException
ResourceAlreadyExistsException
ResourceNotFoundException
]
}
/// 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.
operation CreateStreamingURL {
input: CreateStreamingURLRequest
output: CreateStreamingURLResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
/// For more information, see the "Update an Image by Using
/// Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
operation CreateUpdatedImage {
input: CreateUpdatedImageRequest
output: CreateUpdatedImageResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
LimitExceededException
OperationNotPermittedException
ResourceAlreadyExistsException
ResourceNotFoundException
]
}
/// Creates a usage report subscription. Usage reports are generated daily.
operation CreateUsageReportSubscription {
input: CreateUsageReportSubscriptionRequest
output: CreateUsageReportSubscriptionResult
errors: [
InvalidAccountStatusException
InvalidRoleException
LimitExceededException
]
}
/// Creates a new user in the user pool.
operation CreateUser {
input: CreateUserRequest
output: CreateUserResult
errors: [
InvalidAccountStatusException
InvalidParameterCombinationException
LimitExceededException
OperationNotPermittedException
ResourceAlreadyExistsException
]
}
/// Deletes an app block.
operation DeleteAppBlock {
input: DeleteAppBlockRequest
output: DeleteAppBlockResult
errors: [
ConcurrentModificationException
ResourceInUseException
ResourceNotFoundException
]
}
/// Deletes an application.
operation DeleteApplication {
input: DeleteApplicationRequest
output: DeleteApplicationResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// 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.
operation DeleteDirectoryConfig {
input: DeleteDirectoryConfigRequest
output: DeleteDirectoryConfigResult
errors: [
ResourceInUseException
ResourceNotFoundException
]
}
/// Deletes the specified entitlement.
operation DeleteEntitlement {
input: DeleteEntitlementRequest
output: DeleteEntitlementResult
errors: [
ConcurrentModificationException
EntitlementNotFoundException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Deletes the specified fleet.
operation DeleteFleet {
input: DeleteFleetRequest
output: DeleteFleetResult
errors: [
ConcurrentModificationException
ResourceInUseException
ResourceNotFoundException
]
}
/// 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.
operation DeleteImage {
input: DeleteImageRequest
output: DeleteImageResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// Deletes the specified image builder and releases the capacity.
operation DeleteImageBuilder {
input: DeleteImageBuilderRequest
output: DeleteImageBuilderResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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.
operation DeleteImagePermissions {
input: DeleteImagePermissionsRequest
output: DeleteImagePermissionsResult
errors: [
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// 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.
operation DeleteStack {
input: DeleteStackRequest
output: DeleteStackResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// Disables usage report generation.
operation DeleteUsageReportSubscription {
input: DeleteUsageReportSubscriptionRequest
output: DeleteUsageReportSubscriptionResult
errors: [
InvalidAccountStatusException
ResourceNotFoundException
]
}
/// Deletes a user from the user pool.
operation DeleteUser {
input: DeleteUserRequest
output: DeleteUserResult
errors: [
ResourceNotFoundException
]
}
/// Retrieves a list that describes one or more app blocks.
operation DescribeAppBlocks {
input: DescribeAppBlocksRequest
output: DescribeAppBlocksResult
errors: [
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
operation DescribeApplicationFleetAssociations {
input: DescribeApplicationFleetAssociationsRequest
output: DescribeApplicationFleetAssociationsResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
]
}
/// Retrieves a list that describes one or more applications.
operation DescribeApplications {
input: DescribeApplicationsRequest
output: DescribeApplicationsResult
errors: [
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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.
///
/// Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
operation DescribeDirectoryConfigs {
input: DescribeDirectoryConfigsRequest
output: DescribeDirectoryConfigsResult
errors: [
ResourceNotFoundException
]
}
/// Retrieves a list that describes one of more entitlements.
operation DescribeEntitlements {
input: DescribeEntitlementsRequest
output: DescribeEntitlementsResult
errors: [
EntitlementNotFoundException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
@waitable(
FleetStarted: {
acceptors: [
{
state: "success"
matcher: {
output: {
path: "Fleets[].State"
expected: "RUNNING"
comparator: "allStringEquals"
}
}
}
{
state: "failure"
matcher: {
output: {
path: "Fleets[].State"
expected: "STOPPING"
comparator: "anyStringEquals"
}
}
}
{
state: "failure"
matcher: {
output: {
path: "Fleets[].State"
expected: "STOPPED"
comparator: "anyStringEquals"
}
}
}
]
minDelay: 30
}
FleetStopped: {
acceptors: [
{
state: "success"
matcher: {
output: {
path: "Fleets[].State"
expected: "STOPPED"
comparator: "allStringEquals"
}
}
}
{
state: "failure"
matcher: {
output: {
path: "Fleets[].State"
expected: "STARTING"
comparator: "anyStringEquals"
}
}
}
{
state: "failure"
matcher: {
output: {
path: "Fleets[].State"
expected: "RUNNING"
comparator: "anyStringEquals"
}
}
}
]
minDelay: 30
}
)
operation DescribeFleets {
input: DescribeFleetsRequest
output: DescribeFleetsResult
errors: [
ResourceNotFoundException
]
}
/// 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.
operation DescribeImageBuilders {
input: DescribeImageBuildersRequest
output: DescribeImageBuildersResult
errors: [
ResourceNotFoundException
]
}
/// Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation DescribeImagePermissions {
input: DescribeImagePermissionsRequest
output: DescribeImagePermissionsResult
errors: [
ResourceNotFoundException
]
}
/// 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.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation DescribeImages {
input: DescribeImagesRequest
output: DescribeImagesResult
errors: [
InvalidParameterCombinationException
ResourceNotFoundException
]
}
/// 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.
operation DescribeSessions {
input: DescribeSessionsRequest
output: DescribeSessionsResult
errors: [
InvalidParameterCombinationException
]
}
/// Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
operation DescribeStacks {
input: DescribeStacksRequest
output: DescribeStacksResult
errors: [
ResourceNotFoundException
]
}
/// Retrieves a list that describes one or more usage report subscriptions.
operation DescribeUsageReportSubscriptions {
input: DescribeUsageReportSubscriptionsRequest
output: DescribeUsageReportSubscriptionsResult
errors: [
InvalidAccountStatusException
ResourceNotFoundException
]
}
/// Retrieves a list that describes one or more specified users in the user pool.
operation DescribeUsers {
input: DescribeUsersRequest
output: DescribeUsersResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
///
/// -
///
The stack name
///
/// -
///
The user name (email address of the user associated with the stack) and the authentication type for the user
///
///
operation DescribeUserStackAssociations {
input: DescribeUserStackAssociationsRequest
output: DescribeUserStackAssociationsResult
errors: [
InvalidParameterCombinationException
OperationNotPermittedException
]
}
/// 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.
operation DisableUser {
input: DisableUserRequest
output: DisableUserResult
errors: [
ResourceNotFoundException
]
}
/// Disassociates the specified application from the fleet.
operation DisassociateApplicationFleet {
input: DisassociateApplicationFleetRequest
output: DisassociateApplicationFleetResult
errors: [
ConcurrentModificationException
InvalidParameterCombinationException
OperationNotPermittedException
]
}
/// Deletes the specified application from the specified entitlement.
operation DisassociateApplicationFromEntitlement {
input: DisassociateApplicationFromEntitlementRequest
output: DisassociateApplicationFromEntitlementResult
errors: [
EntitlementNotFoundException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// Disassociates the specified fleet from the specified stack.
operation DisassociateFleet {
input: DisassociateFleetRequest
output: DisassociateFleetResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// 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.
operation EnableUser {
input: EnableUserRequest
output: EnableUserResult
errors: [
InvalidAccountStatusException
ResourceNotFoundException
]
}
/// Immediately stops the specified streaming session.
operation ExpireSession {
input: ExpireSessionRequest
output: ExpireSessionResult
}
/// Retrieves the name of the fleet that is associated with the specified stack.
operation ListAssociatedFleets {
input: ListAssociatedFleetsRequest
output: ListAssociatedFleetsResult
}
/// Retrieves the name of the stack with which the specified fleet is associated.
operation ListAssociatedStacks {
input: ListAssociatedStacksRequest
output: ListAssociatedStacksResult
}
/// Retrieves a list of entitled applications.
operation ListEntitledApplications {
input: ListEntitledApplicationsRequest
output: ListEntitledApplicationsResult
errors: [
EntitlementNotFoundException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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 Administration Guide.
operation ListTagsForResource {
input: ListTagsForResourceRequest
output: ListTagsForResourceResponse
errors: [
ResourceNotFoundException
]
}
/// Starts the specified fleet.
operation StartFleet {
input: StartFleetRequest
output: StartFleetResult
errors: [
ConcurrentModificationException
InvalidAccountStatusException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
RequestLimitExceededException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Starts the specified image builder.
operation StartImageBuilder {
input: StartImageBuilderRequest
output: StartImageBuilderResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Stops the specified fleet.
operation StopFleet {
input: StopFleetRequest
output: StopFleetResult
errors: [
ConcurrentModificationException
ResourceNotFoundException
]
}
/// Stops the specified image builder.
operation StopImageBuilder {
input: StopImageBuilderRequest
output: StopImageBuilderResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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 Administration Guide.
operation TagResource {
input: TagResourceRequest
output: TagResourceResponse
errors: [
InvalidAccountStatusException
LimitExceededException
ResourceNotFoundException
]
}
/// 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 Administration Guide.
operation UntagResource {
input: UntagResourceRequest
output: UntagResourceResponse
errors: [
ResourceNotFoundException
]
}
/// Updates the specified application.
operation UpdateApplication {
input: UpdateApplicationRequest
output: UpdateApplicationResult
errors: [
ConcurrentModificationException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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.
operation UpdateDirectoryConfig {
input: UpdateDirectoryConfigRequest
output: UpdateDirectoryConfigResult
errors: [
ConcurrentModificationException
InvalidRoleException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// Updates the specified entitlement.
operation UpdateEntitlement {
input: UpdateEntitlementRequest
output: UpdateEntitlementResult
errors: [
ConcurrentModificationException
EntitlementNotFoundException
OperationNotPermittedException
ResourceNotFoundException
]
}
/// 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 following based
/// on the fleet type:
///
/// -
///
Always-On and On-Demand fleet types
/// You can update the DisplayName
, ComputeCapacity
,
/// ImageARN
, ImageName
,
/// IdleDisconnectTimeoutInSeconds
, and
/// DisconnectTimeoutInSeconds
attributes.
///
/// -
///
Elastic fleet type
/// You can update the DisplayName
,
/// IdleDisconnectTimeoutInSeconds
,
/// DisconnectTimeoutInSeconds
, MaxConcurrentSessions
, SessionScriptS3Location
/// and UsbDeviceFilterStrings
attributes.
///
///
/// If the fleet is in the STARTING
or STOPPED
state, you can't update it.
operation UpdateFleet {
input: UpdateFleetRequest
output: UpdateFleetResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
InvalidParameterCombinationException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
RequestLimitExceededException
ResourceInUseException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Adds or updates permissions for the specified private image.
operation UpdateImagePermissions {
input: UpdateImagePermissionsRequest
output: UpdateImagePermissionsResult
errors: [
LimitExceededException
ResourceNotAvailableException
ResourceNotFoundException
]
}
/// Updates the specified fields for the specified stack.
operation UpdateStack {
input: UpdateStackRequest
output: UpdateStackResult
errors: [
ConcurrentModificationException
IncompatibleImageException
InvalidAccountStatusException
InvalidParameterCombinationException
InvalidRoleException
LimitExceededException
OperationNotPermittedException
ResourceInUseException
ResourceNotFoundException
]
}
/// 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.
structure AccessEndpoint {
/// The type of interface endpoint.
@required
EndpointType: AccessEndpointType
/// The identifier (ID) of the VPC in which the interface endpoint is used.
VpceId: String
}
/// Describes an app block.
/// App blocks are an Amazon AppStream 2.0 resource that stores the details about the
/// virtual hard disk in an S3 bucket. It also stores the setup script with details about
/// how to mount the virtual hard disk. The virtual hard disk includes the application
/// binaries and other files necessary to launch your applications. Multiple applications
/// can be assigned to a single app block.
/// This is only supported for Elastic fleets.
structure AppBlock {
/// The name of the app block.
@required
Name: String
/// The ARN of the app block.
@required
Arn: Arn
/// The description of the app block.
Description: String
/// The display name of the app block.
DisplayName: String
/// The source S3 location of the app block.
SourceS3Location: S3Location
/// The setup script details of the app block.
@required
SetupScriptDetails: ScriptDetails
/// The created time of the app block.
CreatedTime: Timestamp
}
/// Describes an application in the application catalog.
structure Application {
/// The name of the application.
Name: String
/// The application name to display.
DisplayName: String
/// The URL for the application icon. This URL might be time-limited.
IconURL: String
/// The path to the application executable in the instance.
LaunchPath: String
/// The arguments that are passed to the application at launch.
LaunchParameters: String
/// If there is a problem, the application can be disabled after image creation.
Enabled: Boolean = false
/// Additional attributes that describe the application.
Metadata: Metadata
/// The working directory for the application.
WorkingDirectory: String
/// The description of the application.
Description: String
/// The ARN of the application.
Arn: Arn
/// The app block ARN of the application.
AppBlockArn: Arn
/// The S3 location of the application icon.
IconS3Location: S3Location
/// The platforms on which the application can run.
Platforms: Platforms
/// The instance families for the application.
InstanceFamilies: StringList
/// The time at which the application was created within the app block.
CreatedTime: Timestamp
}
/// Describes the application fleet association.
structure ApplicationFleetAssociation {
/// The name of the fleet associated with the application.
@required
FleetName: String
/// The ARN of the application associated with the fleet.
@required
ApplicationArn: Arn
}
/// The persistent application settings for users of a stack.
structure ApplicationSettings {
/// Enables or disables persistent application settings for users during their streaming sessions.
@required
Enabled: Boolean = false
/// 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.
SettingsGroup: SettingsGroup
}
/// Describes the persistent application settings for users of a stack.
structure ApplicationSettingsResponse {
/// Specifies whether persistent application settings are enabled for users during their streaming sessions.
Enabled: Boolean = false
/// The path prefix for the S3 bucket where users’ persistent application settings are stored.
SettingsGroup: SettingsGroup
/// 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.
///
S3BucketName: String
}
@input
structure AssociateApplicationFleetRequest {
/// The name of the fleet.
@required
FleetName: Name
/// The ARN of the application.
@required
ApplicationArn: Arn
}
structure AssociateApplicationFleetResult {
/// If fleet name is specified, this returns the list of applications that are associated
/// to it. If application ARN is specified, this returns the list of fleets to which it is
/// associated.
ApplicationFleetAssociation: ApplicationFleetAssociation
}
@input
structure AssociateApplicationToEntitlementRequest {
/// The name of the stack.
@required
StackName: Name
/// The name of the entitlement.
@required
EntitlementName: Name
/// The identifier of the application.
@required
ApplicationIdentifier: String
}
structure AssociateApplicationToEntitlementResult {}
@input
structure AssociateFleetRequest {
/// The name of the fleet.
@required
FleetName: String
/// The name of the stack.
@required
StackName: String
}
structure AssociateFleetResult {}
@input
structure BatchAssociateUserStackRequest {
/// The list of UserStackAssociation objects.
@required
UserStackAssociations: UserStackAssociationList
}
structure BatchAssociateUserStackResult {
/// The list of UserStackAssociationError objects.
errors: UserStackAssociationErrorList
}
@input
structure BatchDisassociateUserStackRequest {
/// The list of UserStackAssociation objects.
@required
UserStackAssociations: UserStackAssociationList
}
structure BatchDisassociateUserStackResult {
/// The list of UserStackAssociationError objects.
errors: UserStackAssociationErrorList
}
/// The certificate-based authentication properties used to authenticate SAML 2.0 Identity
/// Provider (IdP) user identities to Active Directory domain-joined streaming instances.
/// Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD
/// domain password if certificate-based authentication is unsuccessful, or to unlock a
/// desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based
/// authentication, but does not allow users to log in using their AD domain password. Users
/// will be disconnected to re-authenticate using certificates.
structure CertificateBasedAuthProperties {
/// The status of the certificate-based authentication properties.
Status: CertificateBasedAuthStatus
/// The ARN of the AWS Certificate Manager Private CA resource.
CertificateAuthorityArn: Arn
}
/// Describes the capacity for a fleet.
structure ComputeCapacity {
/// The desired number of streaming instances.
@required
DesiredInstances: Integer
}
/// Describes the capacity status for a fleet.
structure ComputeCapacityStatus {
/// The desired number of streaming instances.
@required
Desired: Integer
/// The total number of simultaneous streaming instances that are running.
Running: Integer
/// The number of instances in use for streaming.
InUse: Integer
/// The number of currently available instances that can be used to stream
/// sessions.
Available: Integer
}
/// An API error occurred. Wait a few minutes and try again.
@error("client")
@httpError(400)
structure ConcurrentModificationException {
Message: ErrorMessage
}
@input
structure CopyImageRequest {
/// The name of the image to copy.
@required
SourceImageName: Name
/// The name that the image will have when it is copied to the destination.
@required
DestinationImageName: Name
/// 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.
@required
DestinationRegion: RegionName
/// The description that the image will have when it is copied to the destination.
DestinationImageDescription: Description
}
@output
structure CopyImageResponse {
/// The name of the destination image.
DestinationImageName: Name
}
@input
structure CreateAppBlockRequest {
/// The name of the app block.
@required
Name: Name
/// The description of the app block.
Description: Description
/// The display name of the app block. This is not displayed to the user.
DisplayName: DisplayName
/// The source S3 location of the app block.
@required
SourceS3Location: S3Location
/// The setup script details of the app block.
@required
SetupScriptDetails: ScriptDetails
/// The tags assigned to the app block.
Tags: Tags
}
structure CreateAppBlockResult {
/// The app block.
AppBlock: AppBlock
}
@input
structure CreateApplicationRequest {
/// The name of the application. This name is visible to users when display name is not specified.
@required
Name: Name
/// The display name of the application. This name is visible to users in the application catalog.
DisplayName: DisplayName
/// The description of the application.
Description: Description
/// The location in S3 of the application icon.
@required
IconS3Location: S3Location
/// The launch path of the application.
@required
LaunchPath: String
/// The working directory of the application.
WorkingDirectory: String
/// The launch parameters of the application.
LaunchParameters: String
/// The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
@required
Platforms: Platforms
/// The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
@required
InstanceFamilies: StringList
/// The app block ARN to which the application should be associated
@required
AppBlockArn: Arn
/// The tags assigned to the application.
Tags: Tags
}
structure CreateApplicationResult {
Application: Application
}
@input
structure CreateDirectoryConfigRequest {
/// The fully qualified name of the directory (for example, corp.example.com).
@required
DirectoryName: DirectoryName
/// The distinguished names of the organizational units for computer accounts.
@required
OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList
/// The credentials for the service account used by the fleet or image builder to connect to the directory.
ServiceAccountCredentials: ServiceAccountCredentials
/// The certificate-based authentication properties used to authenticate SAML 2.0 Identity
/// Provider (IdP) user identities to Active Directory domain-joined streaming instances.
/// Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD
/// domain password if certificate-based authentication is unsuccessful, or to unlock a
/// desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based
/// authentication, but does not allow users to log in using their AD domain password. Users
/// will be disconnected to re-authenticate using certificates.
CertificateBasedAuthProperties: CertificateBasedAuthProperties
}
structure CreateDirectoryConfigResult {
/// Information about the directory configuration.
DirectoryConfig: DirectoryConfig
}
@input
structure CreateEntitlementRequest {
/// The name of the entitlement.
@required
Name: Name
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The description of the entitlement.
Description: Description
/// Specifies whether all or selected apps are entitled.
@required
AppVisibility: AppVisibility
/// The attributes of the entitlement.
@required
Attributes: EntitlementAttributeList
}
structure CreateEntitlementResult {
/// The entitlement.
Entitlement: Entitlement
}
@input
structure CreateFleetRequest {
/// A unique name for the fleet.
@required
Name: Name
/// The name of the image used to create the fleet.
ImageName: String
/// The ARN of the public, private, or shared image to use.
ImageArn: Arn
/// The instance type to use when launching fleet instances. The following instance types are available:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.standard.xlarge
///
/// -
///
stream.standard.2xlarge
///
/// -
///
stream.compute.large
///
/// -
///
stream.compute.xlarge
///
/// -
///
stream.compute.2xlarge
///
/// -
///
stream.compute.4xlarge
///
/// -
///
stream.compute.8xlarge
///
/// -
///
stream.memory.large
///
/// -
///
stream.memory.xlarge
///
/// -
///
stream.memory.2xlarge
///
/// -
///
stream.memory.4xlarge
///
/// -
///
stream.memory.8xlarge
///
/// -
///
stream.memory.z1d.large
///
/// -
///
stream.memory.z1d.xlarge
///
/// -
///
stream.memory.z1d.2xlarge
///
/// -
///
stream.memory.z1d.3xlarge
///
/// -
///
stream.memory.z1d.6xlarge
///
/// -
///
stream.memory.z1d.12xlarge
///
/// -
///
stream.graphics-design.large
///
/// -
///
stream.graphics-design.xlarge
///
/// -
///
stream.graphics-design.2xlarge
///
/// -
///
stream.graphics-design.4xlarge
///
/// -
///
stream.graphics-desktop.2xlarge
///
/// -
///
stream.graphics.g4dn.xlarge
///
/// -
///
stream.graphics.g4dn.2xlarge
///
/// -
///
stream.graphics.g4dn.4xlarge
///
/// -
///
stream.graphics.g4dn.8xlarge
///
/// -
///
stream.graphics.g4dn.12xlarge
///
/// -
///
stream.graphics.g4dn.16xlarge
///
/// -
///
stream.graphics-pro.4xlarge
///
/// -
///
stream.graphics-pro.8xlarge
///
/// -
///
stream.graphics-pro.16xlarge
///
///
/// The following instance types are available for Elastic fleets:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.standard.xlarge
///
/// -
///
stream.standard.2xlarge
///
///
@required
InstanceType: String
/// 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.
///
///
FleetType: FleetType
/// The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
ComputeCapacity: ComputeCapacity
/// The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
VpcConfig: VpcConfig
/// 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.
/// Specify a value between 600 and 360000.
MaxUserDurationInSeconds: Integer
/// 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.
/// Specify a value between 60 and 360000.
DisconnectTimeoutInSeconds: Integer
/// The description to display.
Description: Description
/// The fleet name to display.
DisplayName: DisplayName
/// Enables or disables default internet access for the fleet.
EnableDefaultInternetAccess: BooleanObject
/// The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
DomainJoinInfo: DomainJoinInfo
/// 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=.
/// If you do not specify a value, the value is set to an empty string.
/// Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
/// _ . : / = + \ - @
/// For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
Tags: Tags
/// The amount of time that users can be idle (inactive) before they are disconnected
/// from their streaming session and the DisconnectTimeoutInSeconds
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
/// DisconnectTimeoutInSeconds
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 IdleDisconnectTimeoutInSeconds
elapses, they are
/// disconnected.
/// 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.
///
/// 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.
///
IdleDisconnectTimeoutInSeconds: Integer
/// 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) AssumeRole
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 appstream_machine_role credential profile on the instance.
/// For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn: Arn
/// The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP
is specified, only the windows of applications opened by users display. When DESKTOP
is specified, the standard desktop that is provided by the operating system displays.
/// The default value is APP
.
StreamView: StreamView
/// The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic
/// fleets.
Platform: PlatformType
/// The maximum concurrent sessions of the Elastic fleet. This is required for Elastic
/// fleets, and not allowed for other fleet types.
MaxConcurrentSessions: Integer
/// The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
UsbDeviceFilterStrings: UsbDeviceFilterStrings
/// The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
SessionScriptS3Location: S3Location
}
structure CreateFleetResult {
/// Information about the fleet.
Fleet: Fleet
}
@input
structure CreateImageBuilderRequest {
/// A unique name for the image builder.
@required
Name: Name
/// The name of the image used to create the image builder.
ImageName: String
/// The ARN of the public, private, or shared image to use.
ImageArn: Arn
/// The instance type to use when launching the image builder. The following instance types are available:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.compute.large
///
/// -
///
stream.compute.xlarge
///
/// -
///
stream.compute.2xlarge
///
/// -
///
stream.compute.4xlarge
///
/// -
///
stream.compute.8xlarge
///
/// -
///
stream.memory.large
///
/// -
///
stream.memory.xlarge
///
/// -
///
stream.memory.2xlarge
///
/// -
///
stream.memory.4xlarge
///
/// -
///
stream.memory.8xlarge
///
/// -
///
stream.memory.z1d.large
///
/// -
///
stream.memory.z1d.xlarge
///
/// -
///
stream.memory.z1d.2xlarge
///
/// -
///
stream.memory.z1d.3xlarge
///
/// -
///
stream.memory.z1d.6xlarge
///
/// -
///
stream.memory.z1d.12xlarge
///
/// -
///
stream.graphics-design.large
///
/// -
///
stream.graphics-design.xlarge
///
/// -
///
stream.graphics-design.2xlarge
///
/// -
///
stream.graphics-design.4xlarge
///
/// -
///
stream.graphics-desktop.2xlarge
///
/// -
///
stream.graphics.g4dn.xlarge
///
/// -
///
stream.graphics.g4dn.2xlarge
///
/// -
///
stream.graphics.g4dn.4xlarge
///
/// -
///
stream.graphics.g4dn.8xlarge
///
/// -
///
stream.graphics.g4dn.12xlarge
///
/// -
///
stream.graphics.g4dn.16xlarge
///
/// -
///
stream.graphics-pro.4xlarge
///
/// -
///
stream.graphics-pro.8xlarge
///
/// -
///
stream.graphics-pro.16xlarge
///
///
@required
InstanceType: String
/// The description to display.
Description: Description
/// The image builder name to display.
DisplayName: DisplayName
/// The VPC configuration for the image builder. You can specify only one subnet.
VpcConfig: VpcConfig
/// 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) AssumeRole
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 appstream_machine_role credential profile on the instance.
/// For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn: Arn
/// Enables or disables default internet access for the image builder.
EnableDefaultInternetAccess: BooleanObject
/// The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DomainJoinInfo: DomainJoinInfo
/// 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].
AppstreamAgentVersion: AppstreamAgentVersion
/// 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=.
/// Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
/// _ . : / = + \ - @
/// If you do not specify a value, the value is set to an empty string.
/// For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
Tags: Tags
/// The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
AccessEndpoints: AccessEndpointList
}
structure CreateImageBuilderResult {
/// Information about the image builder.
ImageBuilder: ImageBuilder
}
@input
structure CreateImageBuilderStreamingURLRequest {
/// The name of the image builder.
@required
Name: String
/// The time that the streaming URL will be valid, in seconds.
/// Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
Validity: Long
}
structure CreateImageBuilderStreamingURLResult {
/// The URL to start the AppStream 2.0 streaming session.
StreamingURL: String
/// The elapsed time, in seconds after the Unix epoch, when this URL expires.
Expires: Timestamp
}
@input
structure CreateStackRequest {
/// The name of the stack.
@required
Name: Name
/// The description to display.
Description: Description
/// The stack name to display.
DisplayName: DisplayName
/// The storage connectors to enable.
StorageConnectors: StorageConnectorList
/// The URL that users are redirected to after their streaming session ends.
RedirectURL: RedirectURL
/// 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.
FeedbackURL: FeedbackURL
/// The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
UserSettings: UserSettingList
/// 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.
ApplicationSettings: ApplicationSettings
/// 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=.
/// If you do not specify a value, the value is set to an empty string.
/// Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
/// _ . : / = + \ - @
/// For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
Tags: Tags
/// The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
AccessEndpoints: AccessEndpointList
/// 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.
EmbedHostDomains: EmbedHostDomains
/// The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
StreamingExperienceSettings: StreamingExperienceSettings
}
structure CreateStackResult {
/// Information about the stack.
Stack: Stack
}
@input
structure CreateStreamingURLRequest {
/// The name of the stack.
@required
StackName: String
/// The name of the fleet.
@required
FleetName: String
/// The identifier of the user.
@required
UserId: StreamingUrlUserId
/// The name of the application to launch after the session starts. This is the name that you specified
/// as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
ApplicationId: String
/// The time that the streaming URL will be valid, in seconds.
/// Specify a value between 1 and 604800 seconds. The default is 60 seconds.
Validity: Long
/// The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
SessionContext: String
}
structure CreateStreamingURLResult {
/// The URL to start the AppStream 2.0 streaming session.
StreamingURL: String
/// The elapsed time, in seconds after the Unix epoch, when this URL expires.
Expires: Timestamp
}
@input
structure CreateUpdatedImageRequest {
/// The name of the image to update.
@required
existingImageName: Name
/// The name of the new image. The name must be unique within the AWS account and Region.
@required
newImageName: Name
/// The description to display for the new image.
newImageDescription: Description
/// The name to display for the new image.
newImageDisplayName: DisplayName
/// The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
/// Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
/// _ . : / = + \ - @
/// If you do not specify a value, the value is set to an empty string.
/// For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
newImageTags: Tags
/// Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true
, AppStream 2.0 displays whether image updates are available. If this value is set to false
, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
dryRun: Boolean = false
}
structure CreateUpdatedImageResult {
image: Image
/// Indicates whether a new image can be created.
canUpdateImage: Boolean = false
}
@input
structure CreateUsageReportSubscriptionRequest {}
structure CreateUsageReportSubscriptionResult {
/// The Amazon S3 bucket where generated reports are stored.
/// 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.
S3BucketName: String
/// The schedule for generating usage reports.
Schedule: UsageReportSchedule
}
@input
structure CreateUserRequest {
/// The email address of the user.
///
/// 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.
///
@required
UserName: Username
/// 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.
///
/// 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.
///
MessageAction: MessageAction
/// The first name, or given name, of the user.
FirstName: UserAttributeValue
/// The last name, or surname, of the user.
LastName: UserAttributeValue
/// The authentication type for the user. You must specify USERPOOL.
@required
AuthenticationType: AuthenticationType
}
structure CreateUserResult {}
@input
structure DeleteAppBlockRequest {
/// The name of the app block.
@required
Name: Name
}
structure DeleteAppBlockResult {}
@input
structure DeleteApplicationRequest {
/// The name of the application.
@required
Name: Name
}
structure DeleteApplicationResult {}
@input
structure DeleteDirectoryConfigRequest {
/// The name of the directory configuration.
@required
DirectoryName: DirectoryName
}
structure DeleteDirectoryConfigResult {}
@input
structure DeleteEntitlementRequest {
/// The name of the entitlement.
@required
Name: Name
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
}
structure DeleteEntitlementResult {}
@input
structure DeleteFleetRequest {
/// The name of the fleet.
@required
Name: String
}
structure DeleteFleetResult {}
@input
structure DeleteImageBuilderRequest {
/// The name of the image builder.
@required
Name: Name
}
structure DeleteImageBuilderResult {
/// Information about the image builder.
ImageBuilder: ImageBuilder
}
@input
structure DeleteImagePermissionsRequest {
/// The name of the private image.
@required
Name: Name
/// The 12-digit identifier of the AWS account for which to delete image permissions.
@required
SharedAccountId: AwsAccountId
}
structure DeleteImagePermissionsResult {}
@input
structure DeleteImageRequest {
/// The name of the image.
@required
Name: Name
}
structure DeleteImageResult {
/// Information about the image.
Image: Image
}
@input
structure DeleteStackRequest {
/// The name of the stack.
@required
Name: String
}
structure DeleteStackResult {}
@input
structure DeleteUsageReportSubscriptionRequest {}
structure DeleteUsageReportSubscriptionResult {}
@input
structure DeleteUserRequest {
/// The email address of the user.
///
/// Users' email addresses are case-sensitive.
///
@required
UserName: Username
/// The authentication type for the user. You must specify USERPOOL.
@required
AuthenticationType: AuthenticationType
}
structure DeleteUserResult {}
@input
structure DescribeAppBlocksRequest {
/// The ARNs of the app blocks.
Arns: ArnList
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
/// The maximum size of each page of results.
MaxResults: Integer
}
structure DescribeAppBlocksResult {
/// The app blocks in the list.
AppBlocks: AppBlocks
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
}
@input
structure DescribeApplicationFleetAssociationsRequest {
/// The name of the fleet.
FleetName: Name
/// The ARN of the application.
ApplicationArn: Arn
/// The maximum size of each page of results.
MaxResults: Integer
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
}
structure DescribeApplicationFleetAssociationsResult {
/// The application fleet associations in the list.
ApplicationFleetAssociations: ApplicationFleetAssociationList
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
}
@input
structure DescribeApplicationsRequest {
/// The ARNs for the applications.
Arns: ArnList
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
/// The maximum size of each page of results.
MaxResults: Integer
}
structure DescribeApplicationsResult {
/// The applications in the list.
Applications: Applications
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
}
@input
structure DescribeDirectoryConfigsRequest {
/// The directory names.
DirectoryNames: DirectoryNameList
/// The maximum size of each page of results.
MaxResults: Integer
/// 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.
NextToken: String
}
structure DescribeDirectoryConfigsResult {
/// 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.
DirectoryConfigs: DirectoryConfigList
/// 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.
NextToken: String
}
@input
structure DescribeEntitlementsRequest {
/// The name of the entitlement.
Name: Name
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The pagination token used to retrieve the next page of results for this operation.
NextToken: String
/// The maximum size of each page of results.
MaxResults: Integer
}
structure DescribeEntitlementsResult {
/// The entitlements.
Entitlements: EntitlementList
/// The pagination token used to retrieve the next page of results for this
/// operation.
NextToken: String
}
@input
structure DescribeFleetsRequest {
/// The names of the fleets to describe.
Names: StringList
/// 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.
NextToken: String
}
structure DescribeFleetsResult {
/// Information about the fleets.
Fleets: FleetList
/// 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.
NextToken: String
}
@input
structure DescribeImageBuildersRequest {
/// The names of the image builders to describe.
Names: StringList
/// The maximum size of each page of results.
MaxResults: Integer
/// 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.
NextToken: String
}
structure DescribeImageBuildersResult {
/// Information about the image builders.
ImageBuilders: ImageBuilderList
/// 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.
NextToken: String
}
@input
structure DescribeImagePermissionsRequest {
/// The name of the private image for which to describe permissions. The image must be one that you own.
@required
Name: Name
/// The maximum size of each page of results.
MaxResults: MaxResults
/// The 12-digit identifier of one or more AWS accounts with which the image is shared.
SharedAwsAccountIds: AwsAccountIdList
/// 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.
NextToken: String
}
structure DescribeImagePermissionsResult {
/// The name of the private image.
Name: Name
/// The permissions for a private image that you own.
SharedImagePermissionsList: SharedImagePermissionsList
/// 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.
NextToken: String
}
@input
structure DescribeImagesRequest {
/// The names of the public or private images to describe.
Names: StringList
/// The ARNs of the public, private, and shared images to describe.
Arns: ArnList
/// The type of image (public, private, or shared) to describe.
Type: VisibilityType
/// 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.
NextToken: String
/// The maximum size of each page of results.
MaxResults: DescribeImagesMaxResults
}
structure DescribeImagesResult {
/// Information about the images.
Images: ImageList
/// 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.
NextToken: String
}
@input
structure DescribeSessionsRequest {
/// The name of the stack. This value is case-sensitive.
@required
StackName: String
/// The name of the fleet. This value is case-sensitive.
@required
FleetName: String
/// The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
UserId: UserId
/// 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.
NextToken: String
/// The size of each page of results. The default value is 20 and the maximum value is 50.
Limit: Integer
/// 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.
AuthenticationType: AuthenticationType
}
structure DescribeSessionsResult {
/// Information about the streaming sessions.
Sessions: SessionList
/// 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.
NextToken: String
}
@input
structure DescribeStacksRequest {
/// The names of the stacks to describe.
Names: StringList
/// 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.
NextToken: String
}
structure DescribeStacksResult {
/// Information about the stacks.
Stacks: StackList
/// 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.
NextToken: String
}
@input
structure DescribeUsageReportSubscriptionsRequest {
/// The maximum size of each page of results.
MaxResults: Integer
/// 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.
NextToken: String
}
structure DescribeUsageReportSubscriptionsResult {
/// Information about the usage report subscription.
UsageReportSubscriptions: UsageReportSubscriptionList
/// 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.
NextToken: String
}
@input
structure DescribeUsersRequest {
/// The authentication type for the users in the user pool to describe. You must specify USERPOOL.
@required
AuthenticationType: AuthenticationType
/// The maximum size of each page of results.
MaxResults: Integer
/// 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.
NextToken: String
}
structure DescribeUsersResult {
/// Information about users in the user pool.
Users: UserList
/// 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.
NextToken: String
}
@input
structure DescribeUserStackAssociationsRequest {
/// The name of the stack that is associated with the user.
StackName: String
/// The email address of the user who is associated with the stack.
///
/// Users' email addresses are case-sensitive.
///
UserName: Username
/// The authentication type for the user who is associated with the stack. You must specify USERPOOL.
AuthenticationType: AuthenticationType
/// The maximum size of each page of results.
MaxResults: MaxResults
/// 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.
NextToken: String
}
structure DescribeUserStackAssociationsResult {
/// The UserStackAssociation objects.
UserStackAssociations: UserStackAssociationList
/// 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.
NextToken: String
}
/// Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
structure DirectoryConfig {
/// The fully qualified name of the directory (for example, corp.example.com).
@required
DirectoryName: DirectoryName
/// The distinguished names of the organizational units for computer accounts.
OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList
/// The credentials for the service account used by the fleet or image builder to connect to the directory.
ServiceAccountCredentials: ServiceAccountCredentials
/// The time the directory configuration was created.
CreatedTime: Timestamp
/// The certificate-based authentication properties used to authenticate SAML 2.0 Identity
/// Provider (IdP) user identities to Active Directory domain-joined streaming instances.
/// Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD
/// domain password if certificate-based authentication is unsuccessful, or to unlock a
/// desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based
/// authentication, but does not allow users to log in using their AD domain password. Users
/// will be disconnected to re-authenticate using certificates.
CertificateBasedAuthProperties: CertificateBasedAuthProperties
}
@input
structure DisableUserRequest {
/// The email address of the user.
///
/// Users' email addresses are case-sensitive.
///
@required
UserName: Username
/// The authentication type for the user. You must specify USERPOOL.
@required
AuthenticationType: AuthenticationType
}
structure DisableUserResult {}
@input
structure DisassociateApplicationFleetRequest {
/// The name of the fleet.
@required
FleetName: Name
/// The ARN of the application.
@required
ApplicationArn: Arn
}
structure DisassociateApplicationFleetResult {}
@input
structure DisassociateApplicationFromEntitlementRequest {
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The name of the entitlement.
@required
EntitlementName: Name
/// The identifier of the application to remove from the entitlement.
@required
ApplicationIdentifier: String
}
structure DisassociateApplicationFromEntitlementResult {}
@input
structure DisassociateFleetRequest {
/// The name of the fleet.
@required
FleetName: String
/// The name of the stack.
@required
StackName: String
}
structure DisassociateFleetResult {}
/// Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
structure DomainJoinInfo {
/// The fully qualified name of the directory (for example, corp.example.com).
DirectoryName: DirectoryName
/// The distinguished name of the organizational unit for computer accounts.
OrganizationalUnitDistinguishedName: OrganizationalUnitDistinguishedName
}
@input
structure EnableUserRequest {
/// The email address of the user.
///
/// 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.
///
@required
UserName: Username
/// The authentication type for the user. You must specify USERPOOL.
@required
AuthenticationType: AuthenticationType
}
structure EnableUserResult {}
/// The application associated to an entitlement. Access is controlled based on user attributes.
structure EntitledApplication {
/// The identifier of the application.
@required
ApplicationIdentifier: String
}
/// Specifies an entitlement. Entitlements control access to specific applications within
/// a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user
/// identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all
/// applications in a stack. Entitlements don't apply to the desktop stream view
/// application, or to applications managed by a dynamic app provider using the Dynamic
/// Application Framework.
structure Entitlement {
/// The name of the entitlement.
@required
Name: Name
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The description of the entitlement.
Description: Description
/// Specifies whether all or selected apps are entitled.
@required
AppVisibility: AppVisibility
/// The attributes of the entitlement.
@required
Attributes: EntitlementAttributeList
/// The time when the entitlement was created.
CreatedTime: Timestamp
/// The time when the entitlement was last modified.
LastModifiedTime: Timestamp
}
/// The entitlement already exists.
@error("client")
@httpError(400)
structure EntitlementAlreadyExistsException {
Message: ErrorMessage
}
/// An attribute associated with an entitlement. Application entitlements work by matching
/// a supported SAML 2.0 attribute name to a value when a user identity federates to an
/// Amazon AppStream 2.0 SAML application.
structure EntitlementAttribute {
/// A supported AWS IAM SAML PrincipalTag
attribute that is matched to the
/// associated value when a user identity federates into an Amazon AppStream 2.0 SAML
/// application.
/// The following are valid values:
///
/// -
///
roles
///
/// -
///
department
///
/// -
///
organization
///
/// -
///
groups
///
/// -
///
title
///
/// -
///
costCenter
///
/// -
///
userType
///
///
///
@required
Name: String
/// A value that is matched to a supported SAML attribute name when a user identity
/// federates into an Amazon AppStream 2.0 SAML application.
@required
Value: String
}
/// The entitlement can't be found.
@error("client")
@httpError(400)
structure EntitlementNotFoundException {
Message: ErrorMessage
}
@input
structure ExpireSessionRequest {
/// The identifier of the streaming session.
@required
SessionId: String
}
structure ExpireSessionResult {}
/// Describes a fleet.
structure Fleet {
/// The Amazon Resource Name (ARN) for the fleet.
@required
Arn: Arn
/// The name of the fleet.
@required
Name: String
/// The fleet name to display.
DisplayName: String
/// The description to display.
Description: String
/// The name of the image used to create the fleet.
ImageName: String
/// The ARN for the public, private, or shared image.
ImageArn: Arn
/// The instance type to use when launching fleet instances. The following instance types are available:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.compute.large
///
/// -
///
stream.compute.xlarge
///
/// -
///
stream.compute.2xlarge
///
/// -
///
stream.compute.4xlarge
///
/// -
///
stream.compute.8xlarge
///
/// -
///
stream.memory.large
///
/// -
///
stream.memory.xlarge
///
/// -
///
stream.memory.2xlarge
///
/// -
///
stream.memory.4xlarge
///
/// -
///
stream.memory.8xlarge
///
/// -
///
stream.memory.z1d.large
///
/// -
///
stream.memory.z1d.xlarge
///
/// -
///
stream.memory.z1d.2xlarge
///
/// -
///
stream.memory.z1d.3xlarge
///
/// -
///
stream.memory.z1d.6xlarge
///
/// -
///
stream.memory.z1d.12xlarge
///
/// -
///
stream.graphics-design.large
///
/// -
///
stream.graphics-design.xlarge
///
/// -
///
stream.graphics-design.2xlarge
///
/// -
///
stream.graphics-design.4xlarge
///
/// -
///
stream.graphics-desktop.2xlarge
///
/// -
///
stream.graphics.g4dn.xlarge
///
/// -
///
stream.graphics.g4dn.2xlarge
///
/// -
///
stream.graphics.g4dn.4xlarge
///
/// -
///
stream.graphics.g4dn.8xlarge
///
/// -
///
stream.graphics.g4dn.12xlarge
///
/// -
///
stream.graphics.g4dn.16xlarge
///
/// -
///
stream.graphics-pro.4xlarge
///
/// -
///
stream.graphics-pro.8xlarge
///
/// -
///
stream.graphics-pro.16xlarge
///
///
@required
InstanceType: String
/// 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.
///
///
FleetType: FleetType
/// The capacity status for the fleet.
@required
ComputeCapacityStatus: ComputeCapacityStatus
/// 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.
/// Specify a value between 600 and 360000.
MaxUserDurationInSeconds: Integer
/// 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.
/// Specify a value between 60 and 360000.
DisconnectTimeoutInSeconds: Integer
/// The current state for the fleet.
@required
State: FleetState
/// The VPC configuration for the fleet.
VpcConfig: VpcConfig
/// The time the fleet was created.
CreatedTime: Timestamp
/// The fleet errors.
FleetErrors: FleetErrors
/// Indicates whether default internet access is enabled for the fleet.
EnableDefaultInternetAccess: BooleanObject
/// The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
DomainJoinInfo: DomainJoinInfo
/// The amount of time that users can be idle (inactive) before they are disconnected
/// from their streaming session and the DisconnectTimeoutInSeconds
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
/// DisconnectTimeoutInSeconds
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 IdleDisconnectTimeoutInSeconds
elapses, they are
/// disconnected.
/// 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.
///
/// 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.
///
IdleDisconnectTimeoutInSeconds: Integer
/// 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) AssumeRole
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 appstream_machine_role credential profile on the instance.
/// For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn: Arn
/// The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP
is specified, only the windows of applications opened by users display. When DESKTOP
is specified, the standard desktop that is provided by the operating system displays.
/// The default value is APP
.
StreamView: StreamView
/// The platform of the fleet.
Platform: PlatformType
/// The maximum number of concurrent sessions for the fleet.
MaxConcurrentSessions: Integer
/// The USB device filter strings associated with the fleet.
UsbDeviceFilterStrings: UsbDeviceFilterStrings
/// The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
SessionScriptS3Location: S3Location
}
/// Describes a fleet error.
structure FleetError {
/// The error code.
ErrorCode: FleetErrorCode
/// The error message.
ErrorMessage: String
}
/// Describes an image.
structure Image {
/// The name of the image.
@required
Name: String
/// The ARN of the image.
Arn: Arn
/// The ARN of the image from which this image was created.
BaseImageArn: Arn
/// The image name to display.
DisplayName: String
/// The image starts in the PENDING
state. If image creation succeeds, the
/// state is AVAILABLE
. If image creation fails, the state is FAILED
.
State: ImageState
/// Indicates whether the image is public or private.
Visibility: VisibilityType
/// Indicates whether an image builder can be launched from this image.
ImageBuilderSupported: Boolean = false
/// The name of the image builder that was used to create the private image. If the image is shared, this value is null.
ImageBuilderName: String
/// The operating system platform of the image.
Platform: PlatformType
/// The description to display.
Description: String
/// The reason why the last state change occurred.
StateChangeReason: ImageStateChangeReason
/// The applications associated with the image.
Applications: Applications
/// The time the image was created.
CreatedTime: Timestamp
/// 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.
PublicBaseImageReleasedDate: Timestamp
/// The version of the AppStream 2.0 agent to use for instances that are launched from this image.
AppstreamAgentVersion: AppstreamAgentVersion
/// The permissions to provide to the destination AWS account for the specified image.
ImagePermissions: ImagePermissions
/// Describes the errors that are returned when a new image can't be created.
ImageErrors: ResourceErrors
}
/// Describes a virtual machine that is used to create an image.
structure ImageBuilder {
/// The name of the image builder.
@required
Name: String
/// The ARN for the image builder.
Arn: Arn
/// The ARN of the image from which this builder was created.
ImageArn: Arn
/// The description to display.
Description: String
/// The image builder name to display.
DisplayName: String
/// The VPC configuration of the image builder.
VpcConfig: VpcConfig
/// The instance type for the image builder. The following instance types are available:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.compute.large
///
/// -
///
stream.compute.xlarge
///
/// -
///
stream.compute.2xlarge
///
/// -
///
stream.compute.4xlarge
///
/// -
///
stream.compute.8xlarge
///
/// -
///
stream.memory.large
///
/// -
///
stream.memory.xlarge
///
/// -
///
stream.memory.2xlarge
///
/// -
///
stream.memory.4xlarge
///
/// -
///
stream.memory.8xlarge
///
/// -
///
stream.memory.z1d.large
///
/// -
///
stream.memory.z1d.xlarge
///
/// -
///
stream.memory.z1d.2xlarge
///
/// -
///
stream.memory.z1d.3xlarge
///
/// -
///
stream.memory.z1d.6xlarge
///
/// -
///
stream.memory.z1d.12xlarge
///
/// -
///
stream.graphics-design.large
///
/// -
///
stream.graphics-design.xlarge
///
/// -
///
stream.graphics-design.2xlarge
///
/// -
///
stream.graphics-design.4xlarge
///
/// -
///
stream.graphics-desktop.2xlarge
///
/// -
///
stream.graphics.g4dn.xlarge
///
/// -
///
stream.graphics.g4dn.2xlarge
///
/// -
///
stream.graphics.g4dn.4xlarge
///
/// -
///
stream.graphics.g4dn.8xlarge
///
/// -
///
stream.graphics.g4dn.12xlarge
///
/// -
///
stream.graphics.g4dn.16xlarge
///
/// -
///
stream.graphics-pro.4xlarge
///
/// -
///
stream.graphics-pro.8xlarge
///
/// -
///
stream.graphics-pro.16xlarge
///
///
InstanceType: String
/// The operating system platform of the image builder.
Platform: PlatformType
/// 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) AssumeRole
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 appstream_machine_role credential profile on the instance.
/// For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn: Arn
/// The state of the image builder.
State: ImageBuilderState
/// The reason why the last state change occurred.
StateChangeReason: ImageBuilderStateChangeReason
/// The time stamp when the image builder was created.
CreatedTime: Timestamp
/// Enables or disables default internet access for the image builder.
EnableDefaultInternetAccess: BooleanObject
/// The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DomainJoinInfo: DomainJoinInfo
NetworkAccessConfiguration: NetworkAccessConfiguration
/// The image builder errors.
ImageBuilderErrors: ResourceErrors
/// The version of the AppStream 2.0 agent that is currently being used by the image builder.
AppstreamAgentVersion: AppstreamAgentVersion
/// The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
AccessEndpoints: AccessEndpointList
}
/// Describes the reason why the last image builder state change occurred.
structure ImageBuilderStateChangeReason {
/// The state change reason code.
Code: ImageBuilderStateChangeReasonCode
/// The state change reason message.
Message: String
}
/// Describes the permissions for an image.
structure ImagePermissions {
/// Indicates whether the image can be used for a fleet.
allowFleet: BooleanObject
/// Indicates whether the image can be used for an image builder.
allowImageBuilder: BooleanObject
}
/// Describes the reason why the last image state change occurred.
structure ImageStateChangeReason {
/// The state change reason code.
Code: ImageStateChangeReasonCode
/// The state change reason message.
Message: String
}
/// The image can't be updated because it's not compatible for updates.
@error("client")
@httpError(400)
structure IncompatibleImageException {
Message: ErrorMessage
}
/// The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
@error("client")
@httpError(400)
structure InvalidAccountStatusException {
Message: ErrorMessage
}
/// Indicates an incorrect combination of parameters, or a missing parameter.
@error("client")
@httpError(400)
structure InvalidParameterCombinationException {
Message: ErrorMessage
}
/// The specified role is invalid.
@error("client")
@httpError(400)
structure InvalidRoleException {
Message: ErrorMessage
}
/// Describes the error that is returned when a usage report can't be generated.
structure LastReportGenerationExecutionError {
/// The error code for the error that is returned when a usage report can't be generated.
ErrorCode: UsageReportExecutionErrorCode
/// The error message for the error that is returned when a usage report can't be generated.
ErrorMessage: String
}
/// The requested limit exceeds the permitted limit for an account.
@error("client")
@httpError(400)
structure LimitExceededException {
Message: ErrorMessage
}
@input
structure ListAssociatedFleetsRequest {
/// The name of the stack.
@required
StackName: String
/// 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.
NextToken: String
}
structure ListAssociatedFleetsResult {
/// The name of the fleet.
Names: StringList
/// 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.
NextToken: String
}
@input
structure ListAssociatedStacksRequest {
/// The name of the fleet.
@required
FleetName: String
/// 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.
NextToken: String
}
structure ListAssociatedStacksResult {
/// The name of the stack.
Names: StringList
/// 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.
NextToken: String
}
@input
structure ListEntitledApplicationsRequest {
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The name of the entitlement.
@required
EntitlementName: Name
/// The pagination token used to retrieve the next page of results for this operation.
NextToken: String
/// The maximum size of each page of results.
MaxResults: Integer
}
structure ListEntitledApplicationsResult {
/// The entitled applications.
EntitledApplications: EntitledApplicationList
/// The pagination token used to retrieve the next page of results for this operation.
NextToken: String
}
@input
structure ListTagsForResourceRequest {
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: Arn
}
@output
structure ListTagsForResourceResponse {
/// The information about the tags.
Tags: Tags
}
/// Describes the network details of the fleet or image builder instance.
structure NetworkAccessConfiguration {
/// The private IP address of the elastic network interface that is attached to instances in your VPC.
EniPrivateIpAddress: String
/// 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.
EniId: String
}
/// The attempted operation is not permitted.
@error("client")
@httpError(400)
structure OperationNotPermittedException {
Message: ErrorMessage
}
/// AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
@error("client")
@httpError(400)
structure RequestLimitExceededException {
Message: ErrorMessage
}
/// The specified resource already exists.
@error("client")
@httpError(400)
structure ResourceAlreadyExistsException {
Message: ErrorMessage
}
/// Describes a resource error.
structure ResourceError {
/// The error code.
ErrorCode: FleetErrorCode
/// The error message.
ErrorMessage: String
/// The time the error occurred.
ErrorTimestamp: Timestamp
}
/// The specified resource is in use.
@error("client")
@httpError(400)
structure ResourceInUseException {
Message: ErrorMessage
}
/// The specified resource exists and is not in use, but isn't available.
@error("client")
@httpError(400)
structure ResourceNotAvailableException {
Message: ErrorMessage
}
/// The specified resource was not found.
@error("client")
@httpError(404)
structure ResourceNotFoundException {
Message: ErrorMessage
}
/// Describes the S3 location.
structure S3Location {
/// The S3 bucket of the S3 object.
@required
S3Bucket: S3Bucket
/// The S3 key of the S3 object.
@required
S3Key: S3Key
}
/// Describes the details of the script.
structure ScriptDetails {
/// The S3 object location for the script.
@required
ScriptS3Location: S3Location
/// The run path for the script.
@required
ExecutablePath: String
/// The runtime parameters passed to the run path for the script.
ExecutableParameters: String
/// The run timeout, in seconds, for the script.
@required
TimeoutInSeconds: Integer
}
/// Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
structure ServiceAccountCredentials {
/// 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.
@required
AccountName: AccountName
/// The password for the account.
@required
AccountPassword: AccountPassword
}
/// Describes a streaming session.
structure Session {
/// The identifier of the streaming session.
@required
Id: String
/// The identifier of the user for whom the session was created.
@required
UserId: UserId
/// The name of the stack for the streaming session.
@required
StackName: String
/// The name of the fleet for the streaming session.
@required
FleetName: String
/// The current state of the streaming session.
@required
State: SessionState
/// Specifies whether a user is connected to the streaming session.
ConnectionState: SessionConnectionState
/// The time when a streaming instance is dedicated for the user.
StartTime: Timestamp
/// The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds
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 SessionMaxExpirationTime
, when the DisconnectTimeOutInSeconds
elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds
elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
MaxExpirationTime: Timestamp
/// The authentication method. The user is authenticated using a streaming URL
/// (API
) or SAML 2.0 federation (SAML
).
AuthenticationType: AuthenticationType
/// The network details for the streaming session.
NetworkAccessConfiguration: NetworkAccessConfiguration
}
/// Describes the permissions that are available to the specified AWS account for a shared image.
structure SharedImagePermissions {
/// The 12-digit identifier of the AWS account with which the image is shared.
@required
sharedAccountId: AwsAccountId
/// Describes the permissions for a shared image.
@required
imagePermissions: ImagePermissions
}
/// Describes a stack.
structure Stack {
/// The ARN of the stack.
Arn: Arn
/// The name of the stack.
@required
Name: String
/// The description to display.
Description: String
/// The stack name to display.
DisplayName: String
/// The time the stack was created.
CreatedTime: Timestamp
/// The storage connectors to enable.
StorageConnectors: StorageConnectorList
/// The URL that users are redirected to after their streaming session ends.
RedirectURL: RedirectURL
/// 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.
FeedbackURL: FeedbackURL
/// The errors for the stack.
StackErrors: StackErrors
/// The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
UserSettings: UserSettingList
/// The persistent application settings for users of the stack.
ApplicationSettings: ApplicationSettingsResponse
/// 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.
AccessEndpoints: AccessEndpointList
/// 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.
EmbedHostDomains: EmbedHostDomains
/// The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
StreamingExperienceSettings: StreamingExperienceSettings
}
/// Describes a stack error.
structure StackError {
/// The error code.
ErrorCode: StackErrorCode
/// The error message.
ErrorMessage: String
}
@input
structure StartFleetRequest {
/// The name of the fleet.
@required
Name: String
}
structure StartFleetResult {}
@input
structure StartImageBuilderRequest {
/// The name of the image builder.
@required
Name: String
/// 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].
AppstreamAgentVersion: AppstreamAgentVersion
}
structure StartImageBuilderResult {
/// Information about the image builder.
ImageBuilder: ImageBuilder
}
@input
structure StopFleetRequest {
/// The name of the fleet.
@required
Name: String
}
structure StopFleetResult {}
@input
structure StopImageBuilderRequest {
/// The name of the image builder.
@required
Name: String
}
structure StopImageBuilderResult {
/// Information about the image builder.
ImageBuilder: ImageBuilder
}
/// Describes a connector that enables persistent storage for users.
structure StorageConnector {
/// The type of storage connector.
@required
ConnectorType: StorageConnectorType
/// The ARN of the storage connector.
ResourceIdentifier: ResourceIdentifier
/// The names of the domains for the account.
Domains: DomainList
}
/// The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
structure StreamingExperienceSettings {
/// The preferred protocol that you want to use while streaming your application.
PreferredProtocol: PreferredProtocol
}
@input
structure TagResourceRequest {
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: Arn
/// 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=.
/// If you do not specify a value, the value is set to an empty string.
/// Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
/// _ . : / = + \ - @
@required
Tags: Tags
}
@output
structure TagResourceResponse {}
@input
structure UntagResourceRequest {
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: Arn
/// The tag keys for the tags to disassociate.
@required
TagKeys: TagKeyList
}
@output
structure UntagResourceResponse {}
@input
structure UpdateApplicationRequest {
/// The name of the application. This name is visible to users when display name is not specified.
@required
Name: Name
/// The display name of the application. This name is visible to users in the application catalog.
DisplayName: DisplayName
/// The description of the application.
Description: Description
/// The icon S3 location of the application.
IconS3Location: S3Location
/// The launch path of the application.
LaunchPath: String
/// The working directory of the application.
WorkingDirectory: String
/// The launch parameters of the application.
LaunchParameters: String
/// The ARN of the app block.
AppBlockArn: Arn
/// The attributes to delete for an application.
AttributesToDelete: ApplicationAttributes
}
structure UpdateApplicationResult {
Application: Application
}
@input
structure UpdateDirectoryConfigRequest {
/// The name of the Directory Config object.
@required
DirectoryName: DirectoryName
/// The distinguished names of the organizational units for computer accounts.
OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList
/// The credentials for the service account used by the fleet or image builder to connect to the directory.
ServiceAccountCredentials: ServiceAccountCredentials
/// The certificate-based authentication properties used to authenticate SAML 2.0 Identity
/// Provider (IdP) user identities to Active Directory domain-joined streaming instances.
/// Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD
/// domain password if certificate-based authentication is unsuccessful, or to unlock a
/// desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based
/// authentication, but does not allow users to log in using their AD domain password. Users
/// will be disconnected to re-authenticate using certificates.
CertificateBasedAuthProperties: CertificateBasedAuthProperties
}
structure UpdateDirectoryConfigResult {
/// Information about the Directory Config object.
DirectoryConfig: DirectoryConfig
}
@input
structure UpdateEntitlementRequest {
/// The name of the entitlement.
@required
Name: Name
/// The name of the stack with which the entitlement is associated.
@required
StackName: Name
/// The description of the entitlement.
Description: Description
/// Specifies whether all or only selected apps are entitled.
AppVisibility: AppVisibility
/// The attributes of the entitlement.
Attributes: EntitlementAttributeList
}
structure UpdateEntitlementResult {
/// The entitlement.
Entitlement: Entitlement
}
@input
structure UpdateFleetRequest {
/// The name of the image used to create the fleet.
ImageName: String
/// The ARN of the public, private, or shared image to use.
ImageArn: Arn
/// A unique name for the fleet.
Name: String
/// The instance type to use when launching fleet instances. The following instance types are available:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.standard.xlarge
///
/// -
///
stream.standard.2xlarge
///
/// -
///
stream.compute.large
///
/// -
///
stream.compute.xlarge
///
/// -
///
stream.compute.2xlarge
///
/// -
///
stream.compute.4xlarge
///
/// -
///
stream.compute.8xlarge
///
/// -
///
stream.memory.large
///
/// -
///
stream.memory.xlarge
///
/// -
///
stream.memory.2xlarge
///
/// -
///
stream.memory.4xlarge
///
/// -
///
stream.memory.8xlarge
///
/// -
///
stream.memory.z1d.large
///
/// -
///
stream.memory.z1d.xlarge
///
/// -
///
stream.memory.z1d.2xlarge
///
/// -
///
stream.memory.z1d.3xlarge
///
/// -
///
stream.memory.z1d.6xlarge
///
/// -
///
stream.memory.z1d.12xlarge
///
/// -
///
stream.graphics-design.large
///
/// -
///
stream.graphics-design.xlarge
///
/// -
///
stream.graphics-design.2xlarge
///
/// -
///
stream.graphics-design.4xlarge
///
/// -
///
stream.graphics-desktop.2xlarge
///
/// -
///
stream.graphics.g4dn.xlarge
///
/// -
///
stream.graphics.g4dn.2xlarge
///
/// -
///
stream.graphics.g4dn.4xlarge
///
/// -
///
stream.graphics.g4dn.8xlarge
///
/// -
///
stream.graphics.g4dn.12xlarge
///
/// -
///
stream.graphics.g4dn.16xlarge
///
/// -
///
stream.graphics-pro.4xlarge
///
/// -
///
stream.graphics-pro.8xlarge
///
/// -
///
stream.graphics-pro.16xlarge
///
///
/// The following instance types are available for Elastic fleets:
///
/// -
///
stream.standard.small
///
/// -
///
stream.standard.medium
///
/// -
///
stream.standard.large
///
/// -
///
stream.standard.xlarge
///
/// -
///
stream.standard.2xlarge
///
///
InstanceType: String
/// The desired capacity for the fleet. This is not allowed for Elastic fleets.
ComputeCapacity: ComputeCapacity
/// The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
VpcConfig: VpcConfig
/// 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.
/// Specify a value between 600 and 360000.
MaxUserDurationInSeconds: Integer
/// 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.
/// Specify a value between 60 and 360000.
DisconnectTimeoutInSeconds: Integer
/// Deletes the VPC association for the specified fleet.
@deprecated
DeleteVpcConfig: Boolean = false
/// The description to display.
Description: Description
/// The fleet name to display.
DisplayName: DisplayName
/// Enables or disables default internet access for the fleet.
EnableDefaultInternetAccess: BooleanObject
/// The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
DomainJoinInfo: DomainJoinInfo
/// The amount of time that users can be idle (inactive) before they are disconnected
/// from their streaming session and the DisconnectTimeoutInSeconds
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
/// DisconnectTimeoutInSeconds
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 IdleDisconnectTimeoutInSeconds
elapses, they are
/// disconnected.
/// 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.
///
/// 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.
///
IdleDisconnectTimeoutInSeconds: Integer
/// The fleet attributes to delete.
AttributesToDelete: FleetAttributes
/// 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) AssumeRole
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 appstream_machine_role credential profile on the instance.
/// For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn: Arn
/// The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP
is specified, only the windows of applications opened by users display. When DESKTOP
is specified, the standard desktop that is provided by the operating system displays.
/// The default value is APP
.
StreamView: StreamView
/// The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
Platform: PlatformType
/// The maximum number of concurrent sessions for a fleet.
MaxConcurrentSessions: Integer
/// The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
UsbDeviceFilterStrings: UsbDeviceFilterStrings
/// The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
SessionScriptS3Location: S3Location
}
structure UpdateFleetResult {
/// Information about the fleet.
Fleet: Fleet
}
@input
structure UpdateImagePermissionsRequest {
/// The name of the private image.
@required
Name: Name
/// The 12-digit identifier of the AWS account for which you want add or update image permissions.
@required
SharedAccountId: AwsAccountId
/// The permissions for the image.
@required
ImagePermissions: ImagePermissions
}
structure UpdateImagePermissionsResult {}
@input
structure UpdateStackRequest {
/// The stack name to display.
DisplayName: DisplayName
/// The description to display.
Description: Description
/// The name of the stack.
@required
Name: String
/// The storage connectors to enable.
StorageConnectors: StorageConnectorList
/// Deletes the storage connectors currently enabled for the stack.
@deprecated
DeleteStorageConnectors: Boolean = false
/// The URL that users are redirected to after their streaming session ends.
RedirectURL: RedirectURL
/// 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.
FeedbackURL: FeedbackURL
/// The stack attributes to delete.
AttributesToDelete: StackAttributes
/// The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
UserSettings: UserSettingList
/// 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.
ApplicationSettings: ApplicationSettings
/// The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
AccessEndpoints: AccessEndpointList
/// 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.
EmbedHostDomains: EmbedHostDomains
/// The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
StreamingExperienceSettings: StreamingExperienceSettings
}
structure UpdateStackResult {
/// Information about the stack.
Stack: Stack
}
/// Describes information about the usage report subscription.
structure UsageReportSubscription {
/// The Amazon S3 bucket where generated reports are stored.
/// 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.
S3BucketName: String
/// The schedule for generating usage reports.
Schedule: UsageReportSchedule
/// The time when the last usage report was generated.
LastGeneratedReportDate: Timestamp
/// The errors that were returned if usage reports couldn't be generated.
SubscriptionErrors: LastReportGenerationExecutionErrors
}
/// Describes a user in the user pool.
structure User {
/// The ARN of the user.
Arn: Arn
/// The email address of the user.
///
/// Users' email addresses are case-sensitive.
///
UserName: Username
/// Specifies whether the user in the user pool is enabled.
Enabled: Boolean = false
/// The status of the user in the user pool. The status can be one of the following:
///
/// -
///
UNCONFIRMED – The user is created but not confirmed.
///
/// -
///
CONFIRMED – The user is confirmed.
///
/// -
///
ARCHIVED – The user is no longer active.
///
/// -
///
COMPROMISED – The user is disabled because of a potential security threat.
///
/// -
///
UNKNOWN – The user status is not known.
///
///
Status: String
/// The first name, or given name, of the user.
FirstName: UserAttributeValue
/// The last name, or surname, of the user.
LastName: UserAttributeValue
/// The date and time the user was created in the user pool.
CreatedTime: Timestamp
/// The authentication type for the user.
@required
AuthenticationType: AuthenticationType
}
/// Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
structure UserSetting {
/// The action that is enabled or disabled.
@required
Action: Action
/// Indicates whether the action is enabled or disabled.
@required
Permission: Permission
}
/// Describes a user in the user pool and the associated stack.
structure UserStackAssociation {
/// The name of the stack that is associated with the user.
@required
StackName: String
/// The email address of the user who is associated with the stack.
///
/// Users' email addresses are case-sensitive.
///
@required
UserName: Username
/// The authentication type for the user.
@required
AuthenticationType: AuthenticationType
/// Specifies whether a welcome email is sent to a user after the user is created in the user pool.
SendEmailNotification: Boolean = false
}
/// Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
structure UserStackAssociationError {
/// Information about the user and associated stack.
UserStackAssociation: UserStackAssociation
/// The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
ErrorCode: UserStackAssociationErrorCode
/// The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
ErrorMessage: String
}
/// Describes VPC configuration information for fleets and image builders.
structure VpcConfig {
/// 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.
SubnetIds: SubnetIdList
/// The identifiers of the security groups for the fleet or image builder.
SecurityGroupIds: SecurityGroupIdList
}
@length(
min: 1
max: 4
)
list AccessEndpointList {
member: AccessEndpoint
}
list AppBlocks {
member: AppBlock
}
@length(
min: 0
max: 2
)
list ApplicationAttributes {
member: ApplicationAttribute
}
@length(
min: 1
max: 25
)
list ApplicationFleetAssociationList {
member: ApplicationFleetAssociation
}
list Applications {
member: Application
}
list ArnList {
member: Arn
}
@length(
min: 1
max: 5
)
list AwsAccountIdList {
member: AwsAccountId
}
list DirectoryConfigList {
member: DirectoryConfig
}
list DirectoryNameList {
member: DirectoryName
}
@length(
min: 0
max: 50
)
list DomainList {
member: Domain
}
@length(
min: 1
max: 20
)
list EmbedHostDomains {
member: EmbedHostDomain
}
list EntitledApplicationList {
member: EntitledApplication
}
@length(
min: 1
)
list EntitlementAttributeList {
member: EntitlementAttribute
}
list EntitlementList {
member: Entitlement
}
/// The fleet attributes.
list FleetAttributes {
member: FleetAttribute
}
list FleetErrors {
member: FleetError
}
/// The fleets.
list FleetList {
member: Fleet
}
list ImageBuilderList {
member: ImageBuilder
}
list ImageList {
member: Image
}
list LastReportGenerationExecutionErrors {
member: LastReportGenerationExecutionError
}
list OrganizationalUnitDistinguishedNamesList {
member: OrganizationalUnitDistinguishedName
}
@length(
min: 0
max: 4
)
list Platforms {
member: PlatformType
}
list ResourceErrors {
member: ResourceError
}
/// The security group identifiers.
@length(
min: 0
max: 5
)
list SecurityGroupIdList {
member: String
}
/// List of sessions.
list SessionList {
member: Session
}
list SharedImagePermissionsList {
member: SharedImagePermissions
}
list StackAttributes {
member: StackAttribute
}
/// The stack errors.
list StackErrors {
member: StackError
}
/// The stacks.
list StackList {
member: Stack
}
/// The storage connectors.
list StorageConnectorList {
member: StorageConnector
}
list StringList {
member: String
}
/// The subnet identifiers.
list SubnetIdList {
member: String
}
@length(
min: 1
max: 50
)
list TagKeyList {
member: TagKey
}
list UsageReportSubscriptionList {
member: UsageReportSubscription
}
list UsbDeviceFilterStrings {
member: UsbDeviceFilterString
}
list UserList {
member: User
}
@length(
min: 1
)
list UserSettingList {
member: UserSetting
}
list UserStackAssociationErrorList {
member: UserStackAssociationError
}
@length(
min: 1
max: 25
)
list UserStackAssociationList {
member: UserStackAssociation
}
map Metadata {
key: String
value: String
}
@length(
min: 1
max: 50
)
map Tags {
key: TagKey
value: TagValue
}
enum AccessEndpointType {
STREAMING
}
@length(
min: 1
)
@sensitive
string AccountName
@length(
min: 1
max: 127
)
@sensitive
string AccountPassword
enum Action {
CLIPBOARD_COPY_FROM_LOCAL_DEVICE
CLIPBOARD_COPY_TO_LOCAL_DEVICE
FILE_UPLOAD
FILE_DOWNLOAD
PRINTING_TO_LOCAL_DEVICE
DOMAIN_PASSWORD_SIGNIN
DOMAIN_SMART_CARD_SIGNIN
}
enum ApplicationAttribute {
LAUNCH_PARAMETERS
WORKING_DIRECTORY
}
@length(
min: 1
max: 100
)
string AppstreamAgentVersion
enum AppVisibility {
ALL
ASSOCIATED
}
@pattern("^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$")
string Arn
enum AuthenticationType {
API
SAML
USERPOOL
AWS_AD
}
@pattern("^\\d+$")
string AwsAccountId
@default(false)
boolean Boolean
boolean BooleanObject
enum CertificateBasedAuthStatus {
DISABLED
ENABLED
ENABLED_NO_DIRECTORY_LOGIN_FALLBACK
}
@range(
min: 0
max: 25
)
integer DescribeImagesMaxResults
@length(
min: 0
max: 256
)
string Description
string DirectoryName
@length(
min: 0
max: 100
)
string DisplayName
/// GSuite domain for GDrive integration.
@length(
min: 1
max: 64
)
string Domain
/// 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". ""]
@length(
min: 0
max: 128
)
@pattern("^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$")
string EmbedHostDomain
/// The error message in the exception.
string ErrorMessage
@length(
min: 0
max: 1000
)
string FeedbackURL
/// The fleet attribute.
enum FleetAttribute {
VPC_CONFIGURATION
VPC_CONFIGURATION_SECURITY_GROUP_IDS
DOMAIN_JOIN_INFO
IAM_ROLE_ARN
USB_DEVICE_FILTER_STRINGS
SESSION_SCRIPT_S3_LOCATION
}
enum FleetErrorCode {
IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION
IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION
IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION
NETWORK_INTERFACE_LIMIT_EXCEEDED
INTERNAL_SERVICE_ERROR
IAM_SERVICE_ROLE_IS_MISSING
MACHINE_ROLE_IS_MISSING
STS_DISABLED_IN_REGION
SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES
IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION
SUBNET_NOT_FOUND
IMAGE_NOT_FOUND
INVALID_SUBNET_CONFIGURATION
SECURITY_GROUPS_NOT_FOUND
IGW_NOT_ATTACHED
IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION
FLEET_STOPPED
FLEET_INSTANCE_PROVISIONING_FAILURE
DOMAIN_JOIN_ERROR_FILE_NOT_FOUND
DOMAIN_JOIN_ERROR_ACCESS_DENIED
DOMAIN_JOIN_ERROR_LOGON_FAILURE
DOMAIN_JOIN_ERROR_INVALID_PARAMETER
DOMAIN_JOIN_ERROR_MORE_DATA
DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN
DOMAIN_JOIN_ERROR_NOT_SUPPORTED
DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME
DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED
DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED
DOMAIN_JOIN_NERR_PASSWORD_EXPIRED
DOMAIN_JOIN_INTERNAL_SERVICE_ERROR
}
enum FleetState {
STARTING
RUNNING
STOPPING
STOPPED
}
enum FleetType {
ALWAYS_ON
ON_DEMAND
ELASTIC
}
enum ImageBuilderState {
PENDING
UPDATING_AGENT
RUNNING
STOPPING
STOPPED
REBOOTING
SNAPSHOTTING
DELETING
FAILED
UPDATING
PENDING_QUALIFICATION
}
enum ImageBuilderStateChangeReasonCode {
INTERNAL_ERROR
IMAGE_UNAVAILABLE
}
enum ImageState {
PENDING
AVAILABLE
FAILED
COPYING
DELETING
CREATING
IMPORTING
}
enum ImageStateChangeReasonCode {
INTERNAL_ERROR
IMAGE_BUILDER_NOT_AVAILABLE
IMAGE_COPY_FAILURE
}
integer Integer
long Long
@range(
min: 0
max: 500
)
integer MaxResults
enum MessageAction {
SUPPRESS
RESEND
}
@pattern("^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$")
string Name
@length(
min: 0
max: 2000
)
string OrganizationalUnitDistinguishedName
enum Permission {
ENABLED
DISABLED
}
enum PlatformType {
WINDOWS
WINDOWS_SERVER_2016
WINDOWS_SERVER_2019
AMAZON_LINUX2
}
enum PreferredProtocol {
TCP
UDP
}
@length(
min: 0
max: 1000
)
string RedirectURL
@length(
min: 1
max: 32
)
string RegionName
/// The ARN of the resource.
@length(
min: 1
max: 2048
)
string ResourceIdentifier
@length(
min: 3
max: 63
)
@pattern("^[0-9a-z\\.\\-]*(?Possible values for the state of a streaming session.
enum SessionState {
ACTIVE
PENDING
EXPIRED
}
@length(
min: 0
max: 100
)
string SettingsGroup
enum StackAttribute {
STORAGE_CONNECTORS
STORAGE_CONNECTOR_HOMEFOLDERS
STORAGE_CONNECTOR_GOOGLE_DRIVE
STORAGE_CONNECTOR_ONE_DRIVE
REDIRECT_URL
FEEDBACK_URL
THEME_NAME
USER_SETTINGS
EMBED_HOST_DOMAINS
IAM_ROLE_ARN
ACCESS_ENDPOINTS
STREAMING_EXPERIENCE_SETTINGS
}
enum StackErrorCode {
STORAGE_CONNECTOR_ERROR
INTERNAL_SERVICE_ERROR
}
/// The type of storage connector.
enum StorageConnectorType {
HOMEFOLDERS
GOOGLE_DRIVE
ONE_DRIVE
}
@length(
min: 2
max: 32
)
@pattern("^[\\w+=,.@-]*$")
string StreamingUrlUserId
enum StreamView {
APP
DESKTOP
}
@length(
min: 1
)
string String
@length(
min: 1
max: 128
)
@pattern("^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$")
string TagKey
@length(
min: 0
max: 256
)
@pattern("^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$")
string TagValue
timestamp Timestamp
enum UsageReportExecutionErrorCode {
RESOURCE_NOT_FOUND
ACCESS_DENIED
INTERNAL_SERVICE_ERROR
}
enum UsageReportSchedule {
DAILY
}
@length(
min: 0
max: 100
)
@pattern("^((\\w*)\\s*(\\w*)\\s*\\,\\s*(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*[0-1]\\s*\\,\\s*[0-1]\\s*)$")
string UsbDeviceFilterString
@length(
min: 0
max: 2048
)
@pattern("^[A-Za-z0-9_\\-\\s]+$")
@sensitive
string UserAttributeValue
@length(
min: 2
max: 128
)
string UserId
@length(
min: 1
max: 128
)
@pattern("^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$")
@sensitive
string Username
enum UserStackAssociationErrorCode {
STACK_NOT_FOUND
USER_NAME_NOT_FOUND
DIRECTORY_NOT_FOUND
INTERNAL_ERROR
}
enum VisibilityType {
PUBLIC
PRIVATE
SHARED
}