AWS Classic v5.41.0, May 15 23

aws.kendra.getExperience

Explore with Pulumi AI

Provides details about a specific Amazon Kendra Experience.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Kendra.GetExperience.Invoke(new()
    {
        ExperienceId = "87654321-1234-4321-4321-321987654321",
        IndexId = "12345678-1234-1234-1234-123456789123",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kendra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kendra.LookupExperience(ctx, &kendra.LookupExperienceArgs{
			ExperienceId: "87654321-1234-4321-4321-321987654321",
			IndexId:      "12345678-1234-1234-1234-123456789123",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.KendraFunctions;
import com.pulumi.aws.kendra.inputs.GetExperienceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = KendraFunctions.getExperience(GetExperienceArgs.builder()
            .experienceId("87654321-1234-4321-4321-321987654321")
            .indexId("12345678-1234-1234-1234-123456789123")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.kendra.get_experience(experience_id="87654321-1234-4321-4321-321987654321",
    index_id="12345678-1234-1234-1234-123456789123")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.kendra.getExperience({
    experienceId: "87654321-1234-4321-4321-321987654321",
    indexId: "12345678-1234-1234-1234-123456789123",
});

variables:
  example:
    fn::invoke:
      Function: aws:kendra:getExperience
      Arguments:
        experienceId: 87654321-1234-4321-4321-321987654321
        indexId: 12345678-1234-1234-1234-123456789123

Using getExperience

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 getExperience(args: GetExperienceArgs, opts?: InvokeOptions): Promise<GetExperienceResult>
function getExperienceOutput(args: GetExperienceOutputArgs, opts?: InvokeOptions): Output<GetExperienceResult>

def get_experience(experience_id: Optional[str] = None,
                   index_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetExperienceResult
def get_experience_output(experience_id: Optional[pulumi.Input[str]] = None,
                   index_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetExperienceResult]

func LookupExperience(ctx *Context, args *LookupExperienceArgs, opts ...InvokeOption) (*LookupExperienceResult, error)
func LookupExperienceOutput(ctx *Context, args *LookupExperienceOutputArgs, opts ...InvokeOption) LookupExperienceResultOutput

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

public static class GetExperience 
{
    public static Task<GetExperienceResult> InvokeAsync(GetExperienceArgs args, InvokeOptions? opts = null)
    public static Output<GetExperienceResult> Invoke(GetExperienceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExperienceResult> getExperience(GetExperienceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:kendra/getExperience:getExperience
  arguments:
    # arguments dictionary

The following arguments are supported:

ExperienceId string: Identifier of the Experience.
IndexId string: Identifier of the index that contains the Experience.

ExperienceId string: Identifier of the Experience.
IndexId string: Identifier of the index that contains the Experience.

experienceId String: Identifier of the Experience.
indexId String: Identifier of the index that contains the Experience.

experienceId string: Identifier of the Experience.
indexId string: Identifier of the index that contains the Experience.

experience_id str: Identifier of the Experience.
index_id str: Identifier of the index that contains the Experience.

experienceId String: Identifier of the Experience.
indexId String: Identifier of the index that contains the Experience.

getExperience Result

The following output properties are available:

Arn string: ARN of the Experience.
Configurations List<GetExperienceConfiguration>: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
CreatedAt string: Unix datetime that the Experience was created.
Description string: Description of the Experience.
Endpoints List<GetExperienceEndpoint>: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
ErrorMessage string: Reason your Amazon Kendra Experience could not properly process.
ExperienceId string
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
Name string: Name of the Experience.
RoleArn string: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
Status string: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
UpdatedAt string: Date and time that the Experience was last updated.

Arn string: ARN of the Experience.
Configurations []GetExperienceConfiguration: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
CreatedAt string: Unix datetime that the Experience was created.
Description string: Description of the Experience.
Endpoints []GetExperienceEndpoint: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
ErrorMessage string: Reason your Amazon Kendra Experience could not properly process.
ExperienceId string
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
Name string: Name of the Experience.
RoleArn string: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
Status string: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
UpdatedAt string: Date and time that the Experience was last updated.

arn String: ARN of the Experience.
configurations List<GetExperienceConfiguration>: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
createdAt String: Unix datetime that the Experience was created.
description String: Description of the Experience.
endpoints List<GetExperienceEndpoint>: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
errorMessage String: Reason your Amazon Kendra Experience could not properly process.
experienceId String
id String: The provider-assigned unique ID for this managed resource.
indexId String
name String: Name of the Experience.
roleArn String: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
status String: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
updatedAt String: Date and time that the Experience was last updated.

arn string: ARN of the Experience.
configurations GetExperienceConfiguration[]: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
createdAt string: Unix datetime that the Experience was created.
description string: Description of the Experience.
endpoints GetExperienceEndpoint[]: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
errorMessage string: Reason your Amazon Kendra Experience could not properly process.
experienceId string
id string: The provider-assigned unique ID for this managed resource.
indexId string
name string: Name of the Experience.
roleArn string: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
status string: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
updatedAt string: Date and time that the Experience was last updated.

arn str: ARN of the Experience.
configurations Sequence[GetExperienceConfiguration]: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
created_at str: Unix datetime that the Experience was created.
description str: Description of the Experience.
endpoints Sequence[GetExperienceEndpoint]: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
error_message str: Reason your Amazon Kendra Experience could not properly process.
experience_id str
id str: The provider-assigned unique ID for this managed resource.
index_id str
name str: Name of the Experience.
role_arn str: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
status str: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
updated_at str: Date and time that the Experience was last updated.

arn String: ARN of the Experience.
configurations List<Property Map>: Block that specifies the configuration information for your Amazon Kendra Experience. This includes content_source_configuration, which specifies the data source IDs and/or FAQ IDs, and user_identity_configuration, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
createdAt String: Unix datetime that the Experience was created.
description String: Description of the Experience.
endpoints List<Property Map>: Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
errorMessage String: Reason your Amazon Kendra Experience could not properly process.
experienceId String
id String: The provider-assigned unique ID for this managed resource.
indexId String
name String: Name of the Experience.
roleArn String: Shows the ARN of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and AWS SSO that stores your user and group information.
status String: Current processing status of your Amazon Kendra Experience. When the status is ACTIVE, your Amazon Kendra Experience is ready to use. When the status is FAILED, the error_message field contains the reason that this failed.
updatedAt String: Date and time that the Experience was last updated.

Supporting Types

GetExperienceConfiguration

ContentSourceConfigurations List<GetExperienceConfigurationContentSourceConfiguration>: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
UserIdentityConfigurations List<GetExperienceConfigurationUserIdentityConfiguration>: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

ContentSourceConfigurations []GetExperienceConfigurationContentSourceConfiguration: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
UserIdentityConfigurations []GetExperienceConfigurationUserIdentityConfiguration: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

contentSourceConfigurations List<GetExperienceConfigurationContentSourceConfiguration>: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
userIdentityConfigurations List<GetExperienceConfigurationUserIdentityConfiguration>: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

contentSourceConfigurations GetExperienceConfigurationContentSourceConfiguration[]: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
userIdentityConfigurations GetExperienceConfigurationUserIdentityConfiguration[]: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

content_source_configurations Sequence[GetExperienceConfigurationContentSourceConfiguration]: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
user_identity_configurations Sequence[GetExperienceConfigurationUserIdentityConfiguration]: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

contentSourceConfigurations List<Property Map>: The identifiers of your data sources and FAQs. This is the content you want to use for your Amazon Kendra Experience. Documented below.
userIdentityConfigurations List<Property Map>: The AWS SSO field name that contains the identifiers of your users, such as their emails. Documented below.

GetExperienceConfigurationContentSourceConfiguration

DataSourceIds List<string>: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
DirectPutContent bool: Whether to use documents you indexed directly using the BatchPutDocument API.
FaqIds List<string>: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

DataSourceIds []string: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
DirectPutContent bool: Whether to use documents you indexed directly using the BatchPutDocument API.
FaqIds []string: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds List<String>: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
directPutContent Boolean: Whether to use documents you indexed directly using the BatchPutDocument API.
faqIds List<String>: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds string[]: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
directPutContent boolean: Whether to use documents you indexed directly using the BatchPutDocument API.
faqIds string[]: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

data_source_ids Sequence[str]: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
direct_put_content bool: Whether to use documents you indexed directly using the BatchPutDocument API.
faq_ids Sequence[str]: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds List<String>: Identifiers of the data sources you want to use for your Amazon Kendra Experience.
directPutContent Boolean: Whether to use documents you indexed directly using the BatchPutDocument API.
faqIds List<String>: Identifier of the FAQs that you want to use for your Amazon Kendra Experience.

GetExperienceConfigurationUserIdentityConfiguration

IdentityAttributeName string: The AWS SSO field name that contains the identifiers of your users, such as their emails.

IdentityAttributeName string: The AWS SSO field name that contains the identifiers of your users, such as their emails.

identityAttributeName String: The AWS SSO field name that contains the identifiers of your users, such as their emails.

identityAttributeName string: The AWS SSO field name that contains the identifiers of your users, such as their emails.

identity_attribute_name str: The AWS SSO field name that contains the identifiers of your users, such as their emails.

identityAttributeName String: The AWS SSO field name that contains the identifiers of your users, such as their emails.

GetExperienceEndpoint

Endpoint string: Endpoint of your Amazon Kendra Experience.
EndpointType string: Type of endpoint for your Amazon Kendra Experience.

Endpoint string: Endpoint of your Amazon Kendra Experience.
EndpointType string: Type of endpoint for your Amazon Kendra Experience.

endpoint String: Endpoint of your Amazon Kendra Experience.
endpointType String: Type of endpoint for your Amazon Kendra Experience.

endpoint string: Endpoint of your Amazon Kendra Experience.
endpointType string: Type of endpoint for your Amazon Kendra Experience.

endpoint str: Endpoint of your Amazon Kendra Experience.
endpoint_type str: Type of endpoint for your Amazon Kendra Experience.

endpoint String: Endpoint of your Amazon Kendra Experience.
endpointType String: Type of endpoint for your Amazon Kendra Experience.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.