1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. kendra
  5. getIndex

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

AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi

aws-native.kendra.getIndex

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi

    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
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    Id string
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    id String
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    id string
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    id str
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    id String
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .

    getIndex Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    CapacityUnits Pulumi.AwsNative.Kendra.Outputs.IndexCapacityUnitsConfiguration
    Capacity units
    Description string
    A description for the index
    DocumentMetadataConfigurations List<Pulumi.AwsNative.Kendra.Outputs.IndexDocumentMetadataConfiguration>
    Document metadata configurations
    Id string
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    Name string
    The name of the index.
    RoleArn string
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Tags for labeling the index
    UserContextPolicy Pulumi.AwsNative.Kendra.IndexUserContextPolicy

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    UserTokenConfigurations List<Pulumi.AwsNative.Kendra.Outputs.IndexUserTokenConfiguration>
    Defines the type of user token used for the index.
    Arn string
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    CapacityUnits IndexCapacityUnitsConfiguration
    Capacity units
    Description string
    A description for the index
    DocumentMetadataConfigurations []IndexDocumentMetadataConfiguration
    Document metadata configurations
    Id string
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    Name string
    The name of the index.
    RoleArn string
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    Tags Tag
    Tags for labeling the index
    UserContextPolicy IndexUserContextPolicy

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    UserTokenConfigurations []IndexUserTokenConfiguration
    Defines the type of user token used for the index.
    arn String
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    capacityUnits IndexCapacityUnitsConfiguration
    Capacity units
    description String
    A description for the index
    documentMetadataConfigurations List<IndexDocumentMetadataConfiguration>
    Document metadata configurations
    id String
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    name String
    The name of the index.
    roleArn String
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    tags List<Tag>
    Tags for labeling the index
    userContextPolicy IndexUserContextPolicy

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    userTokenConfigurations List<IndexUserTokenConfiguration>
    Defines the type of user token used for the index.
    arn string
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    capacityUnits IndexCapacityUnitsConfiguration
    Capacity units
    description string
    A description for the index
    documentMetadataConfigurations IndexDocumentMetadataConfiguration[]
    Document metadata configurations
    id string
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    name string
    The name of the index.
    roleArn string
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    tags Tag[]
    Tags for labeling the index
    userContextPolicy IndexUserContextPolicy

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    userTokenConfigurations IndexUserTokenConfiguration[]
    Defines the type of user token used for the index.
    arn str
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    capacity_units IndexCapacityUnitsConfiguration
    Capacity units
    description str
    A description for the index
    document_metadata_configurations Sequence[IndexDocumentMetadataConfiguration]
    Document metadata configurations
    id str
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    name str
    The name of the index.
    role_arn str
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    tags Sequence[root_Tag]
    Tags for labeling the index
    user_context_policy IndexUserContextPolicy

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    user_token_configurations Sequence[IndexUserTokenConfiguration]
    Defines the type of user token used for the index.
    arn String
    The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
    capacityUnits Property Map
    Capacity units
    description String
    A description for the index
    documentMetadataConfigurations List<Property Map>
    Document metadata configurations
    id String
    The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
    name String
    The name of the index.
    roleArn String
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
    tags List<Property Map>
    Tags for labeling the index
    userContextPolicy "ATTRIBUTE_FILTER" | "USER_TOKEN"

    The user context policy.

    ATTRIBUTE_FILTER

    • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

    USER_TOKEN

    • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
    userTokenConfigurations List<Property Map>
    Defines the type of user token used for the index.

    Supporting Types

    IndexCapacityUnitsConfiguration

    QueryCapacityUnits int

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    StorageCapacityUnits int
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
    QueryCapacityUnits int

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    StorageCapacityUnits int
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
    queryCapacityUnits Integer

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    storageCapacityUnits Integer
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
    queryCapacityUnits number

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    storageCapacityUnits number
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
    query_capacity_units int

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    storage_capacity_units int
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
    queryCapacityUnits Number

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

    storageCapacityUnits Number
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

    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

    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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi