DescribeSharedDirectories
Returns the shared directories in your account.
Request Syntax
{
"Limit": number,
"NextToken": "string",
"OwnerDirectoryId": "string",
"SharedDirectoryIds": [ "string" ]
}Request Parameters
The request accepts the following data in JSON format.
-
The number of shared directories to return in the response object.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
-
The
DescribeSharedDirectoriesResult.NextTokenvalue from a previous call to DescribeSharedDirectories. Pass null if this is the first call.Type: String
Required: No
-
Returns the identifier of the directory in the directory owner account.
Type: String
Pattern:
^d-[0-9a-f]{10}$Required: Yes
-
A list of identifiers of all shared directories in your account.
Type: Array of strings
Pattern:
^d-[0-9a-f]{10}$Required: No
Response Syntax
{
"NextToken": "string",
"SharedDirectories": [
{
"CreatedDateTime": number,
"LastUpdatedDateTime": number,
"OwnerAccountId": "string",
"OwnerDirectoryId": "string",
"SharedAccountId": "string",
"SharedDirectoryId": "string",
"ShareMethod": "string",
"ShareNotes": "string",
"ShareStatus": "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.
-
If not null, token that indicates that more results are available. Pass this value for the
NextTokenparameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.Type: String
-
A list of all shared directories in your account.
Type: Array of SharedDirectory objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
A client exception has occurred.
HTTP Status Code: 400
- EntityDoesNotExistException
-
The specified entity could not be found.
HTTP Status Code: 400
- InvalidNextTokenException
-
The
NextTokenvalue is not valid.HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters are not valid.
HTTP Status Code: 400
- ServiceException
-
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
- UnsupportedOperationException
-
The operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
