AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getIndex

A Kendra index

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>
def get_index(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

> 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)
}
public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:kendra:getIndex
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Id string
id String
id string
id str
id String

getIndex Result

The following output properties are available:

Supporting Types

IndexCapacityUnitsConfiguration

IndexDocumentAttributeValueType

IndexDocumentMetadataConfiguration

IndexJsonTokenTypeConfiguration

IndexJwtTokenTypeConfiguration

IndexKeyLocation

IndexOrder

IndexRelevance

IndexSearch

displayable Boolean
facetable Boolean
searchable Boolean
sortable Boolean
displayable boolean
facetable boolean
searchable boolean
sortable boolean
displayable Boolean
facetable Boolean
searchable Boolean
sortable Boolean

IndexTag

Key string

A string used to identify this tag

Value string

A string containing the value for the tag

Key string

A string used to identify this tag

Value string

A string containing the value for the tag

key String

A string used to identify this tag

value String

A string containing the value for the tag

key string

A string used to identify this tag

value string

A string containing the value for the tag

key str

A string used to identify this tag

value str

A string containing the value for the tag

key String

A string used to identify this tag

value String

A string containing the value for the tag

IndexUserContextPolicy

IndexUserTokenConfiguration

IndexValueImportanceItem

Key string
Value int
Key string
Value int
key String
value Integer
key string
value number
key str
value int
key String
value Number

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0