AWS API Changes

2024/09/06 - QApps - 1 new 5 updated api methods

Changes Adds UpdateLibraryItemMetadata api to change status of app for admin verification feature and returns isVerified field in any api returning the app or library item.

UpdateLibraryItemMetadata (new)

Link ¶

Updates the verification status of a library item for an Amazon Q App.

See also: AWS API Documentation

Request Syntax

client.update_library_item_metadata(
    instanceId='string',
    libraryItemId='string',
    isVerified=True|False
)

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 updated library item.

type isVerified

boolean

param isVerified

The verification status of the library item

returns

None

CreateLibraryItem (updated)

Link ¶
Changes (response)

{'isVerified': 'boolean'}

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

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

type instanceId

string

param instanceId

[REQUIRED]

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

type appId

string

param appId

[REQUIRED]

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

type appVersion

integer

param appVersion

[REQUIRED]

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

type categories

list

param categories

[REQUIRED]

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

(string) --

rtype

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.

GetLibraryItem (updated)

Link ¶
Changes (response)

{'isVerified': 'boolean'}

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'
        },
    ],
    '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.
- 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': {'isVerified': 'boolean'}}

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'
                },
            ],
            '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.
    - 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.

ListQApps (updated)

Link ¶
Changes (response)

{'apps': {'isVerified': 'boolean'}}

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

See also: AWS API Documentation

Request Syntax

client.list_q_apps(
    instanceId='string',
    limit=123,
    nextToken='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 Q Apps to return in the response.

type nextToken

string

param nextToken

The token to request the next page of results.

rtype

dict

returns

Response Syntax

{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'title': 'string',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'canEdit': True|False,
            'status': 'string',
            'isVerified': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- apps (list) --
  
  The list of Amazon Q Apps meeting the request criteria.
  - (dict) --
    
    An Amazon Q App associated with a user, either owned by the user or favorited.
    - appId (string) --
      
      The unique identifier of the Q App.
    - appArn (string) --
      
      The Amazon Resource Name (ARN) of the Q App.
    - title (string) --
      
      The title of the Q App.
    - description (string) --
      
      The description of the Q App.
    - createdAt (datetime) --
      
      The date and time the user's association with the Q App was created.
    - canEdit (boolean) --
      
      A flag indicating whether the user can edit the Q App.
    - status (string) --
      
      The status of the user's association with the Q App.
    - isVerified (boolean) --
      
      Indicates whether the Q App has been verified.
- nextToken (string) --
  
  The token to use to request the next page of results.

UpdateLibraryItem (updated)

Link ¶
Changes (response)

{'isVerified': 'boolean'}

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'
        },
    ],
    '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.
- 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.