AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getExperience

Provides details about a specific Amazon Kendra Experience.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Kendra.GetExperience.InvokeAsync(new Aws.Kendra.GetExperienceArgs
        {
            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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var example = Output.of(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 = pulumi.output(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

The identifier of the Experience.

IndexId string

The identifier of the index that contains the Experience.

ExperienceId string

The identifier of the Experience.

IndexId string

The identifier of the index that contains the Experience.

experienceId String

The identifier of the Experience.

indexId String

The identifier of the index that contains the Experience.

experienceId string

The identifier of the Experience.

indexId string

The identifier of the index that contains the Experience.

experience_id str

The identifier of the Experience.

index_id str

The identifier of the index that contains the Experience.

experienceId String

The identifier of the Experience.

indexId String

The identifier of the index that contains the Experience.

getExperience Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the Experience.

Configurations List<GetExperienceConfiguration>

A 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

The Unix datetime that the Experience was created.

Description string

The 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

The 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

The name of the Experience.

RoleArn string

Shows the Amazon Resource Name (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

The 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

The date and time that the Experience was last updated.

Arn string

The Amazon Resource Name (ARN) of the Experience.

Configurations []GetExperienceConfiguration

A 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

The Unix datetime that the Experience was created.

Description string

The 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

The 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

The name of the Experience.

RoleArn string

Shows the Amazon Resource Name (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

The 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

The date and time that the Experience was last updated.

arn String

The Amazon Resource Name (ARN) of the Experience.

configurations List<GetExperienceConfiguration>

A 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

The Unix datetime that the Experience was created.

description String

The 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

The 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

The name of the Experience.

roleArn String

Shows the Amazon Resource Name (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

The 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

The date and time that the Experience was last updated.

arn string

The Amazon Resource Name (ARN) of the Experience.

configurations GetExperienceConfiguration[]

A 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

The Unix datetime that the Experience was created.

description string

The 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

The 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

The name of the Experience.

roleArn string

Shows the Amazon Resource Name (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

The 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

The date and time that the Experience was last updated.

arn str

The Amazon Resource Name (ARN) of the Experience.

configurations Sequence[GetExperienceConfiguration]

A 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

The Unix datetime that the Experience was created.

description str

The 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

The 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

The name of the Experience.

role_arn str

Shows the Amazon Resource Name (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

The 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

The date and time that the Experience was last updated.

arn String

The Amazon Resource Name (ARN) of the Experience.

configurations List<Property Map>

A 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

The Unix datetime that the Experience was created.

description String

The 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

The 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

The name of the Experience.

roleArn String

Shows the Amazon Resource Name (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

The 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

The 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>

The 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>

The identifier of the FAQs that you want to use for your Amazon Kendra Experience.

DataSourceIds []string

The 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

The identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds List<String>

The 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>

The identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds string[]

The 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[]

The identifier of the FAQs that you want to use for your Amazon Kendra Experience.

data_source_ids Sequence[str]

The 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]

The identifier of the FAQs that you want to use for your Amazon Kendra Experience.

dataSourceIds List<String>

The 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>

The 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

The endpoint of your Amazon Kendra Experience.

EndpointType string

The type of endpoint for your Amazon Kendra Experience.

Endpoint string

The endpoint of your Amazon Kendra Experience.

EndpointType string

The type of endpoint for your Amazon Kendra Experience.

endpoint String

The endpoint of your Amazon Kendra Experience.

endpointType String

The type of endpoint for your Amazon Kendra Experience.

endpoint string

The endpoint of your Amazon Kendra Experience.

endpointType string

The type of endpoint for your Amazon Kendra Experience.

endpoint str

The endpoint of your Amazon Kendra Experience.

endpoint_type str

The type of endpoint for your Amazon Kendra Experience.

endpoint String

The endpoint of your Amazon Kendra Experience.

endpointType String

The type of endpoint for your Amazon Kendra Experience.

Package Details

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

This Pulumi package is based on the aws Terraform Provider.