github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/kendra/getQuerySuggestionsBlockList.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 block list used for query suggestions for an index.
    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.LookupQuerySuggestionsBlockList(ctx, &kendra.LookupQuerySuggestionsBlockListArgs{
    32  //				IndexId:                     "12345678-1234-1234-1234-123456789123",
    33  //				QuerySuggestionsBlockListId: "87654321-1234-4321-4321-321987654321",
    34  //			}, nil)
    35  //			if err != nil {
    36  //				return err
    37  //			}
    38  //			return nil
    39  //		})
    40  //	}
    41  //
    42  // ```
    43  // <!--End PulumiCodeChooser -->
    44  func LookupQuerySuggestionsBlockList(ctx *pulumi.Context, args *LookupQuerySuggestionsBlockListArgs, opts ...pulumi.InvokeOption) (*LookupQuerySuggestionsBlockListResult, error) {
    45  	opts = internal.PkgInvokeDefaultOpts(opts)
    46  	var rv LookupQuerySuggestionsBlockListResult
    47  	err := ctx.Invoke("aws:kendra/getQuerySuggestionsBlockList:getQuerySuggestionsBlockList", 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 getQuerySuggestionsBlockList.
    55  type LookupQuerySuggestionsBlockListArgs struct {
    56  	// Identifier of the index that contains the block list.
    57  	IndexId string `pulumi:"indexId"`
    58  	// Identifier of the block list.
    59  	QuerySuggestionsBlockListId string `pulumi:"querySuggestionsBlockListId"`
    60  	// Metadata that helps organize the block list you create.
    61  	Tags map[string]string `pulumi:"tags"`
    62  }
    63  
    64  // A collection of values returned by getQuerySuggestionsBlockList.
    65  type LookupQuerySuggestionsBlockListResult struct {
    66  	// ARN of the block list.
    67  	Arn string `pulumi:"arn"`
    68  	// Date-time a block list was created.
    69  	CreatedAt string `pulumi:"createdAt"`
    70  	// Description for the block list.
    71  	Description string `pulumi:"description"`
    72  	// Error message containing details if there are issues processing the block list.
    73  	ErrorMessage string `pulumi:"errorMessage"`
    74  	// Current size of the block list text file in S3.
    75  	FileSizeBytes int `pulumi:"fileSizeBytes"`
    76  	// The provider-assigned unique ID for this managed resource.
    77  	Id      string `pulumi:"id"`
    78  	IndexId string `pulumi:"indexId"`
    79  	// Current number of valid, non-empty words or phrases in the block list text file.
    80  	ItemCount int `pulumi:"itemCount"`
    81  	// Name of the block list.
    82  	Name                        string `pulumi:"name"`
    83  	QuerySuggestionsBlockListId string `pulumi:"querySuggestionsBlockListId"`
    84  	// ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see [IAM Roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
    85  	RoleArn string `pulumi:"roleArn"`
    86  	// S3 location of the block list input data. Detailed below.
    87  	SourceS3Paths []GetQuerySuggestionsBlockListSourceS3Path `pulumi:"sourceS3Paths"`
    88  	// Current status of the block list. When the value is `ACTIVE`, the block list is ready for use.
    89  	Status string `pulumi:"status"`
    90  	// Metadata that helps organize the block list you create.
    91  	Tags map[string]string `pulumi:"tags"`
    92  	// Date and time that the block list was last updated.
    93  	UpdatedAt string `pulumi:"updatedAt"`
    94  }
    95  
    96  func LookupQuerySuggestionsBlockListOutput(ctx *pulumi.Context, args LookupQuerySuggestionsBlockListOutputArgs, opts ...pulumi.InvokeOption) LookupQuerySuggestionsBlockListResultOutput {
    97  	return pulumi.ToOutputWithContext(context.Background(), args).
    98  		ApplyT(func(v interface{}) (LookupQuerySuggestionsBlockListResult, error) {
    99  			args := v.(LookupQuerySuggestionsBlockListArgs)
   100  			r, err := LookupQuerySuggestionsBlockList(ctx, &args, opts...)
   101  			var s LookupQuerySuggestionsBlockListResult
   102  			if r != nil {
   103  				s = *r
   104  			}
   105  			return s, err
   106  		}).(LookupQuerySuggestionsBlockListResultOutput)
   107  }
   108  
   109  // A collection of arguments for invoking getQuerySuggestionsBlockList.
   110  type LookupQuerySuggestionsBlockListOutputArgs struct {
   111  	// Identifier of the index that contains the block list.
   112  	IndexId pulumi.StringInput `pulumi:"indexId"`
   113  	// Identifier of the block list.
   114  	QuerySuggestionsBlockListId pulumi.StringInput `pulumi:"querySuggestionsBlockListId"`
   115  	// Metadata that helps organize the block list you create.
   116  	Tags pulumi.StringMapInput `pulumi:"tags"`
   117  }
   118  
   119  func (LookupQuerySuggestionsBlockListOutputArgs) ElementType() reflect.Type {
   120  	return reflect.TypeOf((*LookupQuerySuggestionsBlockListArgs)(nil)).Elem()
   121  }
   122  
   123  // A collection of values returned by getQuerySuggestionsBlockList.
   124  type LookupQuerySuggestionsBlockListResultOutput struct{ *pulumi.OutputState }
   125  
   126  func (LookupQuerySuggestionsBlockListResultOutput) ElementType() reflect.Type {
   127  	return reflect.TypeOf((*LookupQuerySuggestionsBlockListResult)(nil)).Elem()
   128  }
   129  
   130  func (o LookupQuerySuggestionsBlockListResultOutput) ToLookupQuerySuggestionsBlockListResultOutput() LookupQuerySuggestionsBlockListResultOutput {
   131  	return o
   132  }
   133  
   134  func (o LookupQuerySuggestionsBlockListResultOutput) ToLookupQuerySuggestionsBlockListResultOutputWithContext(ctx context.Context) LookupQuerySuggestionsBlockListResultOutput {
   135  	return o
   136  }
   137  
   138  // ARN of the block list.
   139  func (o LookupQuerySuggestionsBlockListResultOutput) Arn() pulumi.StringOutput {
   140  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.Arn }).(pulumi.StringOutput)
   141  }
   142  
   143  // Date-time a block list was created.
   144  func (o LookupQuerySuggestionsBlockListResultOutput) CreatedAt() pulumi.StringOutput {
   145  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.CreatedAt }).(pulumi.StringOutput)
   146  }
   147  
   148  // Description for the block list.
   149  func (o LookupQuerySuggestionsBlockListResultOutput) Description() pulumi.StringOutput {
   150  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.Description }).(pulumi.StringOutput)
   151  }
   152  
   153  // Error message containing details if there are issues processing the block list.
   154  func (o LookupQuerySuggestionsBlockListResultOutput) ErrorMessage() pulumi.StringOutput {
   155  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.ErrorMessage }).(pulumi.StringOutput)
   156  }
   157  
   158  // Current size of the block list text file in S3.
   159  func (o LookupQuerySuggestionsBlockListResultOutput) FileSizeBytes() pulumi.IntOutput {
   160  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) int { return v.FileSizeBytes }).(pulumi.IntOutput)
   161  }
   162  
   163  // The provider-assigned unique ID for this managed resource.
   164  func (o LookupQuerySuggestionsBlockListResultOutput) Id() pulumi.StringOutput {
   165  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.Id }).(pulumi.StringOutput)
   166  }
   167  
   168  func (o LookupQuerySuggestionsBlockListResultOutput) IndexId() pulumi.StringOutput {
   169  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.IndexId }).(pulumi.StringOutput)
   170  }
   171  
   172  // Current number of valid, non-empty words or phrases in the block list text file.
   173  func (o LookupQuerySuggestionsBlockListResultOutput) ItemCount() pulumi.IntOutput {
   174  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) int { return v.ItemCount }).(pulumi.IntOutput)
   175  }
   176  
   177  // Name of the block list.
   178  func (o LookupQuerySuggestionsBlockListResultOutput) Name() pulumi.StringOutput {
   179  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.Name }).(pulumi.StringOutput)
   180  }
   181  
   182  func (o LookupQuerySuggestionsBlockListResultOutput) QuerySuggestionsBlockListId() pulumi.StringOutput {
   183  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.QuerySuggestionsBlockListId }).(pulumi.StringOutput)
   184  }
   185  
   186  // ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see [IAM Roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
   187  func (o LookupQuerySuggestionsBlockListResultOutput) RoleArn() pulumi.StringOutput {
   188  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.RoleArn }).(pulumi.StringOutput)
   189  }
   190  
   191  // S3 location of the block list input data. Detailed below.
   192  func (o LookupQuerySuggestionsBlockListResultOutput) SourceS3Paths() GetQuerySuggestionsBlockListSourceS3PathArrayOutput {
   193  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) []GetQuerySuggestionsBlockListSourceS3Path {
   194  		return v.SourceS3Paths
   195  	}).(GetQuerySuggestionsBlockListSourceS3PathArrayOutput)
   196  }
   197  
   198  // Current status of the block list. When the value is `ACTIVE`, the block list is ready for use.
   199  func (o LookupQuerySuggestionsBlockListResultOutput) Status() pulumi.StringOutput {
   200  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.Status }).(pulumi.StringOutput)
   201  }
   202  
   203  // Metadata that helps organize the block list you create.
   204  func (o LookupQuerySuggestionsBlockListResultOutput) Tags() pulumi.StringMapOutput {
   205  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   206  }
   207  
   208  // Date and time that the block list was last updated.
   209  func (o LookupQuerySuggestionsBlockListResultOutput) UpdatedAt() pulumi.StringOutput {
   210  	return o.ApplyT(func(v LookupQuerySuggestionsBlockListResult) string { return v.UpdatedAt }).(pulumi.StringOutput)
   211  }
   212  
   213  func init() {
   214  	pulumi.RegisterOutputType(LookupQuerySuggestionsBlockListResultOutput{})
   215  }