Interface AppStreamAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateAppBlockBuilderAppBlock
(Consumer<AssociateAppBlockBuilderAppBlockRequest.Builder> associateAppBlockBuilderAppBlockRequest) Associates the specified app block builder with the specified app block.associateAppBlockBuilderAppBlock
(AssociateAppBlockBuilderAppBlockRequest associateAppBlockBuilderAppBlockRequest) Associates the specified app block builder with the specified app block.associateApplicationFleet
(Consumer<AssociateApplicationFleetRequest.Builder> associateApplicationFleetRequest) Associates the specified application with the specified fleet.associateApplicationFleet
(AssociateApplicationFleetRequest associateApplicationFleetRequest) Associates the specified application with the specified fleet.associateApplicationToEntitlement
(Consumer<AssociateApplicationToEntitlementRequest.Builder> associateApplicationToEntitlementRequest) Associates an application to entitle.associateApplicationToEntitlement
(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest) Associates an application to entitle.default CompletableFuture
<AssociateFleetResponse> associateFleet
(Consumer<AssociateFleetRequest.Builder> associateFleetRequest) Associates the specified fleet with the specified stack.default CompletableFuture
<AssociateFleetResponse> associateFleet
(AssociateFleetRequest associateFleetRequest) Associates the specified fleet with the specified stack.batchAssociateUserStack
(Consumer<BatchAssociateUserStackRequest.Builder> batchAssociateUserStackRequest) Associates the specified users with the specified stacks.batchAssociateUserStack
(BatchAssociateUserStackRequest batchAssociateUserStackRequest) Associates the specified users with the specified stacks.batchDisassociateUserStack
(Consumer<BatchDisassociateUserStackRequest.Builder> batchDisassociateUserStackRequest) Disassociates the specified users from the specified stacks.batchDisassociateUserStack
(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest) Disassociates the specified users from the specified stacks.static AppStreamAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAppStreamAsyncClient
.default CompletableFuture
<CopyImageResponse> copyImage
(Consumer<CopyImageRequest.Builder> copyImageRequest) Copies the image within the same region or to a new region within the same AWS account.default CompletableFuture
<CopyImageResponse> copyImage
(CopyImageRequest copyImageRequest) Copies the image within the same region or to a new region within the same AWS account.static AppStreamAsyncClient
create()
Create aAppStreamAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAppBlockResponse> createAppBlock
(Consumer<CreateAppBlockRequest.Builder> createAppBlockRequest) Creates an app block.default CompletableFuture
<CreateAppBlockResponse> createAppBlock
(CreateAppBlockRequest createAppBlockRequest) Creates an app block.createAppBlockBuilder
(Consumer<CreateAppBlockBuilderRequest.Builder> createAppBlockBuilderRequest) Creates an app block builder.createAppBlockBuilder
(CreateAppBlockBuilderRequest createAppBlockBuilderRequest) Creates an app block builder.createAppBlockBuilderStreamingURL
(Consumer<CreateAppBlockBuilderStreamingUrlRequest.Builder> createAppBlockBuilderStreamingUrlRequest) Creates a URL to start a create app block builder streaming session.createAppBlockBuilderStreamingURL
(CreateAppBlockBuilderStreamingUrlRequest createAppBlockBuilderStreamingUrlRequest) Creates a URL to start a create app block builder streaming session.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application.createDirectoryConfig
(Consumer<CreateDirectoryConfigRequest.Builder> createDirectoryConfigRequest) Creates a Directory Config object in AppStream 2.0.createDirectoryConfig
(CreateDirectoryConfigRequest createDirectoryConfigRequest) Creates a Directory Config object in AppStream 2.0.createEntitlement
(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest) Creates a new entitlement.createEntitlement
(CreateEntitlementRequest createEntitlementRequest) Creates a new entitlement.default CompletableFuture
<CreateFleetResponse> createFleet
(Consumer<CreateFleetRequest.Builder> createFleetRequest) Creates a fleet.default CompletableFuture
<CreateFleetResponse> createFleet
(CreateFleetRequest createFleetRequest) Creates a fleet.createImageBuilder
(Consumer<CreateImageBuilderRequest.Builder> createImageBuilderRequest) Creates an image builder.createImageBuilder
(CreateImageBuilderRequest createImageBuilderRequest) Creates an image builder.createImageBuilderStreamingURL
(Consumer<CreateImageBuilderStreamingUrlRequest.Builder> createImageBuilderStreamingUrlRequest) Creates a URL to start an image builder streaming session.createImageBuilderStreamingURL
(CreateImageBuilderStreamingUrlRequest createImageBuilderStreamingUrlRequest) Creates a URL to start an image builder streaming session.default CompletableFuture
<CreateStackResponse> createStack
(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a stack to start streaming applications to users.default CompletableFuture
<CreateStackResponse> createStack
(CreateStackRequest createStackRequest) Creates a stack to start streaming applications to users.createStreamingURL
(Consumer<CreateStreamingUrlRequest.Builder> createStreamingUrlRequest) Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.createStreamingURL
(CreateStreamingUrlRequest createStreamingUrlRequest) Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.createUpdatedImage
(Consumer<CreateUpdatedImageRequest.Builder> createUpdatedImageRequest) Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.createUpdatedImage
(CreateUpdatedImageRequest createUpdatedImageRequest) Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.createUsageReportSubscription
(Consumer<CreateUsageReportSubscriptionRequest.Builder> createUsageReportSubscriptionRequest) Creates a usage report subscription.createUsageReportSubscription
(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest) Creates a usage report subscription.default CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user in the user pool.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a new user in the user pool.default CompletableFuture
<DeleteAppBlockResponse> deleteAppBlock
(Consumer<DeleteAppBlockRequest.Builder> deleteAppBlockRequest) Deletes an app block.default CompletableFuture
<DeleteAppBlockResponse> deleteAppBlock
(DeleteAppBlockRequest deleteAppBlockRequest) Deletes an app block.deleteAppBlockBuilder
(Consumer<DeleteAppBlockBuilderRequest.Builder> deleteAppBlockBuilderRequest) Deletes an app block builder.deleteAppBlockBuilder
(DeleteAppBlockBuilderRequest deleteAppBlockBuilderRequest) Deletes an app block builder.deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.deleteDirectoryConfig
(Consumer<DeleteDirectoryConfigRequest.Builder> deleteDirectoryConfigRequest) Deletes the specified Directory Config object from AppStream 2.0.deleteDirectoryConfig
(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest) Deletes the specified Directory Config object from AppStream 2.0.deleteEntitlement
(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest) Deletes the specified entitlement.deleteEntitlement
(DeleteEntitlementRequest deleteEntitlementRequest) Deletes the specified entitlement.default CompletableFuture
<DeleteFleetResponse> deleteFleet
(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) Deletes the specified fleet.default CompletableFuture
<DeleteFleetResponse> deleteFleet
(DeleteFleetRequest deleteFleetRequest) Deletes the specified fleet.default CompletableFuture
<DeleteImageResponse> deleteImage
(Consumer<DeleteImageRequest.Builder> deleteImageRequest) Deletes the specified image.default CompletableFuture
<DeleteImageResponse> deleteImage
(DeleteImageRequest deleteImageRequest) Deletes the specified image.deleteImageBuilder
(Consumer<DeleteImageBuilderRequest.Builder> deleteImageBuilderRequest) Deletes the specified image builder and releases the capacity.deleteImageBuilder
(DeleteImageBuilderRequest deleteImageBuilderRequest) Deletes the specified image builder and releases the capacity.deleteImagePermissions
(Consumer<DeleteImagePermissionsRequest.Builder> deleteImagePermissionsRequest) Deletes permissions for the specified private image.deleteImagePermissions
(DeleteImagePermissionsRequest deleteImagePermissionsRequest) Deletes permissions for the specified private image.default CompletableFuture
<DeleteStackResponse> deleteStack
(Consumer<DeleteStackRequest.Builder> deleteStackRequest) Deletes the specified stack.default CompletableFuture
<DeleteStackResponse> deleteStack
(DeleteStackRequest deleteStackRequest) Deletes the specified stack.deleteUsageReportSubscription
(Consumer<DeleteUsageReportSubscriptionRequest.Builder> deleteUsageReportSubscriptionRequest) Disables usage report generation.deleteUsageReportSubscription
(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest) Disables usage report generation.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user from the user pool.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user from the user pool.describeAppBlockBuilderAppBlockAssociations
(Consumer<DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder> describeAppBlockBuilderAppBlockAssociationsRequest) Retrieves a list that describes one or more app block builder associations.describeAppBlockBuilderAppBlockAssociations
(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest) Retrieves a list that describes one or more app block builder associations.describeAppBlockBuilderAppBlockAssociationsPaginator
(Consumer<DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder> describeAppBlockBuilderAppBlockAssociationsRequest) describeAppBlockBuilderAppBlockAssociationsPaginator
(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest) describeAppBlockBuilders
(Consumer<DescribeAppBlockBuildersRequest.Builder> describeAppBlockBuildersRequest) Retrieves a list that describes one or more app block builders.describeAppBlockBuilders
(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest) Retrieves a list that describes one or more app block builders.describeAppBlockBuildersPaginator
(Consumer<DescribeAppBlockBuildersRequest.Builder> describeAppBlockBuildersRequest) This is a variant ofdescribeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation.describeAppBlockBuildersPaginator
(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest) This is a variant ofdescribeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation.describeAppBlocks
(Consumer<DescribeAppBlocksRequest.Builder> describeAppBlocksRequest) Retrieves a list that describes one or more app blocks.describeAppBlocks
(DescribeAppBlocksRequest describeAppBlocksRequest) Retrieves a list that describes one or more app blocks.describeApplicationFleetAssociations
(Consumer<DescribeApplicationFleetAssociationsRequest.Builder> describeApplicationFleetAssociationsRequest) Retrieves a list that describes one or more application fleet associations.describeApplicationFleetAssociations
(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest) Retrieves a list that describes one or more application fleet associations.describeApplications
(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) Retrieves a list that describes one or more applications.describeApplications
(DescribeApplicationsRequest describeApplicationsRequest) Retrieves a list that describes one or more applications.Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.describeDirectoryConfigs
(Consumer<DescribeDirectoryConfigsRequest.Builder> describeDirectoryConfigsRequest) Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.describeDirectoryConfigs
(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest) Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.describeEntitlements
(Consumer<DescribeEntitlementsRequest.Builder> describeEntitlementsRequest) Retrieves a list that describes one of more entitlements.describeEntitlements
(DescribeEntitlementsRequest describeEntitlementsRequest) Retrieves a list that describes one of more entitlements.default CompletableFuture
<DescribeFleetsResponse> Retrieves a list that describes one or more specified fleets, if the fleet names are provided.default CompletableFuture
<DescribeFleetsResponse> describeFleets
(Consumer<DescribeFleetsRequest.Builder> describeFleetsRequest) Retrieves a list that describes one or more specified fleets, if the fleet names are provided.default CompletableFuture
<DescribeFleetsResponse> describeFleets
(DescribeFleetsRequest describeFleetsRequest) Retrieves a list that describes one or more specified fleets, if the fleet names are provided.Retrieves a list that describes one or more specified image builders, if the image builder names are provided.describeImageBuilders
(Consumer<DescribeImageBuildersRequest.Builder> describeImageBuildersRequest) Retrieves a list that describes one or more specified image builders, if the image builder names are provided.describeImageBuilders
(DescribeImageBuildersRequest describeImageBuildersRequest) Retrieves a list that describes one or more specified image builders, if the image builder names are provided.describeImagePermissions
(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.describeImagePermissions
(DescribeImagePermissionsRequest describeImagePermissionsRequest) Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.describeImagePermissionsPaginator
(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) This is a variant ofdescribeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.describeImagePermissionsPaginator
(DescribeImagePermissionsRequest describeImagePermissionsRequest) This is a variant ofdescribeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.default CompletableFuture
<DescribeImagesResponse> Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.default CompletableFuture
<DescribeImagesResponse> describeImages
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.default CompletableFuture
<DescribeImagesResponse> describeImages
(DescribeImagesRequest describeImagesRequest) Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.default DescribeImagesPublisher
This is a variant ofdescribeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.default DescribeImagesPublisher
describeImagesPaginator
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.default DescribeImagesPublisher
describeImagesPaginator
(DescribeImagesRequest describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.describeSessions
(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest) Retrieves a list that describes the streaming sessions for a specified stack and fleet.describeSessions
(DescribeSessionsRequest describeSessionsRequest) Retrieves a list that describes the streaming sessions for a specified stack and fleet.default CompletableFuture
<DescribeStacksResponse> Retrieves a list that describes one or more specified stacks, if the stack names are provided.default CompletableFuture
<DescribeStacksResponse> describeStacks
(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) Retrieves a list that describes one or more specified stacks, if the stack names are provided.default CompletableFuture
<DescribeStacksResponse> describeStacks
(DescribeStacksRequest describeStacksRequest) Retrieves a list that describes one or more specified stacks, if the stack names are provided.describeUsageReportSubscriptions
(Consumer<DescribeUsageReportSubscriptionsRequest.Builder> describeUsageReportSubscriptionsRequest) Retrieves a list that describes one or more usage report subscriptions.describeUsageReportSubscriptions
(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest) Retrieves a list that describes one or more usage report subscriptions.default CompletableFuture
<DescribeUsersResponse> describeUsers
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Retrieves a list that describes one or more specified users in the user pool.default CompletableFuture
<DescribeUsersResponse> describeUsers
(DescribeUsersRequest describeUsersRequest) Retrieves a list that describes one or more specified users in the user pool.describeUserStackAssociations
(Consumer<DescribeUserStackAssociationsRequest.Builder> describeUserStackAssociationsRequest) Retrieves a list that describes the UserStackAssociation objects.describeUserStackAssociations
(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest) Retrieves a list that describes the UserStackAssociation objects.default CompletableFuture
<DisableUserResponse> disableUser
(Consumer<DisableUserRequest.Builder> disableUserRequest) Disables the specified user in the user pool.default CompletableFuture
<DisableUserResponse> disableUser
(DisableUserRequest disableUserRequest) Disables the specified user in the user pool.disassociateAppBlockBuilderAppBlock
(Consumer<DisassociateAppBlockBuilderAppBlockRequest.Builder> disassociateAppBlockBuilderAppBlockRequest) Disassociates a specified app block builder from a specified app block.disassociateAppBlockBuilderAppBlock
(DisassociateAppBlockBuilderAppBlockRequest disassociateAppBlockBuilderAppBlockRequest) Disassociates a specified app block builder from a specified app block.disassociateApplicationFleet
(Consumer<DisassociateApplicationFleetRequest.Builder> disassociateApplicationFleetRequest) Disassociates the specified application from the fleet.disassociateApplicationFleet
(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest) Disassociates the specified application from the fleet.disassociateApplicationFromEntitlement
(Consumer<DisassociateApplicationFromEntitlementRequest.Builder> disassociateApplicationFromEntitlementRequest) Deletes the specified application from the specified entitlement.disassociateApplicationFromEntitlement
(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest) Deletes the specified application from the specified entitlement.disassociateFleet
(Consumer<DisassociateFleetRequest.Builder> disassociateFleetRequest) Disassociates the specified fleet from the specified stack.disassociateFleet
(DisassociateFleetRequest disassociateFleetRequest) Disassociates the specified fleet from the specified stack.default CompletableFuture
<EnableUserResponse> enableUser
(Consumer<EnableUserRequest.Builder> enableUserRequest) Enables a user in the user pool.default CompletableFuture
<EnableUserResponse> enableUser
(EnableUserRequest enableUserRequest) Enables a user in the user pool.default CompletableFuture
<ExpireSessionResponse> expireSession
(Consumer<ExpireSessionRequest.Builder> expireSessionRequest) Immediately stops the specified streaming session.default CompletableFuture
<ExpireSessionResponse> expireSession
(ExpireSessionRequest expireSessionRequest) Immediately stops the specified streaming session.listAssociatedFleets
(Consumer<ListAssociatedFleetsRequest.Builder> listAssociatedFleetsRequest) Retrieves the name of the fleet that is associated with the specified stack.listAssociatedFleets
(ListAssociatedFleetsRequest listAssociatedFleetsRequest) Retrieves the name of the fleet that is associated with the specified stack.listAssociatedStacks
(Consumer<ListAssociatedStacksRequest.Builder> listAssociatedStacksRequest) Retrieves the name of the stack with which the specified fleet is associated.listAssociatedStacks
(ListAssociatedStacksRequest listAssociatedStacksRequest) Retrieves the name of the stack with which the specified fleet is associated.listEntitledApplications
(Consumer<ListEntitledApplicationsRequest.Builder> listEntitledApplicationsRequest) Retrieves a list of entitled applications.listEntitledApplications
(ListEntitledApplicationsRequest listEntitledApplicationsRequest) Retrieves a list of entitled applications.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of all tags for the specified AppStream 2.0 resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of all tags for the specified AppStream 2.0 resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAppBlockBuilder
(Consumer<StartAppBlockBuilderRequest.Builder> startAppBlockBuilderRequest) Starts an app block builder.startAppBlockBuilder
(StartAppBlockBuilderRequest startAppBlockBuilderRequest) Starts an app block builder.default CompletableFuture
<StartFleetResponse> startFleet
(Consumer<StartFleetRequest.Builder> startFleetRequest) Starts the specified fleet.default CompletableFuture
<StartFleetResponse> startFleet
(StartFleetRequest startFleetRequest) Starts the specified fleet.startImageBuilder
(Consumer<StartImageBuilderRequest.Builder> startImageBuilderRequest) Starts the specified image builder.startImageBuilder
(StartImageBuilderRequest startImageBuilderRequest) Starts the specified image builder.stopAppBlockBuilder
(Consumer<StopAppBlockBuilderRequest.Builder> stopAppBlockBuilderRequest) Stops an app block builder.stopAppBlockBuilder
(StopAppBlockBuilderRequest stopAppBlockBuilderRequest) Stops an app block builder.default CompletableFuture
<StopFleetResponse> stopFleet
(Consumer<StopFleetRequest.Builder> stopFleetRequest) Stops the specified fleet.default CompletableFuture
<StopFleetResponse> stopFleet
(StopFleetRequest stopFleetRequest) Stops the specified fleet.stopImageBuilder
(Consumer<StopImageBuilderRequest.Builder> stopImageBuilderRequest) Stops the specified image builder.stopImageBuilder
(StopImageBuilderRequest stopImageBuilderRequest) Stops the specified image builder.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites one or more tags for the specified AppStream 2.0 resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified AppStream 2.0 resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates one or more specified tags from the specified AppStream 2.0 resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Disassociates one or more specified tags from the specified AppStream 2.0 resource.updateAppBlockBuilder
(Consumer<UpdateAppBlockBuilderRequest.Builder> updateAppBlockBuilderRequest) Updates an app block builder.updateAppBlockBuilder
(UpdateAppBlockBuilderRequest updateAppBlockBuilderRequest) Updates an app block builder.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates the specified application.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates the specified application.updateDirectoryConfig
(Consumer<UpdateDirectoryConfigRequest.Builder> updateDirectoryConfigRequest) Updates the specified Directory Config object in AppStream 2.0.updateDirectoryConfig
(UpdateDirectoryConfigRequest updateDirectoryConfigRequest) Updates the specified Directory Config object in AppStream 2.0.updateEntitlement
(Consumer<UpdateEntitlementRequest.Builder> updateEntitlementRequest) Updates the specified entitlement.updateEntitlement
(UpdateEntitlementRequest updateEntitlementRequest) Updates the specified entitlement.default CompletableFuture
<UpdateFleetResponse> updateFleet
(Consumer<UpdateFleetRequest.Builder> updateFleetRequest) Updates the specified fleet.default CompletableFuture
<UpdateFleetResponse> updateFleet
(UpdateFleetRequest updateFleetRequest) Updates the specified fleet.updateImagePermissions
(Consumer<UpdateImagePermissionsRequest.Builder> updateImagePermissionsRequest) Adds or updates permissions for the specified private image.updateImagePermissions
(UpdateImagePermissionsRequest updateImagePermissionsRequest) Adds or updates permissions for the specified private image.default CompletableFuture
<UpdateStackResponse> updateStack
(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates the specified fields for the specified stack.default CompletableFuture
<UpdateStackResponse> updateStack
(UpdateStackRequest updateStackRequest) Updates the specified fields for the specified stack.default AppStreamAsyncWaiter
waiter()
Create an instance ofAppStreamAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateAppBlockBuilderAppBlock
default CompletableFuture<AssociateAppBlockBuilderAppBlockResponse> associateAppBlockBuilderAppBlock(AssociateAppBlockBuilderAppBlockRequest associateAppBlockBuilderAppBlockRequest) Associates the specified app block builder with the specified app block.
- Parameters:
associateAppBlockBuilderAppBlockRequest
-- Returns:
- A Java Future containing the result of the AssociateAppBlockBuilderAppBlock operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateAppBlockBuilderAppBlock
default CompletableFuture<AssociateAppBlockBuilderAppBlockResponse> associateAppBlockBuilderAppBlock(Consumer<AssociateAppBlockBuilderAppBlockRequest.Builder> associateAppBlockBuilderAppBlockRequest) Associates the specified app block builder with the specified app block.
This is a convenience which creates an instance of the
AssociateAppBlockBuilderAppBlockRequest.Builder
avoiding the need to create one manually viaAssociateAppBlockBuilderAppBlockRequest.builder()
- Parameters:
associateAppBlockBuilderAppBlockRequest
- AConsumer
that will call methods onAssociateAppBlockBuilderAppBlockRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateAppBlockBuilderAppBlock operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateApplicationFleet
default CompletableFuture<AssociateApplicationFleetResponse> associateApplicationFleet(AssociateApplicationFleetRequest associateApplicationFleetRequest) Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
- Parameters:
associateApplicationFleetRequest
-- Returns:
- A Java Future containing the result of the AssociateApplicationFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateApplicationFleet
default CompletableFuture<AssociateApplicationFleetResponse> associateApplicationFleet(Consumer<AssociateApplicationFleetRequest.Builder> associateApplicationFleetRequest) Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
This is a convenience which creates an instance of the
AssociateApplicationFleetRequest.Builder
avoiding the need to create one manually viaAssociateApplicationFleetRequest.builder()
- Parameters:
associateApplicationFleetRequest
- AConsumer
that will call methods onAssociateApplicationFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateApplicationFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateApplicationToEntitlement
default CompletableFuture<AssociateApplicationToEntitlementResponse> associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest) Associates an application to entitle.
- Parameters:
associateApplicationToEntitlementRequest
-- Returns:
- A Java Future containing the result of the AssociateApplicationToEntitlement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateApplicationToEntitlement
default CompletableFuture<AssociateApplicationToEntitlementResponse> associateApplicationToEntitlement(Consumer<AssociateApplicationToEntitlementRequest.Builder> associateApplicationToEntitlementRequest) Associates an application to entitle.
This is a convenience which creates an instance of the
AssociateApplicationToEntitlementRequest.Builder
avoiding the need to create one manually viaAssociateApplicationToEntitlementRequest.builder()
- Parameters:
associateApplicationToEntitlementRequest
- AConsumer
that will call methods onAssociateApplicationToEntitlementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateApplicationToEntitlement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateFleet
default CompletableFuture<AssociateFleetResponse> associateFleet(AssociateFleetRequest associateFleetRequest) Associates the specified fleet with the specified stack.
- Parameters:
associateFleetRequest
-- Returns:
- A Java Future containing the result of the AssociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateFleet
default CompletableFuture<AssociateFleetResponse> associateFleet(Consumer<AssociateFleetRequest.Builder> associateFleetRequest) Associates the specified fleet with the specified stack.
This is a convenience which creates an instance of the
AssociateFleetRequest.Builder
avoiding the need to create one manually viaAssociateFleetRequest.builder()
- Parameters:
associateFleetRequest
- AConsumer
that will call methods onAssociateFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchAssociateUserStack
default CompletableFuture<BatchAssociateUserStackResponse> batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest) 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.
- Parameters:
batchAssociateUserStackRequest
-- Returns:
- A Java Future containing the result of the BatchAssociateUserStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchAssociateUserStack
default CompletableFuture<BatchAssociateUserStackResponse> batchAssociateUserStack(Consumer<BatchAssociateUserStackRequest.Builder> batchAssociateUserStackRequest) 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.
This is a convenience which creates an instance of the
BatchAssociateUserStackRequest.Builder
avoiding the need to create one manually viaBatchAssociateUserStackRequest.builder()
- Parameters:
batchAssociateUserStackRequest
- AConsumer
that will call methods onBatchAssociateUserStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchAssociateUserStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisassociateUserStack
default CompletableFuture<BatchDisassociateUserStackResponse> batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest) Disassociates the specified users from the specified stacks.
- Parameters:
batchDisassociateUserStackRequest
-- Returns:
- A Java Future containing the result of the BatchDisassociateUserStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisassociateUserStack
default CompletableFuture<BatchDisassociateUserStackResponse> batchDisassociateUserStack(Consumer<BatchDisassociateUserStackRequest.Builder> batchDisassociateUserStackRequest) Disassociates the specified users from the specified stacks.
This is a convenience which creates an instance of the
BatchDisassociateUserStackRequest.Builder
avoiding the need to create one manually viaBatchDisassociateUserStackRequest.builder()
- Parameters:
batchDisassociateUserStackRequest
- AConsumer
that will call methods onBatchDisassociateUserStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDisassociateUserStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyImage
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.
- Parameters:
copyImageRequest
-- Returns:
- A Java Future containing the result of the CopyImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyImage
default CompletableFuture<CopyImageResponse> copyImage(Consumer<CopyImageRequest.Builder> copyImageRequest) 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.
This is a convenience which creates an instance of the
CopyImageRequest.Builder
avoiding the need to create one manually viaCopyImageRequest.builder()
- Parameters:
copyImageRequest
- AConsumer
that will call methods onCopyImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlock
default CompletableFuture<CreateAppBlockResponse> createAppBlock(CreateAppBlockRequest createAppBlockRequest) 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.
- Parameters:
createAppBlockRequest
-- Returns:
- A Java Future containing the result of the CreateAppBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlock
default CompletableFuture<CreateAppBlockResponse> createAppBlock(Consumer<CreateAppBlockRequest.Builder> createAppBlockRequest) 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.
This is a convenience which creates an instance of the
CreateAppBlockRequest.Builder
avoiding the need to create one manually viaCreateAppBlockRequest.builder()
- Parameters:
createAppBlockRequest
- AConsumer
that will call methods onCreateAppBlockRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlockBuilder
default CompletableFuture<CreateAppBlockBuilderResponse> createAppBlockBuilder(CreateAppBlockBuilderRequest createAppBlockBuilderRequest) Creates an app block builder.
- Parameters:
createAppBlockBuilderRequest
-- Returns:
- A Java Future containing the result of the CreateAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The requested limit exceeds the permitted limit for an account.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- InvalidRoleException The specified role is invalid.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceAlreadyExistsException The specified resource already exists.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlockBuilder
default CompletableFuture<CreateAppBlockBuilderResponse> createAppBlockBuilder(Consumer<CreateAppBlockBuilderRequest.Builder> createAppBlockBuilderRequest) Creates an app block builder.
This is a convenience which creates an instance of the
CreateAppBlockBuilderRequest.Builder
avoiding the need to create one manually viaCreateAppBlockBuilderRequest.builder()
- Parameters:
createAppBlockBuilderRequest
- AConsumer
that will call methods onCreateAppBlockBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The requested limit exceeds the permitted limit for an account.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- InvalidRoleException The specified role is invalid.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceAlreadyExistsException The specified resource already exists.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlockBuilderStreamingURL
default CompletableFuture<CreateAppBlockBuilderStreamingUrlResponse> createAppBlockBuilderStreamingURL(CreateAppBlockBuilderStreamingUrlRequest createAppBlockBuilderStreamingUrlRequest) Creates a URL to start a create app block builder streaming session.
- Parameters:
createAppBlockBuilderStreamingUrlRequest
-- Returns:
- A Java Future containing the result of the CreateAppBlockBuilderStreamingURL operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppBlockBuilderStreamingURL
default CompletableFuture<CreateAppBlockBuilderStreamingUrlResponse> createAppBlockBuilderStreamingURL(Consumer<CreateAppBlockBuilderStreamingUrlRequest.Builder> createAppBlockBuilderStreamingUrlRequest) Creates a URL to start a create app block builder streaming session.
This is a convenience which creates an instance of the
CreateAppBlockBuilderStreamingUrlRequest.Builder
avoiding the need to create one manually viaCreateAppBlockBuilderStreamingUrlRequest.builder()
- Parameters:
createAppBlockBuilderStreamingUrlRequest
- AConsumer
that will call methods onCreateAppBlockBuilderStreamingUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppBlockBuilderStreamingURL operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) 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.
- Parameters:
createApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) 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.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDirectoryConfig
default CompletableFuture<CreateDirectoryConfigResponse> createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest) 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.
- Parameters:
createDirectoryConfigRequest
-- Returns:
- A Java Future containing the result of the CreateDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDirectoryConfig
default CompletableFuture<CreateDirectoryConfigResponse> createDirectoryConfig(Consumer<CreateDirectoryConfigRequest.Builder> createDirectoryConfigRequest) 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.
This is a convenience which creates an instance of the
CreateDirectoryConfigRequest.Builder
avoiding the need to create one manually viaCreateDirectoryConfigRequest.builder()
- Parameters:
createDirectoryConfigRequest
- AConsumer
that will call methods onCreateDirectoryConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEntitlement
default CompletableFuture<CreateEntitlementResponse> createEntitlement(CreateEntitlementRequest createEntitlementRequest) 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.
- Parameters:
createEntitlementRequest
-- Returns:
- A Java Future containing the result of the CreateEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEntitlement
default CompletableFuture<CreateEntitlementResponse> createEntitlement(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest) 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.
This is a convenience which creates an instance of the
CreateEntitlementRequest.Builder
avoiding the need to create one manually viaCreateEntitlementRequest.builder()
- Parameters:
createEntitlementRequest
- AConsumer
that will call methods onCreateEntitlementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFleet
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
- Parameters:
createFleetRequest
-- Returns:
- A Java Future containing the result of the CreateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFleet
default CompletableFuture<CreateFleetResponse> createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest) Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
This is a convenience which creates an instance of the
CreateFleetRequest.Builder
avoiding the need to create one manually viaCreateFleetRequest.builder()
- Parameters:
createFleetRequest
- AConsumer
that will call methods onCreateFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImageBuilder
default CompletableFuture<CreateImageBuilderResponse> createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest) 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 isRUNNING
.- Parameters:
createImageBuilderRequest
-- Returns:
- A Java Future containing the result of the CreateImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImageBuilder
default CompletableFuture<CreateImageBuilderResponse> createImageBuilder(Consumer<CreateImageBuilderRequest.Builder> createImageBuilderRequest) 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 isRUNNING
.
This is a convenience which creates an instance of the
CreateImageBuilderRequest.Builder
avoiding the need to create one manually viaCreateImageBuilderRequest.builder()
- Parameters:
createImageBuilderRequest
- AConsumer
that will call methods onCreateImageBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImageBuilderStreamingURL
default CompletableFuture<CreateImageBuilderStreamingUrlResponse> createImageBuilderStreamingURL(CreateImageBuilderStreamingUrlRequest createImageBuilderStreamingUrlRequest) Creates a URL to start an image builder streaming session.
- Parameters:
createImageBuilderStreamingUrlRequest
-- Returns:
- A Java Future containing the result of the CreateImageBuilderStreamingURL operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImageBuilderStreamingURL
default CompletableFuture<CreateImageBuilderStreamingUrlResponse> createImageBuilderStreamingURL(Consumer<CreateImageBuilderStreamingUrlRequest.Builder> createImageBuilderStreamingUrlRequest) Creates a URL to start an image builder streaming session.
This is a convenience which creates an instance of the
CreateImageBuilderStreamingUrlRequest.Builder
avoiding the need to create one manually viaCreateImageBuilderStreamingUrlRequest.builder()
- Parameters:
createImageBuilderStreamingUrlRequest
- AConsumer
that will call methods onCreateImageBuilderStreamingUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateImageBuilderStreamingURL operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStack
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
- Parameters:
createStackRequest
-- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The requested limit exceeds the permitted limit for an account.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- ResourceAlreadyExistsException The specified resource already exists.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidRoleException The specified role is invalid.
- ResourceNotFoundException The specified resource was not found.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStack
default CompletableFuture<CreateStackResponse> createStack(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
This is a convenience which creates an instance of the
CreateStackRequest.Builder
avoiding the need to create one manually viaCreateStackRequest.builder()
- Parameters:
createStackRequest
- AConsumer
that will call methods onCreateStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The requested limit exceeds the permitted limit for an account.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- ResourceAlreadyExistsException The specified resource already exists.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidRoleException The specified role is invalid.
- ResourceNotFoundException The specified resource was not found.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingURL
default CompletableFuture<CreateStreamingUrlResponse> createStreamingURL(CreateStreamingUrlRequest createStreamingUrlRequest) 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.
- Parameters:
createStreamingUrlRequest
-- Returns:
- A Java Future containing the result of the CreateStreamingURL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamingURL
default CompletableFuture<CreateStreamingUrlResponse> createStreamingURL(Consumer<CreateStreamingUrlRequest.Builder> createStreamingUrlRequest) 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.
This is a convenience which creates an instance of the
CreateStreamingUrlRequest.Builder
avoiding the need to create one manually viaCreateStreamingUrlRequest.builder()
- Parameters:
createStreamingUrlRequest
- AConsumer
that will call methods onCreateStreamingUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStreamingURL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUpdatedImage
default CompletableFuture<CreateUpdatedImageResponse> createUpdatedImage(CreateUpdatedImageRequest createUpdatedImageRequest) 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.
- Parameters:
createUpdatedImageRequest
-- Returns:
- A Java Future containing the result of the CreateUpdatedImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUpdatedImage
default CompletableFuture<CreateUpdatedImageResponse> createUpdatedImage(Consumer<CreateUpdatedImageRequest.Builder> createUpdatedImageRequest) 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.
This is a convenience which creates an instance of the
CreateUpdatedImageRequest.Builder
avoiding the need to create one manually viaCreateUpdatedImageRequest.builder()
- Parameters:
createUpdatedImageRequest
- AConsumer
that will call methods onCreateUpdatedImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUpdatedImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUsageReportSubscription
default CompletableFuture<CreateUsageReportSubscriptionResponse> createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest) Creates a usage report subscription. Usage reports are generated daily.
- Parameters:
createUsageReportSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateUsageReportSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUsageReportSubscription
default CompletableFuture<CreateUsageReportSubscriptionResponse> createUsageReportSubscription(Consumer<CreateUsageReportSubscriptionRequest.Builder> createUsageReportSubscriptionRequest) Creates a usage report subscription. Usage reports are generated daily.
This is a convenience which creates an instance of the
CreateUsageReportSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateUsageReportSubscriptionRequest.builder()
- Parameters:
createUsageReportSubscriptionRequest
- AConsumer
that will call methods onCreateUsageReportSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUsageReportSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates a new user in the user pool.
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user in the user pool.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppBlock
default CompletableFuture<DeleteAppBlockResponse> deleteAppBlock(DeleteAppBlockRequest deleteAppBlockRequest) Deletes an app block.
- Parameters:
deleteAppBlockRequest
-- Returns:
- A Java Future containing the result of the DeleteAppBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppBlock
default CompletableFuture<DeleteAppBlockResponse> deleteAppBlock(Consumer<DeleteAppBlockRequest.Builder> deleteAppBlockRequest) Deletes an app block.
This is a convenience which creates an instance of the
DeleteAppBlockRequest.Builder
avoiding the need to create one manually viaDeleteAppBlockRequest.builder()
- Parameters:
deleteAppBlockRequest
- AConsumer
that will call methods onDeleteAppBlockRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppBlock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppBlockBuilder
default CompletableFuture<DeleteAppBlockBuilderResponse> deleteAppBlockBuilder(DeleteAppBlockBuilderRequest deleteAppBlockBuilderRequest) Deletes an app block builder.
An app block builder can only be deleted when it has no association with an app block.
- Parameters:
deleteAppBlockBuilderRequest
-- Returns:
- A Java Future containing the result of the DeleteAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- ResourceInUseException The specified resource is in use.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppBlockBuilder
default CompletableFuture<DeleteAppBlockBuilderResponse> deleteAppBlockBuilder(Consumer<DeleteAppBlockBuilderRequest.Builder> deleteAppBlockBuilderRequest) Deletes an app block builder.
An app block builder can only be deleted when it has no association with an app block.
This is a convenience which creates an instance of the
DeleteAppBlockBuilderRequest.Builder
avoiding the need to create one manually viaDeleteAppBlockBuilderRequest.builder()
- Parameters:
deleteAppBlockBuilderRequest
- AConsumer
that will call methods onDeleteAppBlockBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- ResourceInUseException The specified resource is in use.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.
- Parameters:
deleteApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDirectoryConfig
default CompletableFuture<DeleteDirectoryConfigResponse> deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest) 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.
- Parameters:
deleteDirectoryConfigRequest
-- Returns:
- A Java Future containing the result of the DeleteDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The specified resource is in use.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDirectoryConfig
default CompletableFuture<DeleteDirectoryConfigResponse> deleteDirectoryConfig(Consumer<DeleteDirectoryConfigRequest.Builder> deleteDirectoryConfigRequest) 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.
This is a convenience which creates an instance of the
DeleteDirectoryConfigRequest.Builder
avoiding the need to create one manually viaDeleteDirectoryConfigRequest.builder()
- Parameters:
deleteDirectoryConfigRequest
- AConsumer
that will call methods onDeleteDirectoryConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The specified resource is in use.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEntitlement
default CompletableFuture<DeleteEntitlementResponse> deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest) Deletes the specified entitlement.
- Parameters:
deleteEntitlementRequest
-- Returns:
- A Java Future containing the result of the DeleteEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEntitlement
default CompletableFuture<DeleteEntitlementResponse> deleteEntitlement(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest) Deletes the specified entitlement.
This is a convenience which creates an instance of the
DeleteEntitlementRequest.Builder
avoiding the need to create one manually viaDeleteEntitlementRequest.builder()
- Parameters:
deleteEntitlementRequest
- AConsumer
that will call methods onDeleteEntitlementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleet
Deletes the specified fleet.
- Parameters:
deleteFleetRequest
-- Returns:
- A Java Future containing the result of the DeleteFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleet
default CompletableFuture<DeleteFleetResponse> deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) Deletes the specified fleet.
This is a convenience which creates an instance of the
DeleteFleetRequest.Builder
avoiding the need to create one manually viaDeleteFleetRequest.builder()
- Parameters:
deleteFleetRequest
- AConsumer
that will call methods onDeleteFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImage
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.
- Parameters:
deleteImageRequest
-- Returns:
- A Java Future containing the result of the DeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImage
default CompletableFuture<DeleteImageResponse> deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest) 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.
This is a convenience which creates an instance of the
DeleteImageRequest.Builder
avoiding the need to create one manually viaDeleteImageRequest.builder()
- Parameters:
deleteImageRequest
- AConsumer
that will call methods onDeleteImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImageBuilder
default CompletableFuture<DeleteImageBuilderResponse> deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest) Deletes the specified image builder and releases the capacity.
- Parameters:
deleteImageBuilderRequest
-- Returns:
- A Java Future containing the result of the DeleteImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImageBuilder
default CompletableFuture<DeleteImageBuilderResponse> deleteImageBuilder(Consumer<DeleteImageBuilderRequest.Builder> deleteImageBuilderRequest) Deletes the specified image builder and releases the capacity.
This is a convenience which creates an instance of the
DeleteImageBuilderRequest.Builder
avoiding the need to create one manually viaDeleteImageBuilderRequest.builder()
- Parameters:
deleteImageBuilderRequest
- AConsumer
that will call methods onDeleteImageBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImagePermissions
default CompletableFuture<DeleteImagePermissionsResponse> deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest) 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.
- Parameters:
deleteImagePermissionsRequest
-- Returns:
- A Java Future containing the result of the DeleteImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImagePermissions
default CompletableFuture<DeleteImagePermissionsResponse> deleteImagePermissions(Consumer<DeleteImagePermissionsRequest.Builder> deleteImagePermissionsRequest) 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.
This is a convenience which creates an instance of the
DeleteImagePermissionsRequest.Builder
avoiding the need to create one manually viaDeleteImagePermissionsRequest.builder()
- Parameters:
deleteImagePermissionsRequest
- AConsumer
that will call methods onDeleteImagePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStack
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.
- Parameters:
deleteStackRequest
-- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStack
default CompletableFuture<DeleteStackResponse> deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) 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.
This is a convenience which creates an instance of the
DeleteStackRequest.Builder
avoiding the need to create one manually viaDeleteStackRequest.builder()
- Parameters:
deleteStackRequest
- AConsumer
that will call methods onDeleteStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUsageReportSubscription
default CompletableFuture<DeleteUsageReportSubscriptionResponse> deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest) Disables usage report generation.
- Parameters:
deleteUsageReportSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteUsageReportSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUsageReportSubscription
default CompletableFuture<DeleteUsageReportSubscriptionResponse> deleteUsageReportSubscription(Consumer<DeleteUsageReportSubscriptionRequest.Builder> deleteUsageReportSubscriptionRequest) Disables usage report generation.
This is a convenience which creates an instance of the
DeleteUsageReportSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteUsageReportSubscriptionRequest.builder()
- Parameters:
deleteUsageReportSubscriptionRequest
- AConsumer
that will call methods onDeleteUsageReportSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUsageReportSubscription operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
Deletes a user from the user pool.
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user from the user pool.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilderAppBlockAssociations
default CompletableFuture<DescribeAppBlockBuilderAppBlockAssociationsResponse> describeAppBlockBuilderAppBlockAssociations(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest) Retrieves a list that describes one or more app block builder associations.
- Parameters:
describeAppBlockBuilderAppBlockAssociationsRequest
-- Returns:
- A Java Future containing the result of the DescribeAppBlockBuilderAppBlockAssociations operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilderAppBlockAssociations
default CompletableFuture<DescribeAppBlockBuilderAppBlockAssociationsResponse> describeAppBlockBuilderAppBlockAssociations(Consumer<DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder> describeAppBlockBuilderAppBlockAssociationsRequest) Retrieves a list that describes one or more app block builder associations.
This is a convenience which creates an instance of the
DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeAppBlockBuilderAppBlockAssociationsRequest.builder()
- Parameters:
describeAppBlockBuilderAppBlockAssociationsRequest
- AConsumer
that will call methods onDescribeAppBlockBuilderAppBlockAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppBlockBuilderAppBlockAssociations operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilderAppBlockAssociationsPaginator
default DescribeAppBlockBuilderAppBlockAssociationsPublisher describeAppBlockBuilderAppBlockAssociationsPaginator(DescribeAppBlockBuilderAppBlockAssociationsRequest describeAppBlockBuilderAppBlockAssociationsRequest) This is a variant of
describeAppBlockBuilderAppBlockAssociations(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuilderAppBlockAssociationsPublisher publisher = client.describeAppBlockBuilderAppBlockAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuilderAppBlockAssociationsPublisher publisher = client.describeAppBlockBuilderAppBlockAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAppBlockBuilderAppBlockAssociations(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsRequest)
operation.- Parameters:
describeAppBlockBuilderAppBlockAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilderAppBlockAssociationsPaginator
default DescribeAppBlockBuilderAppBlockAssociationsPublisher describeAppBlockBuilderAppBlockAssociationsPaginator(Consumer<DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder> describeAppBlockBuilderAppBlockAssociationsRequest) This is a variant of
describeAppBlockBuilderAppBlockAssociations(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuilderAppBlockAssociationsPublisher publisher = client.describeAppBlockBuilderAppBlockAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuilderAppBlockAssociationsPublisher publisher = client.describeAppBlockBuilderAppBlockAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAppBlockBuilderAppBlockAssociations(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAppBlockBuilderAppBlockAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeAppBlockBuilderAppBlockAssociationsRequest.builder()
- Parameters:
describeAppBlockBuilderAppBlockAssociationsRequest
- AConsumer
that will call methods onDescribeAppBlockBuilderAppBlockAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilders
default CompletableFuture<DescribeAppBlockBuildersResponse> describeAppBlockBuilders(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest) Retrieves a list that describes one or more app block builders.
- Parameters:
describeAppBlockBuildersRequest
-- Returns:
- A Java Future containing the result of the DescribeAppBlockBuilders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuilders
default CompletableFuture<DescribeAppBlockBuildersResponse> describeAppBlockBuilders(Consumer<DescribeAppBlockBuildersRequest.Builder> describeAppBlockBuildersRequest) Retrieves a list that describes one or more app block builders.
This is a convenience which creates an instance of the
DescribeAppBlockBuildersRequest.Builder
avoiding the need to create one manually viaDescribeAppBlockBuildersRequest.builder()
- Parameters:
describeAppBlockBuildersRequest
- AConsumer
that will call methods onDescribeAppBlockBuildersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppBlockBuilders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuildersPaginator
default DescribeAppBlockBuildersPublisher describeAppBlockBuildersPaginator(DescribeAppBlockBuildersRequest describeAppBlockBuildersRequest) This is a variant of
describeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuildersPublisher publisher = client.describeAppBlockBuildersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuildersPublisher publisher = client.describeAppBlockBuildersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation.- Parameters:
describeAppBlockBuildersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlockBuildersPaginator
default DescribeAppBlockBuildersPublisher describeAppBlockBuildersPaginator(Consumer<DescribeAppBlockBuildersRequest.Builder> describeAppBlockBuildersRequest) This is a variant of
describeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuildersPublisher publisher = client.describeAppBlockBuildersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeAppBlockBuildersPublisher publisher = client.describeAppBlockBuildersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAppBlockBuilders(software.amazon.awssdk.services.appstream.model.DescribeAppBlockBuildersRequest)
operation.
This is a convenience which creates an instance of the
DescribeAppBlockBuildersRequest.Builder
avoiding the need to create one manually viaDescribeAppBlockBuildersRequest.builder()
- Parameters:
describeAppBlockBuildersRequest
- AConsumer
that will call methods onDescribeAppBlockBuildersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlocks
default CompletableFuture<DescribeAppBlocksResponse> describeAppBlocks(DescribeAppBlocksRequest describeAppBlocksRequest) Retrieves a list that describes one or more app blocks.
- Parameters:
describeAppBlocksRequest
-- Returns:
- A Java Future containing the result of the DescribeAppBlocks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppBlocks
default CompletableFuture<DescribeAppBlocksResponse> describeAppBlocks(Consumer<DescribeAppBlocksRequest.Builder> describeAppBlocksRequest) Retrieves a list that describes one or more app blocks.
This is a convenience which creates an instance of the
DescribeAppBlocksRequest.Builder
avoiding the need to create one manually viaDescribeAppBlocksRequest.builder()
- Parameters:
describeAppBlocksRequest
- AConsumer
that will call methods onDescribeAppBlocksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppBlocks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationFleetAssociations
default CompletableFuture<DescribeApplicationFleetAssociationsResponse> describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest) Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
- Parameters:
describeApplicationFleetAssociationsRequest
-- Returns:
- A Java Future containing the result of the DescribeApplicationFleetAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationFleetAssociations
default CompletableFuture<DescribeApplicationFleetAssociationsResponse> describeApplicationFleetAssociations(Consumer<DescribeApplicationFleetAssociationsRequest.Builder> describeApplicationFleetAssociationsRequest) Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
This is a convenience which creates an instance of the
DescribeApplicationFleetAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationFleetAssociationsRequest.builder()
- Parameters:
describeApplicationFleetAssociationsRequest
- AConsumer
that will call methods onDescribeApplicationFleetAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationFleetAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplications
default CompletableFuture<DescribeApplicationsResponse> describeApplications(DescribeApplicationsRequest describeApplicationsRequest) Retrieves a list that describes one or more applications.
- Parameters:
describeApplicationsRequest
-- Returns:
- A Java Future containing the result of the DescribeApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplications
default CompletableFuture<DescribeApplicationsResponse> describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) Retrieves a list that describes one or more applications.
This is a convenience which creates an instance of the
DescribeApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationsRequest.builder()
- Parameters:
describeApplicationsRequest
- AConsumer
that will call methods onDescribeApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDirectoryConfigs
default CompletableFuture<DescribeDirectoryConfigsResponse> describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest) 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.
- Parameters:
describeDirectoryConfigsRequest
-- Returns:
- A Java Future containing the result of the DescribeDirectoryConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDirectoryConfigs
default CompletableFuture<DescribeDirectoryConfigsResponse> describeDirectoryConfigs(Consumer<DescribeDirectoryConfigsRequest.Builder> describeDirectoryConfigsRequest) 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.
This is a convenience which creates an instance of the
DescribeDirectoryConfigsRequest.Builder
avoiding the need to create one manually viaDescribeDirectoryConfigsRequest.builder()
- Parameters:
describeDirectoryConfigsRequest
- AConsumer
that will call methods onDescribeDirectoryConfigsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDirectoryConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDirectoryConfigs
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.
- Returns:
- A Java Future containing the result of the DescribeDirectoryConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEntitlements
default CompletableFuture<DescribeEntitlementsResponse> describeEntitlements(DescribeEntitlementsRequest describeEntitlementsRequest) Retrieves a list that describes one of more entitlements.
- Parameters:
describeEntitlementsRequest
-- Returns:
- A Java Future containing the result of the DescribeEntitlements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- EntitlementNotFoundException The entitlement can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEntitlements
default CompletableFuture<DescribeEntitlementsResponse> describeEntitlements(Consumer<DescribeEntitlementsRequest.Builder> describeEntitlementsRequest) Retrieves a list that describes one of more entitlements.
This is a convenience which creates an instance of the
DescribeEntitlementsRequest.Builder
avoiding the need to create one manually viaDescribeEntitlementsRequest.builder()
- Parameters:
describeEntitlementsRequest
- AConsumer
that will call methods onDescribeEntitlementsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEntitlements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- EntitlementNotFoundException The entitlement can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleets
default CompletableFuture<DescribeFleetsResponse> describeFleets(DescribeFleetsRequest describeFleetsRequest) Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
- Parameters:
describeFleetsRequest
-- Returns:
- A Java Future containing the result of the DescribeFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleets
default CompletableFuture<DescribeFleetsResponse> describeFleets(Consumer<DescribeFleetsRequest.Builder> describeFleetsRequest) Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
This is a convenience which creates an instance of the
DescribeFleetsRequest.Builder
avoiding the need to create one manually viaDescribeFleetsRequest.builder()
- Parameters:
describeFleetsRequest
- AConsumer
that will call methods onDescribeFleetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleets
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
- Returns:
- A Java Future containing the result of the DescribeFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageBuilders
default CompletableFuture<DescribeImageBuildersResponse> describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest) 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.
- Parameters:
describeImageBuildersRequest
-- Returns:
- A Java Future containing the result of the DescribeImageBuilders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageBuilders
default CompletableFuture<DescribeImageBuildersResponse> describeImageBuilders(Consumer<DescribeImageBuildersRequest.Builder> describeImageBuildersRequest) 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.
This is a convenience which creates an instance of the
DescribeImageBuildersRequest.Builder
avoiding the need to create one manually viaDescribeImageBuildersRequest.builder()
- Parameters:
describeImageBuildersRequest
- AConsumer
that will call methods onDescribeImageBuildersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImageBuilders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageBuilders
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.
- Returns:
- A Java Future containing the result of the DescribeImageBuilders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagePermissions
default CompletableFuture<DescribeImagePermissionsResponse> describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest) Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
- Parameters:
describeImagePermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagePermissions
default CompletableFuture<DescribeImagePermissionsResponse> describeImagePermissions(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
This is a convenience which creates an instance of the
DescribeImagePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeImagePermissionsRequest.builder()
- Parameters:
describeImagePermissionsRequest
- AConsumer
that will call methods onDescribeImagePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagePermissionsPaginator
default DescribeImagePermissionsPublisher describeImagePermissionsPaginator(DescribeImagePermissionsRequest describeImagePermissionsRequest) This is a variant of
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsPublisher publisher = client.describeImagePermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsPublisher publisher = client.describeImagePermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.- Parameters:
describeImagePermissionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagePermissionsPaginator
default DescribeImagePermissionsPublisher describeImagePermissionsPaginator(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) This is a variant of
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsPublisher publisher = client.describeImagePermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsPublisher publisher = client.describeImagePermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeImagePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeImagePermissionsRequest.builder()
- Parameters:
describeImagePermissionsRequest
- AConsumer
that will call methods onDescribeImagePermissionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(DescribeImagesRequest describeImagesRequest) 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.
- Parameters:
describeImagesRequest
-- Returns:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) 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.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImages
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.
- Returns:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagesPaginator
This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(DescribeImagesRequest describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.- Parameters:
describeImagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appstream.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appstream.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)
operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSessions
default CompletableFuture<DescribeSessionsResponse> describeSessions(DescribeSessionsRequest describeSessionsRequest) 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.
- Parameters:
describeSessionsRequest
-- Returns:
- A Java Future containing the result of the DescribeSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSessions
default CompletableFuture<DescribeSessionsResponse> describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest) 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.
This is a convenience which creates an instance of the
DescribeSessionsRequest.Builder
avoiding the need to create one manually viaDescribeSessionsRequest.builder()
- Parameters:
describeSessionsRequest
- AConsumer
that will call methods onDescribeSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStacks
default CompletableFuture<DescribeStacksResponse> describeStacks(DescribeStacksRequest describeStacksRequest) Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
- Parameters:
describeStacksRequest
-- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStacks
default CompletableFuture<DescribeStacksResponse> describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
This is a convenience which creates an instance of the
DescribeStacksRequest.Builder
avoiding the need to create one manually viaDescribeStacksRequest.builder()
- Parameters:
describeStacksRequest
- AConsumer
that will call methods onDescribeStacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeStacks
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsageReportSubscriptions
default CompletableFuture<DescribeUsageReportSubscriptionsResponse> describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest) Retrieves a list that describes one or more usage report subscriptions.
- Parameters:
describeUsageReportSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeUsageReportSubscriptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsageReportSubscriptions
default CompletableFuture<DescribeUsageReportSubscriptionsResponse> describeUsageReportSubscriptions(Consumer<DescribeUsageReportSubscriptionsRequest.Builder> describeUsageReportSubscriptionsRequest) Retrieves a list that describes one or more usage report subscriptions.
This is a convenience which creates an instance of the
DescribeUsageReportSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeUsageReportSubscriptionsRequest.builder()
- Parameters:
describeUsageReportSubscriptionsRequest
- AConsumer
that will call methods onDescribeUsageReportSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUsageReportSubscriptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUserStackAssociations
default CompletableFuture<DescribeUserStackAssociationsResponse> describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest) 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
- Parameters:
describeUserStackAssociationsRequest
-- Returns:
- A Java Future containing the result of the DescribeUserStackAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeUserStackAssociations
default CompletableFuture<DescribeUserStackAssociationsResponse> describeUserStackAssociations(Consumer<DescribeUserStackAssociationsRequest.Builder> describeUserStackAssociationsRequest) 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
This is a convenience which creates an instance of the
DescribeUserStackAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeUserStackAssociationsRequest.builder()
- Parameters:
describeUserStackAssociationsRequest
- AConsumer
that will call methods onDescribeUserStackAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUserStackAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeUsers
default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest) Retrieves a list that describes one or more specified users in the user pool.
- Parameters:
describeUsersRequest
-- Returns:
- A Java Future containing the result of the DescribeUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsers
default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Retrieves a list that describes one or more specified users in the user pool.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableUser
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.
- Parameters:
disableUserRequest
-- Returns:
- A Java Future containing the result of the DisableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableUser
default CompletableFuture<DisableUserResponse> disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) 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.
This is a convenience which creates an instance of the
DisableUserRequest.Builder
avoiding the need to create one manually viaDisableUserRequest.builder()
- Parameters:
disableUserRequest
- AConsumer
that will call methods onDisableUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateAppBlockBuilderAppBlock
default CompletableFuture<DisassociateAppBlockBuilderAppBlockResponse> disassociateAppBlockBuilderAppBlock(DisassociateAppBlockBuilderAppBlockRequest disassociateAppBlockBuilderAppBlockRequest) Disassociates a specified app block builder from a specified app block.
- Parameters:
disassociateAppBlockBuilderAppBlockRequest
-- Returns:
- A Java Future containing the result of the DisassociateAppBlockBuilderAppBlock operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateAppBlockBuilderAppBlock
default CompletableFuture<DisassociateAppBlockBuilderAppBlockResponse> disassociateAppBlockBuilderAppBlock(Consumer<DisassociateAppBlockBuilderAppBlockRequest.Builder> disassociateAppBlockBuilderAppBlockRequest) Disassociates a specified app block builder from a specified app block.
This is a convenience which creates an instance of the
DisassociateAppBlockBuilderAppBlockRequest.Builder
avoiding the need to create one manually viaDisassociateAppBlockBuilderAppBlockRequest.builder()
- Parameters:
disassociateAppBlockBuilderAppBlockRequest
- AConsumer
that will call methods onDisassociateAppBlockBuilderAppBlockRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateAppBlockBuilderAppBlock operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateApplicationFleet
default CompletableFuture<DisassociateApplicationFleetResponse> disassociateApplicationFleet(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest) Disassociates the specified application from the fleet.
- Parameters:
disassociateApplicationFleetRequest
-- Returns:
- A Java Future containing the result of the DisassociateApplicationFleet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateApplicationFleet
default CompletableFuture<DisassociateApplicationFleetResponse> disassociateApplicationFleet(Consumer<DisassociateApplicationFleetRequest.Builder> disassociateApplicationFleetRequest) Disassociates the specified application from the fleet.
This is a convenience which creates an instance of the
DisassociateApplicationFleetRequest.Builder
avoiding the need to create one manually viaDisassociateApplicationFleetRequest.builder()
- Parameters:
disassociateApplicationFleetRequest
- AConsumer
that will call methods onDisassociateApplicationFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateApplicationFleet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateApplicationFromEntitlement
default CompletableFuture<DisassociateApplicationFromEntitlementResponse> disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest) Deletes the specified application from the specified entitlement.
- Parameters:
disassociateApplicationFromEntitlementRequest
-- Returns:
- A Java Future containing the result of the DisassociateApplicationFromEntitlement operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateApplicationFromEntitlement
default CompletableFuture<DisassociateApplicationFromEntitlementResponse> disassociateApplicationFromEntitlement(Consumer<DisassociateApplicationFromEntitlementRequest.Builder> disassociateApplicationFromEntitlementRequest) Deletes the specified application from the specified entitlement.
This is a convenience which creates an instance of the
DisassociateApplicationFromEntitlementRequest.Builder
avoiding the need to create one manually viaDisassociateApplicationFromEntitlementRequest.builder()
- Parameters:
disassociateApplicationFromEntitlementRequest
- AConsumer
that will call methods onDisassociateApplicationFromEntitlementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateApplicationFromEntitlement operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFleet
default CompletableFuture<DisassociateFleetResponse> disassociateFleet(DisassociateFleetRequest disassociateFleetRequest) Disassociates the specified fleet from the specified stack.
- Parameters:
disassociateFleetRequest
-- Returns:
- A Java Future containing the result of the DisassociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateFleet
default CompletableFuture<DisassociateFleetResponse> disassociateFleet(Consumer<DisassociateFleetRequest.Builder> disassociateFleetRequest) Disassociates the specified fleet from the specified stack.
This is a convenience which creates an instance of the
DisassociateFleetRequest.Builder
avoiding the need to create one manually viaDisassociateFleetRequest.builder()
- Parameters:
disassociateFleetRequest
- AConsumer
that will call methods onDisassociateFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableUser
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.
- Parameters:
enableUserRequest
-- Returns:
- A Java Future containing the result of the EnableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableUser
default CompletableFuture<EnableUserResponse> enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest) 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.
This is a convenience which creates an instance of the
EnableUserRequest.Builder
avoiding the need to create one manually viaEnableUserRequest.builder()
- Parameters:
enableUserRequest
- AConsumer
that will call methods onEnableUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
expireSession
default CompletableFuture<ExpireSessionResponse> expireSession(ExpireSessionRequest expireSessionRequest) Immediately stops the specified streaming session.
- Parameters:
expireSessionRequest
-- Returns:
- A Java Future containing the result of the ExpireSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
expireSession
default CompletableFuture<ExpireSessionResponse> expireSession(Consumer<ExpireSessionRequest.Builder> expireSessionRequest) Immediately stops the specified streaming session.
This is a convenience which creates an instance of the
ExpireSessionRequest.Builder
avoiding the need to create one manually viaExpireSessionRequest.builder()
- Parameters:
expireSessionRequest
- AConsumer
that will call methods onExpireSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExpireSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedFleets
default CompletableFuture<ListAssociatedFleetsResponse> listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest) Retrieves the name of the fleet that is associated with the specified stack.
- Parameters:
listAssociatedFleetsRequest
-- Returns:
- A Java Future containing the result of the ListAssociatedFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedFleets
default CompletableFuture<ListAssociatedFleetsResponse> listAssociatedFleets(Consumer<ListAssociatedFleetsRequest.Builder> listAssociatedFleetsRequest) Retrieves the name of the fleet that is associated with the specified stack.
This is a convenience which creates an instance of the
ListAssociatedFleetsRequest.Builder
avoiding the need to create one manually viaListAssociatedFleetsRequest.builder()
- Parameters:
listAssociatedFleetsRequest
- AConsumer
that will call methods onListAssociatedFleetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAssociatedFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedStacks
default CompletableFuture<ListAssociatedStacksResponse> listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest) Retrieves the name of the stack with which the specified fleet is associated.
- Parameters:
listAssociatedStacksRequest
-- Returns:
- A Java Future containing the result of the ListAssociatedStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssociatedStacks
default CompletableFuture<ListAssociatedStacksResponse> listAssociatedStacks(Consumer<ListAssociatedStacksRequest.Builder> listAssociatedStacksRequest) Retrieves the name of the stack with which the specified fleet is associated.
This is a convenience which creates an instance of the
ListAssociatedStacksRequest.Builder
avoiding the need to create one manually viaListAssociatedStacksRequest.builder()
- Parameters:
listAssociatedStacksRequest
- AConsumer
that will call methods onListAssociatedStacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAssociatedStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEntitledApplications
default CompletableFuture<ListEntitledApplicationsResponse> listEntitledApplications(ListEntitledApplicationsRequest listEntitledApplicationsRequest) Retrieves a list of entitled applications.
- Parameters:
listEntitledApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListEntitledApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- EntitlementNotFoundException The entitlement can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEntitledApplications
default CompletableFuture<ListEntitledApplicationsResponse> listEntitledApplications(Consumer<ListEntitledApplicationsRequest.Builder> listEntitledApplicationsRequest) Retrieves a list of entitled applications.
This is a convenience which creates an instance of the
ListEntitledApplicationsRequest.Builder
avoiding the need to create one manually viaListEntitledApplicationsRequest.builder()
- Parameters:
listEntitledApplicationsRequest
- AConsumer
that will call methods onListEntitledApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEntitledApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- EntitlementNotFoundException The entitlement can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAppBlockBuilder
default CompletableFuture<StartAppBlockBuilderResponse> startAppBlockBuilder(StartAppBlockBuilderRequest startAppBlockBuilderRequest) Starts an app block builder.
An app block builder can only be started when it's associated with an app block.
Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
- Parameters:
startAppBlockBuilderRequest
-- Returns:
- A Java Future containing the result of the StartAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- LimitExceededException The requested limit exceeds the permitted limit for an account.
- OperationNotPermittedException The attempted operation is not permitted.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAppBlockBuilder
default CompletableFuture<StartAppBlockBuilderResponse> startAppBlockBuilder(Consumer<StartAppBlockBuilderRequest.Builder> startAppBlockBuilderRequest) Starts an app block builder.
An app block builder can only be started when it's associated with an app block.
Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
This is a convenience which creates an instance of the
StartAppBlockBuilderRequest.Builder
avoiding the need to create one manually viaStartAppBlockBuilderRequest.builder()
- Parameters:
startAppBlockBuilderRequest
- AConsumer
that will call methods onStartAppBlockBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- LimitExceededException The requested limit exceeds the permitted limit for an account.
- OperationNotPermittedException The attempted operation is not permitted.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFleet
Starts the specified fleet.
- Parameters:
startFleetRequest
-- Returns:
- A Java Future containing the result of the StartFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFleet
default CompletableFuture<StartFleetResponse> startFleet(Consumer<StartFleetRequest.Builder> startFleetRequest) Starts the specified fleet.
This is a convenience which creates an instance of the
StartFleetRequest.Builder
avoiding the need to create one manually viaStartFleetRequest.builder()
- Parameters:
startFleetRequest
- AConsumer
that will call methods onStartFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImageBuilder
default CompletableFuture<StartImageBuilderResponse> startImageBuilder(StartImageBuilderRequest startImageBuilderRequest) Starts the specified image builder.
- Parameters:
startImageBuilderRequest
-- Returns:
- A Java Future containing the result of the StartImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImageBuilder
default CompletableFuture<StartImageBuilderResponse> startImageBuilder(Consumer<StartImageBuilderRequest.Builder> startImageBuilderRequest) Starts the specified image builder.
This is a convenience which creates an instance of the
StartImageBuilderRequest.Builder
avoiding the need to create one manually viaStartImageBuilderRequest.builder()
- Parameters:
startImageBuilderRequest
- AConsumer
that will call methods onStartImageBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAppBlockBuilder
default CompletableFuture<StopAppBlockBuilderResponse> stopAppBlockBuilder(StopAppBlockBuilderRequest stopAppBlockBuilderRequest) Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
- Parameters:
stopAppBlockBuilderRequest
-- Returns:
- A Java Future containing the result of the StopAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAppBlockBuilder
default CompletableFuture<StopAppBlockBuilderResponse> stopAppBlockBuilder(Consumer<StopAppBlockBuilderRequest.Builder> stopAppBlockBuilderRequest) Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
This is a convenience which creates an instance of the
StopAppBlockBuilderRequest.Builder
avoiding the need to create one manually viaStopAppBlockBuilderRequest.builder()
- Parameters:
stopAppBlockBuilderRequest
- AConsumer
that will call methods onStopAppBlockBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- OperationNotPermittedException The attempted operation is not permitted.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopFleet
Stops the specified fleet.
- Parameters:
stopFleetRequest
-- Returns:
- A Java Future containing the result of the StopFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopFleet
default CompletableFuture<StopFleetResponse> stopFleet(Consumer<StopFleetRequest.Builder> stopFleetRequest) Stops the specified fleet.
This is a convenience which creates an instance of the
StopFleetRequest.Builder
avoiding the need to create one manually viaStopFleetRequest.builder()
- Parameters:
stopFleetRequest
- AConsumer
that will call methods onStopFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopImageBuilder
default CompletableFuture<StopImageBuilderResponse> stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest) Stops the specified image builder.
- Parameters:
stopImageBuilderRequest
-- Returns:
- A Java Future containing the result of the StopImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopImageBuilder
default CompletableFuture<StopImageBuilderResponse> stopImageBuilder(Consumer<StopImageBuilderRequest.Builder> stopImageBuilderRequest) Stops the specified image builder.
This is a convenience which creates an instance of the
StopImageBuilderRequest.Builder
avoiding the need to create one manually viaStopImageBuilderRequest.builder()
- Parameters:
stopImageBuilderRequest
- AConsumer
that will call methods onStopImageBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopImageBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) 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.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppBlockBuilder
default CompletableFuture<UpdateAppBlockBuilderResponse> updateAppBlockBuilder(UpdateAppBlockBuilderRequest updateAppBlockBuilderRequest) Updates an app block builder.
If the app block builder is in the
STARTING
orSTOPPING
state, you can't update it. If the app block builder is in theRUNNING
state, you can only update the DisplayName and Description. If the app block builder is in theSTOPPED
state, you can update any attribute except the Name.- Parameters:
updateAppBlockBuilderRequest
-- Returns:
- A Java Future containing the result of the UpdateAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- InvalidRoleException The specified role is invalid.
- LimitExceededException The requested limit exceeds the permitted limit for an account.
- OperationNotPermittedException The attempted operation is not permitted.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- ResourceInUseException The specified resource is in use.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppBlockBuilder
default CompletableFuture<UpdateAppBlockBuilderResponse> updateAppBlockBuilder(Consumer<UpdateAppBlockBuilderRequest.Builder> updateAppBlockBuilderRequest) Updates an app block builder.
If the app block builder is in the
STARTING
orSTOPPING
state, you can't update it. If the app block builder is in theRUNNING
state, you can only update the DisplayName and Description. If the app block builder is in theSTOPPED
state, you can update any attribute except the Name.
This is a convenience which creates an instance of the
UpdateAppBlockBuilderRequest.Builder
avoiding the need to create one manually viaUpdateAppBlockBuilderRequest.builder()
- Parameters:
updateAppBlockBuilderRequest
- AConsumer
that will call methods onUpdateAppBlockBuilderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAppBlockBuilder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
- InvalidAccountStatusException The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
- InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
- InvalidRoleException The specified role is invalid.
- LimitExceededException The requested limit exceeds the permitted limit for an account.
- OperationNotPermittedException The attempted operation is not permitted.
- RequestLimitExceededException AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
- ResourceInUseException The specified resource is in use.
- ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates the specified application.
- Parameters:
updateApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates the specified application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDirectoryConfig
default CompletableFuture<UpdateDirectoryConfigResponse> updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest) 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.
- Parameters:
updateDirectoryConfigRequest
-- Returns:
- A Java Future containing the result of the UpdateDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDirectoryConfig
default CompletableFuture<UpdateDirectoryConfigResponse> updateDirectoryConfig(Consumer<UpdateDirectoryConfigRequest.Builder> updateDirectoryConfigRequest) 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.
This is a convenience which creates an instance of the
UpdateDirectoryConfigRequest.Builder
avoiding the need to create one manually viaUpdateDirectoryConfigRequest.builder()
- Parameters:
updateDirectoryConfigRequest
- AConsumer
that will call methods onUpdateDirectoryConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDirectoryConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEntitlement
default CompletableFuture<UpdateEntitlementResponse> updateEntitlement(UpdateEntitlementRequest updateEntitlementRequest) Updates the specified entitlement.
- Parameters:
updateEntitlementRequest
-- Returns:
- A Java Future containing the result of the UpdateEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEntitlement
default CompletableFuture<UpdateEntitlementResponse> updateEntitlement(Consumer<UpdateEntitlementRequest.Builder> updateEntitlementRequest) Updates the specified entitlement.
This is a convenience which creates an instance of the
UpdateEntitlementRequest.Builder
avoiding the need to create one manually viaUpdateEntitlementRequest.builder()
- Parameters:
updateEntitlementRequest
- AConsumer
that will call methods onUpdateEntitlementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEntitlement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFleet
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
, andDisconnectTimeoutInSeconds
attributes. -
Elastic fleet type
You can update the
DisplayName
,IdleDisconnectTimeoutInSeconds
,DisconnectTimeoutInSeconds
,MaxConcurrentSessions
,SessionScriptS3Location
andUsbDeviceFilterStrings
attributes.
If the fleet is in the
STARTING
orSTOPPED
state, you can't update it.- Parameters:
updateFleetRequest
-- Returns:
- A Java Future containing the result of the UpdateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateFleet
default CompletableFuture<UpdateFleetResponse> updateFleet(Consumer<UpdateFleetRequest.Builder> updateFleetRequest) 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
, andDisconnectTimeoutInSeconds
attributes. -
Elastic fleet type
You can update the
DisplayName
,IdleDisconnectTimeoutInSeconds
,DisconnectTimeoutInSeconds
,MaxConcurrentSessions
,SessionScriptS3Location
andUsbDeviceFilterStrings
attributes.
If the fleet is in the
STARTING
orSTOPPED
state, you can't update it.
This is a convenience which creates an instance of the
UpdateFleetRequest.Builder
avoiding the need to create one manually viaUpdateFleetRequest.builder()
- Parameters:
updateFleetRequest
- AConsumer
that will call methods onUpdateFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateImagePermissions
default CompletableFuture<UpdateImagePermissionsResponse> updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest) Adds or updates permissions for the specified private image.
- Parameters:
updateImagePermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateImagePermissions
default CompletableFuture<UpdateImagePermissionsResponse> updateImagePermissions(Consumer<UpdateImagePermissionsRequest.Builder> updateImagePermissionsRequest) Adds or updates permissions for the specified private image.
This is a convenience which creates an instance of the
UpdateImagePermissionsRequest.Builder
avoiding the need to create one manually viaUpdateImagePermissionsRequest.builder()
- Parameters:
updateImagePermissionsRequest
- AConsumer
that will call methods onUpdateImagePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateImagePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStack
Updates the specified fields for the specified stack.
- Parameters:
updateStackRequest
-- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStack
default CompletableFuture<UpdateStackResponse> updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates the specified fields for the specified stack.
This is a convenience which creates an instance of the
UpdateStackRequest.Builder
avoiding the need to create one manually viaUpdateStackRequest.builder()
- Parameters:
updateStackRequest
- AConsumer
that will call methods onUpdateStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofAppStreamAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AppStreamAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAppStreamAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAppStreamAsyncClient
.
-