Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. getIndex

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.getIndex

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::QBusiness::Index Resource Type

Using getIndex

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
Copy
def get_index(application_id: Optional[str] = None,
              index_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(application_id: Optional[pulumi.Input[str]] = None,
              index_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
Copy
func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput
Copy

> Note: This function is named LookupIndex in the Go SDK.

public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:qbusiness:getIndex
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApplicationId This property is required. string
The identifier of the Amazon Q Business application using the index.
IndexId This property is required. string
The identifier for the index.
ApplicationId This property is required. string
The identifier of the Amazon Q Business application using the index.
IndexId This property is required. string
The identifier for the index.
applicationId This property is required. String
The identifier of the Amazon Q Business application using the index.
indexId This property is required. String
The identifier for the index.
applicationId This property is required. string
The identifier of the Amazon Q Business application using the index.
indexId This property is required. string
The identifier for the index.
application_id This property is required. str
The identifier of the Amazon Q Business application using the index.
index_id This property is required. str
The identifier for the index.
applicationId This property is required. String
The identifier of the Amazon Q Business application using the index.
indexId This property is required. String
The identifier for the index.

getIndex Result

The following output properties are available:

CapacityConfiguration Pulumi.AwsNative.QBusiness.Outputs.IndexCapacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
CreatedAt string
The Unix timestamp when the index was created.
Description string
A description for the Amazon Q Business index.
DisplayName string
The name of the index.
DocumentAttributeConfigurations List<Pulumi.AwsNative.QBusiness.Outputs.IndexDocumentAttributeConfiguration>

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

IndexArn string
The Amazon Resource Name (ARN) of an Amazon Q Business index.
IndexId string
The identifier for the index.
IndexStatistics Pulumi.AwsNative.QBusiness.Outputs.IndexStatistics
Status Pulumi.AwsNative.QBusiness.IndexStatus
The current status of the index. When the status is ACTIVE , the index is ready.
Tags List<Pulumi.AwsNative.Outputs.Tag>
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
UpdatedAt string
The Unix timestamp when the index was last updated.
CapacityConfiguration IndexCapacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
CreatedAt string
The Unix timestamp when the index was created.
Description string
A description for the Amazon Q Business index.
DisplayName string
The name of the index.
DocumentAttributeConfigurations []IndexDocumentAttributeConfiguration

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

IndexArn string
The Amazon Resource Name (ARN) of an Amazon Q Business index.
IndexId string
The identifier for the index.
IndexStatistics IndexStatistics
Status IndexStatus
The current status of the index. When the status is ACTIVE , the index is ready.
Tags Tag
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
UpdatedAt string
The Unix timestamp when the index was last updated.
capacityConfiguration IndexCapacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
createdAt String
The Unix timestamp when the index was created.
description String
A description for the Amazon Q Business index.
displayName String
The name of the index.
documentAttributeConfigurations List<IndexDocumentAttributeConfiguration>

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

indexArn String
The Amazon Resource Name (ARN) of an Amazon Q Business index.
indexId String
The identifier for the index.
indexStatistics IndexStatistics
status IndexStatus
The current status of the index. When the status is ACTIVE , the index is ready.
tags List<Tag>
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt String
The Unix timestamp when the index was last updated.
capacityConfiguration IndexCapacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
createdAt string
The Unix timestamp when the index was created.
description string
A description for the Amazon Q Business index.
displayName string
The name of the index.
documentAttributeConfigurations IndexDocumentAttributeConfiguration[]

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

indexArn string
The Amazon Resource Name (ARN) of an Amazon Q Business index.
indexId string
The identifier for the index.
indexStatistics IndexStatistics
status IndexStatus
The current status of the index. When the status is ACTIVE , the index is ready.
tags Tag[]
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt string
The Unix timestamp when the index was last updated.
capacity_configuration IndexCapacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
created_at str
The Unix timestamp when the index was created.
description str
A description for the Amazon Q Business index.
display_name str
The name of the index.
document_attribute_configurations Sequence[IndexDocumentAttributeConfiguration]

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

index_arn str
The Amazon Resource Name (ARN) of an Amazon Q Business index.
index_id str
The identifier for the index.
index_statistics IndexStatistics
status IndexStatus
The current status of the index. When the status is ACTIVE , the index is ready.
tags Sequence[root_Tag]
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updated_at str
The Unix timestamp when the index was last updated.
capacityConfiguration Property Map
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
createdAt String
The Unix timestamp when the index was created.
description String
A description for the Amazon Q Business index.
displayName String
The name of the index.
documentAttributeConfigurations List<Property Map>

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

indexArn String
The Amazon Resource Name (ARN) of an Amazon Q Business index.
indexId String
The identifier for the index.
indexStatistics Property Map
status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
The current status of the index. When the status is ACTIVE , the index is ready.
tags List<Property Map>
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt String
The Unix timestamp when the index was last updated.

Supporting Types

IndexAttributeType

IndexCapacityConfiguration

Units double
The number of storage units configured for an Amazon Q Business index.
Units float64
The number of storage units configured for an Amazon Q Business index.
units Double
The number of storage units configured for an Amazon Q Business index.
units number
The number of storage units configured for an Amazon Q Business index.
units float
The number of storage units configured for an Amazon Q Business index.
units Number
The number of storage units configured for an Amazon Q Business index.

IndexDocumentAttributeConfiguration

Name string
The name of the document attribute.
Search Pulumi.AwsNative.QBusiness.QBusinessIndexStatus
Information about whether the document attribute can be used by an end user to search for information on their web experience.
Type Pulumi.AwsNative.QBusiness.IndexAttributeType
The type of document attribute.
Name string
The name of the document attribute.
Search QBusinessIndexStatus
Information about whether the document attribute can be used by an end user to search for information on their web experience.
Type IndexAttributeType
The type of document attribute.
name String
The name of the document attribute.
search QBusinessIndexStatus
Information about whether the document attribute can be used by an end user to search for information on their web experience.
type IndexAttributeType
The type of document attribute.
name string
The name of the document attribute.
search QBusinessIndexStatus
Information about whether the document attribute can be used by an end user to search for information on their web experience.
type IndexAttributeType
The type of document attribute.
name str
The name of the document attribute.
search QBusinessIndexStatus
Information about whether the document attribute can be used by an end user to search for information on their web experience.
type IndexAttributeType
The type of document attribute.
name String
The name of the document attribute.
search "ENABLED" | "DISABLED"
Information about whether the document attribute can be used by an end user to search for information on their web experience.
type "STRING" | "STRING_LIST" | "NUMBER" | "DATE"
The type of document attribute.

IndexStatistics

TextDocumentStatistics IndexTextDocumentStatistics
The number of documents indexed.
textDocumentStatistics IndexTextDocumentStatistics
The number of documents indexed.
textDocumentStatistics IndexTextDocumentStatistics
The number of documents indexed.
textDocumentStatistics Property Map
The number of documents indexed.

IndexStatus

IndexTextDocumentStatistics

IndexedTextBytes double
The total size, in bytes, of the indexed documents.
IndexedTextDocumentCount double
The number of text documents indexed.
IndexedTextBytes float64
The total size, in bytes, of the indexed documents.
IndexedTextDocumentCount float64
The number of text documents indexed.
indexedTextBytes Double
The total size, in bytes, of the indexed documents.
indexedTextDocumentCount Double
The number of text documents indexed.
indexedTextBytes number
The total size, in bytes, of the indexed documents.
indexedTextDocumentCount number
The number of text documents indexed.
indexed_text_bytes float
The total size, in bytes, of the indexed documents.
indexed_text_document_count float
The number of text documents indexed.
indexedTextBytes Number
The total size, in bytes, of the indexed documents.
indexedTextDocumentCount Number
The number of text documents indexed.

QBusinessIndexStatus

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native