- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ModifyStreamingPropertiesCommand
Modifies the specified streaming properties.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesClient, ModifyStreamingPropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, ModifyStreamingPropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // ModifyStreamingPropertiesRequest
ResourceId: "STRING_VALUE", // required
StreamingProperties: { // StreamingProperties
StreamingExperiencePreferredProtocol: "TCP" || "UDP",
UserSettings: [ // UserSettings
{ // UserSetting
Action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE" || "CLIPBOARD_COPY_TO_LOCAL_DEVICE" || "PRINTING_TO_LOCAL_DEVICE" || "SMART_CARD", // required
Permission: "ENABLED" || "DISABLED", // required
MaximumLength: Number("int"),
},
],
StorageConnectors: [ // StorageConnectors
{ // StorageConnector
ConnectorType: "HOME_FOLDER", // required
Status: "ENABLED" || "DISABLED", // required
},
],
GlobalAccelerator: { // GlobalAcceleratorForDirectory
Mode: "ENABLED_AUTO" || "DISABLED", // required
PreferredProtocol: "TCP" || "NONE",
},
},
};
const command = new ModifyStreamingPropertiesCommand(input);
const response = await client.send(command);
// {};
ModifyStreamingPropertiesCommand Input
See ModifyStreamingPropertiesCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceId Required | string | undefined | The identifier of the resource. |
StreamingProperties | StreamingProperties | undefined | The streaming properties to configure. |
ModifyStreamingPropertiesCommand Output
See ModifyStreamingPropertiesCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The user is not authorized to access a resource. |
InvalidParameterValuesException | client | One or more parameter values are not valid. |
OperationNotSupportedException | client | This operation is not supported. |
ResourceNotFoundException | client | The resource could not be found. |
WorkSpacesServiceException | Base exception class for all service exceptions from WorkSpaces service. |