@datafire/amazonaws_config v5.0.0
@datafire/amazonaws_config
Client library for AWS Config
Installation and Usage
npm install --save @datafire/amazonaws_config
let amazonaws_config = require('@datafire/amazonaws_config').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_config.DeleteConfigRule({
"ConfigRuleName": ""
}).then(data => {
console.log(data);
});
Description
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.
Actions
DeleteConfigRule
amazonaws_config.DeleteConfigRule({
"ConfigRuleName": ""
}, context)
Input
- input
object
- ConfigRuleName required StringWithCharLimit64
Output
Output schema unknown
DeleteConfigurationRecorder
amazonaws_config.DeleteConfigurationRecorder({
"ConfigurationRecorderName": ""
}, context)
Input
- input
object
- ConfigurationRecorderName required RecorderName
Output
Output schema unknown
DeleteDeliveryChannel
amazonaws_config.DeleteDeliveryChannel({
"DeliveryChannelName": ""
}, context)
Input
- input
object
- DeliveryChannelName required ChannelName
Output
Output schema unknown
DeleteEvaluationResults
amazonaws_config.DeleteEvaluationResults({
"ConfigRuleName": ""
}, context)
Input
- input
object
- ConfigRuleName required StringWithCharLimit64
Output
DeliverConfigSnapshot
amazonaws_config.DeliverConfigSnapshot({
"deliveryChannelName": ""
}, context)
Input
- input
object
- deliveryChannelName required ChannelName
Output
DescribeComplianceByConfigRule
amazonaws_config.DescribeComplianceByConfigRule({}, context)
Input
- input
object
- ComplianceTypes ComplianceTypes
- ConfigRuleNames ConfigRuleNames
- NextToken String
Output
DescribeComplianceByResource
amazonaws_config.DescribeComplianceByResource({}, context)
Input
- input
object
- ComplianceTypes ComplianceTypes
- Limit Limit
- NextToken NextToken
- ResourceId BaseResourceId
- ResourceType StringWithCharLimit256
Output
DescribeConfigRuleEvaluationStatus
amazonaws_config.DescribeConfigRuleEvaluationStatus({}, context)
Input
- input
object
- ConfigRuleNames ConfigRuleNames
- Limit RuleLimit
- NextToken String
Output
DescribeConfigRules
amazonaws_config.DescribeConfigRules({}, context)
Input
- input
object
- ConfigRuleNames ConfigRuleNames
- NextToken String
Output
- output DescribeConfigRulesResponse
DescribeConfigurationRecorderStatus
amazonaws_config.DescribeConfigurationRecorderStatus({}, context)
Input
- input
object
- ConfigurationRecorderNames ConfigurationRecorderNameList
Output
DescribeConfigurationRecorders
amazonaws_config.DescribeConfigurationRecorders({}, context)
Input
- input
object
- ConfigurationRecorderNames ConfigurationRecorderNameList
Output
DescribeDeliveryChannelStatus
amazonaws_config.DescribeDeliveryChannelStatus({}, context)
Input
- input
object
- DeliveryChannelNames DeliveryChannelNameList
Output
DescribeDeliveryChannels
amazonaws_config.DescribeDeliveryChannels({}, context)
Input
- input
object
- DeliveryChannelNames DeliveryChannelNameList
Output
GetComplianceDetailsByConfigRule
amazonaws_config.GetComplianceDetailsByConfigRule({
"ConfigRuleName": ""
}, context)
Input
- input
object
- ComplianceTypes ComplianceTypes
- ConfigRuleName required StringWithCharLimit64
- Limit Limit
- NextToken NextToken
Output
GetComplianceDetailsByResource
amazonaws_config.GetComplianceDetailsByResource({
"ResourceType": "",
"ResourceId": ""
}, context)
Input
- input
object
- ComplianceTypes ComplianceTypes
- NextToken String
- ResourceId required BaseResourceId
- ResourceType required StringWithCharLimit256
Output
GetComplianceSummaryByConfigRule
amazonaws_config.GetComplianceSummaryByConfigRule({}, context)
Input
- input
object
Output
GetComplianceSummaryByResourceType
amazonaws_config.GetComplianceSummaryByResourceType({}, context)
Input
- input
object
- ResourceTypes ResourceTypes
Output
GetDiscoveredResourceCounts
amazonaws_config.GetDiscoveredResourceCounts({}, context)
Input
- input
object
- limit Limit
- nextToken NextToken
- resourceTypes ResourceTypes
Output
GetResourceConfigHistory
amazonaws_config.GetResourceConfigHistory({
"resourceType": "",
"resourceId": ""
}, context)
Input
- input
object
- limit
string
- nextToken
string
- chronologicalOrder ChronologicalOrder
- earlierTime EarlierTime
- laterTime LaterTime
- limit Limit
- nextToken NextToken
- resourceId required ResourceId
- resourceType required ResourceType
- limit
Output
ListDiscoveredResources
amazonaws_config.ListDiscoveredResources({
"resourceType": ""
}, context)
Input
- input
object
- includeDeletedResources Boolean
- limit Limit
- nextToken NextToken
- resourceIds ResourceIdList
- resourceName ResourceName
- resourceType required ResourceType
Output
PutConfigRule
amazonaws_config.PutConfigRule({
"ConfigRule": {
"Source": {
"Owner": "",
"SourceIdentifier": ""
}
}
}, context)
Input
- input
object
- ConfigRule required ConfigRule
Output
Output schema unknown
PutConfigurationRecorder
amazonaws_config.PutConfigurationRecorder({
"ConfigurationRecorder": {}
}, context)
Input
- input
object
- ConfigurationRecorder required ConfigurationRecorder
Output
Output schema unknown
PutDeliveryChannel
amazonaws_config.PutDeliveryChannel({
"DeliveryChannel": {}
}, context)
Input
- input
object
- DeliveryChannel required DeliveryChannel
Output
Output schema unknown
PutEvaluations
amazonaws_config.PutEvaluations({
"ResultToken": ""
}, context)
Input
- input
object
- Evaluations Evaluations
- ResultToken required String
- TestMode Boolean
Output
- output PutEvaluationsResponse
StartConfigRulesEvaluation
amazonaws_config.StartConfigRulesEvaluation({}, context)
Input
- input
object
- ConfigRuleNames ReevaluateConfigRuleNames
Output
StartConfigurationRecorder
amazonaws_config.StartConfigurationRecorder({
"ConfigurationRecorderName": ""
}, context)
Input
- input
object
- ConfigurationRecorderName required RecorderName
Output
Output schema unknown
StopConfigurationRecorder
amazonaws_config.StopConfigurationRecorder({
"ConfigurationRecorderName": ""
}, context)
Input
- input
object
- ConfigurationRecorderName required RecorderName
Output
Output schema unknown
Definitions
ARN
- ARN
string
AccountId
- AccountId
string
AllSupported
- AllSupported
boolean
AvailabilityZone
- AvailabilityZone
string
AwsRegion
- AwsRegion
string
BaseResourceId
- BaseResourceId
string
Boolean
- Boolean
boolean
ChannelName
- ChannelName
string
ChronologicalOrder
- ChronologicalOrder
string
(values: Reverse, Forward)
Compliance
- Compliance
object
: Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.- ComplianceContributorCount ComplianceContributorCount
- ComplianceType ComplianceType
ComplianceByConfigRule
- ComplianceByConfigRule
object
: Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it, and it is noncompliant if any of these resources do not comply.- Compliance Compliance
- ConfigRuleName StringWithCharLimit64
ComplianceByConfigRules
- ComplianceByConfigRules
array
- items ComplianceByConfigRule
ComplianceByResource
- ComplianceByResource
object
: Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.- Compliance Compliance
- ResourceId BaseResourceId
- ResourceType StringWithCharLimit256
ComplianceByResources
- ComplianceByResources
array
- items ComplianceByResource
ComplianceContributorCount
- ComplianceContributorCount
object
: The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.
ComplianceResourceTypes
- ComplianceResourceTypes
array
- items StringWithCharLimit256
ComplianceSummariesByResourceType
- ComplianceSummariesByResourceType
array
ComplianceSummary
- ComplianceSummary
object
: The number of AWS Config rules or AWS resources that are compliant and noncompliant.- ComplianceSummaryTimestamp Date
- CompliantResourceCount ComplianceContributorCount
- NonCompliantResourceCount ComplianceContributorCount
ComplianceSummaryByResourceType
- ComplianceSummaryByResourceType
object
: The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each compliance.- ComplianceSummary ComplianceSummary
- ResourceType StringWithCharLimit256
ComplianceType
- ComplianceType
string
(values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA)
ComplianceTypes
- ComplianceTypes
array
- items ComplianceType
ConfigExportDeliveryInfo
- ConfigExportDeliveryInfo
object
: Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.
ConfigRule
- ConfigRule
object
: An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours). You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.- ConfigRuleArn String
- ConfigRuleId String
- ConfigRuleName StringWithCharLimit64
- ConfigRuleState ConfigRuleState
- Description EmptiableStringWithCharLimit256
- InputParameters StringWithCharLimit1024
- MaximumExecutionFrequency MaximumExecutionFrequency
- Scope Scope
- Source required Source
ConfigRuleEvaluationStatus
- ConfigRuleEvaluationStatus
object
: Status information for your AWS managed Config rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure. This action does not return status information about custom Config rules.
ConfigRuleEvaluationStatusList
- ConfigRuleEvaluationStatusList
array
ConfigRuleNames
- ConfigRuleNames
array
- items StringWithCharLimit64
ConfigRuleState
- ConfigRuleState
string
(values: ACTIVE, DELETING, DELETING_RESULTS, EVALUATING)
ConfigRules
- ConfigRules
array
- items ConfigRule
ConfigSnapshotDeliveryProperties
- ConfigSnapshotDeliveryProperties
object
: Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel. If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following: The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent: The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for Config rules. The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule. If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot. You specify the MaximumExecutionFrequency value for Six_Hours. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours. You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action. To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.- deliveryFrequency MaximumExecutionFrequency
ConfigStreamDeliveryInfo
- ConfigStreamDeliveryInfo
object
: A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.- lastErrorCode String
- lastErrorMessage String
- lastStatus DeliveryStatus
- lastStatusChangeTime Date
Configuration
- Configuration
string
ConfigurationItem
- ConfigurationItem
object
: A list that contains detailed configurations of a specified resource.- accountId AccountId
- arn ARN
- availabilityZone AvailabilityZone
- awsRegion AwsRegion
- configuration Configuration
- configurationItemCaptureTime ConfigurationItemCaptureTime
- configurationItemMD5Hash ConfigurationItemMD5Hash
- configurationItemStatus ConfigurationItemStatus
- configurationStateId ConfigurationStateId
- relatedEvents RelatedEventList
- relationships RelationshipList
- resourceCreationTime ResourceCreationTime
- resourceId ResourceId
- resourceName ResourceName
- resourceType ResourceType
- supplementaryConfiguration SupplementaryConfiguration
- tags Tags
- version Version
ConfigurationItemCaptureTime
- ConfigurationItemCaptureTime
string
ConfigurationItemList
- ConfigurationItemList
array
- items ConfigurationItem
ConfigurationItemMD5Hash
- ConfigurationItemMD5Hash
string
ConfigurationItemStatus
- ConfigurationItemStatus
string
(values: Ok, Failed, Discovered, Deleted)
ConfigurationRecorder
- ConfigurationRecorder
object
: An object that represents the recording of configuration changes of an AWS resource.- name RecorderName
- recordingGroup RecordingGroup
- roleARN String
ConfigurationRecorderList
- ConfigurationRecorderList
array
- items ConfigurationRecorder
ConfigurationRecorderNameList
- ConfigurationRecorderNameList
array
- items RecorderName
ConfigurationRecorderStatus
- ConfigurationRecorderStatus
object
: The current status of the configuration recorder.
ConfigurationRecorderStatusList
- ConfigurationRecorderStatusList
array
ConfigurationStateId
- ConfigurationStateId
string
Date
- Date
string
DeleteConfigRuleRequest
- DeleteConfigRuleRequest
object
:- ConfigRuleName required StringWithCharLimit64
DeleteConfigurationRecorderRequest
- DeleteConfigurationRecorderRequest
object
: The request object for the DeleteConfigurationRecorder action.- ConfigurationRecorderName required RecorderName
DeleteDeliveryChannelRequest
- DeleteDeliveryChannelRequest
object
: The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.- DeliveryChannelName required ChannelName
DeleteEvaluationResultsRequest
- DeleteEvaluationResultsRequest
object
:- ConfigRuleName required StringWithCharLimit64
DeleteEvaluationResultsResponse
- DeleteEvaluationResultsResponse
object
: The output when you delete the evaluation results for the specified Config rule.
DeliverConfigSnapshotRequest
- DeliverConfigSnapshotRequest
object
: The input for the DeliverConfigSnapshot action.- deliveryChannelName required ChannelName
DeliverConfigSnapshotResponse
- DeliverConfigSnapshotResponse
object
: The output for the DeliverConfigSnapshot action in JSON format.- configSnapshotId String
DeliveryChannel
- DeliveryChannel
object
: The channel through which AWS Config delivers notifications and updated configuration states.- configSnapshotDeliveryProperties ConfigSnapshotDeliveryProperties
- name ChannelName
- s3BucketName String
- s3KeyPrefix String
- snsTopicARN String
DeliveryChannelList
- DeliveryChannelList
array
- items DeliveryChannel
DeliveryChannelNameList
- DeliveryChannelNameList
array
- items ChannelName
DeliveryChannelStatus
- DeliveryChannelStatus
object
: The status of a specified delivery channel. Valid values: Success | Failure- configHistoryDeliveryInfo ConfigExportDeliveryInfo
- configSnapshotDeliveryInfo ConfigExportDeliveryInfo
- configStreamDeliveryInfo ConfigStreamDeliveryInfo
- name String
DeliveryChannelStatusList
- DeliveryChannelStatusList
array
- items DeliveryChannelStatus
DeliveryStatus
- DeliveryStatus
string
(values: Success, Failure, Not_Applicable)
DescribeComplianceByConfigRuleRequest
- DescribeComplianceByConfigRuleRequest
object
:- ComplianceTypes ComplianceTypes
- ConfigRuleNames ConfigRuleNames
- NextToken String
DescribeComplianceByConfigRuleResponse
- DescribeComplianceByConfigRuleResponse
object
:- ComplianceByConfigRules ComplianceByConfigRules
- NextToken String
DescribeComplianceByResourceRequest
- DescribeComplianceByResourceRequest
object
:- ComplianceTypes ComplianceTypes
- Limit Limit
- NextToken NextToken
- ResourceId BaseResourceId
- ResourceType StringWithCharLimit256
DescribeComplianceByResourceResponse
- DescribeComplianceByResourceResponse
object
:- ComplianceByResources ComplianceByResources
- NextToken NextToken
DescribeConfigRuleEvaluationStatusRequest
- DescribeConfigRuleEvaluationStatusRequest
object
:- ConfigRuleNames ConfigRuleNames
- Limit RuleLimit
- NextToken String
DescribeConfigRuleEvaluationStatusResponse
- DescribeConfigRuleEvaluationStatusResponse
object
:- ConfigRulesEvaluationStatus ConfigRuleEvaluationStatusList
- NextToken String
DescribeConfigRulesRequest
- DescribeConfigRulesRequest
object
:- ConfigRuleNames ConfigRuleNames
- NextToken String
DescribeConfigRulesResponse
- DescribeConfigRulesResponse
object
:- ConfigRules ConfigRules
- NextToken String
DescribeConfigurationRecorderStatusRequest
- DescribeConfigurationRecorderStatusRequest
object
: The input for the DescribeConfigurationRecorderStatus action.- ConfigurationRecorderNames ConfigurationRecorderNameList
DescribeConfigurationRecorderStatusResponse
- DescribeConfigurationRecorderStatusResponse
object
: The output for the DescribeConfigurationRecorderStatus action in JSON format.- ConfigurationRecordersStatus ConfigurationRecorderStatusList
DescribeConfigurationRecordersRequest
- DescribeConfigurationRecordersRequest
object
: The input for the DescribeConfigurationRecorders action.- ConfigurationRecorderNames ConfigurationRecorderNameList
DescribeConfigurationRecordersResponse
- DescribeConfigurationRecordersResponse
object
: The output for the DescribeConfigurationRecorders action.- ConfigurationRecorders ConfigurationRecorderList
DescribeDeliveryChannelStatusRequest
- DescribeDeliveryChannelStatusRequest
object
: The input for the DeliveryChannelStatus action.- DeliveryChannelNames DeliveryChannelNameList
DescribeDeliveryChannelStatusResponse
- DescribeDeliveryChannelStatusResponse
object
: The output for the DescribeDeliveryChannelStatus action.- DeliveryChannelsStatus DeliveryChannelStatusList
DescribeDeliveryChannelsRequest
- DescribeDeliveryChannelsRequest
object
: The input for the DescribeDeliveryChannels action.- DeliveryChannelNames DeliveryChannelNameList
DescribeDeliveryChannelsResponse
- DescribeDeliveryChannelsResponse
object
: The output for the DescribeDeliveryChannels action.- DeliveryChannels DeliveryChannelList
EarlierTime
- EarlierTime
string
EmptiableStringWithCharLimit256
- EmptiableStringWithCharLimit256
string
Evaluation
- Evaluation
object
: Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.- Annotation StringWithCharLimit256
- ComplianceResourceId required BaseResourceId
- ComplianceResourceType required StringWithCharLimit256
- ComplianceType required ComplianceType
- OrderingTimestamp required OrderingTimestamp
EvaluationResult
- EvaluationResult
object
: The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information.- Annotation StringWithCharLimit256
- ComplianceType ComplianceType
- ConfigRuleInvokedTime Date
- EvaluationResultIdentifier EvaluationResultIdentifier
- ResultRecordedTime Date
- ResultToken String
EvaluationResultIdentifier
- EvaluationResultIdentifier
object
: Uniquely identifies an evaluation result.- EvaluationResultQualifier EvaluationResultQualifier
- OrderingTimestamp Date
EvaluationResultQualifier
- EvaluationResultQualifier
object
: Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated.- ConfigRuleName StringWithCharLimit64
- ResourceId BaseResourceId
- ResourceType StringWithCharLimit256
EvaluationResults
- EvaluationResults
array
- items EvaluationResult
Evaluations
- Evaluations
array
- items Evaluation
EventSource
- EventSource
string
(values: aws.config)
GetComplianceDetailsByConfigRuleRequest
- GetComplianceDetailsByConfigRuleRequest
object
:- ComplianceTypes ComplianceTypes
- ConfigRuleName required StringWithCharLimit64
- Limit Limit
- NextToken NextToken
GetComplianceDetailsByConfigRuleResponse
- GetComplianceDetailsByConfigRuleResponse
object
:- EvaluationResults EvaluationResults
- NextToken NextToken
GetComplianceDetailsByResourceRequest
- GetComplianceDetailsByResourceRequest
object
:- ComplianceTypes ComplianceTypes
- NextToken String
- ResourceId required BaseResourceId
- ResourceType required StringWithCharLimit256
GetComplianceDetailsByResourceResponse
- GetComplianceDetailsByResourceResponse
object
:- EvaluationResults EvaluationResults
- NextToken String
GetComplianceSummaryByConfigRuleResponse
- GetComplianceSummaryByConfigRuleResponse
object
:- ComplianceSummary ComplianceSummary
GetComplianceSummaryByResourceTypeRequest
- GetComplianceSummaryByResourceTypeRequest
object
:- ResourceTypes ResourceTypes
GetComplianceSummaryByResourceTypeResponse
- GetComplianceSummaryByResourceTypeResponse
object
:- ComplianceSummariesByResourceType ComplianceSummariesByResourceType
GetDiscoveredResourceCountsRequest
- GetDiscoveredResourceCountsRequest
object
- limit Limit
- nextToken NextToken
- resourceTypes ResourceTypes
GetDiscoveredResourceCountsResponse
- GetDiscoveredResourceCountsResponse
object
- nextToken NextToken
- resourceCounts ResourceCounts
- totalDiscoveredResources Long
GetResourceConfigHistoryRequest
- GetResourceConfigHistoryRequest
object
: The input for the GetResourceConfigHistory action.- chronologicalOrder ChronologicalOrder
- earlierTime EarlierTime
- laterTime LaterTime
- limit Limit
- nextToken NextToken
- resourceId required ResourceId
- resourceType required ResourceType
GetResourceConfigHistoryResponse
- GetResourceConfigHistoryResponse
object
: The output for the GetResourceConfigHistory action.- configurationItems ConfigurationItemList
- nextToken NextToken
IncludeGlobalResourceTypes
- IncludeGlobalResourceTypes
boolean
InsufficientDeliveryPolicyException
- InsufficientDeliveryPolicyException
object
: Your Amazon S3 bucket policy does not permit AWS Config to write to it.
InsufficientPermissionsException
- InsufficientPermissionsException
object
: Indicates one of the following errors: The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action. The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
Integer
- Integer
integer
InvalidConfigurationRecorderNameException
- InvalidConfigurationRecorderNameException
object
: You have provided a configuration recorder name that is not valid.
InvalidDeliveryChannelNameException
- InvalidDeliveryChannelNameException
object
: The specified delivery channel name is not valid.
InvalidLimitException
- InvalidLimitException
object
: The specified limit is outside the allowable range.
InvalidNextTokenException
- InvalidNextTokenException
object
: The specified next token is invalid. Specify the NextToken string that was returned in the previous response to get the next page of results.
InvalidParameterValueException
- InvalidParameterValueException
object
: One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
InvalidRecordingGroupException
- InvalidRecordingGroupException
object
: AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted.
InvalidResultTokenException
- InvalidResultTokenException
object
: The specified ResultToken is invalid.
InvalidRoleException
- InvalidRoleException
object
: You have provided a null or empty role ARN.
InvalidS3KeyPrefixException
- InvalidS3KeyPrefixException
object
: The specified Amazon S3 key prefix is not valid.
InvalidSNSTopicARNException
- InvalidSNSTopicARNException
object
: The specified Amazon SNS topic does not exist.
InvalidTimeRangeException
- InvalidTimeRangeException
object
: The specified time range is not valid. The earlier time is not chronologically before the later time.
LastDeliveryChannelDeleteFailedException
- LastDeliveryChannelDeleteFailedException
object
: You cannot delete the delivery channel you specified because the configuration recorder is running.
LaterTime
- LaterTime
string
Limit
- Limit
integer
LimitExceededException
- LimitExceededException
object
: This exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.
ListDiscoveredResourcesRequest
- ListDiscoveredResourcesRequest
object
:- includeDeletedResources Boolean
- limit Limit
- nextToken NextToken
- resourceIds ResourceIdList
- resourceName ResourceName
- resourceType required ResourceType
ListDiscoveredResourcesResponse
- ListDiscoveredResourcesResponse
object
:- nextToken NextToken
- resourceIdentifiers ResourceIdentifierList
Long
- Long
integer
MaxNumberOfConfigRulesExceededException
- MaxNumberOfConfigRulesExceededException
object
: Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules. Consider deleting any deactivated rules before adding new rules.
MaxNumberOfConfigurationRecordersExceededException
- MaxNumberOfConfigurationRecordersExceededException
object
: You have reached the limit on the number of recorders you can create.
MaxNumberOfDeliveryChannelsExceededException
- MaxNumberOfDeliveryChannelsExceededException
object
: You have reached the limit on the number of delivery channels you can create.
MaximumExecutionFrequency
- MaximumExecutionFrequency
string
(values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours)
MessageType
- MessageType
string
(values: ConfigurationItemChangeNotification, ConfigurationSnapshotDeliveryCompleted, ScheduledNotification, OversizedConfigurationItemChangeNotification)
Name
- Name
string
NextToken
- NextToken
string
NoAvailableConfigurationRecorderException
- NoAvailableConfigurationRecorderException
object
: There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
NoAvailableDeliveryChannelException
- NoAvailableDeliveryChannelException
object
: There is no delivery channel available to record configurations.
NoRunningConfigurationRecorderException
- NoRunningConfigurationRecorderException
object
: There is no configuration recorder running.
NoSuchBucketException
- NoSuchBucketException
object
: The specified Amazon S3 bucket does not exist.
NoSuchConfigRuleException
- NoSuchConfigRuleException
object
: One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.
NoSuchConfigurationRecorderException
- NoSuchConfigurationRecorderException
object
: You have specified a configuration recorder that does not exist.
NoSuchDeliveryChannelException
- NoSuchDeliveryChannelException
object
: You have specified a delivery channel that does not exist.
OrderingTimestamp
- OrderingTimestamp
string
Owner
- Owner
string
(values: CUSTOM_LAMBDA, AWS)
PutConfigRuleRequest
- PutConfigRuleRequest
object
- ConfigRule required ConfigRule
PutConfigurationRecorderRequest
- PutConfigurationRecorderRequest
object
: The input for the PutConfigurationRecorder action.- ConfigurationRecorder required ConfigurationRecorder
PutDeliveryChannelRequest
- PutDeliveryChannelRequest
object
: The input for the PutDeliveryChannel action.- DeliveryChannel required DeliveryChannel
PutEvaluationsRequest
- PutEvaluationsRequest
object
:- Evaluations Evaluations
- ResultToken required String
- TestMode Boolean
PutEvaluationsResponse
- PutEvaluationsResponse
object
:- FailedEvaluations Evaluations
RecorderName
- RecorderName
string
RecorderStatus
- RecorderStatus
string
(values: Pending, Success, Failure)
RecordingGroup
- RecordingGroup
object
: Specifies the types of AWS resource for which AWS Config records configuration changes. In the recording group, you specify whether all supported types or specific types of resources are recorded. By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes. You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions. The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions. If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter. For a list of supported resource types, see Supported resource types. For more information, see Selecting Which Resources AWS Config Records.- allSupported AllSupported
- includeGlobalResourceTypes IncludeGlobalResourceTypes
- resourceTypes ResourceTypeList
ReevaluateConfigRuleNames
- ReevaluateConfigRuleNames
array
- items StringWithCharLimit64
RelatedEvent
- RelatedEvent
string
RelatedEventList
- RelatedEventList
array
- items RelatedEvent
Relationship
- Relationship
object
: The relationship of the related resource to the main resource.- relationshipName RelationshipName
- resourceId ResourceId
- resourceName ResourceName
- resourceType ResourceType
RelationshipList
- RelationshipList
array
- items Relationship
RelationshipName
- RelationshipName
string
ResourceCount
- ResourceCount
object
: An object that contains the resource type and the number of resources.- count Long
- resourceType ResourceType
ResourceCounts
- ResourceCounts
array
- items ResourceCount
ResourceCreationTime
- ResourceCreationTime
string
ResourceDeletionTime
- ResourceDeletionTime
string
ResourceId
- ResourceId
string
ResourceIdList
- ResourceIdList
array
- items ResourceId
ResourceIdentifier
- ResourceIdentifier
object
: The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.- resourceDeletionTime ResourceDeletionTime
- resourceId ResourceId
- resourceName ResourceName
- resourceType ResourceType
ResourceIdentifierList
- ResourceIdentifierList
array
- items ResourceIdentifier
ResourceInUseException
- ResourceInUseException
object
: The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.
ResourceName
- ResourceName
string
ResourceNotDiscoveredException
- ResourceNotDiscoveredException
object
: You have specified a resource that is either unknown or has not been discovered.
ResourceType
- ResourceType
string
(values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::EventSubscription, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::S3::Bucket, AWS::SSM::ManagedInstanceInventory, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::DynamoDB::Table, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution)
ResourceTypeList
- ResourceTypeList
array
- items ResourceType
ResourceTypes
- ResourceTypes
array
- items StringWithCharLimit256
RuleLimit
- RuleLimit
integer
Scope
- Scope
object
: Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.- ComplianceResourceId BaseResourceId
- ComplianceResourceTypes ComplianceResourceTypes
- TagKey StringWithCharLimit128
- TagValue StringWithCharLimit256
Source
- Source
object
: Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.- Owner required Owner
- SourceDetails SourceDetails
- SourceIdentifier required StringWithCharLimit256
SourceDetail
- SourceDetail
object
: Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.- EventSource EventSource
- MaximumExecutionFrequency MaximumExecutionFrequency
- MessageType MessageType
SourceDetails
- SourceDetails
array
- items SourceDetail
StartConfigRulesEvaluationRequest
- StartConfigRulesEvaluationRequest
object
:- ConfigRuleNames ReevaluateConfigRuleNames
StartConfigRulesEvaluationResponse
- StartConfigRulesEvaluationResponse
object
: The output when you start the evaluation for the specified Config rule.
StartConfigurationRecorderRequest
- StartConfigurationRecorderRequest
object
: The input for the StartConfigurationRecorder action.- ConfigurationRecorderName required RecorderName
StopConfigurationRecorderRequest
- StopConfigurationRecorderRequest
object
: The input for the StopConfigurationRecorder action.- ConfigurationRecorderName required RecorderName
String
- String
string
StringWithCharLimit1024
- StringWithCharLimit1024
string
StringWithCharLimit128
- StringWithCharLimit128
string
StringWithCharLimit256
- StringWithCharLimit256
string
StringWithCharLimit64
- StringWithCharLimit64
string
SupplementaryConfiguration
- SupplementaryConfiguration
array
- items
object
- items
SupplementaryConfigurationName
- SupplementaryConfigurationName
string
SupplementaryConfigurationValue
- SupplementaryConfigurationValue
string
Tags
ValidationException
- ValidationException
object
: The requested action is not valid.
Value
- Value
string
Version
- Version
string