1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. getRetriever

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.qbusiness.getRetriever

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    Definition of AWS::QBusiness::Retriever Resource Type

    Using getRetriever

    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 getRetriever(args: GetRetrieverArgs, opts?: InvokeOptions): Promise<GetRetrieverResult>
    function getRetrieverOutput(args: GetRetrieverOutputArgs, opts?: InvokeOptions): Output<GetRetrieverResult>
    def get_retriever(application_id: Optional[str] = None,
                      retriever_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRetrieverResult
    def get_retriever_output(application_id: Optional[pulumi.Input[str]] = None,
                      retriever_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRetrieverResult]
    func LookupRetriever(ctx *Context, args *LookupRetrieverArgs, opts ...InvokeOption) (*LookupRetrieverResult, error)
    func LookupRetrieverOutput(ctx *Context, args *LookupRetrieverOutputArgs, opts ...InvokeOption) LookupRetrieverResultOutput

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

    public static class GetRetriever 
    {
        public static Task<GetRetrieverResult> InvokeAsync(GetRetrieverArgs args, InvokeOptions? opts = null)
        public static Output<GetRetrieverResult> Invoke(GetRetrieverInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRetrieverResult> getRetriever(GetRetrieverArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:qbusiness:getRetriever
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApplicationId string
    The identifier of the Amazon Q Business application using the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    ApplicationId string
    The identifier of the Amazon Q Business application using the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    applicationId String
    The identifier of the Amazon Q Business application using the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.
    applicationId string
    The identifier of the Amazon Q Business application using the retriever.
    retrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    application_id str
    The identifier of the Amazon Q Business application using the retriever.
    retriever_id str
    The identifier of the retriever used by your Amazon Q Business application.
    applicationId String
    The identifier of the Amazon Q Business application using the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.

    getRetriever Result

    The following output properties are available:

    Configuration Pulumi.AwsNative.QBusiness.Outputs.RetrieverConfiguration0Properties | Pulumi.AwsNative.QBusiness.Outputs.RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    CreatedAt string
    The Unix timestamp when the retriever was created.
    DisplayName string
    The name of your retriever.
    RetrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    RoleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    Status Pulumi.AwsNative.QBusiness.RetrieverStatus
    The status of your retriever.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    UpdatedAt string
    The Unix timestamp when the retriever was last updated.
    Configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    CreatedAt string
    The Unix timestamp when the retriever was created.
    DisplayName string
    The name of your retriever.
    RetrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    RoleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    Status RetrieverStatus
    The status of your retriever.
    Tags Tag
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    UpdatedAt string
    The Unix timestamp when the retriever was last updated.
    configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    createdAt String
    The Unix timestamp when the retriever was created.
    displayName String
    The name of your retriever.
    retrieverArn String
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.
    roleArn String
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    status RetrieverStatus
    The status of your retriever.
    tags List<Tag>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    updatedAt String
    The Unix timestamp when the retriever was last updated.
    configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    createdAt string
    The Unix timestamp when the retriever was created.
    displayName string
    The name of your retriever.
    retrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    roleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    status RetrieverStatus
    The status of your retriever.
    tags Tag[]
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    updatedAt string
    The Unix timestamp when the retriever was last updated.
    configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    created_at str
    The Unix timestamp when the retriever was created.
    display_name str
    The name of your retriever.
    retriever_arn str
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retriever_id str
    The identifier of the retriever used by your Amazon Q Business application.
    role_arn str
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    status RetrieverStatus
    The status of your retriever.
    tags Sequence[root_Tag]
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    updated_at str
    The Unix timestamp when the retriever was last updated.
    configuration Property Map | Property Map
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    createdAt String
    The Unix timestamp when the retriever was created.
    displayName String
    The name of your retriever.
    retrieverArn String
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.
    roleArn String
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    status "CREATING" | "ACTIVE" | "FAILED"
    The status of your retriever.
    tags List<Property Map>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    updatedAt String
    The Unix timestamp when the retriever was last updated.

    Supporting Types

    RetrieverConfiguration0Properties

    RetrieverConfiguration1Properties

    RetrieverKendraIndexConfiguration

    IndexId string
    IndexId string
    indexId String
    indexId string
    indexId String

    RetrieverNativeIndexConfiguration

    IndexId string
    IndexId string
    indexId String
    indexId string
    indexId String

    RetrieverStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi