AbstractAmazonAppStream (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appstream.AbstractAmazonAppStream

All Implemented Interfaces:

AmazonAppStream

Direct Known Subclasses:

AbstractAmazonAppStreamAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonAppStream
extends Object
implements AmazonAppStream
```
Abstract implementation of AmazonAppStream. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.appstream.AmazonAppStream
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateFleetResult`	`associateFleet(AssociateFleetRequest request)` Associate a fleet to a stack.
`CreateDirectoryConfigResult`	`createDirectoryConfig(CreateDirectoryConfigRequest request)` Creates a directory configuration with the given parameters.
`CreateFleetResult`	`createFleet(CreateFleetRequest request)` Creates a new fleet.
`CreateStackResult`	`createStack(CreateStackRequest request)` Create a new stack.
`CreateStreamingURLResult`	`createStreamingURL(CreateStreamingURLRequest request)` Creates a URL to start an AppStream 2.0 streaming session for a user.
`DeleteDirectoryConfigResult`	`deleteDirectoryConfig(DeleteDirectoryConfigRequest request)` Deletes the directory configuration with the given parameters.
`DeleteFleetResult`	`deleteFleet(DeleteFleetRequest request)` Deletes a fleet.
`DeleteStackResult`	`deleteStack(DeleteStackRequest request)` Deletes the stack.
`DescribeDirectoryConfigsResult`	`describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)` Returns a list describing the specified directory configurations.
`DescribeFleetsResult`	`describeFleets(DescribeFleetsRequest request)` If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest request)` Describes the images.
`DescribeSessionsResult`	`describeSessions(DescribeSessionsRequest request)` Describes the streaming sessions for a stack and a fleet.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest request)` If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described.
`DisassociateFleetResult`	`disassociateFleet(DisassociateFleetRequest request)` Disassociates a fleet from a stack.
`ExpireSessionResult`	`expireSession(ExpireSessionRequest request)` 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 request)` Lists all fleets associated with the stack.
`ListAssociatedStacksResult`	`listAssociatedStacks(ListAssociatedStacksRequest request)` Lists all stacks to which the specified fleet is associated.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("appstream2.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonAppStream.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartFleetResult`	`startFleet(StartFleetRequest request)` Starts a fleet.
`StopFleetResult`	`stopFleet(StopFleetRequest request)` Stops a fleet.
`UpdateDirectoryConfigResult`	`updateDirectoryConfig(UpdateDirectoryConfigRequest request)` Updates the directory configuration with the given parameters.
`UpdateFleetResult`	`updateFleet(UpdateFleetRequest request)` Updates an existing fleet.
`UpdateStackResult`	`updateStack(UpdateStackRequest request)` Updates the specified fields in the stack with the specified name.
`AmazonAppStreamWaiters`	`waiters()`

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

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    setEndpoint in interface AmazonAppStream
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonAppStream
    
    An alternative to AmazonAppStream.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.
    
    Specified by:
    
    setRegion in interface AmazonAppStream
    
    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
```
public AssociateFleetResult associateFleet(AssociateFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Associate a fleet to a stack.
    
    Specified by:
    
    associateFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the AssociateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDirectoryConfig
```
public CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Creates a directory configuration with the given parameters.
    
    Specified by:
    
    createDirectoryConfig in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateDirectoryConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFleet
```
public CreateFleetResult createFleet(CreateFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Creates a new fleet.
    
    Specified by:
    
    createFleet in interface AmazonAppStream
    
    Parameters:
    
    request - Contains the parameters for the new fleet to create.
    
    Returns:
    
    Result of the CreateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
public CreateStackResult createStack(CreateStackRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Create a new stack.
    
    Specified by:
    
    createStack in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStreamingURL
```
public CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    createStreamingURL in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateStreamingURL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectoryConfig
```
public DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes the directory configuration with the given parameters.
    
    Specified by:
    
    deleteDirectoryConfig in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteDirectoryConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFleet
```
public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes a fleet.
    
    Specified by:
    
    deleteFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
public DeleteStackResult deleteStack(DeleteStackRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.
    
    Specified by:
    
    deleteStack in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDirectoryConfigs
```
public DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Returns a list describing the specified directory configurations.
    
    Specified by:
    
    describeDirectoryConfigs in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeDirectoryConfigs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFleets
```
public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
```
    Description copied from interface: AmazonAppStream
    
    If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
    
    Specified by:
    
    describeFleets in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeImages
```
public DescribeImagesResult describeImages(DescribeImagesRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    describeImages in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeImages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSessions
```
public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    describeSessions in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeSessions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
public DescribeStacksResult describeStacks(DescribeStacksRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    describeStacks in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateFleet
```
public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Disassociates a fleet from a stack.
    
    Specified by:
    
    disassociateFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the DisassociateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - expireSession
```
public ExpireSessionResult expireSession(ExpireSessionRequest request)
```
    Description copied from interface: AmazonAppStream
    
    This operation immediately stops a streaming session.
    
    Specified by:
    
    expireSession in interface AmazonAppStream
    
    Returns:
    
    Result of the ExpireSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedFleets
```
public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Lists all fleets associated with the stack.
    
    Specified by:
    
    listAssociatedFleets in interface AmazonAppStream
    
    Returns:
    
    Result of the ListAssociatedFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedStacks
```
public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Lists all stacks to which the specified fleet is associated.
    
    Specified by:
    
    listAssociatedStacks in interface AmazonAppStream
    
    Returns:
    
    Result of the ListAssociatedStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startFleet
```
public StartFleetResult startFleet(StartFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Starts a fleet.
    
    Specified by:
    
    startFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the StartFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopFleet
```
public StopFleetResult stopFleet(StopFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Stops a fleet.
    
    Specified by:
    
    stopFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the StopFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDirectoryConfig
```
public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Updates the directory configuration with the given parameters.
    
    Specified by:
    
    updateDirectoryConfig in interface AmazonAppStream
    
    Returns:
    
    Result of the UpdateDirectoryConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFleet
```
public UpdateFleetResult updateFleet(UpdateFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    Specified by:
    
    updateFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the UpdateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
public UpdateStackResult updateStack(UpdateStackRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Updates the specified fields in the stack with the specified name.
    
    Specified by:
    
    updateStack in interface AmazonAppStream
    
    Returns:
    
    Result of the UpdateStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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.
    
    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

Did this page help you?

Class AbstractAmazonAppStream

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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