list_log_subscriptions `async` ¶

list_log_subscriptions(
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    directory_id: Optional[DirectoryId] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[Limit] = None,
) -> ListLogSubscriptionsResult

Lists the active log subscriptions for the Amazon Web Services account.

Parameters:

directory_id (Optional[DirectoryId], default: None ) –

If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.
next_token (Optional[NextToken], default: None ) –

The token for the next set of items to return.
limit (Optional[Limit], default: None ) –

The maximum number of items returned.

Raises:

ClientException –

A client exception has occurred.
EntityDoesNotExistException –

The specified entity could not be found.
InvalidNextTokenException –

The NextToken value is not valid.
ServiceException –

An exception has occurred in Directory Service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_directory_service/_services/async_directory_service.py

async def list_log_subscriptions(
    self,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    directory_id: Optional[
        "capo_directory_service.types.directory_id.DirectoryId"
    ] = 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.list_log_subscriptions_result.ListLogSubscriptionsResult":
    """<p>Lists the active log subscriptions for the Amazon Web Services account.</p>

    Args:
        directory_id: <p>If a <i>DirectoryID</i> is provided, lists only the log subscription associated with that directory. If no <i>DirectoryId</i> is provided, lists all log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.</p>
        next_token: <p>The token for the next set of items to return.</p>
        limit: <p>The maximum number of items returned.</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.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</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.list_log_subscriptions_request.ListLogSubscriptionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.list_log_subscriptions_result.ListLogSubscriptionsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.list_log_subscriptions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLogSubscriptions")
    )
    input_: capo_directory_service.types.list_log_subscriptions_request.ListLogSubscriptionsRequest = {}
    if directory_id is not None:
        input_["directory_id"] = directory_id
    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

list_log_subscriptions async ¶

list_log_subscriptions `async` ¶