software.amazon.awssdk.services.appstream.AppStreamClient Maven / Gradle / Ivy
Show all versions of appstream Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.appstream;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.appstream.model.AppStreamException;
import software.amazon.awssdk.services.appstream.model.AssociateFleetRequest;
import software.amazon.awssdk.services.appstream.model.AssociateFleetResponse;
import software.amazon.awssdk.services.appstream.model.BatchAssociateUserStackRequest;
import software.amazon.awssdk.services.appstream.model.BatchAssociateUserStackResponse;
import software.amazon.awssdk.services.appstream.model.BatchDisassociateUserStackRequest;
import software.amazon.awssdk.services.appstream.model.BatchDisassociateUserStackResponse;
import software.amazon.awssdk.services.appstream.model.ConcurrentModificationException;
import software.amazon.awssdk.services.appstream.model.CopyImageRequest;
import software.amazon.awssdk.services.appstream.model.CopyImageResponse;
import software.amazon.awssdk.services.appstream.model.CreateDirectoryConfigRequest;
import software.amazon.awssdk.services.appstream.model.CreateDirectoryConfigResponse;
import software.amazon.awssdk.services.appstream.model.CreateFleetRequest;
import software.amazon.awssdk.services.appstream.model.CreateFleetResponse;
import software.amazon.awssdk.services.appstream.model.CreateImageBuilderRequest;
import software.amazon.awssdk.services.appstream.model.CreateImageBuilderResponse;
import software.amazon.awssdk.services.appstream.model.CreateImageBuilderStreamingUrlRequest;
import software.amazon.awssdk.services.appstream.model.CreateImageBuilderStreamingUrlResponse;
import software.amazon.awssdk.services.appstream.model.CreateStackRequest;
import software.amazon.awssdk.services.appstream.model.CreateStackResponse;
import software.amazon.awssdk.services.appstream.model.CreateStreamingUrlRequest;
import software.amazon.awssdk.services.appstream.model.CreateStreamingUrlResponse;
import software.amazon.awssdk.services.appstream.model.CreateUsageReportSubscriptionRequest;
import software.amazon.awssdk.services.appstream.model.CreateUsageReportSubscriptionResponse;
import software.amazon.awssdk.services.appstream.model.CreateUserRequest;
import software.amazon.awssdk.services.appstream.model.CreateUserResponse;
import software.amazon.awssdk.services.appstream.model.DeleteDirectoryConfigRequest;
import software.amazon.awssdk.services.appstream.model.DeleteDirectoryConfigResponse;
import software.amazon.awssdk.services.appstream.model.DeleteFleetRequest;
import software.amazon.awssdk.services.appstream.model.DeleteFleetResponse;
import software.amazon.awssdk.services.appstream.model.DeleteImageBuilderRequest;
import software.amazon.awssdk.services.appstream.model.DeleteImageBuilderResponse;
import software.amazon.awssdk.services.appstream.model.DeleteImagePermissionsRequest;
import software.amazon.awssdk.services.appstream.model.DeleteImagePermissionsResponse;
import software.amazon.awssdk.services.appstream.model.DeleteImageRequest;
import software.amazon.awssdk.services.appstream.model.DeleteImageResponse;
import software.amazon.awssdk.services.appstream.model.DeleteStackRequest;
import software.amazon.awssdk.services.appstream.model.DeleteStackResponse;
import software.amazon.awssdk.services.appstream.model.DeleteUsageReportSubscriptionRequest;
import software.amazon.awssdk.services.appstream.model.DeleteUsageReportSubscriptionResponse;
import software.amazon.awssdk.services.appstream.model.DeleteUserRequest;
import software.amazon.awssdk.services.appstream.model.DeleteUserResponse;
import software.amazon.awssdk.services.appstream.model.DescribeDirectoryConfigsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeDirectoryConfigsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeFleetsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeFleetsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeImageBuildersRequest;
import software.amazon.awssdk.services.appstream.model.DescribeImageBuildersResponse;
import software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeImagesRequest;
import software.amazon.awssdk.services.appstream.model.DescribeImagesResponse;
import software.amazon.awssdk.services.appstream.model.DescribeSessionsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeSessionsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeStacksRequest;
import software.amazon.awssdk.services.appstream.model.DescribeStacksResponse;
import software.amazon.awssdk.services.appstream.model.DescribeUsageReportSubscriptionsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeUsageReportSubscriptionsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeUserStackAssociationsRequest;
import software.amazon.awssdk.services.appstream.model.DescribeUserStackAssociationsResponse;
import software.amazon.awssdk.services.appstream.model.DescribeUsersRequest;
import software.amazon.awssdk.services.appstream.model.DescribeUsersResponse;
import software.amazon.awssdk.services.appstream.model.DisableUserRequest;
import software.amazon.awssdk.services.appstream.model.DisableUserResponse;
import software.amazon.awssdk.services.appstream.model.DisassociateFleetRequest;
import software.amazon.awssdk.services.appstream.model.DisassociateFleetResponse;
import software.amazon.awssdk.services.appstream.model.EnableUserRequest;
import software.amazon.awssdk.services.appstream.model.EnableUserResponse;
import software.amazon.awssdk.services.appstream.model.ExpireSessionRequest;
import software.amazon.awssdk.services.appstream.model.ExpireSessionResponse;
import software.amazon.awssdk.services.appstream.model.IncompatibleImageException;
import software.amazon.awssdk.services.appstream.model.InvalidAccountStatusException;
import software.amazon.awssdk.services.appstream.model.InvalidParameterCombinationException;
import software.amazon.awssdk.services.appstream.model.InvalidRoleException;
import software.amazon.awssdk.services.appstream.model.LimitExceededException;
import software.amazon.awssdk.services.appstream.model.ListAssociatedFleetsRequest;
import software.amazon.awssdk.services.appstream.model.ListAssociatedFleetsResponse;
import software.amazon.awssdk.services.appstream.model.ListAssociatedStacksRequest;
import software.amazon.awssdk.services.appstream.model.ListAssociatedStacksResponse;
import software.amazon.awssdk.services.appstream.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.appstream.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.appstream.model.OperationNotPermittedException;
import software.amazon.awssdk.services.appstream.model.RequestLimitExceededException;
import software.amazon.awssdk.services.appstream.model.ResourceAlreadyExistsException;
import software.amazon.awssdk.services.appstream.model.ResourceInUseException;
import software.amazon.awssdk.services.appstream.model.ResourceNotAvailableException;
import software.amazon.awssdk.services.appstream.model.ResourceNotFoundException;
import software.amazon.awssdk.services.appstream.model.StartFleetRequest;
import software.amazon.awssdk.services.appstream.model.StartFleetResponse;
import software.amazon.awssdk.services.appstream.model.StartImageBuilderRequest;
import software.amazon.awssdk.services.appstream.model.StartImageBuilderResponse;
import software.amazon.awssdk.services.appstream.model.StopFleetRequest;
import software.amazon.awssdk.services.appstream.model.StopFleetResponse;
import software.amazon.awssdk.services.appstream.model.StopImageBuilderRequest;
import software.amazon.awssdk.services.appstream.model.StopImageBuilderResponse;
import software.amazon.awssdk.services.appstream.model.TagResourceRequest;
import software.amazon.awssdk.services.appstream.model.TagResourceResponse;
import software.amazon.awssdk.services.appstream.model.UntagResourceRequest;
import software.amazon.awssdk.services.appstream.model.UntagResourceResponse;
import software.amazon.awssdk.services.appstream.model.UpdateDirectoryConfigRequest;
import software.amazon.awssdk.services.appstream.model.UpdateDirectoryConfigResponse;
import software.amazon.awssdk.services.appstream.model.UpdateFleetRequest;
import software.amazon.awssdk.services.appstream.model.UpdateFleetResponse;
import software.amazon.awssdk.services.appstream.model.UpdateImagePermissionsRequest;
import software.amazon.awssdk.services.appstream.model.UpdateImagePermissionsResponse;
import software.amazon.awssdk.services.appstream.model.UpdateStackRequest;
import software.amazon.awssdk.services.appstream.model.UpdateStackResponse;
import software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable;
import software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable;
import software.amazon.awssdk.services.appstream.waiters.AppStreamWaiter;
/**
* Service client for accessing Amazon AppStream. This can be created using the static {@link #builder()} method.
*
* Amazon AppStream 2.0
*
* This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each
* of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming
* service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the
* AWS resources that are required to host and run your applications, scales automatically, and provides access to your
* users on demand.
*
*
*
* You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more
* information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon
* AppStream 2.0 Administration Guide.
*
*
*
* To learn more about AppStream 2.0, see the following resources:
*
*
* -
*
*
* -
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface AppStreamClient extends SdkClient {
String SERVICE_NAME = "appstream";
/**
* Create a {@link AppStreamClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static AppStreamClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link AppStreamClient}.
*/
static AppStreamClientBuilder builder() {
return new DefaultAppStreamClientBuilder();
}
/**
*
* Associates the specified fleet with the specified stack.
*
*
* @param associateFleetRequest
* @return Result of the AssociateFleet operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.AssociateFleet
* @see AWS API
* Documentation
*/
default AssociateFleetResponse associateFleet(AssociateFleetRequest associateFleetRequest) throws LimitExceededException,
InvalidAccountStatusException, ResourceNotFoundException, ConcurrentModificationException,
IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Associates the specified fleet with the specified stack.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateFleetRequest.Builder} avoiding the need to
* create one manually via {@link AssociateFleetRequest#builder()}
*
*
* @param associateFleetRequest
* A {@link Consumer} that will call methods on {@link AssociateFleetRequest.Builder} to create a request.
* @return Result of the AssociateFleet operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.AssociateFleet
* @see AWS API
* Documentation
*/
default AssociateFleetResponse associateFleet(Consumer associateFleetRequest)
throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException,
ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException,
SdkClientException, AppStreamException {
return associateFleet(AssociateFleetRequest.builder().applyMutation(associateFleetRequest).build());
}
/**
*
* 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.
*
*
* @param batchAssociateUserStackRequest
* @return Result of the BatchAssociateUserStack operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.BatchAssociateUserStack
* @see AWS API Documentation
*/
default BatchAssociateUserStackResponse batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)
throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchAssociateUserStackRequest.Builder} avoiding
* the need to create one manually via {@link BatchAssociateUserStackRequest#builder()}
*
*
* @param batchAssociateUserStackRequest
* A {@link Consumer} that will call methods on {@link BatchAssociateUserStackRequest.Builder} to create a
* request.
* @return Result of the BatchAssociateUserStack operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.BatchAssociateUserStack
* @see AWS API Documentation
*/
default BatchAssociateUserStackResponse batchAssociateUserStack(
Consumer batchAssociateUserStackRequest)
throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
AppStreamException {
return batchAssociateUserStack(BatchAssociateUserStackRequest.builder().applyMutation(batchAssociateUserStackRequest)
.build());
}
/**
*
* Disassociates the specified users from the specified stacks.
*
*
* @param batchDisassociateUserStackRequest
* @return Result of the BatchDisassociateUserStack operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.BatchDisassociateUserStack
* @see AWS API Documentation
*/
default BatchDisassociateUserStackResponse batchDisassociateUserStack(
BatchDisassociateUserStackRequest batchDisassociateUserStackRequest) throws OperationNotPermittedException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates the specified users from the specified stacks.
*
*
*
* This is a convenience which creates an instance of the {@link BatchDisassociateUserStackRequest.Builder} avoiding
* the need to create one manually via {@link BatchDisassociateUserStackRequest#builder()}
*
*
* @param batchDisassociateUserStackRequest
* A {@link Consumer} that will call methods on {@link BatchDisassociateUserStackRequest.Builder} to create a
* request.
* @return Result of the BatchDisassociateUserStack operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.BatchDisassociateUserStack
* @see AWS API Documentation
*/
default BatchDisassociateUserStackResponse batchDisassociateUserStack(
Consumer batchDisassociateUserStackRequest)
throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
AppStreamException {
return batchDisassociateUserStack(BatchDisassociateUserStackRequest.builder()
.applyMutation(batchDisassociateUserStackRequest).build());
}
/**
*
* 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.
*
*
* @param copyImageRequest
* @return Result of the CopyImage operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CopyImage
* @see AWS API
* Documentation
*/
default CopyImageResponse copyImage(CopyImageRequest copyImageRequest) throws ResourceAlreadyExistsException,
ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, InvalidAccountStatusException,
IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CopyImageRequest.Builder} avoiding the need to
* create one manually via {@link CopyImageRequest#builder()}
*
*
* @param copyImageRequest
* A {@link Consumer} that will call methods on {@link CopyImageRequest.Builder} to create a request.
* @return Result of the CopyImage operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CopyImage
* @see AWS API
* Documentation
*/
default CopyImageResponse copyImage(Consumer copyImageRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, ResourceNotAvailableException,
LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, AwsServiceException,
SdkClientException, AppStreamException {
return copyImage(CopyImageRequest.builder().applyMutation(copyImageRequest).build());
}
/**
*
* 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.
*
*
* @param createDirectoryConfigRequest
* @return Result of the CreateDirectoryConfig operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateDirectoryConfig
* @see AWS API Documentation
*/
default CreateDirectoryConfigResponse createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException,
InvalidAccountStatusException, OperationNotPermittedException, InvalidRoleException, AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDirectoryConfigRequest.Builder} avoiding the
* need to create one manually via {@link CreateDirectoryConfigRequest#builder()}
*
*
* @param createDirectoryConfigRequest
* A {@link Consumer} that will call methods on {@link CreateDirectoryConfigRequest.Builder} to create a
* request.
* @return Result of the CreateDirectoryConfig operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateDirectoryConfig
* @see AWS API Documentation
*/
default CreateDirectoryConfigResponse createDirectoryConfig(
Consumer createDirectoryConfigRequest) throws ResourceNotFoundException,
ResourceAlreadyExistsException, LimitExceededException, InvalidAccountStatusException,
OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException {
return createDirectoryConfig(CreateDirectoryConfigRequest.builder().applyMutation(createDirectoryConfigRequest).build());
}
/**
*
* Creates a fleet. A fleet consists of streaming instances that run a specified image.
*
*
* @param createFleetRequest
* @return Result of the CreateFleet operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateFleet
* @see AWS API
* Documentation
*/
default CreateFleetResponse createFleet(CreateFleetRequest createFleetRequest) throws ResourceAlreadyExistsException,
ResourceNotAvailableException, ResourceNotFoundException, LimitExceededException, RequestLimitExceededException,
InvalidAccountStatusException, InvalidRoleException, ConcurrentModificationException,
InvalidParameterCombinationException, IncompatibleImageException, OperationNotPermittedException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a fleet. A fleet consists of streaming instances that run a specified image.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFleetRequest.Builder} avoiding the need to
* create one manually via {@link CreateFleetRequest#builder()}
*
*
* @param createFleetRequest
* A {@link Consumer} that will call methods on {@link CreateFleetRequest.Builder} to create a request.
* @return Result of the CreateFleet operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateFleet
* @see AWS API
* Documentation
*/
default CreateFleetResponse createFleet(Consumer createFleetRequest)
throws ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException,
LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException,
ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
return createFleet(CreateFleetRequest.builder().applyMutation(createFleetRequest).build());
}
/**
*
* Creates an image builder. An image builder is a virtual machine that is used to create an image.
*
*
* The initial state of the builder is PENDING
. When it is ready, the state is RUNNING
.
*
*
* @param createImageBuilderRequest
* @return Result of the CreateImageBuilder operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateImageBuilder
* @see AWS
* API Documentation
*/
default CreateImageBuilderResponse createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
throws LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException,
ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, InvalidRoleException,
ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an image builder. An image builder is a virtual machine that is used to create an image.
*
*
* The initial state of the builder is PENDING
. When it is ready, the state is RUNNING
.
*
*
*
* This is a convenience which creates an instance of the {@link CreateImageBuilderRequest.Builder} avoiding the
* need to create one manually via {@link CreateImageBuilderRequest#builder()}
*
*
* @param createImageBuilderRequest
* A {@link Consumer} that will call methods on {@link CreateImageBuilderRequest.Builder} to create a
* request.
* @return Result of the CreateImageBuilder operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateImageBuilder
* @see AWS
* API Documentation
*/
default CreateImageBuilderResponse createImageBuilder(Consumer createImageBuilderRequest)
throws LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException,
ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, InvalidRoleException,
ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
return createImageBuilder(CreateImageBuilderRequest.builder().applyMutation(createImageBuilderRequest).build());
}
/**
*
* Creates a URL to start an image builder streaming session.
*
*
* @param createImageBuilderStreamingUrlRequest
* @return Result of the CreateImageBuilderStreamingURL operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateImageBuilderStreamingURL
* @see AWS API Documentation
*/
default CreateImageBuilderStreamingUrlResponse createImageBuilderStreamingURL(
CreateImageBuilderStreamingUrlRequest createImageBuilderStreamingUrlRequest) throws OperationNotPermittedException,
ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a URL to start an image builder streaming session.
*
*
*
* This is a convenience which creates an instance of the {@link CreateImageBuilderStreamingUrlRequest.Builder}
* avoiding the need to create one manually via {@link CreateImageBuilderStreamingUrlRequest#builder()}
*
*
* @param createImageBuilderStreamingUrlRequest
* A {@link Consumer} that will call methods on {@link CreateImageBuilderStreamingURLRequest.Builder} to
* create a request.
* @return Result of the CreateImageBuilderStreamingURL operation returned by the service.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateImageBuilderStreamingURL
* @see AWS API Documentation
*/
default CreateImageBuilderStreamingUrlResponse createImageBuilderStreamingURL(
Consumer createImageBuilderStreamingUrlRequest)
throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return createImageBuilderStreamingURL(CreateImageBuilderStreamingUrlRequest.builder()
.applyMutation(createImageBuilderStreamingUrlRequest).build());
}
/**
*
* Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access
* policies, and storage configurations.
*
*
* @param createStackRequest
* @return Result of the CreateStack operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateStack
* @see AWS API
* Documentation
*/
default CreateStackResponse createStack(CreateStackRequest createStackRequest) throws LimitExceededException,
InvalidAccountStatusException, ResourceAlreadyExistsException, ConcurrentModificationException, InvalidRoleException,
ResourceNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateStackRequest.Builder} avoiding the need to
* create one manually via {@link CreateStackRequest#builder()}
*
*
* @param createStackRequest
* A {@link Consumer} that will call methods on {@link CreateStackRequest.Builder} to create a request.
* @return Result of the CreateStack operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateStack
* @see AWS API
* Documentation
*/
default CreateStackResponse createStack(Consumer createStackRequest)
throws LimitExceededException, InvalidAccountStatusException, ResourceAlreadyExistsException,
ConcurrentModificationException, InvalidRoleException, ResourceNotFoundException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
return createStack(CreateStackRequest.builder().applyMutation(createStackRequest).build());
}
/**
*
* 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.
*
*
* @param createStreamingUrlRequest
* @return Result of the CreateStreamingURL operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateStreamingURL
* @see AWS
* API Documentation
*/
default CreateStreamingUrlResponse createStreamingURL(CreateStreamingUrlRequest createStreamingUrlRequest)
throws ResourceNotFoundException, ResourceNotAvailableException, OperationNotPermittedException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateStreamingUrlRequest.Builder} avoiding the
* need to create one manually via {@link CreateStreamingUrlRequest#builder()}
*
*
* @param createStreamingUrlRequest
* A {@link Consumer} that will call methods on {@link CreateStreamingURLRequest.Builder} to create a
* request.
* @return Result of the CreateStreamingURL operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateStreamingURL
* @see AWS
* API Documentation
*/
default CreateStreamingUrlResponse createStreamingURL(Consumer createStreamingUrlRequest)
throws ResourceNotFoundException, ResourceNotAvailableException, OperationNotPermittedException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
return createStreamingURL(CreateStreamingUrlRequest.builder().applyMutation(createStreamingUrlRequest).build());
}
/**
*
* Creates a usage report subscription. Usage reports are generated daily.
*
*
* @param createUsageReportSubscriptionRequest
* @return Result of the CreateUsageReportSubscription operation returned by the service.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateUsageReportSubscription
* @see AWS API Documentation
*/
default CreateUsageReportSubscriptionResponse createUsageReportSubscription(
CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest) throws InvalidRoleException,
InvalidAccountStatusException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a usage report subscription. Usage reports are generated daily.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUsageReportSubscriptionRequest.Builder}
* avoiding the need to create one manually via {@link CreateUsageReportSubscriptionRequest#builder()}
*
*
* @param createUsageReportSubscriptionRequest
* A {@link Consumer} that will call methods on {@link CreateUsageReportSubscriptionRequest.Builder} to
* create a request.
* @return Result of the CreateUsageReportSubscription operation returned by the service.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateUsageReportSubscription
* @see AWS API Documentation
*/
default CreateUsageReportSubscriptionResponse createUsageReportSubscription(
Consumer createUsageReportSubscriptionRequest)
throws InvalidRoleException, InvalidAccountStatusException, LimitExceededException, AwsServiceException,
SdkClientException, AppStreamException {
return createUsageReportSubscription(CreateUsageReportSubscriptionRequest.builder()
.applyMutation(createUsageReportSubscriptionRequest).build());
}
/**
*
* Creates a new user in the user pool.
*
*
* @param createUserRequest
* @return Result of the CreateUser operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceAlreadyExistsException,
InvalidAccountStatusException, InvalidParameterCombinationException, LimitExceededException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new user in the user pool.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUserRequest.Builder} avoiding the need to
* create one manually via {@link CreateUserRequest#builder()}
*
*
* @param createUserRequest
* A {@link Consumer} that will call methods on {@link CreateUserRequest.Builder} to create a request.
* @return Result of the CreateUser operation returned by the service.
* @throws ResourceAlreadyExistsException
* The specified resource already exists.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(Consumer createUserRequest)
throws ResourceAlreadyExistsException, InvalidAccountStatusException, InvalidParameterCombinationException,
LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
return createUser(CreateUserRequest.builder().applyMutation(createUserRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDirectoryConfigRequest
* @return Result of the DeleteDirectoryConfig operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteDirectoryConfig
* @see AWS API Documentation
*/
default DeleteDirectoryConfigResponse deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDirectoryConfigRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDirectoryConfigRequest#builder()}
*
*
* @param deleteDirectoryConfigRequest
* A {@link Consumer} that will call methods on {@link DeleteDirectoryConfigRequest.Builder} to create a
* request.
* @return Result of the DeleteDirectoryConfig operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteDirectoryConfig
* @see AWS API Documentation
*/
default DeleteDirectoryConfigResponse deleteDirectoryConfig(
Consumer deleteDirectoryConfigRequest) throws ResourceInUseException,
ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return deleteDirectoryConfig(DeleteDirectoryConfigRequest.builder().applyMutation(deleteDirectoryConfigRequest).build());
}
/**
*
* Deletes the specified fleet.
*
*
* @param deleteFleetRequest
* @return Result of the DeleteFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteFleet
* @see AWS API
* Documentation
*/
default DeleteFleetResponse deleteFleet(DeleteFleetRequest deleteFleetRequest) throws ResourceInUseException,
ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified fleet.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteFleetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteFleetRequest#builder()}
*
*
* @param deleteFleetRequest
* A {@link Consumer} that will call methods on {@link DeleteFleetRequest.Builder} to create a request.
* @return Result of the DeleteFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteFleet
* @see AWS API
* Documentation
*/
default DeleteFleetResponse deleteFleet(Consumer deleteFleetRequest)
throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException,
SdkClientException, AppStreamException {
return deleteFleet(DeleteFleetRequest.builder().applyMutation(deleteFleetRequest).build());
}
/**
*
* 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.
*
*
* @param deleteImageRequest
* @return Result of the DeleteImage operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImage
* @see AWS API
* Documentation
*/
default DeleteImageResponse deleteImage(DeleteImageRequest deleteImageRequest) throws ResourceInUseException,
ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteImageRequest.Builder} avoiding the need to
* create one manually via {@link DeleteImageRequest#builder()}
*
*
* @param deleteImageRequest
* A {@link Consumer} that will call methods on {@link DeleteImageRequest.Builder} to create a request.
* @return Result of the DeleteImage operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImage
* @see AWS API
* Documentation
*/
default DeleteImageResponse deleteImage(Consumer deleteImageRequest)
throws ResourceInUseException, ResourceNotFoundException, OperationNotPermittedException,
ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException {
return deleteImage(DeleteImageRequest.builder().applyMutation(deleteImageRequest).build());
}
/**
*
* Deletes the specified image builder and releases the capacity.
*
*
* @param deleteImageBuilderRequest
* @return Result of the DeleteImageBuilder operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImageBuilder
* @see AWS
* API Documentation
*/
default DeleteImageBuilderResponse deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified image builder and releases the capacity.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteImageBuilderRequest.Builder} avoiding the
* need to create one manually via {@link DeleteImageBuilderRequest#builder()}
*
*
* @param deleteImageBuilderRequest
* A {@link Consumer} that will call methods on {@link DeleteImageBuilderRequest.Builder} to create a
* request.
* @return Result of the DeleteImageBuilder operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImageBuilder
* @see AWS
* API Documentation
*/
default DeleteImageBuilderResponse deleteImageBuilder(Consumer deleteImageBuilderRequest)
throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException,
AwsServiceException, SdkClientException, AppStreamException {
return deleteImageBuilder(DeleteImageBuilderRequest.builder().applyMutation(deleteImageBuilderRequest).build());
}
/**
*
* 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.
*
*
* @param deleteImagePermissionsRequest
* @return Result of the DeleteImagePermissions operation returned by the service.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImagePermissions
* @see AWS API Documentation
*/
default DeleteImagePermissionsResponse deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)
throws ResourceNotAvailableException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteImagePermissionsRequest.Builder} avoiding the
* need to create one manually via {@link DeleteImagePermissionsRequest#builder()}
*
*
* @param deleteImagePermissionsRequest
* A {@link Consumer} that will call methods on {@link DeleteImagePermissionsRequest.Builder} to create a
* request.
* @return Result of the DeleteImagePermissions operation returned by the service.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteImagePermissions
* @see AWS API Documentation
*/
default DeleteImagePermissionsResponse deleteImagePermissions(
Consumer deleteImagePermissionsRequest) throws ResourceNotAvailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return deleteImagePermissions(DeleteImagePermissionsRequest.builder().applyMutation(deleteImagePermissionsRequest)
.build());
}
/**
*
* 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.
*
*
* @param deleteStackRequest
* @return Result of the DeleteStack operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteStack
* @see AWS API
* Documentation
*/
default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws ResourceInUseException,
ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteStackRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStackRequest#builder()}
*
*
* @param deleteStackRequest
* A {@link Consumer} that will call methods on {@link DeleteStackRequest.Builder} to create a request.
* @return Result of the DeleteStack operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteStack
* @see AWS API
* Documentation
*/
default DeleteStackResponse deleteStack(Consumer deleteStackRequest)
throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException,
SdkClientException, AppStreamException {
return deleteStack(DeleteStackRequest.builder().applyMutation(deleteStackRequest).build());
}
/**
*
* Disables usage report generation.
*
*
* @param deleteUsageReportSubscriptionRequest
* @return Result of the DeleteUsageReportSubscription operation returned by the service.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteUsageReportSubscription
* @see AWS API Documentation
*/
default DeleteUsageReportSubscriptionResponse deleteUsageReportSubscription(
DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest) throws InvalidAccountStatusException,
ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Disables usage report generation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUsageReportSubscriptionRequest.Builder}
* avoiding the need to create one manually via {@link DeleteUsageReportSubscriptionRequest#builder()}
*
*
* @param deleteUsageReportSubscriptionRequest
* A {@link Consumer} that will call methods on {@link DeleteUsageReportSubscriptionRequest.Builder} to
* create a request.
* @return Result of the DeleteUsageReportSubscription operation returned by the service.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteUsageReportSubscription
* @see AWS API Documentation
*/
default DeleteUsageReportSubscriptionResponse deleteUsageReportSubscription(
Consumer deleteUsageReportSubscriptionRequest)
throws InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest.builder()
.applyMutation(deleteUsageReportSubscriptionRequest).build());
}
/**
*
* Deletes a user from the user pool.
*
*
* @param deleteUserRequest
* @return Result of the DeleteUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a user from the user pool.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUserRequest.Builder} avoiding the need to
* create one manually via {@link DeleteUserRequest#builder()}
*
*
* @param deleteUserRequest
* A {@link Consumer} that will call methods on {@link DeleteUserRequest.Builder} to create a request.
* @return Result of the DeleteUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(Consumer deleteUserRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return deleteUser(DeleteUserRequest.builder().applyMutation(deleteUserRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeDirectoryConfigs operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeDirectoryConfigs
* @see #describeDirectoryConfigs(DescribeDirectoryConfigsRequest)
* @see AWS API Documentation
*/
default DescribeDirectoryConfigsResponse describeDirectoryConfigs() throws ResourceNotFoundException, AwsServiceException,
SdkClientException, AppStreamException {
return describeDirectoryConfigs(DescribeDirectoryConfigsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeDirectoryConfigsRequest
* @return Result of the DescribeDirectoryConfigs operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeDirectoryConfigs
* @see AWS API Documentation
*/
default DescribeDirectoryConfigsResponse describeDirectoryConfigs(
DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDirectoryConfigsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDirectoryConfigsRequest#builder()}
*
*
* @param describeDirectoryConfigsRequest
* A {@link Consumer} that will call methods on {@link DescribeDirectoryConfigsRequest.Builder} to create a
* request.
* @return Result of the DescribeDirectoryConfigs operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeDirectoryConfigs
* @see AWS API Documentation
*/
default DescribeDirectoryConfigsResponse describeDirectoryConfigs(
Consumer describeDirectoryConfigsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return describeDirectoryConfigs(DescribeDirectoryConfigsRequest.builder().applyMutation(describeDirectoryConfigsRequest)
.build());
}
/**
*
* Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all
* fleets in the account are described.
*
*
* @return Result of the DescribeFleets operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeFleets
* @see #describeFleets(DescribeFleetsRequest)
* @see AWS API
* Documentation
*/
default DescribeFleetsResponse describeFleets() throws ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return describeFleets(DescribeFleetsRequest.builder().build());
}
/**
*
* Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all
* fleets in the account are described.
*
*
* @param describeFleetsRequest
* @return Result of the DescribeFleets operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeFleets
* @see AWS API
* Documentation
*/
default DescribeFleetsResponse describeFleets(DescribeFleetsRequest describeFleetsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeFleetsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeFleetsRequest#builder()}
*
*
* @param describeFleetsRequest
* A {@link Consumer} that will call methods on {@link DescribeFleetsRequest.Builder} to create a request.
* @return Result of the DescribeFleets operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeFleets
* @see AWS API
* Documentation
*/
default DescribeFleetsResponse describeFleets(Consumer describeFleetsRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return describeFleets(DescribeFleetsRequest.builder().applyMutation(describeFleetsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeImageBuilders operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImageBuilders
* @see #describeImageBuilders(DescribeImageBuildersRequest)
* @see AWS API Documentation
*/
default DescribeImageBuildersResponse describeImageBuilders() throws ResourceNotFoundException, AwsServiceException,
SdkClientException, AppStreamException {
return describeImageBuilders(DescribeImageBuildersRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeImageBuildersRequest
* @return Result of the DescribeImageBuilders operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImageBuilders
* @see AWS API Documentation
*/
default DescribeImageBuildersResponse describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeImageBuildersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeImageBuildersRequest#builder()}
*
*
* @param describeImageBuildersRequest
* A {@link Consumer} that will call methods on {@link DescribeImageBuildersRequest.Builder} to create a
* request.
* @return Result of the DescribeImageBuilders operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImageBuilders
* @see AWS API Documentation
*/
default DescribeImageBuildersResponse describeImageBuilders(
Consumer describeImageBuildersRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return describeImageBuilders(DescribeImageBuildersRequest.builder().applyMutation(describeImageBuildersRequest).build());
}
/**
*
* Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
*
*
* @param describeImagePermissionsRequest
* @return Result of the DescribeImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImagePermissions
* @see AWS API Documentation
*/
default DescribeImagePermissionsResponse describeImagePermissions(
DescribeImagePermissionsRequest describeImagePermissionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeImagePermissionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeImagePermissionsRequest#builder()}
*
*
* @param describeImagePermissionsRequest
* A {@link Consumer} that will call methods on {@link DescribeImagePermissionsRequest.Builder} to create a
* request.
* @return Result of the DescribeImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImagePermissions
* @see AWS API Documentation
*/
default DescribeImagePermissionsResponse describeImagePermissions(
Consumer describeImagePermissionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return describeImagePermissions(DescribeImagePermissionsRequest.builder().applyMutation(describeImagePermissionsRequest)
.build());
}
/**
*
* Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
*
*
*
* This is a variant of
* {@link #describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client
* .describeImagePermissionsPaginator(request);
* for (software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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
* {@link #describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)}
* operation.
*
*
* @param describeImagePermissionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImagePermissions
* @see AWS API Documentation
*/
default DescribeImagePermissionsIterable describeImagePermissionsPaginator(
DescribeImagePermissionsRequest describeImagePermissionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
*
*
*
* This is a variant of
* {@link #describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client
* .describeImagePermissionsPaginator(request);
* for (software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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
* {@link #describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeImagePermissionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeImagePermissionsRequest#builder()}
*
*
* @param describeImagePermissionsRequest
* A {@link Consumer} that will call methods on {@link DescribeImagePermissionsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImagePermissions
* @see AWS API Documentation
*/
default DescribeImagePermissionsIterable describeImagePermissionsPaginator(
Consumer describeImagePermissionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return describeImagePermissionsPaginator(DescribeImagePermissionsRequest.builder()
.applyMutation(describeImagePermissionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeImages operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see #describeImages(DescribeImagesRequest)
* @see AWS API
* Documentation
*/
default DescribeImagesResponse describeImages() throws InvalidParameterCombinationException, ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return describeImages(DescribeImagesRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeImagesRequest
* @return Result of the DescribeImages operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see AWS API
* Documentation
*/
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest)
throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeImagesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeImagesRequest#builder()}
*
*
* @param describeImagesRequest
* A {@link Consumer} that will call methods on {@link DescribeImagesRequest.Builder} to create a request.
* @return Result of the DescribeImages operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see AWS API
* Documentation
*/
default DescribeImagesResponse describeImages(Consumer describeImagesRequest)
throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return describeImages(DescribeImagesRequest.builder().applyMutation(describeImagesRequest).build());
}
/**
*
* 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 variant of
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
* .describeImagesPaginator(request);
* for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see #describeImagesPaginator(DescribeImagesRequest)
* @see AWS API
* Documentation
*/
default DescribeImagesIterable describeImagesPaginator() throws InvalidParameterCombinationException,
ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return describeImagesPaginator(DescribeImagesRequest.builder().build());
}
/**
*
* 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 variant of
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
* .describeImagesPaginator(request);
* for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation.
*
*
* @param describeImagesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see AWS API
* Documentation
*/
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest)
throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 variant of
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
* .describeImagesPaginator(request);
* for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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
* {@link #describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeImagesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeImagesRequest#builder()}
*
*
* @param describeImagesRequest
* A {@link Consumer} that will call methods on {@link DescribeImagesRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeImages
* @see AWS API
* Documentation
*/
default DescribeImagesIterable describeImagesPaginator(Consumer describeImagesRequest)
throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return describeImagesPaginator(DescribeImagesRequest.builder().applyMutation(describeImagesRequest).build());
}
/**
*
* 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.
*
*
* @param describeSessionsRequest
* @return Result of the DescribeSessions operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeSessions
* @see AWS API
* Documentation
*/
default DescribeSessionsResponse describeSessions(DescribeSessionsRequest describeSessionsRequest)
throws InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeSessionsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeSessionsRequest#builder()}
*
*
* @param describeSessionsRequest
* A {@link Consumer} that will call methods on {@link DescribeSessionsRequest.Builder} to create a request.
* @return Result of the DescribeSessions operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeSessions
* @see AWS API
* Documentation
*/
default DescribeSessionsResponse describeSessions(Consumer describeSessionsRequest)
throws InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
return describeSessions(DescribeSessionsRequest.builder().applyMutation(describeSessionsRequest).build());
}
/**
*
* Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all
* stacks in the account are described.
*
*
* @return Result of the DescribeStacks operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeStacks
* @see #describeStacks(DescribeStacksRequest)
* @see AWS API
* Documentation
*/
default DescribeStacksResponse describeStacks() throws ResourceNotFoundException, AwsServiceException, SdkClientException,
AppStreamException {
return describeStacks(DescribeStacksRequest.builder().build());
}
/**
*
* Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all
* stacks in the account are described.
*
*
* @param describeStacksRequest
* @return Result of the DescribeStacks operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeStacks
* @see AWS API
* Documentation
*/
default DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStacksRequest.Builder} avoiding the need to
* create one manually via {@link DescribeStacksRequest#builder()}
*
*
* @param describeStacksRequest
* A {@link Consumer} that will call methods on {@link DescribeStacksRequest.Builder} to create a request.
* @return Result of the DescribeStacks operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeStacks
* @see AWS API
* Documentation
*/
default DescribeStacksResponse describeStacks(Consumer describeStacksRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return describeStacks(DescribeStacksRequest.builder().applyMutation(describeStacksRequest).build());
}
/**
*
* Retrieves a list that describes one or more usage report subscriptions.
*
*
* @param describeUsageReportSubscriptionsRequest
* @return Result of the DescribeUsageReportSubscriptions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUsageReportSubscriptions
* @see AWS API Documentation
*/
default DescribeUsageReportSubscriptionsResponse describeUsageReportSubscriptions(
DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest) throws ResourceNotFoundException,
InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes one or more usage report subscriptions.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUsageReportSubscriptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeUsageReportSubscriptionsRequest#builder()}
*
*
* @param describeUsageReportSubscriptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeUsageReportSubscriptionsRequest.Builder} to
* create a request.
* @return Result of the DescribeUsageReportSubscriptions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUsageReportSubscriptions
* @see AWS API Documentation
*/
default DescribeUsageReportSubscriptionsResponse describeUsageReportSubscriptions(
Consumer describeUsageReportSubscriptionsRequest)
throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException,
AppStreamException {
return describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest.builder()
.applyMutation(describeUsageReportSubscriptionsRequest).build());
}
/**
*
* 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
*
*
*
*
* @param describeUserStackAssociationsRequest
* @return Result of the DescribeUserStackAssociations operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUserStackAssociations
* @see AWS API Documentation
*/
default DescribeUserStackAssociationsResponse describeUserStackAssociations(
DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)
throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeUserStackAssociationsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeUserStackAssociationsRequest#builder()}
*
*
* @param describeUserStackAssociationsRequest
* A {@link Consumer} that will call methods on {@link DescribeUserStackAssociationsRequest.Builder} to
* create a request.
* @return Result of the DescribeUserStackAssociations operation returned by the service.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUserStackAssociations
* @see AWS API Documentation
*/
default DescribeUserStackAssociationsResponse describeUserStackAssociations(
Consumer describeUserStackAssociationsRequest)
throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException,
AppStreamException {
return describeUserStackAssociations(DescribeUserStackAssociationsRequest.builder()
.applyMutation(describeUserStackAssociationsRequest).build());
}
/**
*
* Retrieves a list that describes one or more specified users in the user pool.
*
*
* @param describeUsersRequest
* @return Result of the DescribeUsers operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUsers
* @see AWS API
* Documentation
*/
default DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws ResourceNotFoundException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list that describes one or more specified users in the user pool.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUsersRequest.Builder} avoiding the need to
* create one manually via {@link DescribeUsersRequest#builder()}
*
*
* @param describeUsersRequest
* A {@link Consumer} that will call methods on {@link DescribeUsersRequest.Builder} to create a request.
* @return Result of the DescribeUsers operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DescribeUsers
* @see AWS API
* Documentation
*/
default DescribeUsersResponse describeUsers(Consumer describeUsersRequest)
throws ResourceNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
AppStreamException {
return describeUsers(DescribeUsersRequest.builder().applyMutation(describeUsersRequest).build());
}
/**
*
* 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.
*
*
* @param disableUserRequest
* @return Result of the DisableUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DisableUser
* @see AWS API
* Documentation
*/
default DisableUserResponse disableUser(DisableUserRequest disableUserRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisableUserRequest.Builder} avoiding the need to
* create one manually via {@link DisableUserRequest#builder()}
*
*
* @param disableUserRequest
* A {@link Consumer} that will call methods on {@link DisableUserRequest.Builder} to create a request.
* @return Result of the DisableUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DisableUser
* @see AWS API
* Documentation
*/
default DisableUserResponse disableUser(Consumer disableUserRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return disableUser(DisableUserRequest.builder().applyMutation(disableUserRequest).build());
}
/**
*
* Disassociates the specified fleet from the specified stack.
*
*
* @param disassociateFleetRequest
* @return Result of the DisassociateFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DisassociateFleet
* @see AWS
* API Documentation
*/
default DisassociateFleetResponse disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates the specified fleet from the specified stack.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateFleetRequest.Builder} avoiding the need
* to create one manually via {@link DisassociateFleetRequest#builder()}
*
*
* @param disassociateFleetRequest
* A {@link Consumer} that will call methods on {@link DisassociateFleetRequest.Builder} to create a request.
* @return Result of the DisassociateFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.DisassociateFleet
* @see AWS
* API Documentation
*/
default DisassociateFleetResponse disassociateFleet(Consumer disassociateFleetRequest)
throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException,
OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException {
return disassociateFleet(DisassociateFleetRequest.builder().applyMutation(disassociateFleetRequest).build());
}
/**
*
* 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.
*
*
* @param enableUserRequest
* @return Result of the EnableUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.EnableUser
* @see AWS API
* Documentation
*/
default EnableUserResponse enableUser(EnableUserRequest enableUserRequest) throws ResourceNotFoundException,
InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link EnableUserRequest.Builder} avoiding the need to
* create one manually via {@link EnableUserRequest#builder()}
*
*
* @param enableUserRequest
* A {@link Consumer} that will call methods on {@link EnableUserRequest.Builder} to create a request.
* @return Result of the EnableUser operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.EnableUser
* @see AWS API
* Documentation
*/
default EnableUserResponse enableUser(Consumer enableUserRequest)
throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException,
AppStreamException {
return enableUser(EnableUserRequest.builder().applyMutation(enableUserRequest).build());
}
/**
*
* Immediately stops the specified streaming session.
*
*
* @param expireSessionRequest
* @return Result of the ExpireSession operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ExpireSession
* @see AWS API
* Documentation
*/
default ExpireSessionResponse expireSession(ExpireSessionRequest expireSessionRequest) throws AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Immediately stops the specified streaming session.
*
*
*
* This is a convenience which creates an instance of the {@link ExpireSessionRequest.Builder} avoiding the need to
* create one manually via {@link ExpireSessionRequest#builder()}
*
*
* @param expireSessionRequest
* A {@link Consumer} that will call methods on {@link ExpireSessionRequest.Builder} to create a request.
* @return Result of the ExpireSession operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ExpireSession
* @see AWS API
* Documentation
*/
default ExpireSessionResponse expireSession(Consumer expireSessionRequest)
throws AwsServiceException, SdkClientException, AppStreamException {
return expireSession(ExpireSessionRequest.builder().applyMutation(expireSessionRequest).build());
}
/**
*
* Retrieves the name of the fleet that is associated with the specified stack.
*
*
* @param listAssociatedFleetsRequest
* @return Result of the ListAssociatedFleets operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListAssociatedFleets
* @see AWS
* API Documentation
*/
default ListAssociatedFleetsResponse listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
throws AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the name of the fleet that is associated with the specified stack.
*
*
*
* This is a convenience which creates an instance of the {@link ListAssociatedFleetsRequest.Builder} avoiding the
* need to create one manually via {@link ListAssociatedFleetsRequest#builder()}
*
*
* @param listAssociatedFleetsRequest
* A {@link Consumer} that will call methods on {@link ListAssociatedFleetsRequest.Builder} to create a
* request.
* @return Result of the ListAssociatedFleets operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListAssociatedFleets
* @see AWS
* API Documentation
*/
default ListAssociatedFleetsResponse listAssociatedFleets(
Consumer listAssociatedFleetsRequest) throws AwsServiceException,
SdkClientException, AppStreamException {
return listAssociatedFleets(ListAssociatedFleetsRequest.builder().applyMutation(listAssociatedFleetsRequest).build());
}
/**
*
* Retrieves the name of the stack with which the specified fleet is associated.
*
*
* @param listAssociatedStacksRequest
* @return Result of the ListAssociatedStacks operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListAssociatedStacks
* @see AWS
* API Documentation
*/
default ListAssociatedStacksResponse listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
throws AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the name of the stack with which the specified fleet is associated.
*
*
*
* This is a convenience which creates an instance of the {@link ListAssociatedStacksRequest.Builder} avoiding the
* need to create one manually via {@link ListAssociatedStacksRequest#builder()}
*
*
* @param listAssociatedStacksRequest
* A {@link Consumer} that will call methods on {@link ListAssociatedStacksRequest.Builder} to create a
* request.
* @return Result of the ListAssociatedStacks operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListAssociatedStacks
* @see AWS
* API Documentation
*/
default ListAssociatedStacksResponse listAssociatedStacks(
Consumer listAssociatedStacksRequest) throws AwsServiceException,
SdkClientException, AppStreamException {
return listAssociatedStacks(ListAssociatedStacksRequest.builder().applyMutation(listAssociatedStacksRequest).build());
}
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Starts the specified fleet.
*
*
* @param startFleetRequest
* @return Result of the StartFleet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StartFleet
* @see AWS API
* Documentation
*/
default StartFleetResponse startFleet(StartFleetRequest startFleetRequest) throws ResourceNotFoundException,
OperationNotPermittedException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException,
ConcurrentModificationException, ResourceNotAvailableException, InvalidRoleException, AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Starts the specified fleet.
*
*
*
* This is a convenience which creates an instance of the {@link StartFleetRequest.Builder} avoiding the need to
* create one manually via {@link StartFleetRequest#builder()}
*
*
* @param startFleetRequest
* A {@link Consumer} that will call methods on {@link StartFleetRequest.Builder} to create a request.
* @return Result of the StartFleet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StartFleet
* @see AWS API
* Documentation
*/
default StartFleetResponse startFleet(Consumer startFleetRequest)
throws ResourceNotFoundException, OperationNotPermittedException, LimitExceededException,
RequestLimitExceededException, InvalidAccountStatusException, ConcurrentModificationException,
ResourceNotAvailableException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException {
return startFleet(StartFleetRequest.builder().applyMutation(startFleetRequest).build());
}
/**
*
* Starts the specified image builder.
*
*
* @param startImageBuilderRequest
* @return Result of the StartImageBuilder operation returned by the service.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StartImageBuilder
* @see AWS
* API Documentation
*/
default StartImageBuilderResponse startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
throws ResourceNotAvailableException, ResourceNotFoundException, ConcurrentModificationException,
InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException,
AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Starts the specified image builder.
*
*
*
* This is a convenience which creates an instance of the {@link StartImageBuilderRequest.Builder} avoiding the need
* to create one manually via {@link StartImageBuilderRequest#builder()}
*
*
* @param startImageBuilderRequest
* A {@link Consumer} that will call methods on {@link StartImageBuilderRequest.Builder} to create a request.
* @return Result of the StartImageBuilder operation returned by the service.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StartImageBuilder
* @see AWS
* API Documentation
*/
default StartImageBuilderResponse startImageBuilder(Consumer startImageBuilderRequest)
throws ResourceNotAvailableException, ResourceNotFoundException, ConcurrentModificationException,
InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException,
AppStreamException {
return startImageBuilder(StartImageBuilderRequest.builder().applyMutation(startImageBuilderRequest).build());
}
/**
*
* Stops the specified fleet.
*
*
* @param stopFleetRequest
* @return Result of the StopFleet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StopFleet
* @see AWS API
* Documentation
*/
default StopFleetResponse stopFleet(StopFleetRequest stopFleetRequest) throws ResourceNotFoundException,
ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Stops the specified fleet.
*
*
*
* This is a convenience which creates an instance of the {@link StopFleetRequest.Builder} avoiding the need to
* create one manually via {@link StopFleetRequest#builder()}
*
*
* @param stopFleetRequest
* A {@link Consumer} that will call methods on {@link StopFleetRequest.Builder} to create a request.
* @return Result of the StopFleet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StopFleet
* @see AWS API
* Documentation
*/
default StopFleetResponse stopFleet(Consumer stopFleetRequest) throws ResourceNotFoundException,
ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException {
return stopFleet(StopFleetRequest.builder().applyMutation(stopFleetRequest).build());
}
/**
*
* Stops the specified image builder.
*
*
* @param stopImageBuilderRequest
* @return Result of the StopImageBuilder operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StopImageBuilder
* @see AWS API
* Documentation
*/
default StopImageBuilderResponse stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Stops the specified image builder.
*
*
*
* This is a convenience which creates an instance of the {@link StopImageBuilderRequest.Builder} avoiding the need
* to create one manually via {@link StopImageBuilderRequest#builder()}
*
*
* @param stopImageBuilderRequest
* A {@link Consumer} that will call methods on {@link StopImageBuilderRequest.Builder} to create a request.
* @return Result of the StopImageBuilder operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.StopImageBuilder
* @see AWS API
* Documentation
*/
default StopImageBuilderResponse stopImageBuilder(Consumer stopImageBuilderRequest)
throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException,
AwsServiceException, SdkClientException, AppStreamException {
return stopImageBuilder(StopImageBuilderRequest.builder().applyMutation(stopImageBuilderRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws LimitExceededException,
InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException,
SdkClientException, AppStreamException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param updateDirectoryConfigRequest
* @return Result of the UpdateDirectoryConfig operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateDirectoryConfig
* @see AWS API Documentation
*/
default UpdateDirectoryConfigResponse updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException,
OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateDirectoryConfigRequest.Builder} avoiding the
* need to create one manually via {@link UpdateDirectoryConfigRequest#builder()}
*
*
* @param updateDirectoryConfigRequest
* A {@link Consumer} that will call methods on {@link UpdateDirectoryConfigRequest.Builder} to create a
* request.
* @return Result of the UpdateDirectoryConfig operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateDirectoryConfig
* @see AWS API Documentation
*/
default UpdateDirectoryConfigResponse updateDirectoryConfig(
Consumer updateDirectoryConfigRequest) throws ResourceInUseException,
ResourceNotFoundException, ConcurrentModificationException, OperationNotPermittedException, InvalidRoleException,
AwsServiceException, SdkClientException, AppStreamException {
return updateDirectoryConfig(UpdateDirectoryConfigRequest.builder().applyMutation(updateDirectoryConfigRequest).build());
}
/**
*
* Updates the specified fleet.
*
*
* If the fleet is in the STOPPED
state, you can update any attribute except the fleet name. If the
* fleet is in the RUNNING
state, you can update the DisplayName
,
* ComputeCapacity
, ImageARN
, ImageName
,
* IdleDisconnectTimeoutInSeconds
, and DisconnectTimeoutInSeconds
attributes. If the fleet
* is in the STARTING
or STOPPING
state, you can't update it.
*
*
* @param updateFleetRequest
* @return Result of the UpdateFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateFleet
* @see AWS API
* Documentation
*/
default UpdateFleetResponse updateFleet(UpdateFleetRequest updateFleetRequest) throws ResourceInUseException,
LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException,
ResourceNotFoundException, ResourceNotAvailableException, InvalidParameterCombinationException,
ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified fleet.
*
*
* If the fleet is in the STOPPED
state, you can update any attribute except the fleet name. If the
* fleet is in the RUNNING
state, you can update the DisplayName
,
* ComputeCapacity
, ImageARN
, ImageName
,
* IdleDisconnectTimeoutInSeconds
, and DisconnectTimeoutInSeconds
attributes. If the fleet
* is in the STARTING
or STOPPING
state, you can't update it.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateFleetRequest.Builder} avoiding the need to
* create one manually via {@link UpdateFleetRequest#builder()}
*
*
* @param updateFleetRequest
* A {@link Consumer} that will call methods on {@link UpdateFleetRequest.Builder} to create a request.
* @return Result of the UpdateFleet operation returned by the service.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws 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.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateFleet
* @see AWS API
* Documentation
*/
default UpdateFleetResponse updateFleet(Consumer updateFleetRequest)
throws ResourceInUseException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException,
InvalidRoleException, ResourceNotFoundException, ResourceNotAvailableException, InvalidParameterCombinationException,
ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException,
SdkClientException, AppStreamException {
return updateFleet(UpdateFleetRequest.builder().applyMutation(updateFleetRequest).build());
}
/**
*
* Adds or updates permissions for the specified private image.
*
*
* @param updateImagePermissionsRequest
* @return Result of the UpdateImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateImagePermissions
* @see AWS API Documentation
*/
default UpdateImagePermissionsResponse updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)
throws ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, AwsServiceException,
SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Adds or updates permissions for the specified private image.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateImagePermissionsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateImagePermissionsRequest#builder()}
*
*
* @param updateImagePermissionsRequest
* A {@link Consumer} that will call methods on {@link UpdateImagePermissionsRequest.Builder} to create a
* request.
* @return Result of the UpdateImagePermissions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceNotAvailableException
* The specified resource exists and is not in use, but isn't available.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateImagePermissions
* @see AWS API Documentation
*/
default UpdateImagePermissionsResponse updateImagePermissions(
Consumer updateImagePermissionsRequest) throws ResourceNotFoundException,
ResourceNotAvailableException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException {
return updateImagePermissions(UpdateImagePermissionsRequest.builder().applyMutation(updateImagePermissionsRequest)
.build());
}
/**
*
* Updates the specified fields for the specified stack.
*
*
* @param updateStackRequest
* @return Result of the UpdateStack operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateStack
* @see AWS API
* Documentation
*/
default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws ResourceNotFoundException,
ResourceInUseException, InvalidRoleException, InvalidParameterCombinationException, LimitExceededException,
InvalidAccountStatusException, IncompatibleImageException, OperationNotPermittedException,
ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified fields for the specified stack.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateStackRequest.Builder} avoiding the need to
* create one manually via {@link UpdateStackRequest#builder()}
*
*
* @param updateStackRequest
* A {@link Consumer} that will call methods on {@link UpdateStackRequest.Builder} to create a request.
* @return Result of the UpdateStack operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource was not found.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws InvalidRoleException
* The specified role is invalid.
* @throws InvalidParameterCombinationException
* Indicates an incorrect combination of parameters, or a missing parameter.
* @throws LimitExceededException
* The requested limit exceeds the permitted limit for an account.
* @throws InvalidAccountStatusException
* The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
* Support.
* @throws IncompatibleImageException
* The image does not support storage connectors.
* @throws OperationNotPermittedException
* The attempted operation is not permitted.
* @throws ConcurrentModificationException
* An API error occurred. Wait a few minutes and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AppStreamException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AppStreamClient.UpdateStack
* @see AWS API
* Documentation
*/
default UpdateStackResponse updateStack(Consumer updateStackRequest)
throws ResourceNotFoundException, ResourceInUseException, InvalidRoleException, InvalidParameterCombinationException,
LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, OperationNotPermittedException,
ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException {
return updateStack(UpdateStackRequest.builder().applyMutation(updateStackRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("appstream2");
}
/**
* Create an instance of {@link AppStreamWaiter} using this client.
*
* Waiters created via this method are managed by the SDK and resources will be released when the service client is
* closed.
*
* @return an instance of {@link AppStreamWaiter}
*/
default AppStreamWaiter waiter() {
throw new UnsupportedOperationException();
}
}