QConnect / Client / create_content

create_content

QConnect.Client.create_content(**kwargs)

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

See also: AWS API Documentation

Request Syntax

response = client.create_content(
    clientToken='string',
    knowledgeBaseId='string',
    metadata={
        'string': 'string'
    },
    name='string',
    overrideLinkOutUri='string',
    tags={
        'string': 'string'
    },
    title='string',
    uploadId='string'
)

Parameters:

• clientToken (string) –

  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.

  This field is autopopulated if not provided.

• knowledgeBaseId (string) –

  [REQUIRED]

  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 (dict) –

  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.

  • (string) –

    • (string) –

• name (string) –

  [REQUIRED]

  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.

• overrideLinkOutUri (string) – 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 (dict) –

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

  • (string) –

    • (string) –

• title (string) – The title of the content. If not set, the title is equal to the name.

• uploadId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'content': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'linkOutUri': 'string',
        'metadata': {
            'string': 'string'
        },
        'name': 'string',
        'revisionId': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        },
        'title': 'string',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • content (dict) –

    The content.

    • contentArn (string) –

      The Amazon Resource Name (ARN) of the content.

    • contentId (string) –

      The identifier of the content.

    • contentType (string) –

      The media type of the content.

    • knowledgeBaseArn (string) –

      The Amazon Resource Name (ARN) of the knowledge base.

    • knowledgeBaseId (string) –

      The identifier of the knowledge base.

    • linkOutUri (string) –

      The URI of the content.

    • metadata (dict) –

      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.

      • (string) –

        • (string) –

    • name (string) –

      The name of the content.

    • revisionId (string) –

      The identifier of the content revision.

    • status (string) –

      The status of the content.

    • tags (dict) –

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

      • (string) –

        • (string) –

    • title (string) –

      The title of the content.

    • url (string) –

      The URL of the content.

    • urlExpiry (datetime) –

      The expiration time of the URL as an epoch timestamp.

Exceptions

• QConnect.Client.exceptions.ConflictException

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.ServiceQuotaExceededException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ResourceNotFoundException