AWS.Tools.AccessAnalyzer.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AccessAnalyzer</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.AddIAMAAResourceTagCmdlet"> <summary> Adds a tag to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.AddIAMAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to add the tag to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.AddIAMAAResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to add to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.AddIAMAAResourceTagCmdlet.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.AccessAnalyzer.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.AddIAMAAResourceTagCmdlet.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.IAMAA.AddIAMAAResourceTagCmdlet.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.IAMAA.GetIAMAAAccessPreviewCmdlet"> <summary> Retrieves information about an access preview for the specified analyzer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewCmdlet.AccessPreviewId"> <summary> <para> <para>The unique ID for the access preview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the access preview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPreview'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.GetAccessPreviewResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetAccessPreviewResponse 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.IAMAA.GetIAMAAAccessPreviewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPreviewId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPreviewId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet"> <summary> Retrieves a list of access preview findings generated by the specified access preview.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.AccessPreviewId"> <summary> <para> <para>The unique ID for the access preview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.Filter"> <summary> <para> <para>Criteria to filter the returned findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListAccessPreviewFindingsResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListAccessPreviewFindingsResponse 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.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPreviewId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPreviewId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewFindingListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet"> <summary> Retrieves a list of access previews for the specified analyzer.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the access preview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPreviews'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListAccessPreviewsResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListAccessPreviewsResponse 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.IAMAA.GetIAMAAAccessPreviewListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAccessPreviewListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceCmdlet"> <summary> Retrieves information about a resource that was analyzed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> to retrieve information from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to retrieve information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.GetAnalyzedResourceResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetAnalyzedResourceResponse 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.IAMAA.GetIAMAAAnalyzedResourceCmdlet.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.IAMAA.GetIAMAAAnalyzedResourceListCmdlet"> <summary> Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> to retrieve a list of analyzed resources from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.ResourceType"> <summary> <para> <para>The type of resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnalyzedResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListAnalyzedResourcesResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListAnalyzedResourcesResponse 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.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzedResourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerCmdlet"> <summary> Retrieves information about the specified analyzer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Analyzer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.GetAnalyzerResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetAnalyzerResponse 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.IAMAA.GetIAMAAAnalyzerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerName parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet"> <summary> Retrieves a list of analyzers.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet.Type"> <summary> <para> <para>The type of analyzer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Analyzers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListAnalyzersResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListAnalyzersResponse 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.IAMAA.GetIAMAAAnalyzerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAAnalyzerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleCmdlet"> <summary> Retrieves information about an archive rule. <para> To learn about filter keys that you can use to create an archive rule, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to retrieve rules from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArchiveRule'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.GetArchiveRuleResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetArchiveRuleResponse 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.IAMAA.GetIAMAAArchiveRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet"> <summary> Retrieves a list of archive rules created for the specified analyzer.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to retrieve rules from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArchiveRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListArchiveRulesResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListArchiveRulesResponse 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.IAMAA.GetIAMAAArchiveRuleListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerName parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAArchiveRuleListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingCmdlet"> <summary> Retrieves information about the specified finding. GetFinding and GetFindingV2 both use <c>access-analyzer:GetFinding</c> in the <c>Action</c> element of an IAM policy statement. You must have permission to perform the <c>access-analyzer:GetFinding</c> action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> that generated the finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingCmdlet.Id"> <summary> <para> <para>The ID of the finding to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Finding'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.GetFindingResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetFindingResponse 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.IAMAA.GetIAMAAFindingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet"> <summary> Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use <c>access-analyzer:ListFindings</c> in the <c>Action</c> element of an IAM policy statement. You must have permission to perform the <c>access-analyzer:ListFindings</c> action. <para> To learn about filter keys that you can use to retrieve a list of findings, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> to retrieve findings from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.Sort_AttributeName"> <summary> <para> <para>The name of the attribute to sort on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.Filter"> <summary> <para> <para>A filter to match for the findings to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.Sort_OrderBy"> <summary> <para> <para>The sort order, ascending or descending.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListFindingsResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListFindingsResponse 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.IAMAA.GetIAMAAFindingListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet"> <summary> Retrieves information about a finding recommendation for the specified analyzer.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the finding recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.Id"> <summary> <para> <para>The unique ID for the finding recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.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.AccessAnalyzer.Model.GetFindingRecommendationResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetFindingRecommendationResponse 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.IAMAA.GetIAMAAFindingRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingRecommendationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet"> <summary> Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use <c>access-analyzer:ListFindings</c> in the <c>Action</c> element of an IAM policy statement. You must have permission to perform the <c>access-analyzer:ListFindings</c> action. <para> To learn about filter keys that you can use to retrieve a list of findings, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> to retrieve findings from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.Sort_AttributeName"> <summary> <para> <para>The name of the attribute to sort on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.Filter"> <summary> <para> <para>A filter to match for the findings to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.Sort_OrderBy"> <summary> <para> <para>The sort order, ascending or descending.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListFindingsV2Response). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListFindingsV2Response 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.IAMAA.GetIAMAAFindingsV2ListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingsV2ListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet"> <summary> Retrieves information about the specified finding. GetFinding and GetFindingV2 both use <c>access-analyzer:GetFinding</c> in the <c>Action</c> element of an IAM policy statement. You must have permission to perform the <c>access-analyzer:GetFinding</c> action.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> that generated the finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.Id"> <summary> <para> <para>The ID of the finding to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.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.AccessAnalyzer.Model.GetFindingV2Response). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetFindingV2Response 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.IAMAA.GetIAMAAFindingV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAFindingV2Cmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAGeneratedPolicyCmdlet"> <summary> Retrieves the policy that was generated using <c>StartPolicyGeneration</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAGeneratedPolicyCmdlet.IncludeResourcePlaceholder"> <summary> <para> <para>The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.</para><para>For example, in the resource section of a policy, you can receive a placeholder such as <c>"Resource":"arn:aws:s3:::${BucketName}"</c> instead of <c>"*"</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAGeneratedPolicyCmdlet.IncludeServiceLevelTemplate"> <summary> <para> <para>The level of detail that you want to generate. You can specify whether to generate service-level policies. </para><para>IAM Access Analyzer uses <c>iam:servicelastaccessed</c> to identify services that have been used recently to create this service-level template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAGeneratedPolicyCmdlet.JobId"> <summary> <para> <para>The <c>JobId</c> that is returned by the <c>StartPolicyGeneration</c> operation. The <c>JobId</c> can be used with <c>GetGeneratedPolicy</c> to retrieve the generated policies or used with <c>CancelPolicyGeneration</c> to cancel the policy generation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAGeneratedPolicyCmdlet.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.AccessAnalyzer.Model.GetGeneratedPolicyResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.GetGeneratedPolicyResponse 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.IAMAA.GetIAMAAGeneratedPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet"> <summary> Lists all of the policy generations requested in the last seven days.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet.PrincipalArn"> <summary> <para> <para>The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with <c>ListGeneratedPolicies</c> to filter the results to only include results for a specific principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyGenerations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ListPolicyGenerationsResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ListPolicyGenerationsResponse 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.IAMAA.GetIAMAAPolicyGenerationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAPolicyGenerationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAResourceTagCmdlet"> <summary> Retrieves a list of tags applied to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to retrieve tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.GetIAMAAResourceTagCmdlet.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.AccessAnalyzer.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.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.IAMAA.GetIAMAAResourceTagCmdlet.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.IAMAA.NewIAMAAAccessPreviewCmdlet"> <summary> Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAccessPreviewCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the account analyzer</a> used to generate the access preview. You can only create an access preview for analyzers with an <c>Account</c> type and <c>Active</c> status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAccessPreviewCmdlet.Configuration"> <summary> <para> <para>Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAccessPreviewCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAccessPreviewCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.CreateAccessPreviewResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.CreateAccessPreviewResponse 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.IAMAA.NewIAMAAAccessPreviewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAccessPreviewCmdlet.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.IAMAA.NewIAMAAAnalyzerCmdlet"> <summary> Creates an analyzer for your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.ArchiveRule"> <summary> <para> <para>Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.AnalysisRule_Exclusion"> <summary> <para> <para>A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, <c>_</c>, <c>.</c>, <c>/</c>, <c>=</c>, <c>+</c>, and <c>-</c>.</para><para>For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with <c>aws:</c>.</para><para>For the tag value, you can specify a value that is 0 to 256 characters in length.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.Type"> <summary> <para> <para>The type of analyzer to create. Only <c>ACCOUNT</c>, <c>ORGANIZATION</c>, <c>ACCOUNT_UNUSED_ACCESS</c>, and <c>ORGANIZATION_UNUSED_ACCESS</c> analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.UnusedAccess_UnusedAccessAge"> <summary> <para> <para>The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 365 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.CreateAnalyzerResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.CreateAnalyzerResponse 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.IAMAA.NewIAMAAAnalyzerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerName parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAAnalyzerCmdlet.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.IAMAA.NewIAMAAArchiveRuleCmdlet"> <summary> Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. <para> To learn about filter keys that you can use to create an archive rule, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.AnalyzerName"> <summary> <para> <para>The name of the created analyzer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.Filter"> <summary> <para> <para>The criteria for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.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.AccessAnalyzer.Model.CreateArchiveRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.NewIAMAAArchiveRuleCmdlet.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.IAMAA.RemoveIAMAAAnalyzerCmdlet"> <summary> Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAAnalyzerCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAAnalyzerCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAAnalyzerCmdlet.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.AccessAnalyzer.Model.DeleteAnalyzerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAAnalyzerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerName parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAAnalyzerCmdlet.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.IAMAA.RemoveIAMAAArchiveRuleCmdlet"> <summary> Deletes the specified archive rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer that associated with the archive rule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.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.AccessAnalyzer.Model.DeleteArchiveRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAArchiveRuleCmdlet.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.IAMAA.RemoveIAMAAResourceTagCmdlet"> <summary> Removes a tag from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to remove the tag from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAResourceTagCmdlet.TagKey"> <summary> <para> <para>The key for the tag to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAResourceTagCmdlet.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.AccessAnalyzer.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.RemoveIAMAAResourceTagCmdlet.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.IAMAA.RemoveIAMAAResourceTagCmdlet.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.IAMAA.StartIAMAAArchiveRuleCmdlet"> <summary> Retroactively applies the archive rule to existing findings that meet the archive rule criteria. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.AnalyzerArn"> <summary> <para> <para>The Amazon resource name (ARN) of the analyzer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.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.AccessAnalyzer.Model.ApplyArchiveRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAArchiveRuleCmdlet.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.IAMAA.StartIAMAAFindingRecommendationCmdlet"> <summary> Creates a recommendation for an unused permissions finding. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAFindingRecommendationCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the finding recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAFindingRecommendationCmdlet.Id"> <summary> <para> <para>The unique ID for the finding recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAFindingRecommendationCmdlet.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.AccessAnalyzer.Model.GenerateFindingRecommendationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAFindingRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAFindingRecommendationCmdlet.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.IAMAA.StartIAMAAPolicyGenerationCmdlet"> <summary> Starts the policy generation request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.CloudTrailDetails_AccessRole"> <summary> <para> <para>The ARN of the service role that IAM Access Analyzer uses to access your CloudTrail trail and service last accessed information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.CloudTrailDetails_EndTime"> <summary> <para> <para>The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.PolicyGenerationDetails_PrincipalArn"> <summary> <para> <para>The ARN of the IAM entity (user or role) for which you are generating a policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.CloudTrailDetails_StartTime"> <summary> <para> <para>The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.CloudTrailDetails_Trail"> <summary> <para> <para>A <c>Trail</c> object that contains settings for a trail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.StartPolicyGenerationResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.StartPolicyGenerationResponse 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.IAMAA.StartIAMAAPolicyGenerationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyGenerationDetails_PrincipalArn parameter. The -PassThru parameter is deprecated, use -Select '^PolicyGenerationDetails_PrincipalArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAPolicyGenerationCmdlet.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.IAMAA.StartIAMAAResourceScanCmdlet"> <summary> Immediately starts a scan of the policies applied to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAResourceScanCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> to use to scan the policies applied to the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAResourceScanCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to scan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAResourceScanCmdlet.ResourceOwnerAccount"> <summary> <para> <para>The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAResourceScanCmdlet.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.AccessAnalyzer.Model.StartResourceScanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StartIAMAAResourceScanCmdlet.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.IAMAA.StartIAMAAResourceScanCmdlet.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.IAMAA.StopIAMAAPolicyGenerationCmdlet"> <summary> Cancels the requested policy generation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StopIAMAAPolicyGenerationCmdlet.JobId"> <summary> <para> <para>The <c>JobId</c> that is returned by the <c>StartPolicyGeneration</c> operation. The <c>JobId</c> can be used with <c>GetGeneratedPolicy</c> to retrieve the generated policies or used with <c>CancelPolicyGeneration</c> to cancel the policy generation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StopIAMAAPolicyGenerationCmdlet.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.AccessAnalyzer.Model.CancelPolicyGenerationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StopIAMAAPolicyGenerationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.StopIAMAAPolicyGenerationCmdlet.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.IAMAA.TestIAMAAAccessNotGrantedCmdlet"> <summary> Checks whether the specified access isn't allowed by a policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAAAccessNotGrantedCmdlet.Access"> <summary> <para> <para>An access object containing the permissions that shouldn't be granted by the specified policy. If only actions are specified, IAM Access Analyzer checks for access to peform at least one of the actions on any resource in the policy. If only resources are specified, then IAM Access Analyzer checks for access to perform any action on at least one of the resources. If both actions and resources are specified, IAM Access Analyzer checks for access to perform at least one of the specified actions on at least one of the specified resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAAAccessNotGrantedCmdlet.PolicyDocument"> <summary> <para> <para>The JSON policy document to use as the content for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAAAccessNotGrantedCmdlet.PolicyType"> <summary> <para> <para>The type of policy. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</para><para>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAAAccessNotGrantedCmdlet.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.AccessAnalyzer.Model.CheckAccessNotGrantedResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.CheckAccessNotGrantedResponse 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.IAMAA.TestIAMAAAccessNotGrantedCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyDocument parameter. The -PassThru parameter is deprecated, use -Select '^PolicyDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoNewAccessCmdlet"> <summary> Checks whether new access is allowed for an updated policy when compared to the existing policy. <para> You can find examples for reference policies and learn how to set up and run a custom policy check for new access in the <a href="https://github.com/aws-samples/iam-access-analyzer-custom-policy-check-samples">IAM Access Analyzer custom policy checks samples</a> repository on GitHub. The reference policies in this repository are meant to be passed to the <c>existingPolicyDocument</c> request parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoNewAccessCmdlet.ExistingPolicyDocument"> <summary> <para> <para>The JSON policy document to use as the content for the existing policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoNewAccessCmdlet.NewPolicyDocument"> <summary> <para> <para>The JSON policy document to use as the content for the updated policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoNewAccessCmdlet.PolicyType"> <summary> <para> <para>The type of policy to compare. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</para><para>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoNewAccessCmdlet.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.AccessAnalyzer.Model.CheckNoNewAccessResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.CheckNoNewAccessResponse 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.IAMAA.TestIAMAANoNewAccessCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NewPolicyDocument parameter. The -PassThru parameter is deprecated, use -Select '^NewPolicyDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoPublicAccessCmdlet"> <summary> Checks whether a resource policy can grant public access to the specified resource type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoPublicAccessCmdlet.PolicyDocument"> <summary> <para> <para>The JSON policy document to evaluate for public access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoPublicAccessCmdlet.ResourceType"> <summary> <para> <para>The type of resource to evaluate for public access. For example, to check for public access to Amazon S3 buckets, you can choose <c>AWS::S3::Bucket</c> for the resource type.</para><para>For resource types not supported as valid values, IAM Access Analyzer will return an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.TestIAMAANoPublicAccessCmdlet.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.AccessAnalyzer.Model.CheckNoPublicAccessResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.CheckNoPublicAccessResponse 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.IAMAA.TestIAMAANoPublicAccessCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyDocument parameter. The -PassThru parameter is deprecated, use -Select '^PolicyDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet"> <summary> Modifies the configuration of an existing analyzer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet.AnalysisRule_Exclusion"> <summary> <para> <para>A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet.UnusedAccess_UnusedAccessAge"> <summary> <para> <para>The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 365 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet.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.AccessAnalyzer.Model.UpdateAnalyzerResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.UpdateAnalyzerResponse 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.IAMAA.UpdateIAMAAAnalyzerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerName parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAAnalyzerCmdlet.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.IAMAA.UpdateIAMAAArchiveRuleCmdlet"> <summary> Updates the criteria and values for the specified archive rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.AnalyzerName"> <summary> <para> <para>The name of the analyzer to update the archive rules for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.Filter"> <summary> <para> <para>A filter to match for the rules to update. Only rules that match the filter are updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.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.AccessAnalyzer.Model.UpdateArchiveRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAArchiveRuleCmdlet.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.IAMAA.UpdateIAMAAFindingCmdlet"> <summary> Updates the status for the specified findings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.AnalyzerArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> that generated the findings to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.Id"> <summary> <para> <para>The IDs of the findings to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource identified in the finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.Status"> <summary> <para> <para>The state represents the action to take to update the finding Status. Use <c>ARCHIVE</c> to change an Active finding to an Archived finding. Use <c>ACTIVE</c> to change an Archived finding to an Active finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.ClientToken"> <summary> <para> <para>A client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.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.AccessAnalyzer.Model.UpdateFindingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalyzerArn parameter. The -PassThru parameter is deprecated, use -Select '^AnalyzerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UpdateIAMAAFindingCmdlet.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.IAMAA.UseIAMAAPolicyValidationCmdlet"> <summary> Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.Locale"> <summary> <para> <para>The locale to use for localizing the findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.PolicyDocument"> <summary> <para> <para>The JSON policy document to use as the content for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.PolicyType"> <summary> <para> <para>The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</para><para>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy. </para><para>Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.ValidatePolicyResourceType"> <summary> <para> <para>The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is <c>RESOURCE_POLICY</c>. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose <c>AWS::S3::Bucket</c> for the policy validation resource type.</para><para>For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ValidatePolicyResponse). Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ValidatePolicyResponse 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.IAMAA.UseIAMAAPolicyValidationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyDocument parameter. The -PassThru parameter is deprecated, use -Select '^PolicyDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.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="P:Amazon.PowerShell.Cmdlets.IAMAA.UseIAMAAPolicyValidationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> </members> </doc> |