@datafire/amazonaws_workspaces NPM

@datafire/amazonaws_workspaces

Client library for Amazon WorkSpaces

Installation and Usage

npm install --save @datafire/amazonaws_workspaces

let amazonaws_workspaces = require('@datafire/amazonaws_workspaces').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_workspaces.CreateTags({
  "ResourceId": "",
  "Tags": []
}).then(data => {
  console.log(data);
});

Description

Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows desktops for your users.

Actions

CreateTags

amazonaws_workspaces.CreateTags({
  "ResourceId": "",
  "Tags": []
}, context)

Input

input object
- ResourceId required NonEmptyString
- Tags required TagList

Output

output CreateTagsResult

CreateWorkspaces

amazonaws_workspaces.CreateWorkspaces({
  "Workspaces": []
}, context)

Input

input object
- Workspaces required WorkspaceRequestList

Output

output CreateWorkspacesResult

DeleteTags

amazonaws_workspaces.DeleteTags({
  "ResourceId": "",
  "TagKeys": []
}, context)

Input

input object
- ResourceId required NonEmptyString
- TagKeys required TagKeyList

Output

output DeleteTagsResult

DescribeTags

amazonaws_workspaces.DescribeTags({
  "ResourceId": ""
}, context)

Input

input object
- ResourceId required NonEmptyString

Output

output DescribeTagsResult

DescribeWorkspaceBundles

amazonaws_workspaces.DescribeWorkspaceBundles({}, context)

Input

input object
- NextToken string
- BundleIds BundleIdList
- NextToken PaginationToken
- Owner BundleOwner

Output

output DescribeWorkspaceBundlesResult

DescribeWorkspaceDirectories

amazonaws_workspaces.DescribeWorkspaceDirectories({}, context)

Input

input object
- NextToken string
- DirectoryIds DirectoryIdList
- NextToken PaginationToken

Output

output DescribeWorkspaceDirectoriesResult

DescribeWorkspaces

amazonaws_workspaces.DescribeWorkspaces({}, context)

Input

input object
- Limit string
- NextToken string
- BundleId BundleId
- DirectoryId DirectoryId
- Limit Limit
- NextToken PaginationToken
- UserName UserName
- WorkspaceIds WorkspaceIdList

Output

output DescribeWorkspacesResult

DescribeWorkspacesConnectionStatus

amazonaws_workspaces.DescribeWorkspacesConnectionStatus({}, context)

Input

input object
- NextToken PaginationToken
- WorkspaceIds WorkspaceIdList

Output

output DescribeWorkspacesConnectionStatusResult

ModifyWorkspaceProperties

amazonaws_workspaces.ModifyWorkspaceProperties({
  "WorkspaceId": "",
  "WorkspaceProperties": {}
}, context)

Input

input object
- WorkspaceId required WorkspaceId
- WorkspaceProperties required WorkspaceProperties

Output

output ModifyWorkspacePropertiesResult

RebootWorkspaces

amazonaws_workspaces.RebootWorkspaces({
  "RebootWorkspaceRequests": []
}, context)

Input

input object
- RebootWorkspaceRequests required RebootWorkspaceRequests

Output

output RebootWorkspacesResult

RebuildWorkspaces

amazonaws_workspaces.RebuildWorkspaces({
  "RebuildWorkspaceRequests": []
}, context)

Input

input object
- RebuildWorkspaceRequests required RebuildWorkspaceRequests

Output

output RebuildWorkspacesResult

StartWorkspaces

amazonaws_workspaces.StartWorkspaces({
  "StartWorkspaceRequests": []
}, context)

Input

input object
- StartWorkspaceRequests required StartWorkspaceRequests

Output

output StartWorkspacesResult

StopWorkspaces

amazonaws_workspaces.StopWorkspaces({
  "StopWorkspaceRequests": []
}, context)

Input

input object
- StopWorkspaceRequests required StopWorkspaceRequests

Output

output StopWorkspacesResult

TerminateWorkspaces

amazonaws_workspaces.TerminateWorkspaces({
  "TerminateWorkspaceRequests": []
}, context)

Input

input object
- TerminateWorkspaceRequests required TerminateWorkspaceRequests

Output

output TerminateWorkspacesResult

Definitions

ARN

ARN string

AccessDeniedException

AccessDeniedException object: The user is not authorized to access a resource.
- message ExceptionMessage

Alias

Alias string

BooleanObject

BooleanObject boolean

BundleId

BundleId string

BundleIdList

BundleIdList array
- items BundleId

BundleList

BundleList array
- items WorkspaceBundle

BundleOwner

BundleOwner string

Compute

Compute string (values: VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS)

ComputeType

ComputeType object: Information about the compute type.
- Name Compute

ComputerName

ComputerName string

ConnectionState

ConnectionState string (values: CONNECTED, DISCONNECTED, UNKNOWN)

CreateTagsRequest

CreateTagsRequest object
- ResourceId required NonEmptyString
- Tags required TagList

CreateTagsResult

CreateTagsResult object

CreateWorkspacesRequest

CreateWorkspacesRequest object
- Workspaces required WorkspaceRequestList

CreateWorkspacesResult

CreateWorkspacesResult object
- FailedRequests FailedCreateWorkspaceRequests
- PendingRequests WorkspaceList

DefaultOu

DefaultOu string

DefaultWorkspaceCreationProperties

DefaultWorkspaceCreationProperties object: Information about defaults used to create a WorkSpace.
- CustomSecurityGroupId SecurityGroupId
- DefaultOu DefaultOu
- EnableInternetAccess BooleanObject
- EnableWorkDocs BooleanObject
- UserEnabledAsLocalAdministrator BooleanObject

DeleteTagsRequest

DeleteTagsRequest object
- ResourceId required NonEmptyString
- TagKeys required TagKeyList

DeleteTagsResult

DeleteTagsResult object

DescribeTagsRequest

DescribeTagsRequest object
- ResourceId required NonEmptyString

DescribeTagsResult

DescribeTagsResult object
- TagList TagList

DescribeWorkspaceBundlesRequest

DescribeWorkspaceBundlesRequest object
- BundleIds BundleIdList
- NextToken PaginationToken
- Owner BundleOwner

DescribeWorkspaceBundlesResult

DescribeWorkspaceBundlesResult object
- Bundles BundleList
- NextToken PaginationToken

DescribeWorkspaceDirectoriesRequest

DescribeWorkspaceDirectoriesRequest object
- DirectoryIds DirectoryIdList
- NextToken PaginationToken

DescribeWorkspaceDirectoriesResult

DescribeWorkspaceDirectoriesResult object
- Directories DirectoryList
- NextToken PaginationToken

DescribeWorkspacesConnectionStatusRequest

DescribeWorkspacesConnectionStatusRequest object
- NextToken PaginationToken
- WorkspaceIds WorkspaceIdList

DescribeWorkspacesConnectionStatusResult

DescribeWorkspacesConnectionStatusResult object
- NextToken PaginationToken
- WorkspacesConnectionStatus WorkspaceConnectionStatusList

DescribeWorkspacesRequest

DescribeWorkspacesRequest object
- BundleId BundleId
- DirectoryId DirectoryId
- Limit Limit
- NextToken PaginationToken
- UserName UserName
- WorkspaceIds WorkspaceIdList

DescribeWorkspacesResult

DescribeWorkspacesResult object
- NextToken PaginationToken
- Workspaces WorkspaceList

Description

Description string

DirectoryId

DirectoryId string

DirectoryIdList

DirectoryIdList array
- items DirectoryId

DirectoryList

DirectoryList array
- items WorkspaceDirectory

DirectoryName

DirectoryName string

DnsIpAddresses

DnsIpAddresses array
- items IpAddress

ErrorType

ErrorType string

ExceptionMessage

ExceptionMessage string

FailedCreateWorkspaceRequest

FailedCreateWorkspaceRequest object: Information about a WorkSpace that could not be created.
- ErrorCode ErrorType
- ErrorMessage Description
- WorkspaceRequest WorkspaceRequest

FailedCreateWorkspaceRequests

FailedCreateWorkspaceRequests array
- items FailedCreateWorkspaceRequest

FailedRebootWorkspaceRequests

FailedRebootWorkspaceRequests array
- items FailedWorkspaceChangeRequest

FailedRebuildWorkspaceRequests

FailedRebuildWorkspaceRequests array
- items FailedWorkspaceChangeRequest

FailedStartWorkspaceRequests

FailedStartWorkspaceRequests array
- items FailedWorkspaceChangeRequest

FailedStopWorkspaceRequests

FailedStopWorkspaceRequests array
- items FailedWorkspaceChangeRequest

FailedTerminateWorkspaceRequests

FailedTerminateWorkspaceRequests array
- items FailedWorkspaceChangeRequest

FailedWorkspaceChangeRequest

FailedWorkspaceChangeRequest object: Information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
- ErrorCode ErrorType
- ErrorMessage Description
- WorkspaceId WorkspaceId

InvalidParameterValuesException

InvalidParameterValuesException object: One or more parameter values are not valid.
- message ExceptionMessage

InvalidResourceStateException

InvalidResourceStateException object: The state of the WorkSpace is not valid for this operation.
- message ExceptionMessage

IpAddress

IpAddress string

Limit

Limit integer

ModificationResourceEnum

ModificationResourceEnum string (values: ROOT_VOLUME, USER_VOLUME, COMPUTE_TYPE)

ModificationState

ModificationState object: Information about a WorkSpace modification.
- Resource ModificationResourceEnum
- State ModificationStateEnum

ModificationStateEnum

ModificationStateEnum string (values: UPDATE_INITIATED, UPDATE_IN_PROGRESS)

ModificationStateList

ModificationStateList array
- items ModificationState

ModifyWorkspacePropertiesRequest

ModifyWorkspacePropertiesRequest object
- WorkspaceId required WorkspaceId
- WorkspaceProperties required WorkspaceProperties

ModifyWorkspacePropertiesResult

ModifyWorkspacePropertiesResult object

NonEmptyString

NonEmptyString string

OperationInProgressException

OperationInProgressException object: The properties of this WorkSpace are currently being modified. Try again in a moment.
- message ExceptionMessage

PaginationToken

PaginationToken string

RebootRequest

RebootRequest object: Information used to reboot a WorkSpace.
- WorkspaceId required WorkspaceId

RebootWorkspaceRequests

RebootWorkspaceRequests array
- items RebootRequest

RebootWorkspacesRequest

RebootWorkspacesRequest object
- RebootWorkspaceRequests required RebootWorkspaceRequests

RebootWorkspacesResult

RebootWorkspacesResult object
- FailedRequests FailedRebootWorkspaceRequests

RebuildRequest

RebuildRequest object: Information used to rebuild a WorkSpace.
- WorkspaceId required WorkspaceId

RebuildWorkspaceRequests

RebuildWorkspaceRequests array
- items RebuildRequest

RebuildWorkspacesRequest

RebuildWorkspacesRequest object
- RebuildWorkspaceRequests required RebuildWorkspaceRequests

RebuildWorkspacesResult

RebuildWorkspacesResult object
- FailedRequests FailedRebuildWorkspaceRequests

RegistrationCode

RegistrationCode string

ResourceLimitExceededException

ResourceLimitExceededException object: Your resource limits have been exceeded.
- message ExceptionMessage

ResourceNotFoundException

ResourceNotFoundException object: The resource could not be found.
- ResourceId NonEmptyString
- message ExceptionMessage

ResourceUnavailableException

ResourceUnavailableException object: The specified resource is not available.
- ResourceId NonEmptyString
- message ExceptionMessage

RootStorage

RootStorage object: Information about the root volume for a WorkSpace bundle.
- Capacity NonEmptyString

RootVolumeSizeGib

RootVolumeSizeGib integer

RunningMode

RunningMode string (values: AUTO_STOP, ALWAYS_ON)

RunningModeAutoStopTimeoutInMinutes

RunningModeAutoStopTimeoutInMinutes integer

SecurityGroupId

SecurityGroupId string

StartRequest

StartRequest object: Information used to start a WorkSpace.
- WorkspaceId WorkspaceId

StartWorkspaceRequests

StartWorkspaceRequests array
- items StartRequest

StartWorkspacesRequest

StartWorkspacesRequest object
- StartWorkspaceRequests required StartWorkspaceRequests

StartWorkspacesResult

StartWorkspacesResult object
- FailedRequests FailedStartWorkspaceRequests

StopRequest

StopRequest object: Information used to stop a WorkSpace.
- WorkspaceId WorkspaceId

StopWorkspaceRequests

StopWorkspaceRequests array
- items StopRequest

StopWorkspacesRequest

StopWorkspacesRequest object
- StopWorkspaceRequests required StopWorkspaceRequests

StopWorkspacesResult

StopWorkspacesResult object
- FailedRequests FailedStopWorkspaceRequests

SubnetId

SubnetId string

SubnetIds

SubnetIds array
- items SubnetId

TagKey

TagKey string

TagKeyList

TagKeyList array
- items NonEmptyString

TagList

TagList array
- items Tag

TagValue

TagValue string

TerminateRequest

TerminateRequest object: Information used to terminate a WorkSpace.
- WorkspaceId required WorkspaceId

TerminateWorkspaceRequests

TerminateWorkspaceRequests array
- items TerminateRequest

TerminateWorkspacesRequest

TerminateWorkspacesRequest object
- TerminateWorkspaceRequests required TerminateWorkspaceRequests

TerminateWorkspacesResult

TerminateWorkspacesResult object
- FailedRequests FailedTerminateWorkspaceRequests

Timestamp

Timestamp string

UnsupportedWorkspaceConfigurationException

UnsupportedWorkspaceConfigurationException object: The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.
- message ExceptionMessage

UserName

UserName string

UserStorage

UserStorage object: Information about the user storage for a WorkSpace bundle.
- Capacity NonEmptyString

UserVolumeSizeGib

UserVolumeSizeGib integer

VolumeEncryptionKey

VolumeEncryptionKey string

Workspace

Workspace object: Information about a WorkSpace.
- BundleId BundleId
- ComputerName ComputerName
- DirectoryId DirectoryId
- ErrorCode WorkspaceErrorCode
- ErrorMessage Description
- IpAddress IpAddress
- ModificationStates ModificationStateList
- RootVolumeEncryptionEnabled BooleanObject
- State WorkspaceState
- SubnetId SubnetId
- UserName UserName
- UserVolumeEncryptionEnabled BooleanObject
- VolumeEncryptionKey VolumeEncryptionKey
- WorkspaceId WorkspaceId
- WorkspaceProperties WorkspaceProperties

WorkspaceBundle

WorkspaceBundle object: Information about a WorkSpace bundle.
- BundleId BundleId
- ComputeType ComputeType
- Description Description
- Name NonEmptyString
- Owner BundleOwner
- RootStorage RootStorage
- UserStorage UserStorage

WorkspaceConnectionStatus

WorkspaceConnectionStatus object: Describes the connection status of a WorkSpace.
- ConnectionState ConnectionState
- ConnectionStateCheckTimestamp Timestamp
- LastKnownUserConnectionTimestamp Timestamp
- WorkspaceId WorkspaceId

WorkspaceConnectionStatusList

WorkspaceConnectionStatusList array
- items WorkspaceConnectionStatus

WorkspaceDirectory

WorkspaceDirectory object: Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.
- Alias Alias
- CustomerUserName UserName
- DirectoryId DirectoryId
- DirectoryName DirectoryName
- DirectoryType WorkspaceDirectoryType
- DnsIpAddresses DnsIpAddresses
- IamRoleId ARN
- RegistrationCode RegistrationCode
- State WorkspaceDirectoryState
- SubnetIds SubnetIds
- WorkspaceCreationProperties DefaultWorkspaceCreationProperties
- WorkspaceSecurityGroupId SecurityGroupId

WorkspaceDirectoryState

WorkspaceDirectoryState string (values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR)

WorkspaceDirectoryType

WorkspaceDirectoryType string (values: SIMPLE_AD, AD_CONNECTOR)

WorkspaceErrorCode

WorkspaceErrorCode string

WorkspaceId

WorkspaceId string

WorkspaceIdList

WorkspaceIdList array
- items WorkspaceId

WorkspaceList

WorkspaceList array
- items Workspace

WorkspaceProperties

WorkspaceProperties object: Information about a WorkSpace.
- ComputeTypeName Compute
- RootVolumeSizeGib RootVolumeSizeGib
- RunningMode RunningMode
- RunningModeAutoStopTimeoutInMinutes RunningModeAutoStopTimeoutInMinutes
- UserVolumeSizeGib UserVolumeSizeGib

WorkspaceRequest

WorkspaceRequest object: Information used to create a WorkSpace.
- BundleId required BundleId
- DirectoryId required DirectoryId
- RootVolumeEncryptionEnabled BooleanObject
- Tags TagList
- UserName required UserName
- UserVolumeEncryptionEnabled BooleanObject
- VolumeEncryptionKey VolumeEncryptionKey
- WorkspaceProperties WorkspaceProperties

WorkspaceRequestList

WorkspaceRequestList array
- items WorkspaceRequest

WorkspaceState

WorkspaceState string (values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, STARTING, REBUILDING, MAINTENANCE, TERMINATING, TERMINATED, SUSPENDED, UPDATING, STOPPING, STOPPED, ERROR)

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago