describe_comments ¶

def describe_comments(
    self,
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    version_id: "capo_workdocs.types.document_version_id_type.DocumentVersionIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    marker: Optional["capo_workdocs.types.marker_type.MarkerType"] = None,
) -> "capo_workdocs.types.describe_comments_response.DescribeCommentsResponse":
    """<p>List all the comments for the specified document version.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        document_id: <p>The ID of the document.</p>
        version_id: <p>The ID of the document version.</p>
        limit: <p>The maximum number of items to return.</p>
        marker: <p>The marker for the next set of results. This marker was received from a previous call.</p>

    Raises:
        capo_workdocs.errors.entity_not_exists_exception.EntityNotExistsException: <p>The resource does not exist.</p>
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.service_unavailable_exception.ServiceUnavailableException: <p>One or more of the dependencies is unavailable.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workdocs.types.describe_comments_request.DescribeCommentsRequest]",
    ) -> OperationResponse[
        "capo_workdocs.types.describe_comments_response.DescribeCommentsResponse"
    ]:
        import capo_workdocs._operations.aws_gorilla_boy_service.describe_comments

        output, http_response = (
            capo_workdocs._operations.aws_gorilla_boy_service.describe_comments.describe_comments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.describe_comments_request.DescribeCommentsRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.describe_comments_request

        return capo_workdocs.types.describe_comments_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_workdocs.types.describe_comments_response.DescribeCommentsResponse",
    ) -> dict[str, Any]:
        import capo_workdocs.types.describe_comments_response

        return capo_workdocs.types.describe_comments_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeComments",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_workdocs.types.describe_comments_request.DescribeCommentsRequest = {
        "document_id": document_id,
        "version_id": version_id,
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token
    if limit is not None:
        input_["limit"] = limit
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output