@aws-sdk/client-ssm-guiconnect

Description

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

AWS Systems Manager GUI Connect

Systems Manager GUI Connect, a component of Fleet Manager, lets you connect to your Window
Server-type Amazon Elastic Compute Cloud (Amazon EC2) instances using the Remote Desktop Protocol (RDP). GUI
Connect, which is powered by Amazon DCV, provides you
with secure connectivity to your Windows Server instances directly from the Systems Manager console.
You can have up to four simultaneous connections in a single browser window. In the
console, GUI Connect is also referred to as Fleet Manager Remote Desktop.

This reference is intended to be used with the
Amazon Web Services Systems Manager User
Guide
. To get started, see the following user guide topics:

• 
  

  
  Setting up
  Amazon Web Services Systems Manager
  

  
  


• 
  

  
  Connect to a Windows Server managed instance using Remote Desktop
  

  
  

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { SSMGuiConnectClient, GetConnectionRecordingPreferencesCommand } = require("@aws-sdk/client-ssm-guiconnect");
`

`ts
// ES6+ example
import { SSMGuiConnectClient, GetConnectionRecordingPreferencesCommand } from "@aws-sdk/client-ssm-guiconnect";
`

$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 SSMGuiConnectClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new GetConnectionRecordingPreferencesCommand(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-ssm-guiconnect";
const client = new AWS.SSMGuiConnect({ region: "REGION" });

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

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

// callbacks.
client.getConnectionRecordingPreferences(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-ssm-guiconnect` 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)

DeleteConnectionRecordingPreferences

Command API Reference / Input / Output

GetConnectionRecordingPreferences

Command API Reference / Input / Output

UpdateConnectionRecordingPreferences

Command API Reference / Input / Output