AWS API Changes

2024/11/06 - QApps - 4 new 3 updated api methods

Changes Introduces category apis in AmazonQApps. Web experience users use Categories to tag and filter library items.

BatchDeleteCategory (new)

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

See also: AWS API Documentation

Request Syntax

client.batch_delete_category(
    instanceId='string',
    categories=[
        'string',
    ]
)

type instanceId

string

param instanceId

[REQUIRED]

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

type categories

list

param categories

[REQUIRED]

The list of IDs of the categories to be deleted.

(string) --

returns

None

BatchCreateCategory (new)

Link ¶

Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

See also: AWS API Documentation

Request Syntax

client.batch_create_category(
    instanceId='string',
    categories=[
        {
            'id': 'string',
            'title': 'string',
            'color': 'string'
        },
    ]
)

type instanceId

string

param instanceId

[REQUIRED]

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

type categories

list

param categories

[REQUIRED]

The list of category objects to be created

(dict) --

The category object to be created.
- id (string) --
  
  The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.
- title (string) -- [REQUIRED]
  
  The name of the category.
- color (string) --
  
  The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.

returns

None

BatchUpdateCategory (new)

Link ¶

Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

See also: AWS API Documentation

Request Syntax

client.batch_update_category(
    instanceId='string',
    categories=[
        {
            'id': 'string',
            'title': 'string',
            'color': 'string'
        },
    ]
)

type instanceId

string

param instanceId

[REQUIRED]

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

type categories

list

param categories

[REQUIRED]

The list of categories to be updated with their new values.

(dict) --

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.
- id (string) -- [REQUIRED]
  
  The unique identifier of the category.
- title (string) -- [REQUIRED]
  
  The name of the category.
- color (string) --
  
  The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

returns

None

ListCategories (new)

Link ¶

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

See also: AWS API Documentation

Request Syntax

client.list_categories(
    instanceId='string'
)

type instanceId

string

param instanceId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'categories': [
        {
            'id': 'string',
            'title': 'string',
            'color': 'string',
            'appCount': 123
        },
    ]
}

Response Structure

(dict) --
- categories (list) --
  
  The categories of a Amazon Q Business application environment instance.
  - (dict) --
    
    A category used to classify and filter library items for Amazon Q Apps.
    - id (string) --
      
      The unique identifier of the category.
    - title (string) --
      
      The title or name of the category.
    - color (string) --
      
      The color of the category
    - appCount (integer) --
      
      The number of published Amazon Q Apps associated with a category

GetLibraryItem (updated)

Link ¶
Changes (response)

{'categories': {'appCount': 'integer', 'color': 'string'}}

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

See also: AWS API Documentation

Request Syntax

client.get_library_item(
    instanceId='string',
    libraryItemId='string',
    appId='string'
)

type instanceId

string

param instanceId

[REQUIRED]

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

type libraryItemId

string

param libraryItemId

[REQUIRED]

The unique identifier of the library item to retrieve.

type appId

string

param appId

The unique identifier of the Amazon Q App associated with the library item.

rtype

dict

returns

Response Syntax

{
    'libraryItemId': 'string',
    'appId': 'string',
    'appVersion': 123,
    'categories': [
        {
            'id': 'string',
            'title': 'string',
            'color': 'string',
            'appCount': 123
        },
    ],
    'status': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'ratingCount': 123,
    'isRatedByUser': True|False,
    'userCount': 123,
    'isVerified': True|False
}

Response Structure

(dict) --
- libraryItemId (string) --
  
  The unique identifier of the library item.
- appId (string) --
  
  The unique identifier of the Q App associated with the library item.
- appVersion (integer) --
  
  The version of the Q App associated with the library item.
- categories (list) --
  
  The categories associated with the library item for discovery.
  - (dict) --
    
    A category used to classify and filter library items for Amazon Q Apps.
    - id (string) --
      
      The unique identifier of the category.
    - title (string) --
      
      The title or name of the category.
    - color (string) --
      
      The color of the category
    - appCount (integer) --
      
      The number of published Amazon Q Apps associated with a category
- status (string) --
  
  The status of the 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.
- isRatedByUser (boolean) --
  
  Whether the current user has rated the library item.
- userCount (integer) --
  
  The number of users who have associated the Q App with their account.
