• 沒有找到結果。

Amazon WorkSpaces Service

N/A
N/A
Protected

Academic year: 2022

Share "Amazon WorkSpaces Service"

Copied!
211
0
0

加載中.... (立即查看全文)

全文

(1)

Amazon WorkSpaces Service

API Reference

API Version 2015-04-08

(2)

Amazon WorkSpaces Service: API Reference

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

(3)

Amazon WorkSpaces Service API Reference

Table of Contents

Welcome ... 1

Actions ... 2

AssociateConnectionAlias ... 4

Request Syntax ... 4

Request Parameters ... 4

Response Syntax ... 4

Response Elements ... 4

Errors ... 5

See Also ... 5

AssociateIpGroups ... 7

Request Syntax ... 7

Request Parameters ... 7

Response Elements ... 7

Errors ... 7

See Also ... 8

AuthorizeIpRules ... 9

Request Syntax ... 9

Request Parameters ... 9

Response Elements ... 9

Errors ... 9

See Also ... 10

CopyWorkspaceImage ... 11

Request Syntax ... 11

Request Parameters ... 11

Response Syntax ... 12

Response Elements ... 12

Errors ... 12

See Also ... 13

CreateConnectClientAddIn ... 14

Request Syntax ... 14

Request Parameters ... 14

Response Syntax ... 14

Response Elements ... 15

Errors ... 15

See Also ... 15

CreateConnectionAlias ... 17

Request Syntax ... 17

Request Parameters ... 17

Response Syntax ... 17

Response Elements ... 17

Errors ... 18

See Also ... 18

CreateIpGroup ... 20

Request Syntax ... 20

Request Parameters ... 20

Response Syntax ... 21

Response Elements ... 21

Errors ... 21

See Also ... 22

CreateTags ... 23

Request Syntax ... 23

Request Parameters ... 23

Response Elements ... 23

Errors ... 23

API Version 2015-04-08 iii

(4)

See Also ... 24

CreateUpdatedWorkspaceImage ... 25

Request Syntax ... 25

Request Parameters ... 25

Response Syntax ... 26

Response Elements ... 26

Errors ... 26

See Also ... 27

CreateWorkspaceBundle ... 28

Request Syntax ... 28

Request Parameters ... 28

Response Syntax ... 29

Response Elements ... 30

Errors ... 30

See Also ... 30

CreateWorkspaces ... 32

Request Syntax ... 32

Request Parameters ... 32

Response Syntax ... 32

Response Elements ... 33

Errors ... 34

See Also ... 34

DeleteConnectClientAddIn ... 35

Request Syntax ... 35

Request Parameters ... 35

Response Elements ... 35

Errors ... 35

See Also ... 36

DeleteConnectionAlias ... 37

Request Syntax ... 37

Request Parameters ... 37

Response Elements ... 37

Errors ... 37

See Also ... 38

DeleteIpGroup ... 39

Request Syntax ... 39

Request Parameters ... 39

Response Elements ... 39

Errors ... 39

See Also ... 40

DeleteTags ... 41

Request Syntax ... 41

Request Parameters ... 41

Response Elements ... 41

Errors ... 41

See Also ... 42

DeleteWorkspaceBundle ... 43

Request Syntax ... 43

Request Parameters ... 43

Response Elements ... 43

Errors ... 43

See Also ... 44

DeleteWorkspaceImage ... 45

Request Syntax ... 45

Request Parameters ... 45

(5)

Amazon WorkSpaces Service API Reference

See Also ... 45

DeregisterWorkspaceDirectory ... 47

Request Syntax ... 47

Request Parameters ... 47

Response Elements ... 47

Errors ... 47

See Also ... 48

DescribeAccount ... 49

Response Syntax ... 49

Response Elements ... 49

Errors ... 49

See Also ... 49

DescribeAccountModifications ... 51

Request Syntax ... 51

Request Parameters ... 51

Response Syntax ... 51

Response Elements ... 51

Errors ... 52

See Also ... 52

DescribeClientProperties ... 53

Request Syntax ... 53

Request Parameters ... 53

Response Syntax ... 53

Response Elements ... 53

Errors ... 53

See Also ... 54

DescribeConnectClientAddIns ... 55

Request Syntax ... 55

Request Parameters ... 55

Response Syntax ... 55

Response Elements ... 56

Errors ... 56

See Also ... 56

DescribeConnectionAliases ... 58

Request Syntax ... 58

Request Parameters ... 58

Response Syntax ... 59

Response Elements ... 59

Errors ... 59

See Also ... 60

DescribeConnectionAliasPermissions ... 61

Request Syntax ... 61

Request Parameters ... 61

Response Syntax ... 61

Response Elements ... 62

Errors ... 62

See Also ... 63

DescribeIpGroups ... 64

Request Syntax ... 64

Request Parameters ... 64

Response Syntax ... 64

Response Elements ... 65

Errors ... 65

See Also ... 65

DescribeTags ... 67

Request Syntax ... 67

Request Parameters ... 67

API Version 2015-04-08 v

(6)

Response Syntax ... 67

Response Elements ... 67

Errors ... 67

See Also ... 68

DescribeWorkspaceBundles ... 69

Request Syntax ... 69

Request Parameters ... 69

Response Syntax ... 69

Response Elements ... 70

Errors ... 70

See Also ... 70

DescribeWorkspaceDirectories ... 72

Request Syntax ... 72

Request Parameters ... 72

Response Syntax ... 72

Response Elements ... 73

Errors ... 74

See Also ... 74

DescribeWorkspaceImagePermissions ... 75

Request Syntax ... 75

Request Parameters ... 75

Response Syntax ... 75

Response Elements ... 76

Errors ... 76

See Also ... 76

DescribeWorkspaceImages ... 78

Request Syntax ... 78

Request Parameters ... 78

Response Syntax ... 79

Response Elements ... 79

Errors ... 79

See Also ... 80

DescribeWorkspaces ... 81

Request Syntax ... 81

Request Parameters ... 81

Response Syntax ... 82

Response Elements ... 83

Errors ... 83

See Also ... 83

DescribeWorkspacesConnectionStatus ... 85

Request Syntax ... 85

Request Parameters ... 85

Response Syntax ... 85

Response Elements ... 85

Errors ... 86

See Also ... 86

DescribeWorkspaceSnapshots ... 87

Request Syntax ... 87

Request Parameters ... 87

Response Syntax ... 87

Response Elements ... 87

Errors ... 88

See Also ... 88

DisassociateConnectionAlias ... 89

Request Syntax ... 89

(7)

Amazon WorkSpaces Service API Reference

Errors ... 89

See Also ... 90

DisassociateIpGroups ... 91

Request Syntax ... 91

Request Parameters ... 91

Response Elements ... 91

Errors ... 91

See Also ... 92

ImportWorkspaceImage ... 93

Request Syntax ... 93

Request Parameters ... 93

Response Syntax ... 94

Response Elements ... 94

Errors ... 95

See Also ... 95

ListAvailableManagementCidrRanges ... 96

Request Syntax ... 96

Request Parameters ... 96

Response Syntax ... 97

Response Elements ... 97

Errors ... 97

See Also ... 97

MigrateWorkspace ... 99

Request Syntax ... 99

Request Parameters ... 99

Response Syntax ... 99

Response Elements ... 99

Errors ... 100

See Also ... 100

ModifyAccount ... 102

Request Syntax ... 102

Request Parameters ... 102

Response Elements ... 102

Errors ... 102

See Also ... 103

ModifyClientProperties ... 104

Request Syntax ... 104

Request Parameters ... 104

Response Elements ... 104

Errors ... 104

See Also ... 105

ModifySelfservicePermissions ... 106

Request Syntax ... 106

Request Parameters ... 106

Response Elements ... 106

Errors ... 106

See Also ... 107

ModifyWorkspaceAccessProperties ... 108

Request Syntax ... 108

Request Parameters ... 108

Response Elements ... 108

Errors ... 108

See Also ... 109

ModifyWorkspaceCreationProperties ... 110

Request Syntax ... 110

Request Parameters ... 110

Response Elements ... 110

API Version 2015-04-08 vii

(8)

Errors ... 110

See Also ... 111

ModifyWorkspaceProperties ... 112

Request Syntax ... 112

Request Parameters ... 112

Response Elements ... 112

Errors ... 112

See Also ... 113

ModifyWorkspaceState ... 114

Request Syntax ... 114

Request Parameters ... 114

Response Elements ... 114

Errors ... 114

See Also ... 115

RebootWorkspaces ... 116

Request Syntax ... 116

Request Parameters ... 116

Response Syntax ... 116

Response Elements ... 116

Errors ... 117

See Also ... 117

RebuildWorkspaces ... 118

Request Syntax ... 118

Request Parameters ... 118

Response Syntax ... 118

Response Elements ... 118

Errors ... 119

See Also ... 119

RegisterWorkspaceDirectory ... 120

Request Syntax ... 120

Request Parameters ... 120

Response Elements ... 121

Errors ... 121

See Also ... 122

RestoreWorkspace ... 123

Request Syntax ... 123

Request Parameters ... 123

Response Elements ... 123

Errors ... 123

See Also ... 124

RevokeIpRules ... 125

Request Syntax ... 125

Request Parameters ... 125

Response Elements ... 125

Errors ... 125

See Also ... 126

StartWorkspaces ... 127

Request Syntax ... 127

Request Parameters ... 127

Response Syntax ... 127

Response Elements ... 127

Errors ... 128

See Also ... 128

StopWorkspaces ... 129

Request Syntax ... 129

(9)

Amazon WorkSpaces Service API Reference

Response Elements ... 129

Errors ... 130

See Also ... 130

TerminateWorkspaces ... 131

Request Syntax ... 131

Request Parameters ... 131

Response Syntax ... 131

Response Elements ... 132

Errors ... 132

See Also ... 132

UpdateConnectClientAddIn ... 133

Request Syntax ... 133

Request Parameters ... 133

Response Elements ... 134

Errors ... 134

See Also ... 134

UpdateConnectionAliasPermission ... 135

Request Syntax ... 135

Request Parameters ... 135

Response Elements ... 135

Errors ... 136

See Also ... 136

UpdateRulesOfIpGroup ... 137

Request Syntax ... 137

Request Parameters ... 137

Response Elements ... 137

Errors ... 137

See Also ... 138

UpdateWorkspaceBundle ... 139

Request Syntax ... 139

Request Parameters ... 139

Response Elements ... 139

Errors ... 139

See Also ... 140

UpdateWorkspaceImagePermission ... 141

Request Syntax ... 141

Request Parameters ... 141

Response Elements ... 142

Errors ... 142

See Also ... 142

Data Types ... 143

AccountModification ... 145

Contents ... 145

See Also ... 146

ClientProperties ... 147

Contents ... 147

See Also ... 147

ClientPropertiesResult ... 148

Contents ... 148

See Also ... 148

ComputeType ... 149

Contents ... 149

See Also ... 149

ConnectClientAddIn ... 150

Contents ... 150

See Also ... 150

ConnectionAlias ... 152

API Version 2015-04-08 ix

(10)

Contents ... 152

See Also ... 153

ConnectionAliasAssociation ... 154

Contents ... 154

See Also ... 154

ConnectionAliasPermission ... 156

Contents ... 156

See Also ... 156

DefaultWorkspaceCreationProperties ... 157

Contents ... 157

See Also ... 158

FailedCreateWorkspaceRequest ... 159

Contents ... 159

See Also ... 159

FailedWorkspaceChangeRequest ... 160

Contents ... 160

See Also ... 160

ImagePermission ... 161

Contents ... 161

See Also ... 161

IpRuleItem ... 162

Contents ... 162

See Also ... 162

ModificationState ... 163

Contents ... 163

See Also ... 163

OperatingSystem ... 164

Contents ... 164

See Also ... 164

RebootRequest ... 165

Contents ... 165

See Also ... 165

RebuildRequest ... 166

Contents ... 166

See Also ... 166

RootStorage ... 167

Contents ... 167

See Also ... 167

SelfservicePermissions ... 168

Contents ... 168

See Also ... 168

Snapshot ... 170

Contents ... 170

See Also ... 170

StartRequest ... 171

Contents ... 171

See Also ... 171

StopRequest ... 172

Contents ... 172

See Also ... 172

Tag ... 173

Contents ... 173

See Also ... 173

TerminateRequest ... 174

Contents ... 174

(11)

Amazon WorkSpaces Service API Reference

Contents ... 175

See Also ... 175

UserStorage ... 176

Contents ... 176

See Also ... 176

Workspace ... 177

Contents ... 177

See Also ... 179

WorkspaceAccessProperties ... 180

Contents ... 180

See Also ... 181

WorkspaceBundle ... 182

Contents ... 182

See Also ... 183

WorkspaceConnectionStatus ... 184

Contents ... 184

See Also ... 184

WorkspaceCreationProperties ... 185

Contents ... 185

See Also ... 186

WorkspaceDirectory ... 187

Contents ... 187

See Also ... 189

WorkspaceImage ... 190

Contents ... 190

See Also ... 191

WorkspaceProperties ... 192

Contents ... 192

See Also ... 192

WorkspaceRequest ... 194

Contents ... 194

See Also ... 195

WorkspacesIpGroup ... 196

Contents ... 196

See Also ... 196

Common Errors ... 197

CloudTrail Logging ... 199

WorkSpaces Information in CloudTrail ... 199

Example: WorkSpaces Log File Entry ... 199

API Version 2015-04-08 xi

(12)

Welcome to the Amazon WorkSpaces API Reference

This is the Amazon WorkSpaces API Reference. This guide provides detailed information about the Amazon WorkSpaces API.

(13)

Amazon WorkSpaces Service API Reference

Actions

The following actions are supported:

• AssociateConnectionAlias (p. 4)

• AssociateIpGroups (p. 7)

• AuthorizeIpRules (p. 9)

• CopyWorkspaceImage (p. 11)

• CreateConnectClientAddIn (p. 14)

• CreateConnectionAlias (p. 17)

• CreateIpGroup (p. 20)

• CreateTags (p. 23)

• CreateUpdatedWorkspaceImage (p. 25)

• CreateWorkspaceBundle (p. 28)

• CreateWorkspaces (p. 32)

• DeleteConnectClientAddIn (p. 35)

• DeleteConnectionAlias (p. 37)

• DeleteIpGroup (p. 39)

• DeleteTags (p. 41)

• DeleteWorkspaceBundle (p. 43)

• DeleteWorkspaceImage (p. 45)

• DeregisterWorkspaceDirectory (p. 47)

• DescribeAccount (p. 49)

• DescribeAccountModifications (p. 51)

• DescribeClientProperties (p. 53)

• DescribeConnectClientAddIns (p. 55)

• DescribeConnectionAliases (p. 58)

• DescribeConnectionAliasPermissions (p. 61)

• DescribeIpGroups (p. 64)

• DescribeTags (p. 67)

• DescribeWorkspaceBundles (p. 69)

• DescribeWorkspaceDirectories (p. 72)

• DescribeWorkspaceImagePermissions (p. 75)

• DescribeWorkspaceImages (p. 78)

• DescribeWorkspaces (p. 81)

• DescribeWorkspacesConnectionStatus (p. 85)

• DescribeWorkspaceSnapshots (p. 87)

• DisassociateConnectionAlias (p. 89)

• DisassociateIpGroups (p. 91)

• ImportWorkspaceImage (p. 93)

• ListAvailableManagementCidrRanges (p. 96)

• MigrateWorkspace (p. 99)

• ModifyAccount (p. 102)

• ModifyClientProperties (p. 104)

API Version 2015-04-08 2

(14)

• ModifySelfservicePermissions (p. 106)

• ModifyWorkspaceAccessProperties (p. 108)

• ModifyWorkspaceCreationProperties (p. 110)

