AmazonAppStreamClient (AWS Java SDK for Amazon AppStream 1.12.205 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.appstream.AmazonAppStreamClient

All Implemented Interfaces:

AmazonAppStream

Direct Known Subclasses:

AmazonAppStreamAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAppStreamClient
extends AmazonWebServiceClient
implements AmazonAppStream
```
Client for accessing Amazon AppStream. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon AppStream 2.0
This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

To learn more about AppStream 2.0, see the following resources:
- Amazon AppStream 2.0 product page
- Amazon AppStream 2.0 documentation

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.appstream.AmazonAppStream
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AmazonAppStreamClient()` Deprecated. use `AmazonAppStreamClientBuilder.defaultClient()`
`AmazonAppStreamClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonAppStreamClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonAppStreamClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateApplicationFleetResult`	`associateApplicationFleet(AssociateApplicationFleetRequest request)` Associates the specified application with the specified fleet.
`AssociateApplicationToEntitlementResult`	`associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest request)` Associates an application to entitle.
`AssociateFleetResult`	`associateFleet(AssociateFleetRequest request)` Associates the specified fleet with the specified stack.
`BatchAssociateUserStackResult`	`batchAssociateUserStack(BatchAssociateUserStackRequest request)` Associates the specified users with the specified stacks.
`BatchDisassociateUserStackResult`	`batchDisassociateUserStack(BatchDisassociateUserStackRequest request)` Disassociates the specified users from the specified stacks.
`static AmazonAppStreamClientBuilder`	`builder()`
`CopyImageResult`	`copyImage(CopyImageRequest request)` Copies the image within the same region or to a new region within the same AWS account.
`CreateAppBlockResult`	`createAppBlock(CreateAppBlockRequest request)` Creates an app block.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest request)` Creates an application.
`CreateDirectoryConfigResult`	`createDirectoryConfig(CreateDirectoryConfigRequest request)` Creates a Directory Config object in AppStream 2.0.
`CreateEntitlementResult`	`createEntitlement(CreateEntitlementRequest request)` Creates a new entitlement.
`CreateFleetResult`	`createFleet(CreateFleetRequest request)` Creates a fleet.
`CreateImageBuilderResult`	`createImageBuilder(CreateImageBuilderRequest request)` Creates an image builder.
`CreateImageBuilderStreamingURLResult`	`createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)` Creates a URL to start an image builder streaming session.
`CreateStackResult`	`createStack(CreateStackRequest request)` Creates a stack to start streaming applications to users.
`CreateStreamingURLResult`	`createStreamingURL(CreateStreamingURLRequest request)` Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
`CreateUpdatedImageResult`	`createUpdatedImage(CreateUpdatedImageRequest request)` Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
`CreateUsageReportSubscriptionResult`	`createUsageReportSubscription(CreateUsageReportSubscriptionRequest request)` Creates a usage report subscription.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a new user in the user pool.
`DeleteAppBlockResult`	`deleteAppBlock(DeleteAppBlockRequest request)` Deletes an app block.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes an application.
`DeleteDirectoryConfigResult`	`deleteDirectoryConfig(DeleteDirectoryConfigRequest request)` Deletes the specified Directory Config object from AppStream 2.0.
`DeleteEntitlementResult`	`deleteEntitlement(DeleteEntitlementRequest request)` Deletes the specified entitlement.
`DeleteFleetResult`	`deleteFleet(DeleteFleetRequest request)` Deletes the specified fleet.
`DeleteImageResult`	`deleteImage(DeleteImageRequest request)` Deletes the specified image.
`DeleteImageBuilderResult`	`deleteImageBuilder(DeleteImageBuilderRequest request)` Deletes the specified image builder and releases the capacity.
`DeleteImagePermissionsResult`	`deleteImagePermissions(DeleteImagePermissionsRequest request)` Deletes permissions for the specified private image.
`DeleteStackResult`	`deleteStack(DeleteStackRequest request)` Deletes the specified stack.
`DeleteUsageReportSubscriptionResult`	`deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest request)` Disables usage report generation.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a user from the user pool.
`DescribeAppBlocksResult`	`describeAppBlocks(DescribeAppBlocksRequest request)` Retrieves a list that describes one or more app blocks.
`DescribeApplicationFleetAssociationsResult`	`describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest request)` Retrieves a list that describes one or more application fleet associations.
`DescribeApplicationsResult`	`describeApplications(DescribeApplicationsRequest request)` Retrieves a list that describes one or more applications.
`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.
`DescribeEntitlementsResult`	`describeEntitlements(DescribeEntitlementsRequest request)` Retrieves a list that describes one of more entitlements.
`DescribeFleetsResult`	`describeFleets(DescribeFleetsRequest request)` Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
`DescribeImageBuildersResult`	`describeImageBuilders(DescribeImageBuildersRequest request)` Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
`DescribeImagePermissionsResult`	`describeImagePermissions(DescribeImagePermissionsRequest request)` Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest request)` Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
`DescribeSessionsResult`	`describeSessions(DescribeSessionsRequest request)` Retrieves a list that describes the streaming sessions for a specified stack and fleet.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest request)` Retrieves a list that describes one or more specified stacks, if the stack names are provided.
`DescribeUsageReportSubscriptionsResult`	`describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest request)` Retrieves a list that describes one or more usage report subscriptions.
`DescribeUsersResult`	`describeUsers(DescribeUsersRequest request)` Retrieves a list that describes one or more specified users in the user pool.
`DescribeUserStackAssociationsResult`	`describeUserStackAssociations(DescribeUserStackAssociationsRequest request)` Retrieves a list that describes the UserStackAssociation objects.
`DisableUserResult`	`disableUser(DisableUserRequest request)` Disables the specified user in the user pool.
`DisassociateApplicationFleetResult`	`disassociateApplicationFleet(DisassociateApplicationFleetRequest request)` Disassociates the specified application from the fleet.
`DisassociateApplicationFromEntitlementResult`	`disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest request)` Deletes the specified application from the specified entitlement.
`DisassociateFleetResult`	`disassociateFleet(DisassociateFleetRequest request)` Disassociates the specified fleet from the specified stack.
`EnableUserResult`	`enableUser(EnableUserRequest request)` Enables a user in the user pool.
`ExpireSessionResult`	`expireSession(ExpireSessionRequest request)` 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 request)` Retrieves the name of the fleet that is associated with the specified stack.
`ListAssociatedStacksResult`	`listAssociatedStacks(ListAssociatedStacksRequest request)` Retrieves the name of the stack with which the specified fleet is associated.
`ListEntitledApplicationsResult`	`listEntitledApplications(ListEntitledApplicationsRequest request)` Retrieves a list of entitled applications.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Retrieves a list of all tags for the specified AppStream 2.0 resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartFleetResult`	`startFleet(StartFleetRequest request)` Starts the specified fleet.
`StartImageBuilderResult`	`startImageBuilder(StartImageBuilderRequest request)` Starts the specified image builder.
`StopFleetResult`	`stopFleet(StopFleetRequest request)` Stops the specified fleet.
`StopImageBuilderResult`	`stopImageBuilder(StopImageBuilderRequest request)` Stops the specified image builder.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Disassociates one or more specified tags from the specified AppStream 2.0 resource.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates the specified application.
`UpdateDirectoryConfigResult`	`updateDirectoryConfig(UpdateDirectoryConfigRequest request)` Updates the specified Directory Config object in AppStream 2.0.
`UpdateEntitlementResult`	`updateEntitlement(UpdateEntitlementRequest request)` Updates the specified entitlement.
`UpdateFleetResult`	`updateFleet(UpdateFleetRequest request)` Updates the specified fleet.
`UpdateImagePermissionsResult`	`updateImagePermissions(UpdateImagePermissionsRequest request)` Adds or updates permissions for the specified private image.
`UpdateStackResult`	`updateStack(UpdateStackRequest request)` Updates the specified fields for the specified stack.
`AmazonAppStreamWaiters`	`waiters()`

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.appstream.AmazonAppStream
setEndpoint, setRegion

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient()
```
    Deprecated. use AmazonAppStreamClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Amazon AppStream. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Amazon AppStream. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(AWSCredentials awsCredentials,
                                         ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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.).
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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.).
  - AmazonAppStreamClient
```
@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration,
                                         RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    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 collector
- Method Detail
  - builder
```
public static AmazonAppStreamClientBuilder builder()
```
  - associateApplicationFleet
```
public AssociateApplicationFleetResult associateApplicationFleet(AssociateApplicationFleetRequest request)
```
    Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
    
    Specified by:
    
    associateApplicationFleet in interface AmazonAppStream
    
    Parameters:
    
    associateApplicationFleetRequest -
    
    Returns:
    
    Result of the AssociateApplicationFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - associateApplicationToEntitlement
```
public AssociateApplicationToEntitlementResult associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest request)
```
    Associates an application to entitle.
    
    Specified by:
    
    associateApplicationToEntitlement in interface AmazonAppStream
    
    Parameters:
    
    associateApplicationToEntitlementRequest -
    
    Returns:
    
    Result of the AssociateApplicationToEntitlement operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - associateFleet
```
public AssociateFleetResult associateFleet(AssociateFleetRequest request)
```
    Associates the specified fleet with the specified stack.
    
    Specified by:
    
    associateFleet in interface AmazonAppStream
    
    Parameters:
    
    associateFleetRequest -
    
    Returns:
    
    Result of the AssociateFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - batchAssociateUserStack
```
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.
    
    Specified by:
    
    batchAssociateUserStack in interface AmazonAppStream
    
    Parameters:
    
    batchAssociateUserStackRequest -
    
    Returns:
    
    Result of the BatchAssociateUserStack operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateUserStack
```
public BatchDisassociateUserStackResult batchDisassociateUserStack(BatchDisassociateUserStackRequest request)
```
    Disassociates the specified users from the specified stacks.
    
    Specified by:
    
    batchDisassociateUserStack in interface AmazonAppStream
    
    Parameters:
    
    batchDisassociateUserStackRequest -
    
    Returns:
    
    Result of the BatchDisassociateUserStack operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - copyImage
```
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.
    
    Specified by:
    
    copyImage in interface AmazonAppStream
    
    Parameters:
    
    copyImageRequest -
    
    Returns:
    
    Result of the CopyImage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAppBlock
```
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.
    
    Specified by:
    
    createAppBlock in interface AmazonAppStream
    
    Parameters:
    
    createAppBlockRequest -
    
    Returns:
    
    Result of the CreateAppBlock operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
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.
    
    Specified by:
    
    createApplication in interface AmazonAppStream
    
    Parameters:
    
    createApplicationRequest -
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDirectoryConfig
```
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.
    
    Specified by:
    
    createDirectoryConfig in interface AmazonAppStream
    
    Parameters:
    
    createDirectoryConfigRequest -
    
    Returns:
    
    Result of the CreateDirectoryConfig operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createEntitlement
```
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.
    
    Specified by:
    
    createEntitlement in interface AmazonAppStream
    
    Parameters:
    
    createEntitlementRequest -
    
    Returns:
    
    Result of the CreateEntitlement operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createFleet
```
public CreateFleetResult createFleet(CreateFleetRequest request)
```
    Creates a fleet. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.
    
    Specified by:
    
    createFleet in interface AmazonAppStream
    
    Parameters:
    
    createFleetRequest -
    
    Returns:
    
    Result of the CreateFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilder
```
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.
    
    Specified by:
    
    createImageBuilder in interface AmazonAppStream
    
    Parameters:
    
    createImageBuilderRequest -
    
    Returns:
    
    Result of the CreateImageBuilder operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilderStreamingURL
```
public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
```
    Creates a URL to start an image builder streaming session.
    
    Specified by:
    
    createImageBuilderStreamingURL in interface AmazonAppStream
    
    Parameters:
    
    createImageBuilderStreamingURLRequest -
    
    Returns:
    
    Result of the CreateImageBuilderStreamingURL operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
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.
    
    Specified by:
    
    createStack in interface AmazonAppStream
    
    Parameters:
    
    createStackRequest -
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createStreamingURL
```
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.
    
    Specified by:
    
    createStreamingURL in interface AmazonAppStream
    
    Parameters:
    
    createStreamingURLRequest -
    
    Returns:
    
    Result of the CreateStreamingURL operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUpdatedImage
```
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.
    
    Specified by:
    
    createUpdatedImage in interface AmazonAppStream
    
    Parameters:
    
    createUpdatedImageRequest -
    
    Returns:
    
    Result of the CreateUpdatedImage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUsageReportSubscription
```
public CreateUsageReportSubscriptionResult createUsageReportSubscription(CreateUsageReportSubscriptionRequest request)
```
    Creates a usage report subscription. Usage reports are generated daily.
    
    Specified by:
    
    createUsageReportSubscription in interface AmazonAppStream
    
    Parameters:
    
    createUsageReportSubscriptionRequest -
    
    Returns:
    
    Result of the CreateUsageReportSubscription operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Creates a new user in the user pool.
    
    Specified by:
    
    createUser in interface AmazonAppStream
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAppBlock
```
public DeleteAppBlockResult deleteAppBlock(DeleteAppBlockRequest request)
```
    Deletes an app block.
    
    Specified by:
    
    deleteAppBlock in interface AmazonAppStream
    
    Parameters:
    
    deleteAppBlockRequest -
    
    Returns:
    
    Result of the DeleteAppBlock operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Deletes an application.
    
    Specified by:
    
    deleteApplication in interface AmazonAppStream
    
    Parameters:
    
    deleteApplicationRequest -
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectoryConfig
```
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.
    
    Specified by:
    
    deleteDirectoryConfig in interface AmazonAppStream
    
    Parameters:
    
    deleteDirectoryConfigRequest -
    
    Returns:
    
    Result of the DeleteDirectoryConfig operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteEntitlement
```
public DeleteEntitlementResult deleteEntitlement(DeleteEntitlementRequest request)
```
    Deletes the specified entitlement.
    
    Specified by:
    
    deleteEntitlement in interface AmazonAppStream
    
    Parameters:
    
    deleteEntitlementRequest -
    
    Returns:
    
    Result of the DeleteEntitlement operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteFleet
```
public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
```
    Deletes the specified fleet.
    
    Specified by:
    
    deleteFleet in interface AmazonAppStream
    
    Parameters:
    
    deleteFleetRequest -
    
    Returns:
    
    Result of the DeleteFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteImage
```
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.
    
    Specified by:
    
    deleteImage in interface AmazonAppStream
    
    Parameters:
    
    deleteImageRequest -
    
    Returns:
    
    Result of the DeleteImage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteImageBuilder
```
public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)
```
    Deletes the specified image builder and releases the capacity.
    
    Specified by:
    
    deleteImageBuilder in interface AmazonAppStream
    
    Parameters:
    
    deleteImageBuilderRequest -
    
    Returns:
    
    Result of the DeleteImageBuilder operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteImagePermissions
```
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.
    
    Specified by:
    
    deleteImagePermissions in interface AmazonAppStream
    
    Parameters:
    
    deleteImagePermissionsRequest -
    
    Returns:
    
    Result of the DeleteImagePermissions operation returned by the service.
    
    Throws:
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
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.
    
    Specified by:
    
    deleteStack in interface AmazonAppStream
    
    Parameters:
    
    deleteStackRequest -
    
    Returns:
    
    Result of the DeleteStack operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteUsageReportSubscription
```
public DeleteUsageReportSubscriptionResult deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest request)
```
    Disables usage report generation.
    
    Specified by:
    
    deleteUsageReportSubscription in interface AmazonAppStream
    
    Parameters:
    
    deleteUsageReportSubscriptionRequest -
    
    Returns:
    
    Result of the DeleteUsageReportSubscription operation returned by the service.
    
    Throws:
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Deletes a user from the user pool.
    
    Specified by:
    
    deleteUser in interface AmazonAppStream
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeAppBlocks
```
public DescribeAppBlocksResult describeAppBlocks(DescribeAppBlocksRequest request)
```
    Retrieves a list that describes one or more app blocks.
    
    Specified by:
    
    describeAppBlocks in interface AmazonAppStream
    
    Parameters:
    
    describeAppBlocksRequest -
    
    Returns:
    
    Result of the DescribeAppBlocks operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeApplicationFleetAssociations
```
public DescribeApplicationFleetAssociationsResult describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest request)
```
    Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
    
    Specified by:
    
    describeApplicationFleetAssociations in interface AmazonAppStream
    
    Parameters:
    
    describeApplicationFleetAssociationsRequest -
    
    Returns:
    
    Result of the DescribeApplicationFleetAssociations operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - describeApplications
```
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
```
    Retrieves a list that describes one or more applications.
    
    Specified by:
    
    describeApplications in interface AmazonAppStream
    
    Parameters:
    
    describeApplicationsRequest -
    
    Returns:
    
    Result of the DescribeApplications operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeDirectoryConfigs
```
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.
    
    Specified by:
    
    describeDirectoryConfigs in interface AmazonAppStream
    
    Parameters:
    
    describeDirectoryConfigsRequest -
    
    Returns:
    
    Result of the DescribeDirectoryConfigs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeEntitlements
```
public DescribeEntitlementsResult describeEntitlements(DescribeEntitlementsRequest request)
```
    Retrieves a list that describes one of more entitlements.
    
    Specified by:
    
    describeEntitlements in interface AmazonAppStream
    
    Parameters:
    
    describeEntitlementsRequest -
    
    Returns:
    
    Result of the DescribeEntitlements operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    EntitlementNotFoundException - The entitlement can't be found.
    
    See Also:
    
    AWS API Documentation
  - describeFleets
```
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.
    
    Specified by:
    
    describeFleets in interface AmazonAppStream
    
    Parameters:
    
    describeFleetsRequest -
    
    Returns:
    
    Result of the DescribeFleets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImageBuilders
```
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.
    
    Specified by:
    
    describeImageBuilders in interface AmazonAppStream
    
    Parameters:
    
    describeImageBuildersRequest -
    
    Returns:
    
    Result of the DescribeImageBuilders operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImagePermissions
```
public DescribeImagePermissionsResult describeImagePermissions(DescribeImagePermissionsRequest request)
```
    Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
    
    Specified by:
    
    describeImagePermissions in interface AmazonAppStream
    
    Parameters:
    
    describeImagePermissionsRequest -
    
    Returns:
    
    Result of the DescribeImagePermissions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImages
```
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.
    
    Specified by:
    
    describeImages in interface AmazonAppStream
    
    Parameters:
    
    describeImagesRequest -
    
    Returns:
    
    Result of the DescribeImages operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeSessions
```
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.
    
    Specified by:
    
    describeSessions in interface AmazonAppStream
    
    Parameters:
    
    describeSessionsRequest -
    
    Returns:
    
    Result of the DescribeSessions operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
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.
    
    Specified by:
    
    describeStacks in interface AmazonAppStream
    
    Parameters:
    
    describeStacksRequest -
    
    Returns:
    
    Result of the DescribeStacks operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeUsageReportSubscriptions
```
public DescribeUsageReportSubscriptionsResult describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest request)
```
    Retrieves a list that describes one or more usage report subscriptions.
    
    Specified by:
    
    describeUsageReportSubscriptions in interface AmazonAppStream
    
    Parameters:
    
    describeUsageReportSubscriptionsRequest -
    
    Returns:
    
    Result of the DescribeUsageReportSubscriptions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    See Also:
    
    AWS API Documentation
  - describeUserStackAssociations
```
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
    Specified by:
    
    describeUserStackAssociations in interface AmazonAppStream
    
    Parameters:
    
    describeUserStackAssociationsRequest -
    
    Returns:
    
    Result of the DescribeUserStackAssociations operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
```
    Retrieves a list that describes one or more specified users in the user pool.
    
    Specified by:
    
    describeUsers in interface AmazonAppStream
    
    Parameters:
    
    describeUsersRequest -
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disableUser
```
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.
    
    Specified by:
    
    disableUser in interface AmazonAppStream
    
    Parameters:
    
    disableUserRequest -
    
    Returns:
    
    Result of the DisableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - disassociateApplicationFleet
```
public DisassociateApplicationFleetResult disassociateApplicationFleet(DisassociateApplicationFleetRequest request)
```
    Disassociates the specified application from the fleet.
    
    Specified by:
    
    disassociateApplicationFleet in interface AmazonAppStream
    
    Parameters:
    
    disassociateApplicationFleetRequest -
    
    Returns:
    
    Result of the DisassociateApplicationFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disassociateApplicationFromEntitlement
```
public DisassociateApplicationFromEntitlementResult disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest request)
```
    Deletes the specified application from the specified entitlement.
    
    Specified by:
    
    disassociateApplicationFromEntitlement in interface AmazonAppStream
    
    Parameters:
    
    disassociateApplicationFromEntitlementRequest -
    
    Returns:
    
    Result of the DisassociateApplicationFromEntitlement operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disassociateFleet
```
public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)
```
    Disassociates the specified fleet from the specified stack.
    
    Specified by:
    
    disassociateFleet in interface AmazonAppStream
    
    Parameters:
    
    disassociateFleetRequest -
    
    Returns:
    
    Result of the DisassociateFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - enableUser
```
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.
    
    Specified by:
    
    enableUser in interface AmazonAppStream
    
    Parameters:
    
    enableUserRequest -
    
    Returns:
    
    Result of the EnableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    See Also:
    
    AWS API Documentation
  - expireSession
```
public ExpireSessionResult expireSession(ExpireSessionRequest request)
```
    Immediately stops the specified streaming session.
    
    Specified by:
    
    expireSession in interface AmazonAppStream
    
    Parameters:
    
    expireSessionRequest -
    
    Returns:
    
    Result of the ExpireSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedFleets
```
public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)
```
    Retrieves the name of the fleet that is associated with the specified stack.
    
    Specified by:
    
    listAssociatedFleets in interface AmazonAppStream
    
    Parameters:
    
    listAssociatedFleetsRequest -
    
    Returns:
    
    Result of the ListAssociatedFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedStacks
```
public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)
```
    Retrieves the name of the stack with which the specified fleet is associated.
    
    Specified by:
    
    listAssociatedStacks in interface AmazonAppStream
    
    Parameters:
    
    listAssociatedStacksRequest -
    
    Returns:
    
    Result of the ListAssociatedStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEntitledApplications
```
public ListEntitledApplicationsResult listEntitledApplications(ListEntitledApplicationsRequest request)
```
    Retrieves a list of entitled applications.
    
    Specified by:
    
    listEntitledApplications in interface AmazonAppStream
    
    Parameters:
    
    listEntitledApplicationsRequest -
    
    Returns:
    
    Result of the ListEntitledApplications operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    EntitlementNotFoundException - The entitlement can't be found.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
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.
    
    Specified by:
    
    listTagsForResource in interface AmazonAppStream
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - startFleet
```
public StartFleetResult startFleet(StartFleetRequest request)
```
    Starts the specified fleet.
    
    Specified by:
    
    startFleet in interface AmazonAppStream
    
    Parameters:
    
    startFleetRequest -
    
    Returns:
    
    Result of the StartFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startImageBuilder
```
public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)
```
    Starts the specified image builder.
    
    Specified by:
    
    startImageBuilder in interface AmazonAppStream
    
    Parameters:
    
    startImageBuilderRequest -
    
    Returns:
    
    Result of the StartImageBuilder operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopFleet
```
public StopFleetResult stopFleet(StopFleetRequest request)
```
    Stops the specified fleet.
    
    Specified by:
    
    stopFleet in interface AmazonAppStream
    
    Parameters:
    
    stopFleetRequest -
    
    Returns:
    
    Result of the StopFleet operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - stopImageBuilder
