@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAppStreamClient extends AmazonWebServiceClient implements AmazonAppStream
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:
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonAppStreamClient()
Deprecated.
|
AmazonAppStreamClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonAppStreamClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonAppStreamClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonAppStreamClient()
AmazonAppStreamClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonAppStreamClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonAppStreamClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonAppStreamClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonAppStreamClientBuilder builder()
public AssociateAppBlockBuilderAppBlockResult associateAppBlockBuilderAppBlock(AssociateAppBlockBuilderAppBlockRequest request)
Associates the specified app block builder with the specified app block.
associateAppBlockBuilderAppBlock
in interface AmazonAppStream
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.public AssociateApplicationFleetResult associateApplicationFleet(AssociateApplicationFleetRequest request)
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
associateApplicationFleet
in interface AmazonAppStream
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.public AssociateApplicationToEntitlementResult associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest request)
Associates an application to entitle.
associateApplicationToEntitlement
in interface AmazonAppStream
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.public AssociateFleetResult associateFleet(AssociateFleetRequest request)
Associates the specified fleet with the specified stack.
associateFleet
in interface AmazonAppStream
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.public BatchAssociateUserStackResult batchAssociateUserStack(BatchAssociateUserStackRequest request)
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.
batchAssociateUserStack
in interface AmazonAppStream
batchAssociateUserStackRequest
- OperationNotPermittedException
- The attempted operation is not permitted.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.public BatchDisassociateUserStackResult batchDisassociateUserStack(BatchDisassociateUserStackRequest request)
Disassociates the specified users from the specified stacks.
batchDisassociateUserStack
in interface AmazonAppStream
batchDisassociateUserStackRequest
- OperationNotPermittedException
- The attempted operation is not permitted.InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.public CopyImageResult copyImage(CopyImageRequest request)
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.
copyImage
in interface AmazonAppStream
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.public CreateAppBlockResult createAppBlock(CreateAppBlockRequest request)
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.
createAppBlock
in interface AmazonAppStream
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.public CreateAppBlockBuilderResult createAppBlockBuilder(CreateAppBlockBuilderRequest request)
Creates an app block builder.
createAppBlockBuilder
in interface AmazonAppStream
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.public CreateAppBlockBuilderStreamingURLResult createAppBlockBuilderStreamingURL(CreateAppBlockBuilderStreamingURLRequest request)
Creates a URL to start a create app block builder streaming session.
createAppBlockBuilderStreamingURL
in interface AmazonAppStream
createAppBlockBuilderStreamingURLRequest
- ResourceNotFoundException
- The specified resource was not found.OperationNotPermittedException
- The attempted operation is not permitted.public CreateApplicationResult createApplication(CreateApplicationRequest request)
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.
createApplication
in interface AmazonAppStream
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.public CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest request)
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.
createDirectoryConfig
in interface AmazonAppStream
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.public CreateEntitlementResult createEntitlement(CreateEntitlementRequest request)
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.
createEntitlement
in interface AmazonAppStream
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.public CreateFleetResult createFleet(CreateFleetRequest request)
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
createFleet
in interface AmazonAppStream
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.public CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest request)
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
.
createImageBuilder
in interface AmazonAppStream
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.public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
Creates a URL to start an image builder streaming session.
createImageBuilderStreamingURL
in interface AmazonAppStream
createImageBuilderStreamingURLRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.public CreateStackResult createStack(CreateStackRequest request)
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
createStack
in interface AmazonAppStream
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.public CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest request)
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.
createStreamingURL
in interface AmazonAppStream
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.public CreateUpdatedImageResult createUpdatedImage(CreateUpdatedImageRequest request)
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.
createUpdatedImage
in interface AmazonAppStream
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.public CreateUsageReportSubscriptionResult createUsageReportSubscription(CreateUsageReportSubscriptionRequest request)
Creates a usage report subscription. Usage reports are generated daily.
createUsageReportSubscription
in interface AmazonAppStream
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.public CreateUserResult createUser(CreateUserRequest request)
Creates a new user in the user pool.
createUser
in interface AmazonAppStream
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.public DeleteAppBlockResult deleteAppBlock(DeleteAppBlockRequest request)
Deletes an app block.
deleteAppBlock
in interface AmazonAppStream
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.public DeleteAppBlockBuilderResult deleteAppBlockBuilder(DeleteAppBlockBuilderRequest request)
Deletes an app block builder.
An app block builder can only be deleted when it has no association with an app block.
deleteAppBlockBuilder
in interface AmazonAppStream
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.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Deletes an application.
deleteApplication
in interface AmazonAppStream
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.public DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest request)
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.
deleteDirectoryConfig
in interface AmazonAppStream
deleteDirectoryConfigRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.public DeleteEntitlementResult deleteEntitlement(DeleteEntitlementRequest request)
Deletes the specified entitlement.
deleteEntitlement
in interface AmazonAppStream
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.public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
Deletes the specified fleet.
deleteFleet
in interface AmazonAppStream
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.public DeleteImageResult deleteImage(DeleteImageRequest request)
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.
deleteImage
in interface AmazonAppStream
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.public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)
Deletes the specified image builder and releases the capacity.
deleteImageBuilder
in interface AmazonAppStream
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.public DeleteImagePermissionsResult deleteImagePermissions(DeleteImagePermissionsRequest request)
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.
deleteImagePermissions
in interface AmazonAppStream
deleteImagePermissionsRequest
- ResourceNotAvailableException
- The specified resource exists and is not in use, but isn't available.ResourceNotFoundException
- The specified resource was not found.public DeleteStackResult deleteStack(DeleteStackRequest request)
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.
deleteStack
in interface AmazonAppStream
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.public DeleteUsageReportSubscriptionResult deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest request)
Disables usage report generation.
deleteUsageReportSubscription
in interface AmazonAppStream
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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user from the user pool.
deleteUser
in interface AmazonAppStream
deleteUserRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeAppBlockBuilderAppBlockAssociationsResult describeAppBlockBuilderAppBlockAssociations(DescribeAppBlockBuilderAppBlockAssociationsRequest request)
Retrieves a list that describes one or more app block builder associations.
describeAppBlockBuilderAppBlockAssociations
in interface AmazonAppStream
describeAppBlockBuilderAppBlockAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.public DescribeAppBlockBuildersResult describeAppBlockBuilders(DescribeAppBlockBuildersRequest request)
Retrieves a list that describes one or more app block builders.
describeAppBlockBuilders
in interface AmazonAppStream
describeAppBlockBuildersRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.public DescribeAppBlocksResult describeAppBlocks(DescribeAppBlocksRequest request)
Retrieves a list that describes one or more app blocks.
describeAppBlocks
in interface AmazonAppStream
describeAppBlocksRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.public DescribeApplicationFleetAssociationsResult describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest request)
Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
describeApplicationFleetAssociations
in interface AmazonAppStream
describeApplicationFleetAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
Retrieves a list that describes one or more applications.
describeApplications
in interface AmazonAppStream
describeApplicationsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.public DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)
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.
describeDirectoryConfigs
in interface AmazonAppStream
describeDirectoryConfigsRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeEntitlementsResult describeEntitlements(DescribeEntitlementsRequest request)
Retrieves a list that describes one of more entitlements.
describeEntitlements
in interface AmazonAppStream
describeEntitlementsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
describeFleets
in interface AmazonAppStream
describeFleetsRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest request)
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.
describeImageBuilders
in interface AmazonAppStream
describeImageBuildersRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeImagePermissionsResult describeImagePermissions(DescribeImagePermissionsRequest request)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
describeImagePermissions
in interface AmazonAppStream
describeImagePermissionsRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeImagesResult describeImages(DescribeImagesRequest request)
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.
describeImages
in interface AmazonAppStream
describeImagesRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException
- The specified resource was not found.public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
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.
describeSessions
in interface AmazonAppStream
describeSessionsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.public DescribeStacksResult describeStacks(DescribeStacksRequest request)
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
describeStacks
in interface AmazonAppStream
describeStacksRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeUsageReportSubscriptionsResult describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest request)
Retrieves a list that describes one or more usage report subscriptions.
describeUsageReportSubscriptions
in interface AmazonAppStream
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.public DescribeUserStackAssociationsResult describeUserStackAssociations(DescribeUserStackAssociationsRequest request)
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
describeUserStackAssociations
in interface AmazonAppStream
describeUserStackAssociationsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException
- The attempted operation is not permitted.public DescribeUsersResult describeUsers(DescribeUsersRequest request)
Retrieves a list that describes one or more specified users in the user pool.
describeUsers
in interface AmazonAppStream
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.public DisableUserResult disableUser(DisableUserRequest request)
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.
disableUser
in interface AmazonAppStream
disableUserRequest
- ResourceNotFoundException
- The specified resource was not found.public DisassociateAppBlockBuilderAppBlockResult disassociateAppBlockBuilderAppBlock(DisassociateAppBlockBuilderAppBlockRequest request)
Disassociates a specified app block builder from a specified app block.
disassociateAppBlockBuilderAppBlock
in interface AmazonAppStream
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.public DisassociateApplicationFleetResult disassociateApplicationFleet(DisassociateApplicationFleetRequest request)
Disassociates the specified application from the fleet.
disassociateApplicationFleet
in interface AmazonAppStream
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.public DisassociateApplicationFromEntitlementResult disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest request)
Deletes the specified application from the specified entitlement.
disassociateApplicationFromEntitlement
in interface AmazonAppStream
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.public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)
Disassociates the specified fleet from the specified stack.
disassociateFleet
in interface AmazonAppStream
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.public EnableUserResult enableUser(EnableUserRequest request)
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.
enableUser
in interface AmazonAppStream
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.public ExpireSessionResult expireSession(ExpireSessionRequest request)
Immediately stops the specified streaming session.
expireSession
in interface AmazonAppStream
expireSessionRequest
- public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)
Retrieves the name of the fleet that is associated with the specified stack.
listAssociatedFleets
in interface AmazonAppStream
listAssociatedFleetsRequest
- public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)
Retrieves the name of the stack with which the specified fleet is associated.
listAssociatedStacks
in interface AmazonAppStream
listAssociatedStacksRequest
- public ListEntitledApplicationsResult listEntitledApplications(ListEntitledApplicationsRequest request)
Retrieves a list of entitled applications.
listEntitledApplications
in interface AmazonAppStream
listEntitledApplicationsRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.EntitlementNotFoundException
- The entitlement can't be found.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AmazonAppStream
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource was not found.public StartAppBlockBuilderResult startAppBlockBuilder(StartAppBlockBuilderRequest request)
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.
startAppBlockBuilder
in interface AmazonAppStream
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.public StartFleetResult startFleet(StartFleetRequest request)
Starts the specified fleet.
startFleet
in interface AmazonAppStream
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.public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)
Starts the specified image builder.
startImageBuilder
in interface AmazonAppStream
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.public StopAppBlockBuilderResult stopAppBlockBuilder(StopAppBlockBuilderRequest request)
Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
stopAppBlockBuilder
in interface AmazonAppStream
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.public StopFleetResult stopFleet(StopFleetRequest request)
Stops the specified fleet.
stopFleet
in interface AmazonAppStream
stopFleetRequest
- ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)
Stops the specified image builder.
stopImageBuilder
in interface AmazonAppStream
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.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonAppStream
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.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource
in interface AmazonAppStream
untagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.public UpdateAppBlockBuilderResult updateAppBlockBuilder(UpdateAppBlockBuilderRequest request)
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.
updateAppBlockBuilder
in interface AmazonAppStream
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.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates the specified application.
updateApplication
in interface AmazonAppStream
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.public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)
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.
updateDirectoryConfig
in interface AmazonAppStream
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.public UpdateEntitlementResult updateEntitlement(UpdateEntitlementRequest request)
Updates the specified entitlement.
updateEntitlement
in interface AmazonAppStream
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.public UpdateFleetResult updateFleet(UpdateFleetRequest request)
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.
updateFleet
in interface AmazonAppStream
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.public UpdateImagePermissionsResult updateImagePermissions(UpdateImagePermissionsRequest request)
Adds or updates permissions for the specified private image.
updateImagePermissions
in interface AmazonAppStream
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.public UpdateStackResult updateStack(UpdateStackRequest request)
Updates the specified fields for the specified stack.
updateStack
in interface AmazonAppStream
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonAppStream
request
- The originally executed requestpublic AmazonAppStreamWaiters waiters()
waiters
in interface AmazonAppStream
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonAppStream
shutdown
in class AmazonWebServiceClient