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)` Associates the specified fleet with the specified stack.
`CopyImageResult`	`copyImage(CopyImageRequest request)` Copies the image within the same region or to a new region within the same AWS account.
`CreateDirectoryConfigResult`	`createDirectoryConfig(CreateDirectoryConfigRequest request)` Creates a directory configuration.
`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.
`CreateStreamingURLResult`	`createStreamingURL(CreateStreamingURLRequest request)` Creates a URL to start a streaming session for the specified user.
`DeleteDirectoryConfigResult`	`deleteDirectoryConfig(DeleteDirectoryConfigRequest request)` Deletes the specified directory configuration.
`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.
`DeleteStackResult`	`deleteStack(DeleteStackRequest request)` Deletes the specified stack.
`DescribeDirectoryConfigsResult`	`describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)` Describes the specified directory configurations.
`DescribeFleetsResult`	`describeFleets(DescribeFleetsRequest request)` Describes the specified fleets or all fleets in the account.
`DescribeImageBuildersResult`	`describeImageBuilders(DescribeImageBuildersRequest request)` Describes the specified image builders or all image builders in the account.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest request)` Describes the specified images or all images in the account.
`DescribeSessionsResult`	`describeSessions(DescribeSessionsRequest request)` Describes the streaming sessions for the specified stack and fleet.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest request)` Describes the specified stacks or all stacks in the account.
`DisassociateFleetResult`	`disassociateFleet(DisassociateFleetRequest request)` Disassociates the specified fleet from the specified stack.
`ExpireSessionResult`	`expireSession(ExpireSessionRequest request)` 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)` Lists the fleets associated with the specified stack.
`ListAssociatedStacksResult`	`listAssociatedStacks(ListAssociatedStacksRequest request)` Lists the stacks associated with the specified fleet.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags for the specified AppStream 2.0 resource.
`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 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 the specified tags from the specified AppStream 2.0 resource.
`UpdateDirectoryConfigResult`	`updateDirectoryConfig(UpdateDirectoryConfigRequest request)` Updates the specified directory configuration.
`UpdateFleetResult`	`updateFleet(UpdateFleetRequest request)` Updates the specified fleet.
`UpdateStackResult`	`updateStack(UpdateStackRequest request)` Updates the specified stack.
`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
    
    Associates the specified fleet with the specified stack.
    
    Specified by:
    
    associateFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the AssociateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copyImage
```
public CopyImageResult copyImage(CopyImageRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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
    
    Returns:
    
    Result of the CopyImage 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.
    
    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 fleet.
    
    Specified by:
    
    createFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilder
```
public CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Creates an image builder.
    
    The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
    
    Specified by:
    
    createImageBuilder in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateImageBuilder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilderStreamingURL
```
public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Creates a URL to start an image builder streaming session.
    
    Specified by:
    
    createImageBuilderStreamingURL in interface AmazonAppStream
    
    Returns:
    
    Result of the CreateImageBuilderStreamingURL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
public CreateStackResult createStack(CreateStackRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Creates a 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 a streaming session for the specified user.
    
    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 specified directory configuration.
    
    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 the specified fleet.
    
    Specified by:
    
    deleteFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImage
```
public DeleteImageResult deleteImage(DeleteImageRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.
    
    Specified by:
    
    deleteImage in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImageBuilder
```
public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes the specified image builder and releases the capacity.
    
    Specified by:
    
    deleteImageBuilder in interface AmazonAppStream
    
    Returns:
    
    Result of the DeleteImageBuilder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
public DeleteStackResult deleteStack(DeleteStackRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Deletes the specified 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
    
    Describes the specified directory configurations. Note that 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
    
    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
    
    Describes the specified fleets or all fleets in the account.
    
    Specified by:
    
    describeFleets in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeImageBuilders
```
public DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Describes the specified image builders or all image builders in the account.
    
    Specified by:
    
    describeImageBuilders in interface AmazonAppStream
    
    Returns:
    
    Result of the DescribeImageBuilders operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeImages
```
public DescribeImagesResult describeImages(DescribeImagesRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Describes the specified images or all images in the account.
    
    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 the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users 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
    
    Describes the specified stacks or all stacks in the account.
    
    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 the specified fleet from the specified 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
    
    Stops the specified 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 the fleets associated with the specified 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 the stacks associated with the specified fleet.
    
    Specified by:
    
    listAssociatedStacks in interface AmazonAppStream
    
    Returns:
    
    Result of the ListAssociatedStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Lists the 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 Developer Guide.
    
    Specified by:
    
    listTagsForResource in interface AmazonAppStream
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startFleet
```
public StartFleetResult startFleet(StartFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Starts the specified fleet.
    
    Specified by:
    
    startFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the StartFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startImageBuilder
```
public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Starts the specified image builder.
    
    Specified by:
    
    startImageBuilder in interface AmazonAppStream
    
    Returns:
    
    Result of the StartImageBuilder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopFleet
```
public StopFleetResult stopFleet(StopFleetRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Stops the specified fleet.
    
    Specified by:
    
    stopFleet in interface AmazonAppStream
    
    Returns:
    
    Result of the StopFleet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopImageBuilder
```
public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Stops the specified image builder.
    
    Specified by:
    
    stopImageBuilder in interface AmazonAppStream
    
    Returns:
    
    Result of the StopImageBuilder operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonAppStream
    
    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 Developer Guide.
    
    Specified by:
    
    tagResource in interface AmazonAppStream
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Disassociates the 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 Developer Guide.
    
    Specified by:
    
    untagResource in interface AmazonAppStream
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDirectoryConfig
```
public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)
```
    Description copied from interface: AmazonAppStream
    
    Updates the specified directory configuration.
    
    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 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 DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.
    
    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 stack.
    
    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

copyImage

createDirectoryConfig

createFleet

createImageBuilder

createImageBuilderStreamingURL

createStack

createStreamingURL

deleteDirectoryConfig

deleteFleet

deleteImage

deleteImageBuilder

deleteStack

describeDirectoryConfigs

describeFleets

describeImageBuilders

describeImages

describeSessions

describeStacks

disassociateFleet

expireSession

listAssociatedFleets

listAssociatedStacks

listTagsForResource

startFleet

startImageBuilder

stopFleet

stopImageBuilder

tagResource

untagResource

updateDirectoryConfig

updateFleet

updateStack

shutdown

getCachedResponseMetadata

waiters