Paws::Config - Perl Interface to AWS AWS Config
use Paws; my $obj = Paws->service('Config'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
AWS Config
AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources.
You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process.
For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide.
Each argument is described in detail in: Paws::Config::DeleteConfigRule
Returns: nothing
Deletes the specified AWS Config rule and all of its evaluation results.
AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.
DELETING
PutConfigRule
DeleteConfigRule
ResourceInUseException
You can check the state of a rule by using the DescribeConfigRules request.
DescribeConfigRules
Each argument is described in detail in: Paws::Config::DeleteConfigurationRecorder
Deletes the configuration recorder.
After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.
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 GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.
GetResourceConfigHistory
Each argument is described in detail in: Paws::Config::DeleteDeliveryChannel
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
Each argument is described in detail in: Paws::Config::DeleteEvaluationResults
Returns: a Paws::Config::DeleteEvaluationResultsResponse instance
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.
Each argument is described in detail in: Paws::Config::DeliverConfigSnapshot
Returns: a Paws::Config::DeliverConfigSnapshotResponse instance
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
Notification of starting the delivery.
Notification of delivery completed, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed to complete.
Each argument is described in detail in: Paws::Config::DescribeComplianceByConfigRule
Returns: a Paws::Config::DescribeComplianceByConfigRuleResponse instance
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.
A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.
If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:
INSUFFICIENT_DATA
AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
DescribeConfigRuleEvaluationStatus
LastSuccessfulInvocationTime
LastFailedInvocationTime
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 config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.
config:PutEvaluations
The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
NOT_APPLICABLE
Each argument is described in detail in: Paws::Config::DescribeComplianceByResource
Returns: a Paws::Config::DescribeComplianceByResourceResponse instance
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.
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.
If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:
Each argument is described in detail in: Paws::Config::DescribeConfigRuleEvaluationStatus
Returns: a Paws::Config::DescribeConfigRuleEvaluationStatusResponse instance
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.
Each argument is described in detail in: Paws::Config::DescribeConfigRules
Returns: a Paws::Config::DescribeConfigRulesResponse instance
Returns details about your AWS Config rules.
Each argument is described in detail in: Paws::Config::DescribeConfigurationRecorders
Returns: a Paws::Config::DescribeConfigurationRecordersResponse instance
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.
Currently, you can specify only one configuration recorder per region in your account.
Each argument is described in detail in: Paws::Config::DescribeConfigurationRecorderStatus
Returns: a Paws::Config::DescribeConfigurationRecorderStatusResponse instance
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
Each argument is described in detail in: Paws::Config::DescribeDeliveryChannels
Returns: a Paws::Config::DescribeDeliveryChannelsResponse instance
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.
Currently, you can specify only one delivery channel per region in your account.
Each argument is described in detail in: Paws::Config::DescribeDeliveryChannelStatus
Returns: a Paws::Config::DescribeDeliveryChannelStatusResponse instance
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.
Each argument is described in detail in: Paws::Config::GetComplianceDetailsByConfigRule
Returns: a Paws::Config::GetComplianceDetailsByConfigRuleResponse instance
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.
Each argument is described in detail in: Paws::Config::GetComplianceDetailsByResource
Returns: a Paws::Config::GetComplianceDetailsByResourceResponse instance
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.
Each argument is described in detail in: Paws::Config::GetComplianceSummaryByConfigRule
Returns: a Paws::Config::GetComplianceSummaryByConfigRuleResponse instance
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Each argument is described in detail in: Paws::Config::GetComplianceSummaryByResourceType
Returns: a Paws::Config::GetComplianceSummaryByResourceTypeResponse instance
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.
Each argument is described in detail in: Paws::Config::GetResourceConfigHistory
Returns: a Paws::Config::GetResourceConfigHistoryResponse instance
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.
The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.
limit
nextToken
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 limit. In such cases, you can make another call, using the nextToken.
Each argument is described in detail in: Paws::Config::ListDiscoveredResources
Returns: a Paws::Config::ListDiscoveredResourcesResponse instance
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.
You can specify either resource IDs or a resource name but not both in the same request.
The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.
Each argument is described in detail in: Paws::Config::PutConfigRule
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.
If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule 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 SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.
SourceIdentifier
Source
ConfigRule
If you are adding a new AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see Using AWS Managed Config Rules.
For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.
ConfigRuleName
ConfigRuleArn
ConfigRuleId
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.
The maximum number of rules that AWS Config supports is 50.
For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
Each argument is described in detail in: Paws::Config::PutConfigurationRecorder
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
roleARN
recordingGroup
If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.
ConfigurationRecorder
Each argument is described in detail in: Paws::Config::PutDeliveryChannel
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
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.
You can have only one delivery channel per region in your account.
Each argument is described in detail in: Paws::Config::PutEvaluations
Returns: a Paws::Config::PutEvaluationsResponse instance
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.
Each argument is described in detail in: Paws::Config::StartConfigRulesEvaluation
Returns: a Paws::Config::StartConfigRulesEvaluationResponse instance
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use C<StartConfigRulesEvaluation> when you want to test a rule that you updated is working as expected. C<StartConfigRulesEvaluation> does not re-record the latest configuration state for your resources; it re-runs an evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing StartConfigRulesEvaluation call must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.
StartConfigRulesEvaluation
ConfigRuleEvaluationStarted
You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.
The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:
You have a custom rule that evaluates your IAM resources every 24 hours.
You update your Lambda function to add additional conditions to your rule.
Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.
AWS Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
Each argument is described in detail in: Paws::Config::StartConfigurationRecorder
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder.
Each argument is described in detail in: Paws::Config::StopConfigurationRecorder
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- ComplianceByConfigRules, passing the object as the first parameter, and the string 'ComplianceByConfigRules' as the second parameter
If not, it will return a a Paws::Config::DescribeComplianceByConfigRuleResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
- ComplianceByResources, passing the object as the first parameter, and the string 'ComplianceByResources' as the second parameter
If not, it will return a a Paws::Config::DescribeComplianceByResourceResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- ConfigRules, passing the object as the first parameter, and the string 'ConfigRules' as the second parameter
If not, it will return a a Paws::Config::DescribeConfigRulesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- EvaluationResults, passing the object as the first parameter, and the string 'EvaluationResults' as the second parameter
If not, it will return a a Paws::Config::GetComplianceDetailsByConfigRuleResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::Config::GetComplianceDetailsByResourceResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- configurationItems, passing the object as the first parameter, and the string 'configurationItems' as the second parameter
If not, it will return a a Paws::Config::GetResourceConfigHistoryResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- resourceIdentifiers, passing the object as the first parameter, and the string 'resourceIdentifiers' as the second parameter
If not, it will return a a Paws::Config::ListDiscoveredResourcesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.