```
public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)
```
    Stops the specified image builder.
    
    Specified by:
    
    stopImageBuilder in interface AmazonAppStream
    
    Parameters:
    
    stopImageBuilderRequest -
    
    Returns:
    
    Result of the StopImageBuilder operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
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.
    
    Specified by:
    
    tagResource in interface AmazonAppStream
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
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.
    
    Specified by:
    
    untagResource in interface AmazonAppStream
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Updates the specified application.
    
    Specified by:
    
    updateApplication in interface AmazonAppStream
    
    Parameters:
    
    updateApplicationRequest -
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateDirectoryConfig
```
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.
    
    Specified by:
    
    updateDirectoryConfig in interface AmazonAppStream
    
    Parameters:
    
    updateDirectoryConfigRequest -
    
    Returns:
    
    Result of the UpdateDirectoryConfig operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEntitlement
```
public UpdateEntitlementResult updateEntitlement(UpdateEntitlementRequest request)
```
    Updates the specified entitlement.
    
    Specified by:
    
    updateEntitlement in interface AmazonAppStream
    
    Parameters:
    
    updateEntitlementRequest -
    
    Returns:
    
    Result of the UpdateEntitlement operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateFleet
```
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, and UsbDeviceFilterStrings attributes.
    If the fleet is in the STARTING or STOPPED state, you can't update it.
    Specified by:
    
    updateFleet in interface AmazonAppStream
    
    Parameters:
    
    updateFleetRequest -
    
    Returns:
    
    Result of the UpdateFleet operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateImagePermissions
```
public UpdateImagePermissionsResult updateImagePermissions(UpdateImagePermissionsRequest request)
```
    Adds or updates permissions for the specified private image.
    
    Specified by:
    
    updateImagePermissions in interface AmazonAppStream
    
    Parameters:
    
    updateImagePermissionsRequest -
    
    Returns:
    
    Result of the UpdateImagePermissions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
public UpdateStackResult updateStack(UpdateStackRequest request)
```
    Updates the specified fields for the specified stack.
    
    Specified by:
    
    updateStack in interface AmazonAppStream
    
    Parameters:
    
    updateStackRequest -
    
    Returns:
    
    Result of the UpdateStack operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonAppStream
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonAppStreamWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonAppStream
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonAppStream
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonAppStream
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonAppStreamClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.appstream.AmazonAppStream

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.appstream.AmazonAppStream

Field Detail

configFactory

Constructor Detail

AmazonAppStreamClient

AmazonAppStreamClient

AmazonAppStreamClient

AmazonAppStreamClient

AmazonAppStreamClient

AmazonAppStreamClient

AmazonAppStreamClient

Method Detail

builder

associateApplicationFleet

associateApplicationToEntitlement

associateFleet

batchAssociateUserStack

batchDisassociateUserStack

copyImage

createAppBlock

createApplication

createDirectoryConfig

createEntitlement

createFleet

createImageBuilder

createImageBuilderStreamingURL

createStack

createStreamingURL

createUpdatedImage

createUsageReportSubscription

createUser

deleteAppBlock

deleteApplication

deleteDirectoryConfig

deleteEntitlement

deleteFleet

deleteImage

deleteImageBuilder

deleteImagePermissions

deleteStack

deleteUsageReportSubscription

deleteUser

describeAppBlocks

describeApplicationFleetAssociations

describeApplications

describeDirectoryConfigs

describeEntitlements

describeFleets

describeImageBuilders

describeImagePermissions

describeImages

describeSessions

describeStacks

describeUsageReportSubscriptions

describeUserStackAssociations

describeUsers

disableUser

disassociateApplicationFleet

disassociateApplicationFromEntitlement

disassociateFleet

enableUser

expireSession

listAssociatedFleets

listAssociatedStacks

listEntitledApplications

listTagsForResource

startFleet

startImageBuilder

stopFleet

stopImageBuilder

tagResource

untagResource