@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAppStream
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAppStream
instead.
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:
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateAppBlockBuilderAppBlockResult |
associateAppBlockBuilderAppBlock(AssociateAppBlockBuilderAppBlockRequest associateAppBlockBuilderAppBlockRequest)
Associates the specified app block builder with the specified app block.
|
AssociateApplicationFleetResult |
associateApplicationFleet(AssociateApplicationFleetRequest associateApplicationFleetRequest)
Associates the specified application with the specified fleet.
|
AssociateApplicationToEntitlementResult |
associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest)
Associates an application to entitle.
|
AssociateFleetResult |
associateFleet(AssociateFleetRequest associateFleetRequest)
Associates the specified fleet with the specified stack.
|
BatchAssociateUserStackResult |
batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)
Associates the specified users with the specified stacks.
|
BatchDisassociateUserStackResult |
batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest)
Disassociates the specified users from the specified stacks.
|
CopyImageResult |
copyImage(CopyImageRequest copyImageRequest)
Copies the image within the same region or to a new region within the same AWS account.
|
CreateAppBlockResult |
createAppBlock(CreateAppBlockRequest createAppBlockRequest)
Creates an app block.
|
CreateAppBlockBuilderResult |
createAppBlockBuilder(CreateAppBlockBuilderRequest createAppBlockBuilderRequest)
Creates an app block builder.
|
CreateAppBlockBuilderStreamingURLResult |
createAppBlockBuilderStreamingURL(CreateAppBlockBuilderStreamingURLRequest createAppBlockBuilderStreamingURLRequest)
Creates a URL to start a create app block builder streaming session.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application.
|
CreateDirectoryConfigResult |
createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
Creates a Directory Config object in AppStream 2.0.
|
CreateEntitlementResult |
createEntitlement(CreateEntitlementRequest createEntitlementRequest)
Creates a new entitlement.
|
CreateFleetResult |
createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet.
|
CreateImageBuilderResult |
createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
Creates an image builder.
|
CreateImageBuilderStreamingURLResult |
createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)
Creates a URL to start an image builder streaming session.
|
CreateStackResult |
createStack(CreateStackRequest createStackRequest)
Creates a stack to start streaming applications to users.
|
CreateStreamingURLResult |
createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
|
CreateUpdatedImageResult |
createUpdatedImage(CreateUpdatedImageRequest createUpdatedImageRequest)
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent
software.
|
CreateUsageReportSubscriptionResult |
createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest)
Creates a usage report subscription.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a new user in the user pool.
|
DeleteAppBlockResult |
deleteAppBlock(DeleteAppBlockRequest deleteAppBlockRequest)
Deletes an app block.
|
DeleteAppBlockBuilderResult |
deleteAppBlockBuilder(DeleteAppBlockBuilderRequest deleteAppBlockBuilderRequest)
Deletes an app block builder.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
|
DeleteDirectoryConfigResult |
deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
Deletes the specified Directory Config object from AppStream 2.0.
|
DeleteEntitlementResult |
deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest)
Deletes the specified entitlement.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes the specified fleet.
|
DeleteImageResult |
deleteImage(DeleteImageRequest deleteImageRequest)
Deletes the specified image.
|
DeleteImageBuilderResult |
deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
Deletes the specified image builder and releases the capacity.
|
DeleteImagePermissionsResult |
deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)
Deletes permissions for the specified private image.
|
DeleteStackResult |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes the specified stack.
|
DeleteUsageReportSubscriptionResult |
deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest)
Disables usage report generation.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from the user pool.
|
DescribeAppBlockBuilderAppBlockAssociationsResult |
describeAppBlockBuilderAppBlockAssociations(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest)
Retrieves a list that describes one or more app block builder associations.
|
DescribeAppBlockBuildersResult |
describeAppBlockBuilders(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest)
Retrieves a list that describes one or more app block builders.
|
DescribeAppBlocksResult |
describeAppBlocks(DescribeAppBlocksRequest describeAppBlocksRequest)
Retrieves a list that describes one or more app blocks.
|
DescribeApplicationFleetAssociationsResult |
describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest)
Retrieves a list that describes one or more application fleet associations.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Retrieves a list that describes one or more applications.
|
DescribeDirectoryConfigsResult |
describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names
for these objects are provided.
|
DescribeEntitlementsResult |
describeEntitlements(DescribeEntitlementsRequest describeEntitlementsRequest)
Retrieves a list that describes one of more entitlements.
|
DescribeFleetsResult |
describeFleets(DescribeFleetsRequest describeFleetsRequest)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
|
DescribeImageBuildersResult |
describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
|
DescribeImagePermissionsResult |
describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
DescribeImagesResult |
describeImages(DescribeImagesRequest describeImagesRequest)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
DescribeSessionsResult |
describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest describeStacksRequest)
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
|
DescribeUsageReportSubscriptionsResult |
describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest)
Retrieves a list that describes one or more usage report subscriptions.
|
DescribeUsersResult |
describeUsers(DescribeUsersRequest describeUsersRequest)
Retrieves a list that describes one or more specified users in the user pool.
|
DescribeUserStackAssociationsResult |
describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)
Retrieves a list that describes the UserStackAssociation objects.
|
DisableUserResult |
disableUser(DisableUserRequest disableUserRequest)
Disables the specified user in the user pool.
|
DisassociateAppBlockBuilderAppBlockResult |
disassociateAppBlockBuilderAppBlock(DisassociateAppBlockBuilderAppBlockRequest disassociateAppBlockBuilderAppBlockRequest)
Disassociates a specified app block builder from a specified app block.
|
DisassociateApplicationFleetResult |
disassociateApplicationFleet(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest)
Disassociates the specified application from the fleet.
|
DisassociateApplicationFromEntitlementResult |
disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest)
Deletes the specified application from the specified entitlement.
|
DisassociateFleetResult |
disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
Disassociates the specified fleet from the specified stack.
|
EnableUserResult |
enableUser(EnableUserRequest enableUserRequest)
Enables a user in the user pool.
|
ExpireSessionResult |
expireSession(ExpireSessionRequest expireSessionRequest)
Immediately stops the specified streaming session.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAssociatedFleetsResult |
listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
Retrieves the name of the fleet that is associated with the specified stack.
|
ListAssociatedStacksResult |
listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
Retrieves the name of the stack with which the specified fleet is associated.
|
ListEntitledApplicationsResult |
listEntitledApplications(ListEntitledApplicationsRequest listEntitledApplicationsRequest)
Retrieves a list of entitled applications.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves a list of all tags for the specified AppStream 2.0 resource.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAppBlockBuilderResult |
startAppBlockBuilder(StartAppBlockBuilderRequest startAppBlockBuilderRequest)
Starts an app block builder.
|
StartFleetResult |
startFleet(StartFleetRequest startFleetRequest)
Starts the specified fleet.
|
StartImageBuilderResult |
startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
Starts the specified image builder.
|
StopAppBlockBuilderResult |
stopAppBlockBuilder(StopAppBlockBuilderRequest stopAppBlockBuilderRequest)
Stops an app block builder.
|
StopFleetResult |
stopFleet(StopFleetRequest stopFleetRequest)
Stops the specified fleet.
|
StopImageBuilderResult |
stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
Stops the specified image builder.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Disassociates one or more specified tags from the specified AppStream 2.0 resource.
|
UpdateAppBlockBuilderResult |
updateAppBlockBuilder(UpdateAppBlockBuilderRequest updateAppBlockBuilderRequest)
Updates an app block builder.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application.
|
UpdateDirectoryConfigResult |
updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
Updates the specified Directory Config object in AppStream 2.0.
|
UpdateEntitlementResult |
updateEntitlement(UpdateEntitlementRequest updateEntitlementRequest)
Updates the specified entitlement.
|
UpdateFleetResult |
updateFleet(UpdateFleetRequest updateFleetRequest)
Updates the specified fleet.
|
UpdateImagePermissionsResult |
updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)
Adds or updates permissions for the specified private image.
|
UpdateStackResult |
updateStack(UpdateStackRequest updateStackRequest)
Updates the specified fields for the specified stack.
|
AmazonAppStreamWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "appstream2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"appstream2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AssociateAppBlockBuilderAppBlockResult associateAppBlockBuilderAppBlock(AssociateAppBlockBuilderAppBlockRequest associateAppBlockBuilderAppBlockRequest)
Associates the specified app block builder with the specified app block.
associateAppBlockBuilderAppBlockRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.LimitExceededException
- The requested limit exceeds the permitted limit for an account.ResourceNotFoundException
- The specified resource was not found.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.AssociateApplicationFleetResult associateApplicationFleet(AssociateApplicationFleetRequest associateApplicationFleetRequest)
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
associateApplicationFleetRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.LimitExceededException
- The requested limit exceeds the permitted limit for an account.ResourceNotFoundException
- The specified resource was not found.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.AssociateApplicationToEntitlementResult associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest)
Associates an application to entitle.
associateApplicationToEntitlementRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.LimitExceededException
- The requested limit exceeds the permitted limit for an account.OperationNotPermittedException
- The attempted operation is not permitted.AssociateFleetResult associateFleet(AssociateFleetRequest associateFleetRequest)
Associates the specified fleet with the specified stack.
associateFleetRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.OperationNotPermittedException
- The attempted operation is not permitted.BatchAssociateUserStackResult batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)
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.
batchAssociateUserStackRequest
- OperationNotPermittedException
- The attempted operation is not permitted.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.BatchDisassociateUserStackResult batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest)
Disassociates the specified users from the specified stacks.
batchDisassociateUserStackRequest
- OperationNotPermittedException
- The attempted operation is not permitted.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.CopyImageResult copyImage(CopyImageRequest copyImageRequest)
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.
copyImageRequest
- ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotFoundException
- The specified resource was not found.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.CreateAppBlockResult createAppBlock(CreateAppBlockRequest createAppBlockRequest)
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.
createAppBlockRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.LimitExceededException
- The requested limit exceeds the permitted limit for an account.OperationNotPermittedException
- The attempted operation is not permitted.ResourceAlreadyExistsException
- The specified resource already exists.CreateAppBlockBuilderResult createAppBlockBuilder(CreateAppBlockBuilderRequest createAppBlockBuilderRequest)
Creates an app block builder.
createAppBlockBuilderRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.RequestLimitExceededException
- 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.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidRoleException
- The specified role is invalid.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.OperationNotPermittedException
- The attempted operation is not permitted.ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.CreateAppBlockBuilderStreamingURLResult createAppBlockBuilderStreamingURL(CreateAppBlockBuilderStreamingURLRequest createAppBlockBuilderStreamingURLRequest)
Creates a URL to start a create app block builder streaming session.
createAppBlockBuilderStreamingURLRequest
- ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
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.
createApplicationRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceAlreadyExistsException
- The specified resource already exists.LimitExceededException
- The requested limit exceeds the permitted limit for an account.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.ResourceNotFoundException
- The specified resource was not found.CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
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.
createDirectoryConfigRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceAlreadyExistsException
- The specified resource already exists.LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException
- The attempted operation is not permitted.InvalidRoleException
- The specified role is invalid.CreateEntitlementResult createEntitlement(CreateEntitlementRequest createEntitlementRequest)
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.
createEntitlementRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The requested limit exceeds the permitted limit for an account.EntitlementAlreadyExistsException
- The entitlement already exists.CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
createFleetRequest
- ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The requested limit exceeds the permitted limit for an account.RequestLimitExceededException
- 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.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidRoleException
- The specified role is invalid.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.OperationNotPermittedException
- The attempted operation is not permitted.CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
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
.
createImageBuilderRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.RequestLimitExceededException
- 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.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.InvalidRoleException
- The specified role is invalid.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.OperationNotPermittedException
- The attempted operation is not permitted.CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)
Creates a URL to start an image builder streaming session.
createImageBuilderStreamingURLRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.CreateStackResult createStack(CreateStackRequest createStackRequest)
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
createStackRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceAlreadyExistsException
- The specified resource already exists.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidRoleException
- The specified role is invalid.ResourceNotFoundException
- The specified resource was not found.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)
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.
createStreamingURLRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.OperationNotPermittedException
- The attempted operation is not permitted.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.CreateUpdatedImageResult createUpdatedImage(CreateUpdatedImageRequest createUpdatedImageRequest)
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.
createUpdatedImageRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException
- The attempted operation is not permitted.ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.CreateUsageReportSubscriptionResult createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest)
Creates a usage report subscription. Usage reports are generated daily.
createUsageReportSubscriptionRequest
- InvalidRoleException
- The specified role is invalid.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.LimitExceededException
- The requested limit exceeds the permitted limit for an account.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new user in the user pool.
createUserRequest
- ResourceAlreadyExistsException
- The specified resource already exists.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.LimitExceededException
- The requested limit exceeds the permitted limit for an account.OperationNotPermittedException
- The attempted operation is not permitted.DeleteAppBlockResult deleteAppBlock(DeleteAppBlockRequest deleteAppBlockRequest)
Deletes an app block.
deleteAppBlockRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.DeleteAppBlockBuilderResult deleteAppBlockBuilder(DeleteAppBlockBuilderRequest deleteAppBlockBuilderRequest)
Deletes an app block builder.
An app block builder can only be deleted when it has no association with an app block.
deleteAppBlockBuilderRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
deleteApplicationRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
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.
deleteDirectoryConfigRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.DeleteEntitlementResult deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest)
Deletes the specified entitlement.
deleteEntitlementRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes the specified fleet.
deleteFleetRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteImageResult deleteImage(DeleteImageRequest deleteImageRequest)
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.
deleteImageRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
Deletes the specified image builder and releases the capacity.
deleteImageBuilderRequest
- ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteImagePermissionsResult deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)
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.
deleteImagePermissionsRequest
- ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
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.
deleteStackRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.DeleteUsageReportSubscriptionResult deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest)
Disables usage report generation.
deleteUsageReportSubscriptionRequest
- InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException
- The specified resource was not found.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from the user pool.
deleteUserRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeAppBlockBuilderAppBlockAssociationsResult describeAppBlockBuilderAppBlockAssociations(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest)
Retrieves a list that describes one or more app block builder associations.
describeAppBlockBuilderAppBlockAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.DescribeAppBlockBuildersResult describeAppBlockBuilders(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest)
Retrieves a list that describes one or more app block builders.
describeAppBlockBuildersRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.DescribeAppBlocksResult describeAppBlocks(DescribeAppBlocksRequest describeAppBlocksRequest)
Retrieves a list that describes one or more app blocks.
describeAppBlocksRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.DescribeApplicationFleetAssociationsResult describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest)
Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
describeApplicationFleetAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Retrieves a list that describes one or more applications.
describeApplicationsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)
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.
describeDirectoryConfigsRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeEntitlementsResult describeEntitlements(DescribeEntitlementsRequest describeEntitlementsRequest)
Retrieves a list that describes one of more entitlements.
describeEntitlementsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.DescribeFleetsResult describeFleets(DescribeFleetsRequest describeFleetsRequest)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
describeFleetsRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
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.
describeImageBuildersRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeImagePermissionsResult describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
describeImagePermissionsRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)
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.
describeImagesRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException
- The specified resource was not found.DescribeSessionsResult describeSessions(DescribeSessionsRequest describeSessionsRequest)
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.
describeSessionsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
describeStacksRequest
- ResourceNotFoundException
- The specified resource was not found.DescribeUsageReportSubscriptionsResult describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest)
Retrieves a list that describes one or more usage report subscriptions.
describeUsageReportSubscriptionsRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.DescribeUserStackAssociationsResult describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)
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
describeUserStackAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.DescribeUsersResult describeUsers(DescribeUsersRequest describeUsersRequest)
Retrieves a list that describes one or more specified users in the user pool.
describeUsersRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.DisableUserResult disableUser(DisableUserRequest disableUserRequest)
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.
disableUserRequest
- ResourceNotFoundException
- The specified resource was not found.DisassociateAppBlockBuilderAppBlockResult disassociateAppBlockBuilderAppBlock(DisassociateAppBlockBuilderAppBlockRequest disassociateAppBlockBuilderAppBlockRequest)
Disassociates a specified app block builder from a specified app block.
disassociateAppBlockBuilderAppBlockRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.DisassociateApplicationFleetResult disassociateApplicationFleet(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest)
Disassociates the specified application from the fleet.
disassociateApplicationFleetRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.DisassociateApplicationFromEntitlementResult disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest)
Deletes the specified application from the specified entitlement.
disassociateApplicationFromEntitlementRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.OperationNotPermittedException
- The attempted operation is not permitted.DisassociateFleetResult disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
Disassociates the specified fleet from the specified stack.
disassociateFleetRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.OperationNotPermittedException
- The attempted operation is not permitted.EnableUserResult enableUser(EnableUserRequest enableUserRequest)
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.
enableUserRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ExpireSessionResult expireSession(ExpireSessionRequest expireSessionRequest)
Immediately stops the specified streaming session.
expireSessionRequest
- ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
Retrieves the name of the fleet that is associated with the specified stack.
listAssociatedFleetsRequest
- ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
Retrieves the name of the stack with which the specified fleet is associated.
listAssociatedStacksRequest
- ListEntitledApplicationsResult listEntitledApplications(ListEntitledApplicationsRequest listEntitledApplicationsRequest)
Retrieves a list of entitled applications.
listEntitledApplicationsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource was not found.StartAppBlockBuilderResult startAppBlockBuilder(StartAppBlockBuilderRequest startAppBlockBuilderRequest)
Starts an app block builder.
An app block builder can only be started when it's associated with an app block.
Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
startAppBlockBuilderRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.LimitExceededException
- The requested limit exceeds the permitted limit for an account.OperationNotPermittedException
- The attempted operation is not permitted.RequestLimitExceededException
- 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.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.StartFleetResult startFleet(StartFleetRequest startFleetRequest)
Starts the specified fleet.
startFleetRequest
- ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.LimitExceededException
- The requested limit exceeds the permitted limit for an account.RequestLimitExceededException
- 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.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.InvalidRoleException
- The specified role is invalid.StartImageBuilderResult startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
Starts the specified image builder.
startImageBuilderRequest
- ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.StopAppBlockBuilderResult stopAppBlockBuilder(StopAppBlockBuilderRequest stopAppBlockBuilderRequest)
Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
stopAppBlockBuilderRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.StopFleetResult stopFleet(StopFleetRequest stopFleetRequest)
Stops the specified fleet.
stopFleetRequest
- ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
Stops the specified image builder.
stopImageBuilderRequest
- ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException
- The specified resource was not found.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.UpdateAppBlockBuilderResult updateAppBlockBuilder(UpdateAppBlockBuilderRequest updateAppBlockBuilderRequest)
Updates an app block builder.
If the app block builder is in the STARTING
or STOPPING
state, you can't update it. If
the app block builder is in the RUNNING
state, you can only update the DisplayName and Description.
If the app block builder is in the STOPPED
state, you can update any attribute except the Name.
updateAppBlockBuilderRequest
- ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.InvalidRoleException
- The specified role is invalid.LimitExceededException
- The requested limit exceeds the permitted limit for an account.OperationNotPermittedException
- The attempted operation is not permitted.RequestLimitExceededException
- 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.ResourceInUseException
- The specified resource is in use.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application.
updateApplicationRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.ResourceNotFoundException
- The specified resource was not found.UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
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.
updateDirectoryConfigRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.OperationNotPermittedException
- The attempted operation is not permitted.InvalidRoleException
- The specified role is invalid.UpdateEntitlementResult updateEntitlement(UpdateEntitlementRequest updateEntitlementRequest)
Updates the specified entitlement.
updateEntitlementRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)
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.
updateFleetRequest
- ResourceInUseException
- The specified resource is in use.LimitExceededException
- The requested limit exceeds the permitted limit for an account.RequestLimitExceededException
- 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.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidRoleException
- The specified role is invalid.ResourceNotFoundException
- The specified resource was not found.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.OperationNotPermittedException
- The attempted operation is not permitted.UpdateImagePermissionsResult updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)
Adds or updates permissions for the specified private image.
updateImagePermissionsRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.LimitExceededException
- The requested limit exceeds the permitted limit for an account.UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
Updates the specified fields for the specified stack.
updateStackRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- The specified resource is in use.InvalidRoleException
- The specified role is invalid.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.LimitExceededException
- The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException
- The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException
- The image can't be updated because it's not compatible for updates.OperationNotPermittedException
- The attempted operation is not permitted.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.AmazonAppStreamWaiters waiters()