Get-CFGConfigRuleEvaluationStatus Cmdlet

AWS Config

Synopsis

Syntax

Get-CFGConfigRuleEvaluationStatus

-ConfigRuleName <String[]>

-Limit <Int32>

-NextToken <String>

Description

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.

Parameters

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.

Required?

False

Position?

Named

Accept pipeline input?

False

-Limit <Int32>

The number of rule evaluation results that you want returned.This parameter is required if the rule limit for your account is more than the default of 50 rules.For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

Used to specify the name and location of the ini-format credential file (shared with
the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential
file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first.
If the profile is not found then the cmdlet will search in the ini-format credential
file at the default location: (user's home directory)\.aws\credentials.
Note that the encrypted credential file is not supported on all platforms.
It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential
file at the location given.

As the current folder can vary in a shell or during script execution it is advised
that you use specify a fully qualified path instead of a relative path.

The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.

Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for
normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region
parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must
direct the call to a specific custom endpoint.

Required?

False

Position?

Named

Accept pipeline input?

False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a collection of ConfigRuleEvaluationStatus objects.
The service call response (type Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)