Skip to content

CreateContentRequest

Source code in docs_src/capo_qconnect/types/create_content_request.py
class CreateContentRequest(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. URLs cannot contain the ARN.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>"""
    title: NotRequired["capo_qconnect.types.content_title.ContentTitle"]
    """<p>The title of the content. If not set, the title is equal to the name.</p>"""
    override_link_out_uri: NotRequired["capo_qconnect.types.uri.Uri"]
    """<p>The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.</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: "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>"""
    client_token: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

client_token instance-attribute

client_token: NotRequired[NonEmptyString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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. URLs cannot contain 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.

name instance-attribute

name: Name

The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

override_link_out_uri: NotRequired[Uri]

The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

tags instance-attribute

tags: NotRequired[Tags]

The tags used to organize, track, or control access for this resource.

title instance-attribute

title: NotRequired[ContentTitle]

The title of the content. If not set, the title is equal to the name.

upload_id instance-attribute

upload_id: UploadId

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