选择您的 Cookie 首选项

我们使用必要 Cookie 和类似工具提供我们的网站和服务。我们使用性能 Cookie 收集匿名统计数据,以便我们可以了解客户如何使用我们的网站并进行改进。必要 Cookie 无法停用,但您可以单击“自定义”或“拒绝”来拒绝性能 Cookie。

如果您同意,AWS 和经批准的第三方还将使用 Cookie 提供有用的网站功能、记住您的首选项并显示相关内容,包括相关广告。要接受或拒绝所有非必要 Cookie,请单击“接受”或“拒绝”。要做出更详细的选择,请单击“自定义”。

DescribeWorkspaceDirectories - Amazon WorkSpaces Service
此页面尚未翻译为您的语言。 请求翻译

DescribeWorkspaceDirectories

Describes the available directories that are registered with Amazon WorkSpaces.

Request Syntax

{ "DirectoryIds": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "Limit": number, "NextToken": "string", "WorkspaceDirectoryNames": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

DirectoryIds

The identifiers of the directories. If the value is null, all directories are retrieved.

Type: Array of strings

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

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

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: No

Filters

The filter condition for the WorkSpaces.

Type: Array of DescribeWorkspaceDirectoriesFilter objects

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

Required: No

Limit

The maximum number of directories to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

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

WorkspaceDirectoryNames

The names of the WorkSpace directories.

Type: Array of strings

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

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$

Required: No

Response Syntax

{ "Directories": [ { "ActiveDirectoryConfig": { "DomainName": "string", "ServiceAccountSecretArn": "string" }, "Alias": "string", "CertificateBasedAuthProperties": { "CertificateAuthorityArn": "string", "Status": "string" }, "CustomerUserName": "string", "DirectoryId": "string", "DirectoryName": "string", "DirectoryType": "string", "DnsIpAddresses": [ "string" ], "ErrorMessage": "string", "IamRoleId": "string", "IDCConfig": { "ApplicationArn": "string", "InstanceArn": "string" }, "ipGroupIds": [ "string" ], "MicrosoftEntraConfig": { "ApplicationConfigSecretArn": "string", "TenantId": "string" }, "RegistrationCode": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" }, "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" }, "State": "string", "StreamingProperties": { "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "StorageConnectors": [ { "ConnectorType": "string", "Status": "string" } ], "StreamingExperiencePreferredProtocol": "string", "UserSettings": [ { "Action": "string", "MaximumLength": number, "Permission": "string" } ] }, "SubnetIds": [ "string" ], "Tenancy": "string", "UserIdentityType": "string", "WorkspaceAccessProperties": { "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeZeroClient": "string" }, "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "EnableWorkDocs": boolean, "InstanceIamRoleArn": "string", "UserEnabledAsLocalAdministrator": boolean }, "WorkspaceDirectoryDescription": "string", "WorkspaceDirectoryName": "string", "WorkspaceSecurityGroupId": "string", "WorkspaceType": "string" } ], "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.

Directories

Information about the directories.

Type: Array of WorkspaceDirectory objects

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Errors

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

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

See Also

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

隐私网站条款Cookie 首选项
© 2024, Amazon Web Services, Inc. 或其附属公司。保留所有权利。