- isVerified (boolean) --
  
  Indicates whether the library item has been verified.

ListLibraryItems (updated)

Link ¶
Changes (response)

{'libraryItems': {'categories': {'appCount': 'integer', 'color': 'string'}}}

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_library_items(
    instanceId='string',
    limit=123,
    nextToken='string',
    categoryId='string'
)

type instanceId

string

param instanceId

[REQUIRED]

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

type limit

integer

param limit

The maximum number of library items to return in the response.

type nextToken

string

param nextToken

The token to request the next page of results.

type categoryId

string

param categoryId

Optional category to filter the library items by.

rtype

dict

returns

Response Syntax

{
    'libraryItems': [
        {
            'libraryItemId': 'string',
            'appId': 'string',
            'appVersion': 123,
            'categories': [
                {
                    'id': 'string',
                    'title': 'string',
                    'color': 'string',
                    'appCount': 123
                },
            ],
            'status': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'ratingCount': 123,
            'isRatedByUser': True|False,
            'userCount': 123,
            'isVerified': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- libraryItems (list) --
  
  The list of library items meeting the request criteria.
  - (dict) --
    
    A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.
    - libraryItemId (string) --
      
      The unique identifier of the library item.
    - appId (string) --
      
      The unique identifier of the Q App associated with the library item.
    - appVersion (integer) --
      
      The version of the Q App associated with the library item.
    - categories (list) --
      
      The categories associated with the library item.
      - (dict) --
        
        A category used to classify and filter library items for Amazon Q Apps.
        
        id (string) --
        
        The unique identifier of the category.
        
        title (string) --
        
        The title or name of the category.
        
        color (string) --
        
        The color of the category
        
        appCount (integer) --
        
        The number of published Amazon Q Apps associated with a category
    - status (string) --
      
      The status of the library item.
    - 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.
    - isRatedByUser (boolean) --
      
      Whether the current user has rated the library item.
    - userCount (integer) --
      
      The number of users who have the associated Q App.
    - isVerified (boolean) --
      
      Indicates whether the library item has been verified.
- nextToken (string) --
  
  The token to use to request the next page of results.

UpdateLibraryItem (updated)

Link ¶
Changes (response)

{'categories': {'appCount': 'integer', 'color': 'string'}}

Updates the library item for an Amazon Q App.

See also: AWS API Documentation

Request Syntax

client.update_library_item(
    instanceId='string',
    libraryItemId='string',
    status='PUBLISHED'|'DISABLED',
    categories=[
        'string',
    ]
)

type instanceId

string

param instanceId

[REQUIRED]

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

type libraryItemId

string

param libraryItemId

[REQUIRED]

The unique identifier of the library item to update.

type status

string

param status

The new status to set for the library item, such as "Published" or "Hidden".

type categories

list

param categories

The new categories to associate with the library item.

(string) --

rtype

dict

returns

Response Syntax

{
    'libraryItemId': 'string',
    'appId': 'string',
    'appVersion': 123,
    'categories': [
        {
            'id': 'string',
            'title': 'string',
            'color': 'string',
            'appCount': 123
        },
    ],
    'status': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'ratingCount': 123,
    'isRatedByUser': True|False,
    'userCount': 123,
    'isVerified': True|False
}

Response Structure

(dict) --
- libraryItemId (string) --
  
  The unique identifier of the updated library item.
- appId (string) --
  
  The unique identifier of the Q App associated with the library item.
- appVersion (integer) --
  
  The version of the Q App associated with the library item.
- categories (list) --
  
  The categories associated with the updated library item.
  - (dict) --
    
    A category used to classify and filter library items for Amazon Q Apps.
    - id (string) --
      
      The unique identifier of the category.
    - title (string) --
      
      The title or name of the category.
    - color (string) --
      
      The color of the category
    - appCount (integer) --
      
      The number of published Amazon Q Apps associated with a category
- status (string) --
  
  The new status of the updated library item.
- createdAt (datetime) --
  
  The date and time the library item was originally created.
- createdBy (string) --
  
  The user who originally 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.
- isRatedByUser (boolean) --
  
  Whether the current user has rated the library item.
- userCount (integer) --
  
  The number of users who have the associated Q App.
- isVerified (boolean) --
  
  Indicates whether the library item has been verified.