AWS.Tools.ResourceExplorer2

4.1.224

AWS.Tools.ResourceExplorer2.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.ResourceExplorer2</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet">
            <summary>
            Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer
            view or index.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet.Tag">
            <summary>
            <para>
            <para>A list of tag key and value pairs that you want to attach to the specified view or
            index.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.TagResourceResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.AddAREXResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXDefaultViewCmdlet">
            <summary>
            Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon
            Web Services Region in which you call this operation. You can then call <a>GetView</a>
            to retrieve the details of that view.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXDefaultViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ViewArn'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.GetDefaultViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.GetDefaultViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexCmdlet">
            <summary>
            Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon
            Web Services Region in which you invoked the operation.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.GetIndexResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.GetIndexResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet">
            <summary>
            Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently
            collecting resource information for Amazon Web Services Resource Explorer.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet.RegionList">
            <summary>
            <para>
            <para>If specified, limits the response to only information about the index in the specified
            list of Amazon Web Services Regions.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet.Type">
            <summary>
            <para>
            <para>If specified, limits the output to only indexes of the specified Type, either <code>LOCAL</code>
            or <code>AGGREGATOR</code>.</para><para>Use this option to discover the aggregator index for your account.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results that you want included on each page of the response.
            If you do not include this parameter, it defaults to a value appropriate to the operation.
            If additional items exist beyond those included in the current response, the <code>NextToken</code>
            response element is present and has a value (is not null). Include that value as the
            <code>NextToken</code> request parameter in the next call to the operation to get
            the next part of the results.</para><note><para>An API operation can return fewer results than the maximum even when there are more
            results available. You should check <code>NextToken</code> after every operation to
            ensure that you receive all of the results.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet.NextToken">
            <summary>
            <para>
            <para>The parameter for receiving additional results if you receive a <code>NextToken</code>
            response in a previous request. A <code>NextToken</code> response indicates that more
            output is available. Set this parameter to the value of the previous call's <code>NextToken</code>
            response to indicate where the output should continue from.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXIndexListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Indexes'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.ListIndexesResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.ListIndexesResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXResourceTagCmdlet">
            <summary>
            Lists the tags that are attached to the specified resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the view or index that you want to attach tags to.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Tags'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.ListTagsForResourceResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.ListTagsForResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXSupportedResourceTypeListCmdlet">
            <summary>
            Retrieves a list of all resource types currently supported by Amazon Web Services
            Resource Explorer.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXSupportedResourceTypeListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results that you want included on each page of the response.
            If you do not include this parameter, it defaults to a value appropriate to the operation.
            If additional items exist beyond those included in the current response, the <code>NextToken</code>
            response element is present and has a value (is not null). Include that value as the
            <code>NextToken</code> request parameter in the next call to the operation to get
            the next part of the results.</para><note><para>An API operation can return fewer results than the maximum even when there are more
            results available. You should check <code>NextToken</code> after every operation to
            ensure that you receive all of the results.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXSupportedResourceTypeListCmdlet.NextToken">
            <summary>
            <para>
            <para>The parameter for receiving additional results if you receive a <code>NextToken</code>
            response in a previous request. A <code>NextToken</code> response indicates that more
            output is available. Set this parameter to the value of the previous call's <code>NextToken</code>
            response to indicate where the output should continue from.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXSupportedResourceTypeListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTypes'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.ListSupportedResourceTypesResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.ListSupportedResourceTypesResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewCmdlet">
            <summary>
            Retrieves details of the specified view.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewCmdlet.ViewArn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the view that you want information about.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.GetViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.GetViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewArnListCmdlet">
            <summary>
            Lists the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource names (ARNs)</a> of the views available in the Amazon Web Services Region
            in which you call this operation.
             
             <note><para>
            Always check the <code>NextToken</code> response parameter for a <code>null</code>
            value when calling a paginated operation. These operations can occasionally return
            an empty set of results even when there are more results available. The <code>NextToken</code>
            response parameter value is <code>null</code><i>only</i> when there are no more results
            to display.
            </para></note>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewArnListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results that you want included on each page of the response.
            If you do not include this parameter, it defaults to a value appropriate to the operation.
            If additional items exist beyond those included in the current response, the <code>NextToken</code>
            response element is present and has a value (is not null). Include that value as the
            <code>NextToken</code> request parameter in the next call to the operation to get
            the next part of the results.</para><note><para>An API operation can return fewer results than the maximum even when there are more
            results available. You should check <code>NextToken</code> after every operation to
            ensure that you receive all of the results.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewArnListCmdlet.NextToken">
            <summary>
            <para>
            <para>The parameter for receiving additional results if you receive a <code>NextToken</code>
            response in a previous request. A <code>NextToken</code> response indicates that more
            output is available. Set this parameter to the value of the previous call's <code>NextToken</code>
            response to indicate where the output should continue from.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewArnListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Views'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.ListViewsResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.ListViewsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewBatchCmdlet">
            <summary>
            Retrieves details about a list of views.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewBatchCmdlet.ViewArn">
            <summary>
            <para>
            <para>A list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource names (ARNs)</a> that identify the views you want details for.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewBatchCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.BatchGetViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.BatchGetViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.GetAREXViewBatchCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.NewAREXIndexCmdlet">
            <summary>
            Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in
            which you called this operation by creating an index. Resource Explorer begins discovering
            the resources in this Region and stores the details about the resources in the index
            so that they can be queried by using the <a>Search</a> operation. You can create only
            one index in a Region.
             
             <note><para>
            This operation creates only a <i>local</i> index. To promote the local index in one
            Amazon Web Services Region into the aggregator index for the Amazon Web Services account,
            use the <a>UpdateIndexType</a> operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning
            on cross-Region search by creating an aggregator index</a> in the <i>Amazon Web Services
            Resource Explorer User Guide</i>.
            </para></note><para>
            For more details about what happens when you turn on Resource Explorer in an Amazon
            Web Services Region, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html">Turn
            on Resource Explorer to index your resources in an Amazon Web Services Region</a>
            in the <i>Amazon Web Services Resource Explorer User Guide</i>.
            </para><para>
            If this is the first Amazon Web Services Region in which you've created an index for
            Resource Explorer, then this operation also <a href="https://docs.aws.amazon.com/arexug/mainline/security_iam_service-linked-roles.html">creates
            a service-linked role</a> in your Amazon Web Services account that allows Resource
            Explorer to enumerate your resources to populate the index.
            </para><ul><li><para><b>Action</b>: <code>resource-explorer-2:CreateIndex</code></para><para><b>Resource</b>: The ARN of the index (as it will exist after the operation completes)
            in the Amazon Web Services Region and account in which you're trying to create the
            index. Use the wildcard character (<code>*</code>) at the end of the string to match
            the eventual UUID. For example, the following <code>Resource</code> element restricts
            the role or user to creating an index in only the <code>us-east-2</code> Region of
            the specified account.
            </para><para><code>"Resource": "arn:aws:resource-explorer-2:us-west-2:<i>&lt;account-id&gt;</i>:index/*"</code></para><para>
            Alternatively, you can use <code>"Resource": "*"</code> to allow the role or user
            to create an index in any Region.
            </para></li><li><para><b>Action</b>: <code>iam:CreateServiceLinkedRole</code></para><para><b>Resource</b>: No specific resource (*).
            </para><para>
            This permission is required only the first time you create an index to turn on Resource
            Explorer in the account. Resource Explorer uses this to create the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html">service-linked
            role needed to index the resources in your account</a>. Resource Explorer uses the
            same service-linked role for all additional indexes you create afterwards.
            </para></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXIndexCmdlet.Tag">
            <summary>
            <para>
            <para>The specified tags are attached only to the index created in this Amazon Web Services
            Region. The tags aren't attached to any of the resources listed in the index.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXIndexCmdlet.ClientToken">
            <summary>
            <para>
            <para>This value helps ensure idempotency. Resource Explorer uses this value to prevent
            the accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type value</a>
            to ensure the uniqueness of your views.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXIndexCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.CreateIndexResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.CreateIndexResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXIndexCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet">
            <summary>
            Creates a view that users can query by using the <a>Search</a> operation. Results
            from queries that you make using this view include only resources that match the view's
            <code>Filters</code>. For more information about Amazon Web Services Resource Explorer
            views, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-views.html">Managing
            views</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.
             
              
            <para>
            Only the principals with an IAM identity-based policy that grants <code>Allow</code>
            to the <code>Search</code> action on a <code>Resource</code> with the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of this view can <a>Search</a> using views you create with
            this operation.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.Filters_FilterString">
            <summary>
            <para>
            <para>The string that contains the search keywords, prefixes, and operators to control the
            results that can be returned by a <a>Search</a> operation. For more details, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
            query syntax</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.IncludedProperty">
            <summary>
            <para>
            <para>Specifies optional fields that you want included in search results from this view.
            It is a list of objects that each describe a field to include.</para><para>The default is an empty list, with no optional fields included in the results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.Tag">
            <summary>
            <para>
            <para>Tag key and value pairs that are attached to the view.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.ViewName">
            <summary>
            <para>
            <para>The name of the new view. This name appears in the list of views in Resource Explorer.</para><para>The name must be no more than 64 characters long, and can include letters, digits,
            and the dash (-) character. The name must be unique within its Amazon Web Services
            Region.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.ClientToken">
            <summary>
            <para>
            <para>This value helps ensure idempotency. Resource Explorer uses this value to prevent
            the accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type value</a>
            to ensure the uniqueness of your views.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'View'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.CreateViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.CreateViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewName parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.NewAREXViewCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.RegisterAREXDefaultViewCmdlet">
            <summary>
            Sets the specified view as the default for the Amazon Web Services Region in which
            you call this operation. When a user performs a <a>Search</a> that doesn't explicitly
            specify which view to use, then Amazon Web Services Resource Explorer automatically
            chooses this default view for searches performed in this Amazon Web Services Region.
             
              
            <para>
            If an Amazon Web Services Region doesn't have a default view configured, then users
            must explicitly specify a view with every <code>Search</code> operation performed
            in that Region.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RegisterAREXDefaultViewCmdlet.ViewArn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the view to set as the default for the Amazon Web Services
            Region and Amazon Web Services account in which you call this operation. The specified
            view must already exist in the called Region.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RegisterAREXDefaultViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ViewArn'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.AssociateDefaultViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.AssociateDefaultViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RegisterAREXDefaultViewCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RegisterAREXDefaultViewCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXIndexCmdlet">
            <summary>
            Deletes the specified index and turns off Amazon Web Services Resource Explorer in
            the specified Amazon Web Services Region. When you delete an index, Resource Explorer
            stops discovering and indexing resources in that Region. Resource Explorer also deletes
            all views in that Region. These actions occur as asynchronous background tasks. You
            can check to see when the actions are complete by using the <a>GetIndex</a> operation
            and checking the <code>Status</code> response value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXIndexCmdlet.Arn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the index that you want to delete.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXIndexCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.DeleteIndexResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.DeleteIndexResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXIndexCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Arn parameter.
            The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXIndexCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet">
            <summary>
            Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer
            view or index.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet.TagKey">
            <summary>
            <para>
            <para>A list of the keys for the tags that you want to remove from the specified view or
            index.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.UntagResourceResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXViewCmdlet">
            <summary>
            Deletes the specified view.
             
              
            <para>
            If the specified view is the default view for its Amazon Web Services Region, then
            all <a>Search</a> operations in that Region must explicitly specify the view to use
            until you configure a new default by calling the <a>AssociateDefaultView</a> operation.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXViewCmdlet.ViewArn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the view that you want to delete.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ViewArn'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.DeleteViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.DeleteViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXViewCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.RemoveAREXViewCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet">
            <summary>
            Searches for resources and displays details about all resources that match the specified
            criteria. You must specify a query string.
             
              
            <para>
            All search queries must use a view. If you don't explicitly specify a view, then Amazon
            Web Services Resource Explorer uses the default view for the Amazon Web Services Region
            in which you call this operation. The results are the logical intersection of the
            results that match both the <code>QueryString</code> parameter supplied to this operation
            and the <code>SearchFilter</code> parameter attached to the view.
            </para><para>
            For the complete syntax supported by the <code>QueryString</code> parameter, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
            query syntax reference for Resource Explorer</a>.
            </para><para>
            If your search results are empty, or are missing results that you think should be
            there, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html">Troubleshooting
            Resource Explorer search</a>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.QueryString">
            <summary>
            <para>
            <para>A string that includes keywords and filters that specify the resources that you want
            to include in the results.</para><para>For the complete syntax supported by the <code>QueryString</code> parameter, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search
            query syntax reference for Resource Explorer</a>.</para><para>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.</para><note><para>The operation can return only the first 1,000 results. If the resource you want is
            not included, then use a different value for <code>QueryString</code> to refine the
            results.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.ViewArn">
            <summary>
            <para>
            <para>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> 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
            Amazon Web Services 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 <code>401 Unauthorized</code> exception.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results that you want included on each page of the response.
            If you do not include this parameter, it defaults to a value appropriate to the operation.
            If additional items exist beyond those included in the current response, the <code>NextToken</code>
            response element is present and has a value (is not null). Include that value as the
            <code>NextToken</code> request parameter in the next call to the operation to get
            the next part of the results.</para><note><para>An API operation can return fewer results than the maximum even when there are more
            results available. You should check <code>NextToken</code> after every operation to
            ensure that you receive all of the results.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.NextToken">
            <summary>
            <para>
            <para>The parameter for receiving additional results if you receive a <code>NextToken</code>
            response in a previous request. A <code>NextToken</code> response indicates that more
            output is available. Set this parameter to the value of the previous call's <code>NextToken</code>
            response to indicate where the output should continue from.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.SearchResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.SearchResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.SearchAREXResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the QueryString parameter.
            The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.UnregisterAREXDefaultViewCmdlet">
            <summary>
            After you call this operation, the affected Amazon Web Services Region no longer has
            a default view. All <a>Search</a> operations in that Region must explicitly specify
            a view or the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a>
            operation.
             
              
            <para>
            If an Amazon Web Services Region doesn't have a default view configured, then users
            must explicitly specify a view with every <code>Search</code> operation performed
            in that Region.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UnregisterAREXDefaultViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.DisassociateDefaultViewResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UnregisterAREXDefaultViewCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet">
            <summary>
            Changes the type of the index from one of the following types to the other. For more
            information about indexes and the role they perform in Amazon Web Services Resource
            Explorer, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">Turning
            on cross-Region search by creating an aggregator index</a> in the <i>Amazon Web Services
            Resource Explorer User Guide</i>.
             
             <ul><li><para><b><code>AGGREGATOR</code> index type</b></para><para>
            The index contains information about resources from all Amazon Web Services Regions
            in the Amazon Web Services account in which you've created a Resource Explorer index.
            Resource information from all other Regions is replicated to this Region's index.
            </para><para>
            When you change the index type to <code>AGGREGATOR</code>, Resource Explorer turns
            on replication of all discovered resource information from the other Amazon Web Services
            Regions in your account to this index. You can then, from this Region only, perform
            resource search queries that span all Amazon Web Services Regions in the Amazon Web
            Services account. Turning on replication from all other Regions is performed by asynchronous
            background tasks. You can check the status of the asynchronous tasks by using the
            <a>GetIndex</a> operation. When the asynchronous tasks complete, the <code>Status</code>
            response of that operation changes from <code>UPDATING</code> to <code>ACTIVE</code>.
            After that, you can start to see results from other Amazon Web Services Regions in
            query results. However, it can take several hours for replication from all other Regions
            to complete.
            </para><important><para>
            You can have only one aggregator index per Amazon Web Services account. Before you
            can promote a different index to be the aggregator index for the account, you must
            first demote the existing aggregator index to type <code>LOCAL</code>.
            </para></important></li><li><para><b><code>LOCAL</code> index type</b></para><para>
            The index contains information about resources in only the Amazon Web Services Region
            in which the index exists. If an aggregator index in another Region exists, then information
            in this local index is replicated to the aggregator index.
            </para><para>
            When you change the index type to <code>LOCAL</code>, Resource Explorer turns off
            the replication of resource information from all other Amazon Web Services Regions
            in the Amazon Web Services account to this Region. The aggregator index remains in
            the <code>UPDATING</code> state until all replication with other Regions successfully
            stops. You can check the status of the asynchronous task by using the <a>GetIndex</a>
            operation. When Resource Explorer successfully stops all replication with other Regions,
            the <code>Status</code> response of that operation changes from <code>UPDATING</code>
            to <code>ACTIVE</code>. Separately, the resource information from other Regions that
            was previously stored in the index is deleted within 30 days by another background
            task. Until that asynchronous task completes, some results from other Regions can
            continue to appear in search results.
            </para><important><para>
            After you demote an aggregator index to a local index, you must wait 24 hours before
            you can promote another index to be the new aggregator index for the account.
            </para></important></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet.Arn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the index that you want to update.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet.Type">
            <summary>
            <para>
            <para>The type of the index. To understand the difference between <code>LOCAL</code> and
            <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning
            on cross-Region search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.UpdateIndexTypeResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.UpdateIndexTypeResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Arn parameter.
            The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXIndexTypeCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet">
            <summary>
            Modifies some of the details of a view. You can change the filter string and the list
            of included properties. You can't change the name of the view.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.Filters_FilterString">
            <summary>
            <para>
            <para>The string that contains the search keywords, prefixes, and operators to control the
            results that can be returned by a <a>Search</a> operation. For more details, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
            query syntax</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.IncludedProperty">
            <summary>
            <para>
            <para>Specifies optional fields that you want included in search results from this view.
            It is a list of objects that each describe a field to include.</para><para>The default is an empty list, with no optional fields included in the results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.ViewArn">
            <summary>
            <para>
            <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
            resource name (ARN)</a> of the view that you want to modify.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'View'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ResourceExplorer2.Model.UpdateViewResponse).
            Specifying the name of a property of type Amazon.ResourceExplorer2.Model.UpdateViewResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ViewArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ViewArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AREX.UpdateAREXViewCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>