AWS.Tools.ConfigService.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ConfigService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CFG.AddCFGResourceTagCmdlet"> <summary> Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.AddCFGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are <code>ConfigRule</code>, <code>ConfigurationAggregator</code> and <code>AggregatorAuthorization</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.AddCFGResourceTagCmdlet.Tag"> <summary> <para> <para>An array of tag object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.AddCFGResourceTagCmdlet.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.ConfigService.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.AddCFGResourceTagCmdlet.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.CFG.AddCFGResourceTagCmdlet.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.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet"> <summary> Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. <note><para> The results can return an empty result page, but if you have a <code>nextToken</code>, the results are displayed on the next page. </para></note><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.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Filters_AccountId"> <summary> <para> <para>The 12-digit account ID of the source account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Filters_AwsRegion"> <summary> <para> <para>The source region where the data is aggregated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Filters_ComplianceType"> <summary> <para> <para>The rule compliance status.</para><para>For the <code>ConfigRuleComplianceFilters</code> data type, AWS Config supports only <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. AWS Config does not support the <code>NOT_APPLICABLE</code> and the <code>INSUFFICIENT_DATA</code> values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Filters_ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregateComplianceByConfigRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeAggregateComplianceByConfigRulesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeAggregateComplianceByConfigRulesResponse 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.CFG.GetCFGAggregateComplianceByConfigRuleListCmdlet.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.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet"> <summary> Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. <note><para> The results can return an empty result page. But if you have a <code>nextToken</code>, the results are displayed on the next page. </para></note><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.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.AccountId"> <summary> <para> <para>The 12-digit account ID of the source account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.AwsRegion"> <summary> <para> <para>The source region from where the data is aggregated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.ComplianceType"> <summary> <para> <para>The resource compliance status.</para><note><para>For the <code>GetAggregateComplianceDetailsByConfigRuleRequest</code> data type, AWS Config supports only the <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. AWS Config does not support the <code>NOT_APPLICABLE</code> and <code>INSUFFICIENT_DATA</code> values.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregateEvaluationResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetAggregateComplianceDetailsByConfigRuleResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetAggregateComplianceDetailsByConfigRuleResponse 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.CFG.GetCFGAggregateComplianceDetailsByConfigRuleCmdlet.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.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet"> <summary> Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. <note><para> The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. </para></note><br/><br/>In the AWS.Tools.ConfigService module, 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.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.Filters_AccountId"> <summary> <para> <para>The 12-digit account ID of the source account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.Filters_AwsRegion"> <summary> <para> <para>The source region where the data is aggregated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.GroupByKey"> <summary> <para> <para>Groups the result based on ACCOUNT_ID or AWS_REGION.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.ConfigService module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.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.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetAggregateConfigRuleComplianceSummaryResponse 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.CFG.GetCFGAggregateConfigRuleComplianceSummaryCmdlet.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.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet"> <summary> Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey. <para> For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator. </para><br/><br/>In the AWS.Tools.ConfigService module, 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.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.Filters_AccountId"> <summary> <para> <para>The 12-digit ID of the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.GroupByKey"> <summary> <para> <para>The key to group the resource counts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.Filters_Region"> <summary> <para> <para>The region where the account is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.Filters_ResourceType"> <summary> <para> <para>The type of the AWS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.Limit"> <summary> <para> <para>The maximum number of <a>GroupedResourceCount</a> objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.ConfigService module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.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.ConfigService.Model.GetAggregateDiscoveredResourceCountsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetAggregateDiscoveredResourceCountsResponse 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.CFG.GetCFGAggregateDiscoveredResourceCountCmdlet.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.CFG.GetCFGAggregateDiscoveredResourceListCmdlet"> <summary> Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region. <para> For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type <code>AWS::EC2::Instance</code> then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1. </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.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Filters_AccountId"> <summary> <para> <para>The 12-digit source account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Filters_Region"> <summary> <para> <para>The source region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Filters_ResourceId"> <summary> <para> <para>The ID of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Filters_ResourceName"> <summary> <para> <para>The name of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.ResourceType"> <summary> <para> <para>The type of resources that you want AWS Config to list in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Limit"> <summary> <para> <para>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.ListAggregateDiscoveredResourcesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.ListAggregateDiscoveredResourcesResponse 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.CFG.GetCFGAggregateDiscoveredResourceListCmdlet.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.CFG.GetCFGAggregateResourceConfigCmdlet"> <summary> Returns configuration item that is aggregated for your specific resource in a specific source account and region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ResourceIdentifier_ResourceId"> <summary> <para> <para>The ID of the AWS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ResourceIdentifier_ResourceName"> <summary> <para> <para>The name of the AWS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ResourceIdentifier_ResourceType"> <summary> <para> <para>The type of the AWS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ResourceIdentifier_SourceAccountId"> <summary> <para> <para>The 12-digit account ID of the source account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.ResourceIdentifier_SourceRegion"> <summary> <para> <para>The source region where data is aggregated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationItem'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetAggregateResourceConfigResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetAggregateResourceConfigResponse 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.CFG.GetCFGAggregateResourceConfigBatchCmdlet"> <summary> Returns the current configuration items for resources that are present in your AWS Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty <code>unprocessedResourceIdentifiers</code> list. <note><ul><li><para> The API does not return results for deleted resources. </para></li><li><para> The API does not return tags and relationships. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigBatchCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigBatchCmdlet.ResourceIdentifier"> <summary> <para> <para>A list of aggregate ResourceIdentifiers objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregateResourceConfigBatchCmdlet.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.ConfigService.Model.BatchGetAggregateResourceConfigResponse). Specifying the name of a property of type Amazon.ConfigService.Model.BatchGetAggregateResourceConfigResponse 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.CFG.GetCFGAggregationAuthorizationListCmdlet"> <summary> Returns a list of authorizations granted to various aggregator accounts and regions.<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.CFG.GetCFGAggregationAuthorizationListCmdlet.Limit"> <summary> <para> <para>The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregationAuthorizationListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGAggregationAuthorizationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregationAuthorizations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeAggregationAuthorizationsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeAggregationAuthorizationsResponse 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.CFG.GetCFGAggregationAuthorizationListCmdlet.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.CFG.GetCFGComplianceByConfigRuleCmdlet"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply. </para><para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: </para><ul><li><para> AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>. </para></li><li><para> The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission. </para></li><li><para> The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. </para></li></ul><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.CFG.GetCFGComplianceByConfigRuleCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance.</para><para>The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>Specify one or more AWS Config rule names to filter the results by rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceByConfigRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResponse 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.CFG.GetCFGComplianceByConfigRuleCmdlet.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.CFG.GetCFGComplianceByResourceCmdlet"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para><para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: </para><ul><li><para> AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>. </para></li><li><para> The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission. </para></li><li><para> The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. </para></li></ul><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.CFG.GetCFGComplianceByResourceCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance.</para><para>The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>INSUFFICIENT_DATA</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.ResourceType"> <summary> <para> <para>The types of AWS resources for which you want compliance information (for example, <code>AWS::EC2::Instance</code>). For this action, you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceByResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeComplianceByResourceResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeComplianceByResourceResponse 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.CFG.GetCFGComplianceByResourceCmdlet.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.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.<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.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance.</para><para>The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResponse 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.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.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.CFG.GetCFGComplianceDetailsByResourceCmdlet"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.<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.CFG.GetCFGComplianceDetailsByResourceCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance.</para><para>The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the AWS resource for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.ResourceType"> <summary> <para> <para>The type of the AWS resource for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetComplianceDetailsByResourceResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetComplianceDetailsByResourceResponse 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.CFG.GetCFGComplianceDetailsByResourceCmdlet.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.CFG.GetCFGComplianceSummaryByConfigRuleCmdlet"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResponse 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.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet.ResourceType"> <summary> <para> <para>Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.</para><para>For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>. You can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComplianceSummariesByResourceType'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResponse 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.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleCmdlet"> <summary> Returns details about your AWS Config rules.<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.CFG.GetCFGConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigRulesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigRulesResponse 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.CFG.GetCFGConfigRuleCmdlet.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.CFG.GetCFGConfigRuleEvaluationStatusCmdlet"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.<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.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.Limit"> <summary> <para> <para>The number of rule evaluation results that you want returned.</para><para>This parameter is required if the rule limit for your account is more than the default of 150 rules.</para><para>For information about requesting a rule limit increase, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config">AWS Config Limits</a> in the <i>AWS General Reference Guide</i>.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigRulesEvaluationStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResponse 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.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.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.CFG.GetCFGConfigurationAggregatorListCmdlet"> <summary> Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.<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.CFG.GetCFGConfigurationAggregatorListCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregators.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorListCmdlet.Limit"> <summary> <para> <para>The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationAggregators'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigurationAggregatorsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigurationAggregatorsResponse 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.CFG.GetCFGConfigurationAggregatorListCmdlet.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.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet"> <summary> Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.<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.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.UpdateStatus"> <summary> <para> <para>Filters the status type.</para><ul><li><para>Valid value FAILED indicates errors while moving data.</para></li><li><para>Valid value SUCCEEDED indicates the data was successfully moved.</para></li><li><para>Valid value OUTDATED indicates the data is not the most recent.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.Limit"> <summary> <para> <para>The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregatedSourceStatusList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigurationAggregatorSourcesStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigurationAggregatorSourcesStatusResponse 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.CFG.GetCFGConfigurationAggregatorSourcesStatusCmdlet.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.CFG.GetCFGConfigurationRecorderCmdlet"> <summary> Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account. <note><para> Currently, you can specify only one configuration recorder per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>A list of configuration recorder names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationRecorders'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigurationRecordersResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigurationRecordersResponse 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.CFG.GetCFGConfigurationRecorderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderStatusCmdlet"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account. <note><para> Currently, you can specify only one configuration recorder per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderStatusCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationRecordersStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResponse 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.CFG.GetCFGConfigurationRecorderStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelCmdlet"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note><para> Currently, you can specify only one delivery channel per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelCmdlet.DeliveryChannelName"> <summary> <para> <para>A list of delivery channel names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryChannels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeDeliveryChannelsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeDeliveryChannelsResponse 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.CFG.GetCFGDeliveryChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryChannelName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelStatusCmdlet"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note><para> Currently, you can specify only one delivery channel per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelStatusCmdlet.DeliveryChannelName"> <summary> <para> <para>A list of delivery channel names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeliveryChannelsStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResponse 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.CFG.GetCFGDeliveryChannelStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryChannelName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note><para> You can specify either resource IDs or a resource name, but not both, in the same request. </para></note><para> The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter. </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.CFG.GetCFGDiscoveredResourceCmdlet.IncludeDeletedResource"> <summary> <para> <para>Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceId"> <summary> <para> <para>The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceName"> <summary> <para> <para>The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceType"> <summary> <para> <para>The type of resources that you want AWS Config to list in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.Limit"> <summary> <para> <para>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.ListDiscoveredResourcesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.ListDiscoveredResourcesResponse 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.CFG.GetCFGDiscoveredResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceName parameter. The -PassThru parameter is deprecated, use -Select '^ResourceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.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.CFG.GetCFGDiscoveredResourceCountCmdlet"> <summary> Amazon.ConfigService.IAmazonConfigService.GetDiscoveredResourceCounts<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.CFG.GetCFGDiscoveredResourceCountCmdlet.ResourceType"> <summary> <para> <para>The comma-separated list that specifies the resource types that you want AWS Config to return (for example, <code>"AWS::EC2::Instance"</code>, <code>"AWS::IAM::User"</code>).</para><para>If a value for <code>resourceTypes</code> is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account.</para><note><para>If the configuration recorder is turned off, AWS Config returns an empty list of <a>ResourceCount</a> objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of <a>ResourceCount</a> objects.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCountCmdlet.Limit"> <summary> <para> <para>The maximum number of <a>ResourceCount</a> objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCountCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceCounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetDiscoveredResourceCountsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetDiscoveredResourceCountsResponse 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.CFG.GetCFGDiscoveredResourceCountCmdlet.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.CFG.GetCFGGetResourceConfigBatchCmdlet"> <summary> Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list. <note><ul><li><para> The API does not return results for deleted resources. </para></li><li><para> The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGGetResourceConfigBatchCmdlet.ResourceKey"> <summary> <para> <para>A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGGetResourceConfigBatchCmdlet.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.ConfigService.Model.BatchGetResourceConfigResponse). Specifying the name of a property of type Amazon.ConfigService.Model.BatchGetResourceConfigResponse 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.CFG.GetCFGGetResourceConfigBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceKey parameter. The -PassThru parameter is deprecated, use -Select '^ResourceKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleCmdlet"> <summary> Returns a list of organization config rules. <note><para> When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules. </para><para> Only a master account can call this API. </para></note><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.CFG.GetCFGOrganizationConfigRuleCmdlet.OrganizationConfigRuleName"> <summary> <para> <para>The names of organization config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization config rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleCmdlet.Limit"> <summary> <para> <para>The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OrganizationConfigRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeOrganizationConfigRulesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeOrganizationConfigRulesResponse 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.CFG.GetCFGOrganizationConfigRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrganizationConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^OrganizationConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleCmdlet.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.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet"> <summary> Returns detailed status for each member account within an organization for a given organization config rule. <note><para> Only a master account can call this API. </para></note><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.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.Filters_AccountId"> <summary> <para> <para>The 12-digit account ID of the member account within an organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.Filters_MemberAccountRuleStatus"> <summary> <para> <para>Indicates deployment status for config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </para><para>AWS Config sets the state of the rule to:</para><ul><li><para><code>CREATE_SUCCESSFUL</code> when config rule has been created in the member account.</para></li><li><para><code>CREATE_IN_PROGRESS</code> when config rule is being created in the member account.</para></li><li><para><code>CREATE_FAILED</code> when config rule creation has failed in the member account.</para></li><li><para><code>DELETE_FAILED</code> when config rule deletion has failed in the member account.</para></li><li><para><code>DELETE_IN_PROGRESS</code> when config rule is being deleted in the member account.</para></li><li><para><code>DELETE_SUCCESSFUL</code> when config rule has been deleted in the member account.</para></li><li><para><code>UPDATE_SUCCESSFUL</code> when config rule has been updated in the member account.</para></li><li><para><code>UPDATE_IN_PROGRESS</code> when config rule is being updated in the member account.</para></li><li><para><code>UPDATE_FAILED</code> when config rule deletion has failed in the member account.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.OrganizationConfigRuleName"> <summary> <para> <para>The name of organization config rule for which you want status details for member accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.Limit"> <summary> <para> <para>The maximum number of <code>OrganizationConfigRuleDetailedStatus</code> returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OrganizationConfigRuleDetailedStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetOrganizationConfigRuleDetailedStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetOrganizationConfigRuleDetailedStatusResponse 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.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrganizationConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^OrganizationConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleDetailedStatusCmdlet.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.CFG.GetCFGOrganizationConfigRuleStatusCmdlet"> <summary> Provides organization config rule deployment status for an organization. <note><para> The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts. </para><para> When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules. </para><para> Only a master account can call this API. </para></note><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.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.OrganizationConfigRuleName"> <summary> <para> <para>The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.Limit"> <summary> <para> <para>The maximum number of <code>OrganizationConfigRuleStatuses</code> returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OrganizationConfigRuleStatuses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeOrganizationConfigRuleStatusesResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeOrganizationConfigRuleStatusesResponse 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.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrganizationConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^OrganizationConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGOrganizationConfigRuleStatusCmdlet.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.CFG.GetCFGPendingAggregationRequestListCmdlet"> <summary> Returns a list of all pending aggregation requests.<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.CFG.GetCFGPendingAggregationRequestListCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGPendingAggregationRequestListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGPendingAggregationRequestListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PendingAggregationRequests'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribePendingAggregationRequestsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribePendingAggregationRequestsResponse 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.CFG.GetCFGPendingAggregationRequestListCmdlet.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.CFG.GetCFGRemediationConfigurationCmdlet"> <summary> Returns the details of one or more remediation configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationConfigurationCmdlet.ConfigRuleName"> <summary> <para> <para>A list of AWS Config rule names of remediation configurations for which you want details. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RemediationConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeRemediationConfigurationsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeRemediationConfigurationsResponse 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.CFG.GetCFGRemediationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet"> <summary> Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response. <note><para> When you specify the limit and the next token, you receive a paginated response. </para><para> Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources. </para></note><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.CFG.GetCFGRemediationExceptionCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet.ResourceKey"> <summary> <para> <para>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet.Limit"> <summary> <para> <para>The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RemediationExceptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeRemediationExceptionsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeRemediationExceptionsResponse 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.CFG.GetCFGRemediationExceptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExceptionCmdlet.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.CFG.GetCFGRemediationExecutionStatusCmdlet"> <summary> Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.<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.CFG.GetCFGRemediationExecutionStatusCmdlet.ConfigRuleName"> <summary> <para> <para>A list of AWS Config rule names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExecutionStatusCmdlet.ResourceKey"> <summary> <para> <para>A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExecutionStatusCmdlet.Limit"> <summary> <para> <para>The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExecutionStatusCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExecutionStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RemediationExecutionStatuses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeRemediationExecutionStatusResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeRemediationExecutionStatusResponse 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.CFG.GetCFGRemediationExecutionStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRemediationExecutionStatusCmdlet.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.CFG.GetCFGResourceConfigHistoryCmdlet"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your <code>ConfigurationItems</code> between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the <code>ConfigurationItems</code> for the specified retention period. <para> The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter. </para><note><para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para></note><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.CFG.GetCFGResourceConfigHistoryCmdlet.ChronologicalOrder"> <summary> <para> <para>The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.EarlierTime"> <summary> <para> <para>The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.LaterTime"> <summary> <para> <para>The time stamp that indicates a later time. If not specified, current time is taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource (for example., <code>sg-xxxxxx</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.ResourceType"> <summary> <para> <para>The resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.Limit"> <summary> <para> <para>The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.GetResourceConfigHistoryResponse). Specifying the name of a property of type Amazon.ConfigService.Model.GetResourceConfigHistoryResponse 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.CFG.GetCFGResourceConfigHistoryCmdlet.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.CFG.GetCFGResourceTagCmdlet"> <summary> List the tags for AWS Config resource.<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.CFG.GetCFGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are <code>ConfigRule</code>, <code>ConfigurationAggregator</code> and <code>AggregatorAuthorization</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceTagCmdlet.Limit"> <summary> <para> <para>The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceTagCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceTagCmdlet.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.ConfigService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ConfigService.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.CFG.GetCFGResourceTagCmdlet.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.CFG.GetCFGResourceTagCmdlet.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.CFG.GetCFGRetentionConfigurationCmdlet"> <summary> Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account. <note><para> Currently, AWS Config supports only one retention configuration per region in your account. </para></note><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.CFG.GetCFGRetentionConfigurationCmdlet.RetentionConfigurationName"> <summary> <para> <para>A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account.</para><note><para>Currently, AWS Config supports only one retention configuration per region in your account.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRetentionConfigurationCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGRetentionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RetentionConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DescribeRetentionConfigurationsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DescribeRetentionConfigurationsResponse 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.CFG.GetCFGRetentionConfigurationCmdlet.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.CFG.RemoveCFGAggregationAuthorizationCmdlet"> <summary> Deletes the authorization granted to the specified configuration aggregator account in a specified region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGAggregationAuthorizationCmdlet.AuthorizedAccountId"> <summary> <para> <para>The 12-digit account ID of the account authorized to aggregate data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGAggregationAuthorizationCmdlet.AuthorizedAwsRegion"> <summary> <para> <para>The region authorized to collect aggregated data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGAggregationAuthorizationCmdlet.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.ConfigService.Model.DeleteAggregationAuthorizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGAggregationAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AuthorizedAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AuthorizedAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGAggregationAuthorizationCmdlet.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.CFG.RemoveCFGConfigRuleCmdlet"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> or <code>DeleteConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para><para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.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.ConfigService.Model.DeleteConfigRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.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.CFG.RemoveCFGConfigurationAggregatorCmdlet"> <summary> Deletes the specified configuration aggregator and the aggregated data associated with the aggregator. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationAggregatorCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationAggregatorCmdlet.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.ConfigService.Model.DeleteConfigurationAggregatorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationAggregatorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationAggregatorName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationAggregatorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationAggregatorCmdlet.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.CFG.RemoveCFGConfigurationRecorderCmdlet"> <summary> Deletes the configuration recorder. <para> After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder. </para><para> This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the <code>GetResourceConfigHistory</code> action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the <code>DescribeConfigurationRecorders</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationRecorderCmdlet.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.ConfigService.Model.DeleteConfigurationRecorderResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationRecorderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigurationRecorderCmdlet.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.CFG.RemoveCFGDeliveryChannelCmdlet"> <summary> Deletes the delivery channel. <para> Before you can delete the delivery channel, you must stop the configuration recorder by using the <a>StopConfigurationRecorder</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.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.ConfigService.Model.DeleteDeliveryChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryChannelName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.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.CFG.RemoveCFGEvaluationResultCmdlet"> <summary> Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the <a>StartConfigRulesEvaluation</a> API to start evaluating your AWS resources against the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGEvaluationResultCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want to delete the evaluation results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGEvaluationResultCmdlet.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.ConfigService.Model.DeleteEvaluationResultsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGEvaluationResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGEvaluationResultCmdlet.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.CFG.RemoveCFGOrganizationConfigRuleCmdlet"> <summary> Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. Only a master account can delete an organization config rule. <para> AWS Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGOrganizationConfigRuleCmdlet.OrganizationConfigRuleName"> <summary> <para> <para>The name of organization config rule that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGOrganizationConfigRuleCmdlet.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.ConfigService.Model.DeleteOrganizationConfigRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGOrganizationConfigRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrganizationConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^OrganizationConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGOrganizationConfigRuleCmdlet.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.CFG.RemoveCFGPendingAggregationRequestCmdlet"> <summary> Deletes pending authorization requests for a specified aggregator account in a specified region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGPendingAggregationRequestCmdlet.RequesterAccountId"> <summary> <para> <para>The 12-digit account ID of the account requesting to aggregate data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGPendingAggregationRequestCmdlet.RequesterAwsRegion"> <summary> <para> <para>The region requesting to aggregate data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGPendingAggregationRequestCmdlet.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.ConfigService.Model.DeletePendingAggregationRequestResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGPendingAggregationRequestCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RequesterAccountId parameter. The -PassThru parameter is deprecated, use -Select '^RequesterAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGPendingAggregationRequestCmdlet.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.CFG.RemoveCFGRemediationConfigurationCmdlet"> <summary> Deletes the remediation configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationConfigurationCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want to delete remediation configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationConfigurationCmdlet.ResourceType"> <summary> <para> <para>The type of a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationConfigurationCmdlet.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.ConfigService.Model.DeleteRemediationConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationConfigurationCmdlet.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.CFG.RemoveCFGRemediationExceptionCmdlet"> <summary> Deletes one or more remediation exceptions mentioned in the resource keys. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationExceptionCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want to delete remediation exception configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationExceptionCmdlet.ResourceKey"> <summary> <para> <para>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationExceptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedBatches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DeleteRemediationExceptionsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DeleteRemediationExceptionsResponse 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.CFG.RemoveCFGRemediationExceptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRemediationExceptionCmdlet.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.CFG.RemoveCFGResourceTagCmdlet"> <summary> Deletes specified tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are <code>ConfigRule</code>, <code>ConfigurationAggregator</code> and <code>AggregatorAuthorization</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGResourceTagCmdlet.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.ConfigService.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGResourceTagCmdlet.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.CFG.RemoveCFGResourceTagCmdlet.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.CFG.RemoveCFGRetentionConfigurationCmdlet"> <summary> Deletes the retention configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRetentionConfigurationCmdlet.RetentionConfigurationName"> <summary> <para> <para>The name of the retention configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRetentionConfigurationCmdlet.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.ConfigService.Model.DeleteRetentionConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRetentionConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetentionConfigurationName parameter. The -PassThru parameter is deprecated, use -Select '^RetentionConfigurationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGRetentionConfigurationCmdlet.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.CFG.SelectCFGResourceConfigCmdlet"> <summary> Accepts a structured query language (SQL) <code>SELECT</code> command, performs the corresponding search, and returns resource configurations matching the properties. <para> For more information about query components, see the <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html"><b>Query Components</b></a> section in the AWS Config Developer Guide. </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.CFG.SelectCFGResourceConfigCmdlet.Expression"> <summary> <para> <para>The SQL query <code>SELECT</code> command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SelectCFGResourceConfigCmdlet.Limit"> <summary> <para> <para>The maximum number of query results returned on each page. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SelectCFGResourceConfigCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response. </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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SelectCFGResourceConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.SelectResourceConfigResponse). Specifying the name of a property of type Amazon.ConfigService.Model.SelectResourceConfigResponse 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.CFG.SelectCFGResourceConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Expression parameter. The -PassThru parameter is deprecated, use -Select '^Expression' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SelectCFGResourceConfigCmdlet.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.CFG.SelectCFGResourceConfigCmdlet.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.CFG.StartCFGConfigRulesEvaluationCmdlet"> <summary> Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use <code>StartConfigRulesEvaluation</code> when you want to test that a rule you updated is working as expected. <code>StartConfigRulesEvaluation</code> does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. <para> You can specify up to 25 AWS Config rules per request. </para><para> An existing <code>StartConfigRulesEvaluation</code> call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a <code>ConfigRuleEvaluationStarted</code> notification when the evaluation starts. </para><note><para> You don't need to call the <code>StartConfigRulesEvaluation</code> API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically. </para></note><para> The <code>StartConfigRulesEvaluation</code> API is useful if you want to run on-demand evaluations, such as the following example: </para><ol><li><para> You have a custom rule that evaluates your IAM resources every 24 hours. </para></li><li><para> You update your Lambda function to add additional conditions to your rule. </para></li><li><para> Instead of waiting for the next periodic evaluation, you call the <code>StartConfigRulesEvaluation</code> API. </para></li><li><para> AWS Config invokes your Lambda function and evaluates your IAM resources. </para></li><li><para> Your custom rule will still run periodic evaluations every 24 hours. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigRulesEvaluationCmdlet.ConfigRuleName"> <summary> <para> <para>The list of names of AWS Config rules that you want to run evaluations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigRulesEvaluationCmdlet.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.ConfigService.Model.StartConfigRulesEvaluationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigRulesEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigRulesEvaluationCmdlet.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.CFG.StartCFGConfigurationRecorderCmdlet"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder object that records each configuration change made to the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.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.ConfigService.Model.StartConfigurationRecorderResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.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.CFG.StartCFGRemediationExecutionCmdlet"> <summary> Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous. <para> You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGRemediationExecutionCmdlet.ConfigRuleName"> <summary> <para> <para>The list of names of AWS Config rules that you want to run remediation execution for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGRemediationExecutionCmdlet.ResourceKey"> <summary> <para> <para>A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGRemediationExecutionCmdlet.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.ConfigService.Model.StartRemediationExecutionResponse). Specifying the name of a property of type Amazon.ConfigService.Model.StartRemediationExecutionResponse 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.CFG.StartCFGRemediationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceKey parameter. The -PassThru parameter is deprecated, use -Select '^ResourceKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGRemediationExecutionCmdlet.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.CFG.StopCFGConfigurationRecorderCmdlet"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder object that records each configuration change made to the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.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.ConfigService.Model.StopConfigurationRecorderResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.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.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified. <ul><li><para> Notification of the start of the delivery. </para></li><li><para> Notification of the completion of the delivery, if the delivery was successfully completed. </para></li><li><para> Notification of delivery failure, if the delivery failed. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel through which the snapshot is delivered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigSnapshotId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.DeliverConfigSnapshotResponse). Specifying the name of a property of type Amazon.ConfigService.Model.DeliverConfigSnapshotResponse 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.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryChannelName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.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.CFG.WriteCFGAggregationAuthorizationCmdlet"> <summary> Authorizes the aggregator account and region to collect data from the source account and region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGAggregationAuthorizationCmdlet.AuthorizedAccountId"> <summary> <para> <para>The 12-digit account ID of the account authorized to aggregate data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGAggregationAuthorizationCmdlet.AuthorizedAwsRegion"> <summary> <para> <para>The region authorized to collect aggregated data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGAggregationAuthorizationCmdlet.Tag"> <summary> <para> <para>An array of tag object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGAggregationAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AggregationAuthorization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutAggregationAuthorizationResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutAggregationAuthorizationResponse 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.CFG.WriteCFGAggregationAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AuthorizedAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AuthorizedAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGAggregationAuthorizationCmdlet.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.CFG.WriteCFGConfigRuleCmdlet"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides. </para><para> If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para><para> If you are adding an AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">About AWS Managed Config Rules</a>. </para><para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para><para> If you are updating a rule that you added previously, you can specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para><para> The maximum number of rules that AWS Config supports is 150. </para><para> For information about requesting a rule limit increase, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config">AWS Config Limits</a> in the <i>AWS General Reference Guide</i>. </para><para> For more information about developing and using AWS Config rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_ComplianceResourceId"> <summary> <para> <para>The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for <code>ComplianceResourceTypes</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_ComplianceResourceType"> <summary> <para> <para>The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for <code>ComplianceResourceId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleId"> <summary> <para> <para>The ID of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleName"> <summary> <para> <para>The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleState"> <summary> <para> <para>Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.</para><para>AWS Config sets the state of the rule to <code>EVALUATING</code> temporarily after you use the <code>StartConfigRulesEvaluation</code> request to evaluate your resources against the AWS Config rule.</para><para>AWS Config sets the state of the rule to <code>DELETING_RESULTS</code> temporarily after you use the <code>DeleteEvaluationResults</code> request to delete the current evaluation results for the AWS Config rule.</para><para>AWS Config temporarily sets the state of a rule to <code>DELETING</code> after you use the <code>DeleteConfigRule</code> request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_CreatedBy"> <summary> <para> <para>Service principal name of the service that created the rule.</para><note><para>The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_Description"> <summary> <para> <para>The description that you provide for the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_InputParameter"> <summary> <para> <para>A string, in JSON format, that is passed to the AWS Config rule Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_MaximumExecutionFrequency"> <summary> <para> <para>The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for <code>MaximumExecutionFrequency</code> when:</para><ul><li><para>You are using an AWS managed rule that is triggered at a periodic frequency.</para></li><li><para>Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</para></li></ul><note><para>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_Owner"> <summary> <para> <para>Indicates whether AWS or the customer owns and manages the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_SourceDetail"> <summary> <para> <para>Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_SourceIdentifier"> <summary> <para> <para>For AWS Config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>.</para><para>For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as <code>arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_TagKey"> <summary> <para> <para>The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Tag"> <summary> <para> <para>An array of tag object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_TagValue"> <summary> <para> <para>The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for <code>TagValue</code>, you must also specify a value for <code>TagKey</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.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.ConfigService.Model.PutConfigRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRule_ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRule_ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.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.CFG.WriteCFGConfigurationAggregatorCmdlet"> <summary> Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. <note><para> AWS Config should be enabled in source accounts and regions you want to aggregate. </para><para> If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls <code>EnableAwsServiceAccess</code> API to enable integration between AWS Config and AWS Organizations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.AccountAggregationSource"> <summary> <para> <para>A list of AccountAggregationSource object. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.OrganizationAggregationSource_AllAwsRegion"> <summary> <para> <para>If true, aggregate existing AWS Config regions and future regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.OrganizationAggregationSource_AwsRegion"> <summary> <para> <para>The source regions being aggregated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.ConfigurationAggregatorName"> <summary> <para> <para>The name of the configuration aggregator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.OrganizationAggregationSource_RoleArn"> <summary> <para> <para>ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.Tag"> <summary> <para> <para>An array of tag object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationAggregator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutConfigurationAggregatorResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutConfigurationAggregatorResponse 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.CFG.WriteCFGConfigurationAggregatorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationAggregatorName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationAggregatorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationAggregatorCmdlet.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.CFG.WriteCFGConfigurationRecorderCmdlet"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para><note><para> Currently, you can specify only one configuration recorder per region in your account. </para><para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.RecordingGroup_AllSupported"> <summary> <para> <para>Specifies whether AWS Config records configuration changes for every supported type of regional resource.</para><para>If you set this option to <code>true</code>, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically.</para><para>If you set this option to <code>true</code>, you cannot enumerate a list of <code>resourceTypes</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.RecordingGroup_IncludeGlobalResourceType"> <summary> <para> <para>Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.</para><para>Before you can set this option to <code>true</code>, you must set the <code>allSupported</code> option to <code>true</code>.</para><para>If you set this option to <code>true</code>, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically.</para><para>The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.RecordingGroup_ResourceType"> <summary> <para> <para>A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, <code>AWS::EC2::Instance</code> or <code>AWS::CloudTrail::Trail</code>).</para><para>Before you can set this option to <code>true</code>, you must set the <code>allSupported</code> option to <code>false</code>.</para><para>If you set this option to <code>true</code>, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.</para><para>For a list of valid <code>resourceTypes</code> values, see the <b>resourceType Value</b> column in <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resource Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.ConfigurationRecorder_RoleARN"> <summary> <para> <para>Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.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.ConfigService.Model.PutConfigurationRecorderResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationRecorderName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationRecorderName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.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.CFG.WriteCFGDeliveryChannelCmdlet"> <summary> Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. <para> Before you can create a delivery channel, you must create a configuration recorder. </para><para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para><note><para> You can have only one delivery channel per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.ConfigSnapshotDeliveryProperties_DeliveryFrequency"> <summary> <para> <para>The frequency with which AWS Config delivers configuration snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.</para><para>If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html">Permissions for the Amazon S3 Bucket</a> in the AWS Config Developer Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_S3KeyPrefix"> <summary> <para> <para>The prefix for the specified Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_SnsTopicARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.</para><para>If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html">Permissions for the Amazon SNS Topic</a> in the AWS Config Developer Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.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.ConfigService.Model.PutDeliveryChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeliveryChannelName parameter. The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.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.CFG.WriteCFGEvaluationCmdlet"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationCmdlet.Evaluation"> <summary> <para> <para>The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationCmdlet.ResultToken"> <summary> <para> <para>An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationCmdlet.TestMode"> <summary> <para> <para>Use this parameter to specify a test run for <code>PutEvaluations</code>. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.</para><note><para>When <code>TestMode</code> is <code>true</code>, <code>PutEvaluations</code> doesn't require a valid value for the <code>ResultToken</code> parameter, but the value cannot be null.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedEvaluations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutEvaluationsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutEvaluationsResponse 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.CFG.WriteCFGEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Evaluation parameter. The -PassThru parameter is deprecated, use -Select '^Evaluation' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationCmdlet.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.CFG.WriteCFGOrganizationConfigRuleCmdlet"> <summary> Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations. Only a master account can create or update an organization config rule. <para> This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with <code>GetRole</code> action. </para><para> You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account that the rule invokes to evaluate your resources. When you use the <code>PutOrganizationConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the <code>RuleIdentifier</code> key. </para><para> The maximum number of organization config rules that AWS Config supports is 150. </para><note><para> Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_Description"> <summary> <para> <para>The description that you provide for organization config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_Description"> <summary> <para> <para>The description that you provide for organization config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.ExcludedAccount"> <summary> <para> <para>A comma-separated list of accounts that you want to exclude from an organization config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_InputParameter"> <summary> <para> <para>A string, in JSON format, that is passed to organization config rule Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_InputParameter"> <summary> <para> <para>A string, in JSON format, that is passed to organization config rule Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_LambdaFunctionArn"> <summary> <para> <para>The lambda function ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_MaximumExecutionFrequency"> <summary> <para> <para>The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</para><note><para>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_MaximumExecutionFrequency"> <summary> <para> <para>The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency.</para><note><para>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationConfigRuleName"> <summary> <para> <para>The name that you assign to an organization config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_OrganizationConfigRuleTriggerType"> <summary> <para> <para>The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:</para><ul><li><para><code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.</para></li><li><para><code>OversizedConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.</para></li><li><para><code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_ResourceIdScope"> <summary> <para> <para>The ID of the AWS resource that was evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_ResourceIdScope"> <summary> <para> <para>The ID of the AWS resource that was evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_ResourceTypesScope"> <summary> <para> <para>The type of the AWS resource that was evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_ResourceTypesScope"> <summary> <para> <para>The type of the AWS resource that was evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_RuleIdentifier"> <summary> <para> <para>For organization config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_TagKeyScope"> <summary> <para> <para>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_TagKeyScope"> <summary> <para> <para>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationCustomRuleMetadata_TagValueScope"> <summary> <para> <para>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.OrganizationManagedRuleMetadata_TagValueScope"> <summary> <para> <para>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OrganizationConfigRuleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutOrganizationConfigRuleResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutOrganizationConfigRuleResponse 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.CFG.WriteCFGOrganizationConfigRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OrganizationConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^OrganizationConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGOrganizationConfigRuleCmdlet.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.CFG.WriteCFGRemediationConfigurationCmdlet"> <summary> Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the <code>RemediationConfiguration</code> object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationConfigurationCmdlet.RemediationConfiguration"> <summary> <para> <para>A list of remediation configuration objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedBatches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutRemediationConfigurationsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutRemediationConfigurationsResponse 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.CFG.WriteCFGRemediationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RemediationConfiguration parameter. The -PassThru parameter is deprecated, use -Select '^RemediationConfiguration' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationConfigurationCmdlet.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.CFG.WriteCFGRemediationExceptionCmdlet"> <summary> A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want to create remediation exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.ExpirationTime"> <summary> <para> <para>The exception is automatically deleted after the expiration date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.Message"> <summary> <para> <para>The message contains an explanation of the exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.ResourceKey"> <summary> <para> <para>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FailedBatches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutRemediationExceptionsResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutRemediationExceptionsResponse 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.CFG.WriteCFGRemediationExceptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigRuleName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigRuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRemediationExceptionCmdlet.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.CFG.WriteCFGRetentionConfigurationCmdlet"> <summary> Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the <code>RetentionConfiguration</code> object and names the object as <b>default</b>. When you have a <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the default object. <note><para> Currently, AWS Config supports only one retention configuration per region in your account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRetentionConfigurationCmdlet.RetentionPeriodInDay"> <summary> <para> <para>Number of days AWS Config stores your historical information.</para><note><para>Currently, only applicable to the configuration item history.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRetentionConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RetentionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutRetentionConfigurationResponse). Specifying the name of a property of type Amazon.ConfigService.Model.PutRetentionConfigurationResponse 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.CFG.WriteCFGRetentionConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetentionPeriodInDay parameter. The -PassThru parameter is deprecated, use -Select '^RetentionPeriodInDay' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGRetentionConfigurationCmdlet.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> |