We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
Resource Type definition for AWS::Kendra::FeaturedResultsSet. A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there’s an exact match of a query, then one or more specific documents are featured in the search results.
Using getFeaturedResultsSet
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 getFeaturedResultsSet(args: GetFeaturedResultsSetArgs, opts?: InvokeOptions): Promise<GetFeaturedResultsSetResult>
function getFeaturedResultsSetOutput(args: GetFeaturedResultsSetOutputArgs, opts?: InvokeOutputOptions): Output<GetFeaturedResultsSetResult>def get_featured_results_set(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFeaturedResultsSetResult
def get_featured_results_set_output(arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetFeaturedResultsSetResult]func LookupFeaturedResultsSet(ctx *Context, args *LookupFeaturedResultsSetArgs, opts ...InvokeOption) (*LookupFeaturedResultsSetResult, error)
func LookupFeaturedResultsSetOutput(ctx *Context, args *LookupFeaturedResultsSetOutputArgs, opts ...InvokeOption) LookupFeaturedResultsSetResultOutput> Note: This function is named LookupFeaturedResultsSet in the Go SDK.
public static class GetFeaturedResultsSet
{
public static Task<GetFeaturedResultsSetResult> InvokeAsync(GetFeaturedResultsSetArgs args, InvokeOptions? opts = null)
public static Output<GetFeaturedResultsSetResult> Invoke(GetFeaturedResultsSetInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetFeaturedResultsSetResult> Invoke(GetFeaturedResultsSetInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetFeaturedResultsSetResult> getFeaturedResultsSet(GetFeaturedResultsSetArgs args, InvokeOptions options)
public static Output<GetFeaturedResultsSetResult> getFeaturedResultsSet(GetFeaturedResultsSetArgs args, InvokeOptions options)
public static Output<GetFeaturedResultsSetResult> getFeaturedResultsSet(GetFeaturedResultsSetArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:kendra:getFeaturedResultsSet
arguments:
# arguments dictionarydata "aws-native_kendra_get_featured_results_set" "name" {
# arguments
}The following arguments are supported:
- Arn string
- The Amazon Resource Name (ARN) of the featured results set.
- Arn string
- The Amazon Resource Name (ARN) of the featured results set.
- arn string
- The Amazon Resource Name (ARN) of the featured results set.
- arn String
- The Amazon Resource Name (ARN) of the featured results set.
- arn string
- The Amazon Resource Name (ARN) of the featured results set.
- arn str
- The Amazon Resource Name (ARN) of the featured results set.
- arn String
- The Amazon Resource Name (ARN) of the featured results set.
getFeaturedResultsSet Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the featured results set.
- Description string
- A description for the set of featured results.
- Featured
Results stringSet Id - The identifier of the set of featured results.
- Featured
Results stringSet Name - A name for the set of featured results.
- Query
Texts List<string> - A list of queries for featuring results.
- Status
Pulumi.
Aws Native. Kendra. Featured Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
-
List<Pulumi.
Aws Native. Outputs. Tag> - A list of key-value pairs that identify or categorize the featured results set.
- Arn string
- The Amazon Resource Name (ARN) of the featured results set.
- Description string
- A description for the set of featured results.
- Featured
Results stringSet Id - The identifier of the set of featured results.
- Featured
Results stringSet Name - A name for the set of featured results.
- Query
Texts []string - A list of queries for featuring results.
- Status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- Tag
- A list of key-value pairs that identify or categorize the featured results set.
- arn string
- The Amazon Resource Name (ARN) of the featured results set.
- description string
- A description for the set of featured results.
- featured_
results_ stringset_ id - The identifier of the set of featured results.
- featured_
results_ stringset_ name - A name for the set of featured results.
- query_
texts list(string) - A list of queries for featuring results.
- status "ACTIVE" | "INACTIVE"
- The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- list(object)
- A list of key-value pairs that identify or categorize the featured results set.
- arn String
- The Amazon Resource Name (ARN) of the featured results set.
- description String
- A description for the set of featured results.
- featured
Results StringSet Id - The identifier of the set of featured results.
- featured
Results StringSet Name - A name for the set of featured results.
- query
Texts List<String> - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- List<Tag>
- A list of key-value pairs that identify or categorize the featured results set.
- arn string
- The Amazon Resource Name (ARN) of the featured results set.
- description string
- A description for the set of featured results.
- featured
Results stringSet Id - The identifier of the set of featured results.
- featured
Results stringSet Name - A name for the set of featured results.
- query
Texts string[] - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- Tag[]
- A list of key-value pairs that identify or categorize the featured results set.
- arn str
- The Amazon Resource Name (ARN) of the featured results set.
- description str
- A description for the set of featured results.
- featured_
results_ strset_ id - The identifier of the set of featured results.
- featured_
results_ strset_ name - A name for the set of featured results.
- query_
texts Sequence[str] - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- Sequence[root_Tag]
- A list of key-value pairs that identify or categorize the featured results set.
- arn String
- The Amazon Resource Name (ARN) of the featured results set.
- description String
- A description for the set of featured results.
- featured
Results StringSet Id - The identifier of the set of featured results.
- featured
Results StringSet Name - A name for the set of featured results.
- query
Texts List<String> - A list of queries for featuring results.
- status "ACTIVE" | "INACTIVE"
- The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- List<Property Map>
- A list of key-value pairs that identify or categorize the featured results set.
Supporting Types
FeaturedResultsSetStatus
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi