AppStream
public struct AppStream
Client object for interacting with AWS AppStream service.
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: Amazon AppStream 2.0 product page Amazon AppStream 2.0 documentation
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AppStream client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Associates the specified fleet with the specified stack.
Declaration
Swift
public func associateFleet(_ input: AssociateFleetRequest) -> EventLoopFuture<AssociateFleetResult>
-
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.
Declaration
Swift
public func batchAssociateUserStack(_ input: BatchAssociateUserStackRequest) -> EventLoopFuture<BatchAssociateUserStackResult>
-
Disassociates the specified users from the specified stacks.
Declaration
Swift
public func batchDisassociateUserStack(_ input: BatchDisassociateUserStackRequest) -> EventLoopFuture<BatchDisassociateUserStackResult>
-
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.
Declaration
Swift
public func copyImage(_ input: CopyImageRequest) -> EventLoopFuture<CopyImageResponse>
-
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.
Declaration
Swift
public func createDirectoryConfig(_ input: CreateDirectoryConfigRequest) -> EventLoopFuture<CreateDirectoryConfigResult>
-
Creates a fleet. A fleet consists of streaming instances that run a specified image.
Declaration
Swift
public func createFleet(_ input: CreateFleetRequest) -> EventLoopFuture<CreateFleetResult>
-
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.
Declaration
Swift
public func createImageBuilder(_ input: CreateImageBuilderRequest) -> EventLoopFuture<CreateImageBuilderResult>
-
Creates a URL to start an image builder streaming session.
Declaration
Swift
public func createImageBuilderStreamingURL(_ input: CreateImageBuilderStreamingURLRequest) -> EventLoopFuture<CreateImageBuilderStreamingURLResult>
-
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
Declaration
Swift
public func createStack(_ input: CreateStackRequest) -> EventLoopFuture<CreateStackResult>
-
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.
Declaration
Swift
public func createStreamingURL(_ input: CreateStreamingURLRequest) -> EventLoopFuture<CreateStreamingURLResult>
-
Creates a usage report subscription. Usage reports are generated daily.
Declaration
Swift
public func createUsageReportSubscription(_ input: CreateUsageReportSubscriptionRequest) -> EventLoopFuture<CreateUsageReportSubscriptionResult>
-
Creates a new user in the user pool.
Declaration
Swift
public func createUser(_ input: CreateUserRequest) -> EventLoopFuture<CreateUserResult>
-
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.
Declaration
Swift
public func deleteDirectoryConfig(_ input: DeleteDirectoryConfigRequest) -> EventLoopFuture<DeleteDirectoryConfigResult>
-
Deletes the specified fleet.
Declaration
Swift
public func deleteFleet(_ input: DeleteFleetRequest) -> EventLoopFuture<DeleteFleetResult>
-
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.
Declaration
Swift
public func deleteImage(_ input: DeleteImageRequest) -> EventLoopFuture<DeleteImageResult>
-
Deletes the specified image builder and releases the capacity.
Declaration
Swift
public func deleteImageBuilder(_ input: DeleteImageBuilderRequest) -> EventLoopFuture<DeleteImageBuilderResult>
-
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.
Declaration
Swift
public func deleteImagePermissions(_ input: DeleteImagePermissionsRequest) -> EventLoopFuture<DeleteImagePermissionsResult>
-
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.
Declaration
Swift
public func deleteStack(_ input: DeleteStackRequest) -> EventLoopFuture<DeleteStackResult>
-
Disables usage report generation.
Declaration
Swift
public func deleteUsageReportSubscription(_ input: DeleteUsageReportSubscriptionRequest) -> EventLoopFuture<DeleteUsageReportSubscriptionResult>
-
Deletes a user from the user pool.
Declaration
Swift
public func deleteUser(_ input: DeleteUserRequest) -> EventLoopFuture<DeleteUserResult>
-
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.
Declaration
Swift
public func describeDirectoryConfigs(_ input: DescribeDirectoryConfigsRequest) -> EventLoopFuture<DescribeDirectoryConfigsResult>
-
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
Declaration
Swift
public func describeFleets(_ input: DescribeFleetsRequest) -> EventLoopFuture<DescribeFleetsResult>
-
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.
Declaration
Swift
public func describeImageBuilders(_ input: DescribeImageBuildersRequest) -> EventLoopFuture<DescribeImageBuildersResult>
-
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
Declaration
Swift
public func describeImagePermissions(_ input: DescribeImagePermissionsRequest) -> EventLoopFuture<DescribeImagePermissionsResult>
-
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.
Declaration
Swift
public func describeImages(_ input: DescribeImagesRequest) -> EventLoopFuture<DescribeImagesResult>
-
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.
Declaration
Swift
public func describeSessions(_ input: DescribeSessionsRequest) -> EventLoopFuture<DescribeSessionsResult>
-
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
Declaration
Swift
public func describeStacks(_ input: DescribeStacksRequest) -> EventLoopFuture<DescribeStacksResult>
-
Retrieves a list that describes one or more usage report subscriptions.
Declaration
Swift
public func describeUsageReportSubscriptions(_ input: DescribeUsageReportSubscriptionsRequest) -> EventLoopFuture<DescribeUsageReportSubscriptionsResult>
-
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
Declaration
Swift
public func describeUserStackAssociations(_ input: DescribeUserStackAssociationsRequest) -> EventLoopFuture<DescribeUserStackAssociationsResult>
-
Retrieves a list that describes one or more specified users in the user pool.
Declaration
Swift
public func describeUsers(_ input: DescribeUsersRequest) -> EventLoopFuture<DescribeUsersResult>
-
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.
Declaration
Swift
public func disableUser(_ input: DisableUserRequest) -> EventLoopFuture<DisableUserResult>
-
Disassociates the specified fleet from the specified stack.
Declaration
Swift
public func disassociateFleet(_ input: DisassociateFleetRequest) -> EventLoopFuture<DisassociateFleetResult>
-
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.
Declaration
Swift
public func enableUser(_ input: EnableUserRequest) -> EventLoopFuture<EnableUserResult>
-
Immediately stops the specified streaming session.
Declaration
Swift
public func expireSession(_ input: ExpireSessionRequest) -> EventLoopFuture<ExpireSessionResult>
-
Retrieves the name of the fleet that is associated with the specified stack.
Declaration
Swift
public func listAssociatedFleets(_ input: ListAssociatedFleetsRequest) -> EventLoopFuture<ListAssociatedFleetsResult>
-
Retrieves the name of the stack with which the specified fleet is associated.
Declaration
Swift
public func listAssociatedStacks(_ input: ListAssociatedStacksRequest) -> EventLoopFuture<ListAssociatedStacksResult>
-
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.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
Starts the specified fleet.
Declaration
Swift
public func startFleet(_ input: StartFleetRequest) -> EventLoopFuture<StartFleetResult>
-
Starts the specified image builder.
Declaration
Swift
public func startImageBuilder(_ input: StartImageBuilderRequest) -> EventLoopFuture<StartImageBuilderResult>
-
Stops the specified fleet.
Declaration
Swift
public func stopFleet(_ input: StopFleetRequest) -> EventLoopFuture<StopFleetResult>
-
Stops the specified image builder.
Declaration
Swift
public func stopImageBuilder(_ input: StopImageBuilderRequest) -> EventLoopFuture<StopImageBuilderResult>
-
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.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
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.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
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.
Declaration
Swift
public func updateDirectoryConfig(_ input: UpdateDirectoryConfigRequest) -> EventLoopFuture<UpdateDirectoryConfigResult>
-
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.
Declaration
Swift
public func updateFleet(_ input: UpdateFleetRequest) -> EventLoopFuture<UpdateFleetResult>
-
Adds or updates permissions for the specified private image.
Declaration
Swift
public func updateImagePermissions(_ input: UpdateImagePermissionsRequest) -> EventLoopFuture<UpdateImagePermissionsResult>
-
Updates the specified fields for the specified stack.
Declaration
Swift
public func updateStack(_ input: UpdateStackRequest) -> EventLoopFuture<UpdateStackResult>
-
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
Declaration
Swift
public func describeImagePermissionsPaginator(_ input: DescribeImagePermissionsRequest, onPage: @escaping (DescribeImagePermissionsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func describeImagesPaginator(_ input: DescribeImagesRequest, onPage: @escaping (DescribeImagesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeImagePermissionsRequest : AWSShape
extension AppStream.DescribeImagePermissionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeImagesRequest : AWSShape
extension AppStream.DescribeImagesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AccessEndpointType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Action : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AuthenticationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FleetAttribute : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FleetErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FleetState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FleetType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImageBuilderState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImageBuilderStateChangeReasonCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImageState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ImageStateChangeReasonCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum MessageAction : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Permission : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PlatformType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SessionConnectionState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SessionState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StackAttribute : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StackErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StorageConnectorType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StreamView : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UsageReportExecutionErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UsageReportSchedule : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UserStackAssociationErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VisibilityType : String, CustomStringConvertible, Codable