indices

Creates, updates, deletes, gets or lists an indices resource.

Overview

Name	indices
Type	Resource
Id	aws.qbusiness.indices

Fields

The following fields are returned by SELECT queries:

list_indices

Name	Datatype	Description
created_at	string (date-time)	The Unix timestamp when the index was created.
display_name	string	The name of the index. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
index_id	string	The identifier for the index. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
status	string	The current status of the index. When the status is ACTIVE, the index is ready. (CREATING, ACTIVE, DELETING, FAILED, UPDATING)
updated_at	string (date-time)	The Unix timestamp when the index was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_indices	select	application_id, region	nextToken, maxResults	Lists the Amazon Q Business indices you have created.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application connected to the index.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of indices to return.
nextToken	string	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.

SELECT examples

list_indices

Lists the Amazon Q Business indices you have created.

SELECT
created_at,
display_name,
index_id,
status,
updated_at
FROM aws.qbusiness.indices
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;