@aws-sdk/client-appstream

Description

AWS SDK for JavaScript AppStream Client for Node.js, Browser and React Native.

Amazon WorkSpaces Applications

This is the Amazon WorkSpaces Applications API Reference. This documentation provides descriptions and syntax for each of the actions and data types in WorkSpaces Applications. WorkSpaces Applications is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. WorkSpaces Applications 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 WorkSpaces Applications API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access WorkSpaces Applications API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon WorkSpaces Applications Administration Guide.

To learn more about WorkSpaces Applications, see the following resources:

• 
  

  
  Amazon WorkSpaces Applications product page
  

  
  


• 
  

  
  Amazon WorkSpaces Applications documentation
  

  
  

Installing

To install this package, simply type add or install @aws-sdk/client-appstream
using your favorite package manager:
- npm install @aws-sdk/client-appstream
- yarn add @aws-sdk/client-appstream
- pnpm add @aws-sdk/client-appstream

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AppStreamClient and
the commands you need, for example ListExportImageTasksCommand:

``js
// ES5 example
const { AppStreamClient, ListExportImageTasksCommand } = require("@aws-sdk/client-appstream");
`

`ts
// ES6+ example
import { AppStreamClient, ListExportImageTasksCommand } from "@aws-sdk/client-appstream";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new AppStreamClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListExportImageTasksCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-appstream";
const client = new AWS.AppStream({ region: "REGION" });

// async/await.
try {
const data = await client.listExportImageTasks(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listExportImageTasks(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listExportImageTasks(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-appstream` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateAppBlockBuilderAppBlock

Command API Reference / Input / Output

AssociateApplicationFleet

Command API Reference / Input / Output

AssociateApplicationToEntitlement

Command API Reference / Input / Output

AssociateFleet

Command API Reference / Input / Output

AssociateSoftwareToImageBuilder

Command API Reference / Input / Output

BatchAssociateUserStack

Command API Reference / Input / Output

BatchDisassociateUserStack

Command API Reference / Input / Output

CopyImage

Command API Reference / Input / Output

CreateAppBlock

Command API Reference / Input / Output

CreateAppBlockBuilder

Command API Reference / Input / Output

CreateAppBlockBuilderStreamingURL

Command API Reference / Input / Output

CreateApplication

Command API Reference / Input / Output

CreateDirectoryConfig

Command API Reference / Input / Output

CreateEntitlement

Command API Reference / Input / Output

CreateExportImageTask

Command API Reference / Input / Output

CreateFleet

Command API Reference / Input / Output

CreateImageBuilder

Command API Reference / Input / Output

CreateImageBuilderStreamingURL

Command API Reference / Input / Output

CreateImportedImage

Command API Reference / Input / Output

CreateStack

Command API Reference / Input / Output

CreateStreamingURL

Command API Reference / Input / Output

CreateThemeForStack

Command API Reference / Input / Output

CreateUpdatedImage

Command API Reference / Input / Output

CreateUsageReportSubscription

Command API Reference / Input / Output

CreateUser

Command API Reference / Input / Output

DeleteAppBlock

Command API Reference / Input / Output

DeleteAppBlockBuilder

Command API Reference / Input / Output

DeleteApplication

Command API Reference / Input / Output

DeleteDirectoryConfig

Command API Reference / Input / Output

DeleteEntitlement

Command API Reference / Input / Output

DeleteFleet

Command API Reference / Input / Output

DeleteImage

Command API Reference / Input / Output

DeleteImageBuilder

Command API Reference / Input / Output

DeleteImagePermissions

Command API Reference / Input / Output

DeleteStack

Command API Reference / Input / Output

DeleteThemeForStack

Command API Reference / Input / Output

DeleteUsageReportSubscription

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

DescribeAppBlockBuilderAppBlockAssociations

Command API Reference / Input / Output

DescribeAppBlockBuilders

Command API Reference / Input / Output

DescribeAppBlocks

Command API Reference / Input / Output

DescribeApplicationFleetAssociations

Command API Reference / Input / Output

DescribeApplications

Command API Reference / Input / Output

DescribeAppLicenseUsage

Command API Reference / Input / Output

DescribeDirectoryConfigs

Command API Reference / Input / Output

DescribeEntitlements

Command API Reference / Input / Output

DescribeFleets

Command API Reference / Input / Output

DescribeImageBuilders

Command API Reference / Input / Output

DescribeImagePermissions

Command API Reference / Input / Output

DescribeImages

Command API Reference / Input / Output

DescribeSessions

Command API Reference / Input / Output

DescribeSoftwareAssociations

Command API Reference / Input / Output

DescribeStacks

Command API Reference / Input / Output

DescribeThemeForStack

Command API Reference / Input / Output

DescribeUsageReportSubscriptions

Command API Reference / Input / Output

DescribeUsers

Command API Reference / Input / Output

DescribeUserStackAssociations

Command API Reference / Input / Output

DisableUser

Command API Reference / Input / Output

DisassociateAppBlockBuilderAppBlock

Command API Reference / Input / Output

DisassociateApplicationFleet

Command API Reference / Input / Output

DisassociateApplicationFromEntitlement

Command API Reference / Input / Output

DisassociateFleet

Command API Reference / Input / Output

DisassociateSoftwareFromImageBuilder

Command API Reference / Input / Output

EnableUser

Command API Reference / Input / Output

ExpireSession

Command API Reference / Input / Output

GetExportImageTask

Command API Reference / Input / Output

ListAssociatedFleets

Command API Reference / Input / Output

ListAssociatedStacks

Command API Reference / Input / Output

ListEntitledApplications

Command API Reference / Input / Output

ListExportImageTasks

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartAppBlockBuilder

Command API Reference / Input / Output

StartFleet

Command API Reference / Input / Output

StartImageBuilder

Command API Reference / Input / Output

StartSoftwareDeploymentToImageBuilder

Command API Reference / Input / Output

StopAppBlockBuilder

Command API Reference / Input / Output

StopFleet

Command API Reference / Input / Output

StopImageBuilder

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAppBlockBuilder

Command API Reference / Input / Output

UpdateApplication

Command API Reference / Input / Output

UpdateDirectoryConfig

Command API Reference / Input / Output

UpdateEntitlement

Command API Reference / Input / Output

UpdateFleet

Command API Reference / Input / Output

UpdateImagePermissions

Command API Reference / Input / Output

UpdateStack

Command API Reference / Input / Output

UpdateThemeForStack

Command API Reference / Input / Output