Skip to content

describe_shared_directories async

describe_shared_directories(
    owner_directory_id: DirectoryId,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    shared_directory_ids: Optional[DirectoryIds] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[Limit] = None,
) -> DescribeSharedDirectoriesResult

Returns the shared directories in your account.

Parameters:

  • owner_directory_id (DirectoryId) –

    Returns the identifier of the directory in the directory owner account.

  • shared_directory_ids (Optional[DirectoryIds], default: None ) –

    A list of identifiers of all shared directories in your account.

  • next_token (Optional[NextToken], default: None ) –

    The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

  • limit (Optional[Limit], default: None ) –

    The number of shared directories to return in the response object.

Raises:

Source code in docs_src/capo_directory_service/_services/async_directory_service.py
async def describe_shared_directories(
    self,
    owner_directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    shared_directory_ids: Optional[
        "capo_directory_service.types.directory_ids.DirectoryIds"
    ] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
    limit: Optional["capo_directory_service.types.limit.Limit"] = None,
) -> "capo_directory_service.types.describe_shared_directories_result.DescribeSharedDirectoriesResult":
    """<p>Returns the shared directories in your account. </p>

    Args:
        owner_directory_id: <p>Returns the identifier of the directory in the directory owner account. </p>
        shared_directory_ids: <p>A list of identifiers of all shared directories in your account. </p>
        next_token: <p>The <code>DescribeSharedDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeSharedDirectories</a>. Pass null if this is the first call. </p>
        limit: <p>The number of shared directories to return in the response object.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</p>
        capo_directory_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value is not valid.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.describe_shared_directories_request.DescribeSharedDirectoriesRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.describe_shared_directories_result.DescribeSharedDirectoriesResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.describe_shared_directories

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.describe_shared_directories.async_describe_shared_directories(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_directory_service.types.describe_shared_directories_result.DescribeSharedDirectoriesResult",
    ) -> dict[str, Any]:
        import capo_directory_service.types.describe_shared_directories_result

        return capo_directory_service.types.describe_shared_directories_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeSharedDirectories", redact_output=_redact_output),
    )
    input_: capo_directory_service.types.describe_shared_directories_request.DescribeSharedDirectoriesRequest = {
        "owner_directory_id": owner_directory_id
    }
    if shared_directory_ids is not None:
        input_["shared_directory_ids"] = shared_directory_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output