QApps / Client / create_library_item

create_library_item#

QApps.Client.create_library_item(**kwargs)#

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

See also: AWS API Documentation

Request Syntax

response = client.create_library_item(
    instanceId='string',
    appId='string',
    appVersion=123,
    categories=[
        'string',
    ]
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

    The unique identifier of the Amazon Q Business application environment instance.

  • appId (string) –

    [REQUIRED]

    The unique identifier of the Amazon Q App to publish to the library.

  • appVersion (integer) –

    [REQUIRED]

    The version of the Amazon Q App to publish to the library.

  • categories (list) –

    [REQUIRED]

    The categories to associate with the library item for easier discovery.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'libraryItemId': 'string',
    'status': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'ratingCount': 123,
    'isVerified': True|False
}

Response Structure

  • (dict) –

    • libraryItemId (string) –

      The unique identifier of the new library item.

    • status (string) –

      The status of the new library item, such as “Published”.

    • createdAt (datetime) –

      The date and time the library item was created.

    • createdBy (string) –

      The user who created the library item.

    • updatedAt (datetime) –

      The date and time the library item was last updated.

    • updatedBy (string) –

      The user who last updated the library item.

    • ratingCount (integer) –

      The number of ratings the library item has received from users.

    • isVerified (boolean) –

      Indicates whether the library item has been verified.

Exceptions