• ModifyWorkspaceProperties (p. 112)

• ModifyWorkspaceState (p. 114)

• RebootWorkspaces (p. 116)

• RebuildWorkspaces (p. 118)

• RegisterWorkspaceDirectory (p. 120)

• RestoreWorkspace (p. 123)

• RevokeIpRules (p. 125)

• StartWorkspaces (p. 127)

• StopWorkspaces (p. 129)

• TerminateWorkspaces (p. 131)

• UpdateConnectClientAddIn (p. 133)

• UpdateConnectionAliasPermission (p. 135)

• UpdateRulesOfIpGroup (p. 137)

• UpdateWorkspaceBundle (p. 139)

• UpdateWorkspaceImagePermission (p. 141)

(15)

Amazon WorkSpaces Service API Reference AssociateConnectionAlias

AssociateConnectionAlias

Associates the specified connection alias with the specified directory to enable cross-Region redirection.

For more information, see Cross-Region Redirection for Amazon WorkSpaces.

NoteBefore performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Request Syntax

{ "AliasId": "string", "ResourceId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

AliasId (p. 4)

The identifier of the connection alias.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: Yes ResourceId (p. 4)

The identifier of the directory to associate the connection alias with.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{

"ConnectionIdentifier": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2015-04-08 4

(16)

Errors

ConnectionIdentifier (p. 4)

The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^[a-zA-Z0-9]+$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceAssociatedException

The resource is associated with a directory.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(17)

Amazon WorkSpaces Service API Reference See Also

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 6

(18)

AssociateIpGroups

AssociateIpGroups

Associates the specified IP access control group with the specified directory.

Request Syntax

{

"DirectoryId": "string", "GroupIds": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

DirectoryId (p. 7)

The identifier of the directory.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes GroupIds (p. 7)

The identifiers of one or more IP access control groups.

Type: Array of strings

Pattern: wsipg-[0-9a-z]{8,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

(19)

Amazon WorkSpaces Service API Reference See Also

InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 8

(20)

AuthorizeIpRules

AuthorizeIpRules

Adds one or more rules to the specified IP access control group.

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Request Syntax

{ "GroupId": "string", "UserRules": [ {

"ipRule": "string", "ruleDesc": "string"

} ]}

Request Parameters

The request accepts the following data in JSON format.

GroupId (p. 9)

The identifier of the group.

Type: String

Pattern: wsipg-[0-9a-z]{8,63}$

Required: Yes UserRules (p. 9)

The rules to add to the group.

Type: Array of IpRuleItem (p. 162) objects Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

(21)

Amazon WorkSpaces Service API Reference See Also

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 10

(22)

CopyWorkspaceImage

CopyWorkspaceImage

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

In the China (Ningxia) Region, you can copy images only within the same Region.

In AWS GovCloud (US), to copy images to and from other Regions, contact AWS Support.

Important

Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the ID of the AWS account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Request Syntax

{ "Description": "string", "Name": "string",

"SourceImageId": "string", "SourceRegion": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

The request accepts the following data in JSON format.

Description (p. 11)

A description of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: No Name (p. 11)

The name of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_./()\\-]+$

Required: Yes

(23)

Amazon WorkSpaces Service API Reference Response Syntax

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes SourceRegion (p. 11)

The identifier of the source Region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 31.

Pattern: ^[-0-9a-z]{1,31}$

Required: Yes Tags (p. 11)

The tags for the image.

Type: Array of Tag (p. 173) objects Required: No

Response Syntax

{ "ImageId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImageId (p. 12)

The identifier of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

API Version 2015-04-08 12

(24)

See Also

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400 ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(25)

Amazon WorkSpaces Service API Reference CreateConnectClientAddIn

CreateConnectClientAddIn

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

Request Syntax

{ "Name": "string", "ResourceId": "string", "URL": "string"

}

Request Parameters

The request accepts the following data in JSON format.

Name (p. 14)

The name of the client add-in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^.*$

Required: Yes ResourceId (p. 14)

The directory identifier for which to configure the client add-in.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes URL (p. 14)

The endpoint URL of the Amazon Connect client add-in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(http|https)\://\S+

Required: Yes

Response Syntax

{

API Version 2015-04-08 14

(26)

Response Elements

"AddInId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AddInId (p. 14)

The client add-in identifier.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceCreationFailedException

The resource could not be created.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

(27)

Amazon WorkSpaces Service API Reference See Also

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 16

(28)

CreateConnectionAlias

CreateConnectionAlias

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Request Syntax

{ "ConnectionString": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ] }

Request Parameters

The request accepts the following data in JSON format.

ConnectionString (p. 17)

A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

Important

After you create a connection string, it is always associated to your AWS account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[.0-9a-zA-Z\-]{1,255}$

Required: Yes Tags (p. 17)

The tags to associate with the connection alias.

Type: Array of Tag (p. 173) objects Required: No

Response Syntax

{ "AliasId": "string"

}

Response Elements

(29)

Amazon WorkSpaces Service API Reference Errors

The following data is returned in JSON format by the service.

AliasId (p. 17)

The identifier of the connection alias.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

API Version 2015-04-08 18

(30)

See Also

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(31)

Amazon WorkSpaces Service API Reference CreateIpGroup

CreateIpGroup

Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules (p. 9).

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Request Syntax

{ "GroupDesc": "string", "GroupName": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ],

"UserRules": [ {

"ipRule": "string", "ruleDesc": "string"

} ]}

Request Parameters

The request accepts the following data in JSON format.

GroupDesc (p. 20)

The description of the group.

Type: String Required: No GroupName (p. 20)

The name of the group.

Type: String Required: Yes Tags (p. 20)

The tags. Each WorkSpaces resource can have a maximum of 50 tags.

Type: Array of Tag (p. 173) objects Required: No

API Version 2015-04-08 20

(32)

Response Syntax

UserRules (p. 20)

The rules to add to the group.

Type: Array of IpRuleItem (p. 162) objects Required: No

Response Syntax

{ "GroupId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupId (p. 21)

The identifier of the group.

Type: String

Pattern: wsipg-[0-9a-z]{8,63}$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceCreationFailedException

The resource could not be created.

HTTP Status Code: 400

(33)

Amazon WorkSpaces Service API Reference See Also

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 22

(34)

CreateTags

CreateTags

Creates the specified tags for the specified WorkSpaces resource.

Request Syntax

{ "ResourceId": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ] }

Request Parameters

The request accepts the following data in JSON format.

ResourceId (p. 23)

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes Tags (p. 23)

The tags. Each WorkSpaces resource can have a maximum of 50 tags.

Type: Array of Tag (p. 173) objects Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

(35)

Amazon WorkSpaces Service API Reference See Also

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 24

(36)

CreateUpdatedWorkspaceImage

CreateUpdatedWorkspaceImage

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

Note

• Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

• Microsoft Windows updates and other application updates are not included in the update process.

• The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Request Syntax

{

"Description": "string", "Name": "string",

"SourceImageId": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

The request accepts the following data in JSON format.

Description (p. 25)

A description of whether updates for the WorkSpace image are available.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: Yes Name (p. 25)

The name of the new updated WorkSpace image.

Type: String

(37)

Amazon WorkSpaces Service API Reference Response Syntax

Required: Yes SourceImageId (p. 25)

The identifier of the source WorkSpace image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes Tags (p. 25)

The tags that you want to add to the new updated WorkSpace image.

Note

To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

Type: Array of Tag (p. 173) objects Required: No

Response Syntax

{ "ImageId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImageId (p. 26)

The identifier of the new updated WorkSpace image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

API Version 2015-04-08 26

(38)

See Also

InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(39)

Amazon WorkSpaces Service API Reference CreateWorkspaceBundle

CreateWorkspaceBundle

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Request Syntax

{ "BundleDescription": "string", "BundleName": "string", "ComputeType": { "Name": "string"

},

"ImageId": "string", "RootStorage": { "Capacity": "string"

},

"Tags": [ {

"Key": "string", "Value": "string"

} ],

"UserStorage": { "Capacity": "string"

}}

Request Parameters

The request accepts the following data in JSON format.

BundleDescription (p. 28) The description of the bundle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: Yes BundleName (p. 28)

The name of the bundle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_./()\\-]+$

Required: Yes ComputeType (p. 28)

Describes the compute type of the bundle.

API Version 2015-04-08 28

(40)

Response Syntax

Type: ComputeType (p. 149) object Required: Yes

ImageId (p. 28)

The identifier of the image that is used to create the bundle.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes RootStorage (p. 28)

Describes the root volume for a WorkSpace bundle.

Type: RootStorage (p. 167) object Required: No

Tags (p. 28)

The tags associated with the bundle.

NoteTo add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

Type: Array of Tag (p. 173) objects Required: No

UserStorage (p. 28)

Describes the user volume for a WorkSpace bundle.

Type: UserStorage (p. 176) object Required: Yes

Response Syntax

{ "WorkspaceBundle": { "BundleId": "string", "ComputeType": { "Name": "string"

},

"CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string",

"Owner": "string", "RootStorage": { "Capacity": "string"

},

"UserStorage": {

(41)

Amazon WorkSpaces Service API Reference Response Elements

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

WorkspaceBundle (p. 29)

Describes a WorkSpace bundle.

Type: WorkspaceBundle (p. 182) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400 ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

API Version 2015-04-08 30

(42)

See Also

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(43)

Amazon WorkSpaces Service API Reference CreateWorkspaces

CreateWorkspaces

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

Request Syntax

{ "Workspaces": [ {

"BundleId": "string", "DirectoryId": "string",

"RootVolumeEncryptionEnabled": boolean, "Tags": [

{

"Key": "string", "Value": "string"

} ],

"UserName": "string",

"UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string",

"WorkspaceProperties": { "ComputeTypeName": "string", "RootVolumeSizeGib": number, "RunningMode": "string",

"RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number

} } ]}

Request Parameters

The request accepts the following data in JSON format.

Workspaces (p. 32)

The WorkSpaces to create. You can specify up to 25 WorkSpaces.

Type: Array of WorkspaceRequest (p. 194) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax

{ "FailedRequests": [ {

"ErrorCode": "string", "ErrorMessage": "string", "WorkspaceRequest": { "BundleId": "string",

API Version 2015-04-08 32

(44)

Response Elements

"DirectoryId": "string",

"RootVolumeEncryptionEnabled": boolean, "Tags": [

{

"Key": "string", "Value": "string"

} ],

"UserName": "string",

"UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string",

"WorkspaceProperties": { "ComputeTypeName": "string", "RootVolumeSizeGib": number, "RunningMode": "string",

"RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number

} } } ],

"PendingRequests": [ {

"BundleId": "string", "ComputerName": "string", "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "ModificationStates": [ {

"Resource": "string", "State": "string"

} ],

"RootVolumeEncryptionEnabled": boolean, "State": "string",

"SubnetId": "string", "UserName": "string",

"UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string",

"WorkspaceId": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "RootVolumeSizeGib": number, "RunningMode": "string",

"RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number

} } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedRequests (p. 32)

(45)

Amazon WorkSpaces Service API Reference Errors

PendingRequests (p. 32)

Information about the WorkSpaces that were created.

Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces (p. 81) before the WorkSpace is created, the information returned can be incomplete.

Type: Array of Workspace (p. 177) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 34

(46)

DeleteConnectClientAddIn

DeleteConnectClientAddIn

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Request Syntax

{

"AddInId": "string", "ResourceId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

AddInId (p. 35)

The identifier of the client add-in to delete.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes ResourceId (p. 35)

The directory identifier for which the client add-in is configured.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

(47)

Amazon WorkSpaces Service API Reference See Also

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 36

(48)

DeleteConnectionAlias

DeleteConnectionAlias

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Important

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

NoteTo delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Request Syntax

{ "AliasId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

AliasId (p. 37)

The identifier of the connection alias to delete.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

(49)

Amazon WorkSpaces Service API Reference See Also

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceAssociatedException

The resource is associated with a directory.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 38

(50)

DeleteIpGroup

DeleteIpGroup

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

Request Syntax

{ "GroupId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

GroupId (p. 39)

The identifier of the IP access control group.

Type: String

Pattern: wsipg-[0-9a-z]{8,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceAssociatedException

The resource is associated with a directory.

HTTP Status Code: 400 ResourceNotFoundException

(51)

Amazon WorkSpaces Service API Reference See Also

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 40

(52)

DeleteTags

DeleteTags

Deletes the specified tags from the specified WorkSpaces resource.

Request Syntax

{ "ResourceId": "string", "TagKeys": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

ResourceId (p. 41)

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes TagKeys (p. 41)

The tag keys.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceNotFoundException

(53)

Amazon WorkSpaces Service API Reference See Also

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 42

(54)

DeleteWorkspaceBundle

DeleteWorkspaceBundle

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Request Syntax

{ "BundleId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

BundleId (p. 43)

The identifier of the bundle.

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceAssociatedException

The resource is associated with a directory.

HTTP Status Code: 400 ResourceNotFoundException

(55)

Amazon WorkSpaces Service API Reference See Also

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 44

(56)

DeleteWorkspaceImage

DeleteWorkspaceImage

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Request Syntax

{ "ImageId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ImageId (p. 45)

The identifier of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400 ResourceAssociatedException

The resource is associated with a directory.

HTTP Status Code: 400

See Also

(57)

Amazon WorkSpaces Service API Reference See Also

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 46

(58)

DeregisterWorkspaceDirectory

DeregisterWorkspaceDirectory

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

NoteSimple AD and AD Connector are made available to you free of charge to use with WorkSpaces.

If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Service pricing terms.

To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Request Syntax

{ "DirectoryId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId (p. 47)

The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

(59)

Amazon WorkSpaces Service API Reference See Also

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 InvalidResourceStateException

The state of the resource is not valid for this operation.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 48

(60)

DescribeAccount

DescribeAccount

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Response Syntax

{

"DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DedicatedTenancyManagementCidrRange (p. 49)

The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

Type: String

Pattern: (^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9]

[0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$

DedicatedTenancySupport (p. 49)

The status of BYOL (whether BYOL is enabled or disabled).

Type: String

Valid Values: ENABLED | DISABLED

Errors

For information about the errors that are common to all actions, see Common Errors (p. 197).

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

See Also

(61)

Amazon WorkSpaces Service API Reference See Also

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2015-04-08 50

(62)

DescribeAccountModifications

DescribeAccountModifications

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Request Syntax

{

"NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

NextToken (p. 51)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{ "AccountModifications": [ {

"DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string",

"ErrorCode": "string", "ErrorMessage": "string", "ModificationState": "string", "StartTime": number

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountModifications (p. 51)

The list of modifications to the configuration of BYOL.

參考文獻

相關文件

(https://www.mercadolibre.cl/): 提供平台由當地供 應商自營,不像 amazon、pchome 等有 B2B2C 廠商

4-7 The photocopy of the letter of agreement between Business Incubation Center of Feng Chia University and the applied company over the operations and cultivations.. 4-8

To take the development of ITEd forward, it was recommended in the Second Information Technology in Education Strategy “Empowering Learning and Teaching with Information

If a contributor is actively seeking an appointment in the aided school sector but has not yet obtained an appointment as a regular teacher in a grant/subsidized school, or he

FIGURE 5. Item fit p-values based on equivalence classes when the 2LC model is fit to mixed-number data... Item fit plots when the 2LC model is fitted to the mixed-number

Wikipedia – Customer Service http://en.wikipedia.org/wiki/Customer_service Institute of Customer Service http://www.instituteofcustomerservice.com/. The Customer Service Zone

™ Independent networks (indep. basic service set, IBSS), also known as ad hoc networks.. ™

Improving Interpersonal Communication between Clients and Providers Reference Manual, Centre for Human Service: USA Curtin, R.B. “Patient-Provider Interaction: Strategies for