{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-08", "endpointPrefix":"workspaces", "jsonVersion":"1.1", "serviceFullName":"Amazon WorkSpaces", "signatureVersion":"v4", "targetPrefix":"WorkspacesService", "protocol":"json" }, "operations":{ "CreateWorkspaces":{ "name":"CreateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkspacesRequest"}, "output":{"shape":"CreateWorkspacesResult"}, "errors":[ { "shape":"ResourceLimitExceededException", "exception":true } ] }, "DescribeWorkspaceBundles":{ "name":"DescribeWorkspaceBundles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceBundlesRequest"}, "output":{"shape":"DescribeWorkspaceBundlesResult"}, "errors":[ { "shape":"InvalidParameterValuesException", "exception":true } ] }, "DescribeWorkspaceDirectories":{ "name":"DescribeWorkspaceDirectories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, "errors":[ { "shape":"InvalidParameterValuesException", "exception":true } ] }, "DescribeWorkspaces":{ "name":"DescribeWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspacesRequest"}, "output":{"shape":"DescribeWorkspacesResult"}, "errors":[ { "shape":"InvalidParameterValuesException", "exception":true }, { "shape":"ResourceUnavailableException", "exception":true } ] }, "RebootWorkspaces":{ "name":"RebootWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootWorkspacesRequest"}, "output":{"shape":"RebootWorkspacesResult"} }, "RebuildWorkspaces":{ "name":"RebuildWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebuildWorkspacesRequest"}, "output":{"shape":"RebuildWorkspacesResult"} }, "TerminateWorkspaces":{ "name":"TerminateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateWorkspacesRequest"}, "output":{"shape":"TerminateWorkspacesResult"} } }, "shapes":{ "ARN":{ "type":"string", "pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" }, "Alias":{"type":"string"}, "BooleanObject":{"type":"boolean"}, "BundleId":{ "type":"string", "pattern":"^wsb-[0-9a-z]{8,63}$" }, "BundleIdList":{ "type":"list", "member":{"shape":"BundleId"}, "min":1, "max":25 }, "BundleList":{ "type":"list", "member":{"shape":"WorkspaceBundle"} }, "BundleOwner":{"type":"string"}, "Compute":{ "type":"string", "enum":[ "VALUE", "STANDARD", "PERFORMANCE" ] }, "ComputeType":{ "type":"structure", "members":{ "Name":{"shape":"Compute"} } }, "CreateWorkspacesRequest":{ "type":"structure", "required":["Workspaces"], "members":{ "Workspaces":{"shape":"WorkspaceRequestList"} } }, "CreateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{"shape":"FailedCreateWorkspaceRequests"}, "PendingRequests":{"shape":"WorkspaceList"} } }, "DefaultOu":{"type":"string"}, "DefaultWorkspaceCreationProperties":{ "type":"structure", "members":{ "EnableWorkDocs":{"shape":"BooleanObject"}, "EnableInternetAccess":{"shape":"BooleanObject"}, "DefaultOu":{"shape":"DefaultOu"}, "CustomSecurityGroupId":{"shape":"SecurityGroupId"}, "UserEnabledAsLocalAdministrator":{"shape":"BooleanObject"} } }, "DescribeWorkspaceBundlesRequest":{ "type":"structure", "members":{ "BundleIds":{"shape":"BundleIdList"}, "Owner":{"shape":"BundleOwner"}, "NextToken":{"shape":"PaginationToken"} } }, "DescribeWorkspaceBundlesResult":{ "type":"structure", "members":{ "Bundles":{"shape":"BundleList"}, "NextToken":{"shape":"PaginationToken"} } }, "DescribeWorkspaceDirectoriesRequest":{ "type":"structure", "members":{ "DirectoryIds":{"shape":"DirectoryIdList"}, "NextToken":{"shape":"PaginationToken"} } }, "DescribeWorkspaceDirectoriesResult":{ "type":"structure", "members":{ "Directories":{"shape":"DirectoryList"}, "NextToken":{"shape":"PaginationToken"} } }, "DescribeWorkspacesRequest":{ "type":"structure", "members":{ "WorkspaceIds":{"shape":"WorkspaceIdList"}, "DirectoryId":{"shape":"DirectoryId"}, "UserName":{"shape":"UserName"}, "BundleId":{"shape":"BundleId"}, "Limit":{"shape":"Limit"}, "NextToken":{"shape":"PaginationToken"} } }, "DescribeWorkspacesResult":{ "type":"structure", "members":{ "Workspaces":{"shape":"WorkspaceList"}, "NextToken":{"shape":"PaginationToken"} } }, "Description":{"type":"string"}, "DirectoryId":{ "type":"string", "pattern":"^d-[0-9a-f]{8,63}$" }, "DirectoryIdList":{ "type":"list", "member":{"shape":"DirectoryId"}, "min":1, "max":25 }, "DirectoryList":{ "type":"list", "member":{"shape":"WorkspaceDirectory"} }, "DirectoryName":{"type":"string"}, "DnsIpAddresses":{ "type":"list", "member":{"shape":"IpAddress"} }, "ErrorType":{"type":"string"}, "ExceptionMessage":{"type":"string"}, "FailedCreateWorkspaceRequest":{ "type":"structure", "members":{ "WorkspaceRequest":{"shape":"WorkspaceRequest"}, "ErrorCode":{"shape":"ErrorType"}, "ErrorMessage":{"shape":"Description"} } }, "FailedCreateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedCreateWorkspaceRequest"} }, "FailedRebootWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedRebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedTerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedWorkspaceChangeRequest":{ "type":"structure", "members":{ "WorkspaceId":{"shape":"WorkspaceId"}, "ErrorCode":{"shape":"ErrorType"}, "ErrorMessage":{"shape":"Description"} } }, "InvalidParameterValuesException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "exception":true }, "IpAddress":{"type":"string"}, "Limit":{ "type":"integer", "min":1, "max":25 }, "NonEmptyString":{ "type":"string", "min":1 }, "PaginationToken":{ "type":"string", "min":1, "max":63 }, "RebootRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{"shape":"WorkspaceId"} } }, "RebootWorkspaceRequests":{ "type":"list", "member":{"shape":"RebootRequest"}, "min":1, "max":25 }, "RebootWorkspacesRequest":{ "type":"structure", "required":["RebootWorkspaceRequests"], "members":{ "RebootWorkspaceRequests":{"shape":"RebootWorkspaceRequests"} } }, "RebootWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{"shape":"FailedRebootWorkspaceRequests"} } }, "RebuildRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{"shape":"WorkspaceId"} } }, "RebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"RebuildRequest"}, "min":1, "max":1 }, "RebuildWorkspacesRequest":{ "type":"structure", "required":["RebuildWorkspaceRequests"], "members":{ "RebuildWorkspaceRequests":{"shape":"RebuildWorkspaceRequests"} } }, "RebuildWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{"shape":"FailedRebuildWorkspaceRequests"} } }, "RegistrationCode":{ "type":"string", "min":1, "max":20 }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "exception":true }, "ResourceUnavailableException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "ResourceId":{"shape":"NonEmptyString"} }, "exception":true }, "SecurityGroupId":{ "type":"string", "pattern":"^(sg-[0-9a-f]{8})$" }, "SubnetId":{ "type":"string", "pattern":"^(subnet-[0-9a-f]{8})$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"} }, "TerminateRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{"shape":"WorkspaceId"} } }, "TerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"TerminateRequest"}, "min":1, "max":25 }, "TerminateWorkspacesRequest":{ "type":"structure", "required":["TerminateWorkspaceRequests"], "members":{ "TerminateWorkspaceRequests":{"shape":"TerminateWorkspaceRequests"} } }, "TerminateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{"shape":"FailedTerminateWorkspaceRequests"} } }, "UserName":{ "type":"string", "min":1, "max":63 }, "UserStorage":{ "type":"structure", "members":{ "Capacity":{"shape":"NonEmptyString"} } }, "Workspace":{ "type":"structure", "members":{ "WorkspaceId":{"shape":"WorkspaceId"}, "DirectoryId":{"shape":"DirectoryId"}, "UserName":{"shape":"UserName"}, "IpAddress":{"shape":"IpAddress"}, "State":{"shape":"WorkspaceState"}, "BundleId":{"shape":"BundleId"}, "SubnetId":{"shape":"SubnetId"}, "ErrorMessage":{"shape":"Description"}, "ErrorCode":{"shape":"WorkspaceErrorCode"} } }, "WorkspaceBundle":{ "type":"structure", "members":{ "BundleId":{"shape":"BundleId"}, "Name":{"shape":"NonEmptyString"}, "Owner":{"shape":"BundleOwner"}, "Description":{"shape":"Description"}, "UserStorage":{"shape":"UserStorage"}, "ComputeType":{"shape":"ComputeType"} } }, "WorkspaceDirectory":{ "type":"structure", "members":{ "DirectoryId":{"shape":"DirectoryId"}, "Alias":{"shape":"Alias"}, "DirectoryName":{"shape":"DirectoryName"}, "RegistrationCode":{"shape":"RegistrationCode"}, "SubnetIds":{"shape":"SubnetIds"}, "DnsIpAddresses":{"shape":"DnsIpAddresses"}, "CustomerUserName":{"shape":"UserName"}, "IamRoleId":{"shape":"ARN"}, "DirectoryType":{"shape":"WorkspaceDirectoryType"}, "WorkspaceSecurityGroupId":{"shape":"SecurityGroupId"}, "State":{"shape":"WorkspaceDirectoryState"}, "WorkspaceCreationProperties":{"shape":"DefaultWorkspaceCreationProperties"} } }, "WorkspaceDirectoryState":{ "type":"string", "enum":[ "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR" ] }, "WorkspaceDirectoryType":{ "type":"string", "enum":[ "SIMPLE_AD", "AD_CONNECTOR" ] }, "WorkspaceErrorCode":{"type":"string"}, "WorkspaceId":{ "type":"string", "pattern":"^ws-[0-9a-z]{8,63}$" }, "WorkspaceIdList":{ "type":"list", "member":{"shape":"WorkspaceId"}, "min":1, "max":25 }, "WorkspaceList":{ "type":"list", "member":{"shape":"Workspace"} }, "WorkspaceRequest":{ "type":"structure", "required":[ "DirectoryId", "UserName", "BundleId" ], "members":{ "DirectoryId":{"shape":"DirectoryId"}, "UserName":{"shape":"UserName"}, "BundleId":{"shape":"BundleId"} } }, "WorkspaceRequestList":{ "type":"list", "member":{"shape":"WorkspaceRequest"}, "min":1, "max":25 }, "WorkspaceState":{ "type":"string", "enum":[ "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "REBUILDING", "TERMINATING", "TERMINATED", "SUSPENDED", "ERROR" ] } } }