github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/kendra/getExperience.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package kendra
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides details about a specific Amazon Kendra Experience.
    15  //
    16  // ## Example Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := kendra.LookupExperience(ctx, &kendra.LookupExperienceArgs{
    32  //				ExperienceId: "87654321-1234-4321-4321-321987654321",
    33  //				IndexId:      "12345678-1234-1234-1234-123456789123",
    34  //			}, nil)
    35  //			if err != nil {
    36  //				return err
    37  //			}
    38  //			return nil
    39  //		})
    40  //	}
    41  //
    42  // ```
    43  // <!--End PulumiCodeChooser -->
    44  func LookupExperience(ctx *pulumi.Context, args *LookupExperienceArgs, opts ...pulumi.InvokeOption) (*LookupExperienceResult, error) {
    45  	opts = internal.PkgInvokeDefaultOpts(opts)
    46  	var rv LookupExperienceResult
    47  	err := ctx.Invoke("aws:kendra/getExperience:getExperience", args, &rv, opts...)
    48  	if err != nil {
    49  		return nil, err
    50  	}
    51  	return &rv, nil
    52  }
    53  
    54  // A collection of arguments for invoking getExperience.
    55  type LookupExperienceArgs struct {
    56  	// Identifier of the Experience.
    57  	ExperienceId string `pulumi:"experienceId"`
    58  	// Identifier of the index that contains the Experience.
    59  	IndexId string `pulumi:"indexId"`
    60  }
    61  
    62  // A collection of values returned by getExperience.
    63  type LookupExperienceResult struct {
    64  	// ARN of the Experience.
    65  	Arn string `pulumi:"arn"`
    66  	// Block that specifies the configuration information for your Amazon Kendra Experience. This includes `contentSourceConfiguration`, which specifies the data source IDs and/or FAQ IDs, and `userIdentityConfiguration`, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
    67  	Configurations []GetExperienceConfiguration `pulumi:"configurations"`
    68  	// Unix datetime that the Experience was created.
    69  	CreatedAt string `pulumi:"createdAt"`
    70  	// Description of the Experience.
    71  	Description string `pulumi:"description"`
    72  	// Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
    73  	Endpoints []GetExperienceEndpoint `pulumi:"endpoints"`
    74  	// Reason your Amazon Kendra Experience could not properly process.
    75  	ErrorMessage string `pulumi:"errorMessage"`
    76  	ExperienceId string `pulumi:"experienceId"`
    77  	// The provider-assigned unique ID for this managed resource.
    78  	Id      string `pulumi:"id"`
    79  	IndexId string `pulumi:"indexId"`
    80  	// Name of the Experience.
    81  	Name string `pulumi:"name"`
    82  	// 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.
    83  	RoleArn string `pulumi:"roleArn"`
    84  	// 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 `errorMessage` field contains the reason that this failed.
    85  	Status string `pulumi:"status"`
    86  	// Date and time that the Experience was last updated.
    87  	UpdatedAt string `pulumi:"updatedAt"`
    88  }
    89  
    90  func LookupExperienceOutput(ctx *pulumi.Context, args LookupExperienceOutputArgs, opts ...pulumi.InvokeOption) LookupExperienceResultOutput {
    91  	return pulumi.ToOutputWithContext(context.Background(), args).
    92  		ApplyT(func(v interface{}) (LookupExperienceResult, error) {
    93  			args := v.(LookupExperienceArgs)
    94  			r, err := LookupExperience(ctx, &args, opts...)
    95  			var s LookupExperienceResult
    96  			if r != nil {
    97  				s = *r
    98  			}
    99  			return s, err
   100  		}).(LookupExperienceResultOutput)
   101  }
   102  
   103  // A collection of arguments for invoking getExperience.
   104  type LookupExperienceOutputArgs struct {
   105  	// Identifier of the Experience.
   106  	ExperienceId pulumi.StringInput `pulumi:"experienceId"`
   107  	// Identifier of the index that contains the Experience.
   108  	IndexId pulumi.StringInput `pulumi:"indexId"`
   109  }
   110  
   111  func (LookupExperienceOutputArgs) ElementType() reflect.Type {
   112  	return reflect.TypeOf((*LookupExperienceArgs)(nil)).Elem()
   113  }
   114  
   115  // A collection of values returned by getExperience.
   116  type LookupExperienceResultOutput struct{ *pulumi.OutputState }
   117  
   118  func (LookupExperienceResultOutput) ElementType() reflect.Type {
   119  	return reflect.TypeOf((*LookupExperienceResult)(nil)).Elem()
   120  }
   121  
   122  func (o LookupExperienceResultOutput) ToLookupExperienceResultOutput() LookupExperienceResultOutput {
   123  	return o
   124  }
   125  
   126  func (o LookupExperienceResultOutput) ToLookupExperienceResultOutputWithContext(ctx context.Context) LookupExperienceResultOutput {
   127  	return o
   128  }
   129  
   130  // ARN of the Experience.
   131  func (o LookupExperienceResultOutput) Arn() pulumi.StringOutput {
   132  	return o.ApplyT(func(v LookupExperienceResult) string { return v.Arn }).(pulumi.StringOutput)
   133  }
   134  
   135  // Block that specifies the configuration information for your Amazon Kendra Experience. This includes `contentSourceConfiguration`, which specifies the data source IDs and/or FAQ IDs, and `userIdentityConfiguration`, which specifies the user or group information to grant access to your Amazon Kendra Experience. Documented below.
   136  func (o LookupExperienceResultOutput) Configurations() GetExperienceConfigurationArrayOutput {
   137  	return o.ApplyT(func(v LookupExperienceResult) []GetExperienceConfiguration { return v.Configurations }).(GetExperienceConfigurationArrayOutput)
   138  }
   139  
   140  // Unix datetime that the Experience was created.
   141  func (o LookupExperienceResultOutput) CreatedAt() pulumi.StringOutput {
   142  	return o.ApplyT(func(v LookupExperienceResult) string { return v.CreatedAt }).(pulumi.StringOutput)
   143  }
   144  
   145  // Description of the Experience.
   146  func (o LookupExperienceResultOutput) Description() pulumi.StringOutput {
   147  	return o.ApplyT(func(v LookupExperienceResult) string { return v.Description }).(pulumi.StringOutput)
   148  }
   149  
   150  // Shows the endpoint URLs for your Amazon Kendra Experiences. The URLs are unique and fully hosted by AWS. Documented below.
   151  func (o LookupExperienceResultOutput) Endpoints() GetExperienceEndpointArrayOutput {
   152  	return o.ApplyT(func(v LookupExperienceResult) []GetExperienceEndpoint { return v.Endpoints }).(GetExperienceEndpointArrayOutput)
   153  }
   154  
   155  // Reason your Amazon Kendra Experience could not properly process.
   156  func (o LookupExperienceResultOutput) ErrorMessage() pulumi.StringOutput {
   157  	return o.ApplyT(func(v LookupExperienceResult) string { return v.ErrorMessage }).(pulumi.StringOutput)
   158  }
   159  
   160  func (o LookupExperienceResultOutput) ExperienceId() pulumi.StringOutput {
   161  	return o.ApplyT(func(v LookupExperienceResult) string { return v.ExperienceId }).(pulumi.StringOutput)
   162  }
   163  
   164  // The provider-assigned unique ID for this managed resource.
   165  func (o LookupExperienceResultOutput) Id() pulumi.StringOutput {
   166  	return o.ApplyT(func(v LookupExperienceResult) string { return v.Id }).(pulumi.StringOutput)
   167  }
   168  
   169  func (o LookupExperienceResultOutput) IndexId() pulumi.StringOutput {
   170  	return o.ApplyT(func(v LookupExperienceResult) string { return v.IndexId }).(pulumi.StringOutput)
   171  }
   172  
   173  // Name of the Experience.
   174  func (o LookupExperienceResultOutput) Name() pulumi.StringOutput {
   175  	return o.ApplyT(func(v LookupExperienceResult) string { return v.Name }).(pulumi.StringOutput)
   176  }
   177  
   178  // 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.
   179  func (o LookupExperienceResultOutput) RoleArn() pulumi.StringOutput {
   180  	return o.ApplyT(func(v LookupExperienceResult) string { return v.RoleArn }).(pulumi.StringOutput)
   181  }
   182  
   183  // 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 `errorMessage` field contains the reason that this failed.
   184  func (o LookupExperienceResultOutput) Status() pulumi.StringOutput {
   185  	return o.ApplyT(func(v LookupExperienceResult) string { return v.Status }).(pulumi.StringOutput)
   186  }
   187  
   188  // Date and time that the Experience was last updated.
   189  func (o LookupExperienceResultOutput) UpdatedAt() pulumi.StringOutput {
   190  	return o.ApplyT(func(v LookupExperienceResult) string { return v.UpdatedAt }).(pulumi.StringOutput)
   191  }
   192  
   193  func init() {
   194  	pulumi.RegisterOutputType(LookupExperienceResultOutput{})
   195  }