@pulumi/aws/resourceexplorer/search.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Data source for managing an AWS Resource Explorer Search.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.resourceexplorer.Search({
 *     queryString: "region:us-west-2",
 *     viewArn: test.arn,
 * });
 * ```
 */
export declare function search(args: SearchArgs, opts?: pulumi.InvokeOptions): Promise<SearchResult>;
/**
 * A collection of arguments for invoking Search.
 */
export interface SearchArgs {
    /**
     * String that includes keywords and filters that specify the resources that you want to include in the results. For the complete syntax supported by the QueryString parameter, see Search query syntax reference for [Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html). The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results. The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.
     *
     * The following arguments are optional:
     */
    queryString: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the AWS Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a `401 Unauthorized` exception.
     */
    viewArn?: string;
}
/**
 * A collection of values returned by Search.
 */
export interface SearchResult {
    /**
     * Query String.
     */
    readonly id: string;
    readonly queryString: string;
    /**
     * Amazon Web Services Region in which the resource was created and exists.
     */
    readonly region: string;
    /**
     * Number of resources that match the query. See `resourceCount` below.
     */
    readonly resourceCounts: outputs.resourceexplorer.SearchResourceCount[];
    /**
     * List of structures that describe the resources that match the query. See `resources` below.
     */
    readonly resources: outputs.resourceexplorer.SearchResource[];
    readonly viewArn: string;
}
/**
 * Data source for managing an AWS Resource Explorer Search.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.resourceexplorer.Search({
 *     queryString: "region:us-west-2",
 *     viewArn: test.arn,
 * });
 * ```
 */
export declare function searchOutput(args: SearchOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<SearchResult>;
/**
 * A collection of arguments for invoking Search.
 */
export interface SearchOutputArgs {
    /**
     * String that includes keywords and filters that specify the resources that you want to include in the results. For the complete syntax supported by the QueryString parameter, see Search query syntax reference for [Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html). The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results. The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.
     *
     * The following arguments are optional:
     */
    queryString: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the AWS Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a `401 Unauthorized` exception.
     */
    viewArn?: pulumi.Input<string>;
}