Skip to content

UpdateContentRequest

Source code in docs_src/capo_qconnect/types/update_content_request.py
class UpdateContentRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN</p>"""
    content_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    revision_id: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>The <code>revisionId</code> of the content resource to update, taken from an earlier call to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a <code>PreconditionFailedException</code>.</p>"""
    title: NotRequired["capo_qconnect.types.content_title.ContentTitle"]
    """<p>The title of the content.</p>"""
    override_link_out_uri: NotRequired["capo_qconnect.types.uri.Uri"]
    """<p>The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>, exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>"""
    remove_override_link_out_uri: NotRequired["bool"]
    """<p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>"""
    metadata: NotRequired["capo_qconnect.types.content_metadata.ContentMetadata"]
    """<p>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>"""
    upload_id: NotRequired["capo_qconnect.types.upload_id.UploadId"]
    """<p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>. </p>"""

content_id instance-attribute

content_id: UuidOrArn

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

knowledge_base_id instance-attribute

knowledge_base_id: UuidOrArn

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

metadata instance-attribute

metadata: NotRequired[ContentMetadata]

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

override_link_out_uri: NotRequired[Uri]

The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

remove_override_link_out_uri: NotRequired[bool]

Unset the existing overrideLinkOutUri if it exists.

revision_id instance-attribute

revision_id: NotRequired[NonEmptyString]

The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

title instance-attribute

title: NotRequired[ContentTitle]

The title of the content.

upload_id instance-attribute

upload_id: NotRequired[UploadId]

A pointer to the uploaded asset. This value is returned by StartContentUpload.