Skip to content

export_compliance_inquiry async

export_compliance_inquiry(
    compliance_inquiry_id: InquiryId,
    *,
    config_overrides: Optional[AsyncArtifactClientConfig] = None,
    query_identifiers: Optional[QueryIdentifiersList] = None,
    include_citations: Optional[bool] = None,
) -> ExportComplianceInquiryResponse

Export a compliance inquiry report.

Parameters:

  • compliance_inquiry_id (InquiryId) –

    Unique resource ID for the compliance inquiry.

  • query_identifiers (Optional[QueryIdentifiersList], default: None ) –

    List of query identifiers to include in the export.

  • include_citations (Optional[bool], default: None ) –

    When true, include citations in the exported document.

Raises:

Examples:

Invoke ExportComplianceInquiry operation Exports a compliance inquiry report.

>>> await client.export_compliance_inquiry(compliance_inquiry_id='compliance-inquiry-abcdef0123456789', query_identifiers=[1, 2], include_citations=True)
Source code in docs_src/capo_artifact/_services/async_artifact.py
async def export_compliance_inquiry(
    self,
    compliance_inquiry_id: "capo_artifact.types.inquiry_id.InquiryId",
    *,
    config_overrides: Optional[AsyncArtifactClientConfig] = None,
    query_identifiers: Optional[
        "capo_artifact.types.query_identifiers_list.QueryIdentifiersList"
    ] = None,
    include_citations: Optional[bool] = None,
) -> "capo_artifact.types.export_compliance_inquiry_response.ExportComplianceInquiryResponse":
    """<p>Export a compliance inquiry report.</p>

    Args:
        compliance_inquiry_id: <p>Unique resource ID for the compliance inquiry.</p>
        query_identifiers: <p>List of query identifiers to include in the export.</p>
        include_citations: <p>When true, include citations in the exported document.</p>

    Raises:
        capo_artifact.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_artifact.errors.internal_server_exception.InternalServerException: <p>An unknown server exception has occurred.</p>
        capo_artifact.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_artifact.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_artifact.errors.validation_exception.ValidationException: <p>Request fails to satisfy the constraints specified by an AWS service.</p>
        capo_artifact.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Invoke ExportComplianceInquiry operation
        Exports a compliance inquiry report.

        >>> await client.export_compliance_inquiry(compliance_inquiry_id='compliance-inquiry-abcdef0123456789', query_identifiers=[1, 2], include_citations=True)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_artifact.types.export_compliance_inquiry_request.ExportComplianceInquiryRequest]",
    ) -> AsyncOperationResponse[
        "capo_artifact.types.export_compliance_inquiry_response.ExportComplianceInquiryResponse"
    ]:
        import capo_artifact._operations.artifact.export_compliance_inquiry

        (
            output,
            http_response,
        ) = await capo_artifact._operations.artifact.export_compliance_inquiry.async_export_compliance_inquiry(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_artifact.types.export_compliance_inquiry_response.ExportComplianceInquiryResponse",
    ) -> dict[str, Any]:
        import capo_artifact.types.export_compliance_inquiry_response

        return (
            capo_artifact.types.export_compliance_inquiry_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ExportComplianceInquiry", redact_output=_redact_output),
    )
    input_: capo_artifact.types.export_compliance_inquiry_request.ExportComplianceInquiryRequest = {
        "compliance_inquiry_id": compliance_inquiry_id
    }
    if query_identifiers is not None:
        input_["query_identifiers"] = query_identifiers
    if include_citations is not None:
        input_["include_citations"] = include_citations

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