AmazonAppStream (AWS SDK for Java

All Known Subinterfaces:

AmazonAppStreamAsync

All Known Implementing Classes:

AbstractAmazonAppStream, AbstractAmazonAppStreamAsync, AmazonAppStreamAsyncClient, AmazonAppStreamClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppStream
```
Interface for accessing Amazon AppStream.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAppStream instead.

Amazon AppStream 2.0
API documentation for Amazon AppStream 2.0.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AssociateFleetResult`	`associateFleet(AssociateFleetRequest associateFleetRequest)` Associate a fleet to a stack.
`CreateDirectoryConfigResult`	`createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)` Creates a directory configuration with the given parameters.
`CreateFleetResult`	`createFleet(CreateFleetRequest createFleetRequest)` Creates a new fleet.
`CreateStackResult`	`createStack(CreateStackRequest createStackRequest)` Create a new stack.
`CreateStreamingURLResult`	`createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)` Creates a URL to start an AppStream 2.0 streaming session for a user.
`DeleteDirectoryConfigResult`	`deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)` Deletes the directory configuration with the given parameters.
`DeleteFleetResult`	`deleteFleet(DeleteFleetRequest deleteFleetRequest)` Deletes a fleet.
`DeleteStackResult`	`deleteStack(DeleteStackRequest deleteStackRequest)` Deletes the stack.
`DescribeDirectoryConfigsResult`	`describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)` Returns a list describing the specified directory configurations.
`DescribeFleetsResult`	`describeFleets(DescribeFleetsRequest describeFleetsRequest)` If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest describeImagesRequest)` Describes the images.
`DescribeSessionsResult`	`describeSessions(DescribeSessionsRequest describeSessionsRequest)` Describes the streaming sessions for a stack and a fleet.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest describeStacksRequest)` If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described.
`DisassociateFleetResult`	`disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)` Disassociates a fleet from a stack.
`ExpireSessionResult`	`expireSession(ExpireSessionRequest expireSessionRequest)` This operation immediately stops a streaming session.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAssociatedFleetsResult`	`listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)` Lists all fleets associated with the stack.
`ListAssociatedStacksResult`	`listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)` Lists all stacks to which the specified fleet is associated.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartFleetResult`	`startFleet(StartFleetRequest startFleetRequest)` Starts a fleet.
`StopFleetResult`	`stopFleet(StopFleetRequest stopFleetRequest)` Stops a fleet.
`UpdateDirectoryConfigResult`	`updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)` Updates the directory configuration with the given parameters.
`UpdateFleetResult`	`updateFleet(UpdateFleetRequest updateFleetRequest)` Updates an existing fleet.
`UpdateStackResult`	`updateStack(UpdateStackRequest updateStackRequest)` Updates the specified fields in the stack with the specified name.
`AmazonAppStreamWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("appstream2.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - associateFleet
```
AssociateFleetResult associateFleet(AssociateFleetRequest associateFleetRequest)
```
    Associate a fleet to a stack.
    
    Parameters:
    
    associateFleetRequest -
    
    Returns:
    
    Result of the AssociateFleet operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - createDirectoryConfig
```
CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
```
    Creates a directory configuration with the given parameters.
    
    Parameters:
    
    createDirectoryConfigRequest -
    
    Returns:
    
    Result of the CreateDirectoryConfig operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    See Also:
    
    AWS API Documentation
  - createFleet
```
CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
```
    Creates a new fleet.
    
    Parameters:
    
    createFleetRequest - Contains the parameters for the new fleet to create.
    
    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.
    
    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 does not support storage connectors.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
CreateStackResult createStack(CreateStackRequest createStackRequest)
```
    Create a new stack.
    
    Parameters:
    
    createStackRequest -
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    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
```
CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)
```
    Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.
    
    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
  - deleteDirectoryConfig
```
DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
```
    Deletes the directory configuration with the given parameters.
    
    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
  - deleteFleet
```
DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
```
    Deletes a fleet.
    
    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
  - deleteStack
```
DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
```
    Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.
    
    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.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - describeDirectoryConfigs
```
DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)
```
    Returns a list describing the specified directory configurations.
    
    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
  - describeFleets
```
DescribeFleetsResult describeFleets(DescribeFleetsRequest describeFleetsRequest)
```
    If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
    
    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
  - describeImages
```
DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)
```
    Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.
    
    Parameters:
    
    describeImagesRequest -
    
    Returns:
    
    Result of the DescribeImages operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeSessions
```
DescribeSessionsResult describeSessions(DescribeSessionsRequest describeSessionsRequest)
```
    Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. To retrieve the next set of items, pass this value for the nextToken parameter in a subsequent call to this operation. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.
    
    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
```
DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
```
    If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. To retrieve the next set of items, pass the nextToken value in a subsequent call to this operation.
    
    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
  - disassociateFleet
```
DisassociateFleetResult disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
```
    Disassociates a fleet from a stack.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - expireSession
```
ExpireSessionResult expireSession(ExpireSessionRequest expireSessionRequest)
```
    This operation immediately stops a streaming session.
    
    Parameters:
    
    expireSessionRequest -
    
    Returns:
    
    Result of the ExpireSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedFleets
```
ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
```
    Lists all fleets associated with the stack.
    
    Parameters:
    
    listAssociatedFleetsRequest -
    
    Returns:
    
    Result of the ListAssociatedFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedStacks
```
ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
```
    Lists all stacks to which the specified fleet is associated.
    
    Parameters:
    
    listAssociatedStacksRequest -
    
    Returns:
    
    Result of the ListAssociatedStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startFleet
```
StartFleetResult startFleet(StartFleetRequest startFleetRequest)
```
    Starts a fleet.
    
    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.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - stopFleet
```
StopFleetResult stopFleet(StopFleetRequest stopFleetRequest)
```
    Stops a fleet.
    
    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
  - updateDirectoryConfig
```
UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
```
    Updates the directory configuration with the given parameters.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateFleet
```
UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)
```
    Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.
    
    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.
    
    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 does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
```
    Updates the specified fields in the stack with the specified name.
    
    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.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AmazonAppStreamWaiters waiters()
```

Did this page help you?

Interface AmazonAppStream

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

associateFleet

createDirectoryConfig

createFleet

createStack

createStreamingURL

deleteDirectoryConfig

deleteFleet

deleteStack

describeDirectoryConfigs

describeFleets

describeImages

describeSessions

describeStacks

disassociateFleet

expireSession

listAssociatedFleets

listAssociatedStacks

startFleet

stopFleet

updateDirectoryConfig

updateFleet

updateStack

shutdown

getCachedResponseMetadata

waiters